diff --git a/LICENSE b/LICENSE index 9a0c6aa66a..5d7c9f4cf7 100644 --- a/LICENSE +++ b/LICENSE @@ -216,3 +216,7 @@ The text of each license is the standard Apache 2.0 license. ScriptRunner from https://github.com/mybatis/mybatis-3 Apache 2.0 mvnw files from https://github.com/takari/maven-wrapper Apache 2.0 PropertyPlaceholderHelper from https://github.com/spring-projects/spring-framework Apache 2.0 + DolphinPluginClassLoader from https://github.com/prestosql/presto Apache 2.0 + DolphinPluginDiscovery from https://github.com/prestosql/presto Apache 2.0 + DolphinPluginLoader from https://github.com/prestosql/presto Apache 2.0 + diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-dingtalk/pom.xml b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-dingtalk/pom.xml new file mode 100644 index 0000000000..7a42257e00 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-dingtalk/pom.xml @@ -0,0 +1,32 @@ + + + + + dolphinscheduler-alert-plugin + org.apache.dolphinscheduler + 1.3.2-SNAPSHOT + + 4.0.0 + + org.apache.dolphinscheduler + dolphinscheduler-alert-dingtalk + + + \ No newline at end of file diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml new file mode 100644 index 0000000000..61b8371be8 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml @@ -0,0 +1,124 @@ + + + + + dolphinscheduler-alert-plugin + org.apache.dolphinscheduler + 1.3.2-SNAPSHOT + + 4.0.0 + + org.apache.dolphinscheduler + dolphinscheduler-alert-email + + dolphinscheduler-plugin + + + + org.apache.dolphinscheduler + dolphinscheduler-spi + provided + + + + com.fasterxml.jackson.core + jackson-annotations + provided + + + com.fasterxml.jackson.core + jackson-databind + provided + + + org.apache.commons + commons-collections4 + + + + org.apache.poi + poi + + + + com.google.guava + guava + + + + ch.qos.logback + logback-classic + + + + org.slf4j + slf4j-api + + + + org.apache.commons + commons-email + + + + com.fasterxml.jackson.core + jackson-annotations + provided + + + + com.fasterxml.jackson.core + jackson-databind + provided + + + + junit + junit + test + + + + org.mockito + mockito-core + jar + test + + + + org.powermock + powermock-module-junit4 + test + + + + org.powermock + powermock-api-mockito2 + test + + + org.mockito + mockito-core + + + + + + \ No newline at end of file diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannel.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannel.java new file mode 100644 index 0000000000..c793af5710 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannel.java @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.spi.alert.AlertChannel; +import org.apache.dolphinscheduler.spi.alert.AlertData; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; +import org.apache.dolphinscheduler.spi.alert.AlertResult; +import org.apache.dolphinscheduler.spi.params.PluginParamsTransfer; + +import java.util.Map; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * email alert channel . use email to seed the alertInfo + */ +public class EmailAlertChannel implements AlertChannel { + private static final Logger logger = LoggerFactory.getLogger(EmailAlertChannel.class); + + @Override + public AlertResult process(AlertInfo info) { + + AlertData alert = info.getAlertData(); + String alertParams = info.getAlertParams(); + Map paramsMap = PluginParamsTransfer.getPluginParamsMap(alertParams); + MailSender mailSender = new MailSender(paramsMap); + AlertResult alertResult = mailSender.sendMails(alert.getTitle(), alert.getContent()); + + //send flag + boolean flag = false; + + if (alertResult == null) { + alertResult = new AlertResult(); + alertResult.setStatus("false"); + alertResult.setMessage("alert send error."); + logger.info("alert send error : {}", alertResult.getMessage()); + return alertResult; + } + + flag = Boolean.parseBoolean(String.valueOf(alertResult.getStatus())); + + if (flag) { + logger.info("alert send success"); + alertResult.setMessage("email send success."); + } else { + alertResult.setMessage("alert send error."); + logger.info("alert send error : {}", alertResult.getMessage()); + } + + return alertResult; + } +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelFactory.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelFactory.java new file mode 100644 index 0000000000..dc38fc011b --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelFactory.java @@ -0,0 +1,137 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.spi.alert.AlertChannel; +import org.apache.dolphinscheduler.spi.alert.AlertChannelFactory; +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.params.InputParam; +import org.apache.dolphinscheduler.spi.params.PasswordParam; +import org.apache.dolphinscheduler.spi.params.RadioParam; +import org.apache.dolphinscheduler.spi.params.base.DataType; +import org.apache.dolphinscheduler.spi.params.base.ParamsOptions; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.Validate; + +import java.util.ArrayList; +import java.util.List; + +/** + * email alert factory + */ +public class EmailAlertChannelFactory implements AlertChannelFactory { + @Override + public String getName() { + return "email alert"; + } + + @Override + public List getParams() { + + List paramsList = new ArrayList<>(); + InputParam receivesParam = InputParam.newBuilder(MailParamsConstants.NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERS, MailParamsConstants.PLUGIN_DEFAULT_EMAIL_RECEIVERS) + .setPlaceholder("please input receives") + .addValidate(Validate.newBuilder() + .setRequired(true) + .build()) + .build(); + + InputParam receiveCcsParam = InputParam.newBuilder(MailParamsConstants.NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERCCS, MailParamsConstants.PLUGIN_DEFAULT_EMAIL_RECEIVERCCS) + .build(); + + InputParam mailSmtpHost = InputParam.newBuilder(MailParamsConstants.NAME_MAIL_SMTP_HOST, MailParamsConstants.MAIL_SMTP_HOST) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam mailSmtpPort = InputParam.newBuilder(MailParamsConstants.NAME_MAIL_SMTP_PORT, MailParamsConstants.MAIL_SMTP_PORT) + .setValue(25) + .addValidate(Validate.newBuilder() + .setRequired(true) + .setType(DataType.NUMBER.getDataType()) + .build()) + .build(); + + InputParam mailSender = InputParam.newBuilder(MailParamsConstants.NAME_MAIL_SENDER, MailParamsConstants.MAIL_SENDER) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + RadioParam enableSmtpAuth = RadioParam.newBuilder(MailParamsConstants.NAME_MAIL_SMTP_AUTH, MailParamsConstants.MAIL_SMTP_AUTH) + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .setValue(true) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam mailUser = InputParam.newBuilder(MailParamsConstants.NAME_MAIL_USER, MailParamsConstants.MAIL_USER) + .setPlaceholder("if enable use authentication, you need input user") + .build(); + + PasswordParam mailPassword = PasswordParam.newBuilder(MailParamsConstants.NAME_MAIL_PASSWD, MailParamsConstants.MAIL_PASSWD) + .setPlaceholder("if enable use authentication, you need input password") + .build(); + + RadioParam enableTls = RadioParam.newBuilder(MailParamsConstants.NAME_MAIL_SMTP_STARTTLS_ENABLE, MailParamsConstants.MAIL_SMTP_STARTTLS_ENABLE) + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .setValue(false) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + RadioParam enableSsl = RadioParam.newBuilder(MailParamsConstants.NAME_MAIL_SMTP_SSL_ENABLE, MailParamsConstants.MAIL_SMTP_SSL_ENABLE) + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .setValue(false) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam sslTrust = InputParam.newBuilder(MailParamsConstants.NAME_MAIL_SMTP_SSL_TRUST, MailParamsConstants.MAIL_SMTP_SSL_TRUST) + .setValue("*") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + RadioParam showType = RadioParam.newBuilder(AlertConstants.SHOW_TYPE, AlertConstants.SHOW_TYPE) + .addParamsOptions(new ParamsOptions(ShowType.TABLE.getDescp(), ShowType.TABLE.getDescp(), false)) + .addParamsOptions(new ParamsOptions(ShowType.TEXT.getDescp(), ShowType.TEXT.getDescp(), false)) + .addParamsOptions(new ParamsOptions(ShowType.ATTACHMENT.getDescp(), ShowType.ATTACHMENT.getDescp(), false)) + .addParamsOptions(new ParamsOptions(ShowType.TABLEATTACHMENT.getDescp(), ShowType.TABLEATTACHMENT.getDescp(), false)) + .setValue(ShowType.TABLE.getDescp()) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + paramsList.add(receivesParam); + paramsList.add(receiveCcsParam); + paramsList.add(mailSmtpHost); + paramsList.add(mailSmtpPort); + paramsList.add(mailSender); + paramsList.add(enableSmtpAuth); + paramsList.add(mailUser); + paramsList.add(mailPassword); + paramsList.add(enableTls); + paramsList.add(enableSsl); + paramsList.add(sslTrust); + paramsList.add(showType); + + return paramsList; + } + + @Override + public AlertChannel create() { + return new EmailAlertChannel(); + } +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertPlugin.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertPlugin.java new file mode 100644 index 0000000000..175b518189 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertPlugin.java @@ -0,0 +1,33 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.spi.DolphinSchedulerPlugin; +import org.apache.dolphinscheduler.spi.alert.AlertChannelFactory; + +import com.google.common.collect.ImmutableList; + +/** + * email alert plugin + */ +public class EmailAlertPlugin implements DolphinSchedulerPlugin { + @Override + public Iterable getAlertChannelFactorys() { + return ImmutableList.of(new EmailAlertChannelFactory()); + } +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailConstants.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailConstants.java new file mode 100644 index 0000000000..d0e85ffb03 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/EmailConstants.java @@ -0,0 +1,75 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +public class EmailConstants { + + + public static final String XLS_FILE_PATH = "xls.file.path"; + + public static final String MAIL_TRANSPORT_PROTOCOL = "mail.transport.protocol"; + + public static final String DEFAULT_SMTP_PORT = "25"; + + public static final String TEXT_HTML_CHARSET_UTF_8 = "text/html;charset=utf-8"; + + public static final int NUMBER_1000 = 1000; + + public static final String TR = ""; + + public static final String TD = ""; + + public static final String TD_END = ""; + + public static final String TR_END = ""; + + public static final String TITLE = "title"; + + public static final String CONTENT = "content"; + + public static final String TH = ""; + + public static final String TH_END = ""; + + public static final String MARKDOWN_QUOTE = ">"; + + public static final String MARKDOWN_ENTER = "\n"; + + public static final String HTML_HEADER_PREFIX = new StringBuilder("") + .append("") + .append("") + .append("dolphinscheduler") + .append("") + .append("") + .append("") + .append("") + .append(" ") + .toString(); + + public static final String TABLE_BODY_HTML_TAIL = "
"; + + public static final String UTF_8 = "UTF-8"; + + public static final String EXCEL_SUFFIX_XLS = ".xls"; + + public static final String SINGLE_SLASH = "/"; +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/ExcelUtils.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/ExcelUtils.java new file mode 100644 index 0000000000..0ca8ae80d3 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/ExcelUtils.java @@ -0,0 +1,149 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.spi.utils.JSONUtils; + +import org.apache.commons.collections4.CollectionUtils; +import org.apache.poi.hssf.usermodel.HSSFCell; +import org.apache.poi.hssf.usermodel.HSSFRow; +import org.apache.poi.hssf.usermodel.HSSFSheet; +import org.apache.poi.hssf.usermodel.HSSFWorkbook; +import org.apache.poi.ss.usermodel.CellStyle; +import org.apache.poi.ss.usermodel.HorizontalAlignment; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * excel utils + */ +public class ExcelUtils { + + private static final Logger logger = LoggerFactory.getLogger(ExcelUtils.class); + + /** + * generate excel file + * + * @param content the content + * @param title the title + * @param xlsFilePath the xls path + */ + public static void genExcelFile(String content, String title, String xlsFilePath) { + List itemsList; + + //The JSONUtils.toList has been try catch ex + itemsList = JSONUtils.toList(content, LinkedHashMap.class); + + if (CollectionUtils.isEmpty(itemsList)) { + logger.error("itemsList is null"); + throw new RuntimeException("itemsList is null"); + } + + LinkedHashMap headerMap = itemsList.get(0); + + List headerList = new ArrayList<>(); + + Iterator> iter = headerMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry en = iter.next(); + headerList.add(en.getKey()); + } + + HSSFWorkbook wb = null; + FileOutputStream fos = null; + try { + // declare a workbook + wb = new HSSFWorkbook(); + // generate a table + HSSFSheet sheet = wb.createSheet(); + HSSFRow row = sheet.createRow(0); + //set the height of the first line + row.setHeight((short) 500); + + //set Horizontal right + CellStyle cellStyle = wb.createCellStyle(); + cellStyle.setAlignment(HorizontalAlignment.RIGHT); + + //setting excel headers + for (int i = 0; i < headerList.size(); i++) { + HSSFCell cell = row.createCell(i); + cell.setCellStyle(cellStyle); + cell.setCellValue(headerList.get(i)); + } + + //setting excel body + int rowIndex = 1; + for (LinkedHashMap itemsMap : itemsList) { + Object[] values = itemsMap.values().toArray(); + row = sheet.createRow(rowIndex); + //setting excel body height + row.setHeight((short) 500); + rowIndex++; + for (int j = 0; j < values.length; j++) { + HSSFCell cell1 = row.createCell(j); + cell1.setCellStyle(cellStyle); + cell1.setCellValue(String.valueOf(values[j])); + } + } + + for (int i = 0; i < headerList.size(); i++) { + sheet.setColumnWidth(i, headerList.get(i).length() * 800); + } + + File file = new File(xlsFilePath); + if (!file.exists()) { + file.mkdirs(); + } + + //setting file output + fos = new FileOutputStream(xlsFilePath + EmailConstants.SINGLE_SLASH + title + EmailConstants.EXCEL_SUFFIX_XLS); + + wb.write(fos); + + } catch (Exception e) { + logger.error("generate excel error", e); + throw new RuntimeException("generate excel error", e); + } finally { + if (wb != null) { + try { + wb.close(); + } catch (IOException e) { + logger.error(e.getMessage(), e); + } + } + if (fos != null) { + try { + fos.close(); + } catch (IOException e) { + logger.error(e.getMessage(), e); + } + } + } + } + +} \ No newline at end of file diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/MailParamsConstants.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/MailParamsConstants.java new file mode 100644 index 0000000000..87e691ce17 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/MailParamsConstants.java @@ -0,0 +1,61 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +/** + * mail plugin params json use + */ +public class MailParamsConstants { + + public static final String PLUGIN_DEFAULT_EMAIL_RECEIVERS = "receivers"; + public static final String NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERS = "receivers"; + + public static final String PLUGIN_DEFAULT_EMAIL_RECEIVERCCS = "receiverCcs"; + public static final String NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERCCS = "receiverCcs"; + + public static final String MAIL_PROTOCOL = "mail.transport.protocol"; + public static final String NAME_MAIL_PROTOCOL = "mailProtocol"; + + public static final String MAIL_SMTP_HOST = "mail.smtp.host"; + public static final String NAME_MAIL_SMTP_HOST = "mailServerHost"; + + public static final String MAIL_SMTP_PORT = "mail.smtp.port"; + public static final String NAME_MAIL_SMTP_PORT = "mailServerPort"; + + public static final String MAIL_SENDER = "mail.sender"; + public static final String NAME_MAIL_SENDER = "mailSender"; + + public static final String MAIL_SMTP_AUTH = "mail.smtp.auth"; + public static final String NAME_MAIL_SMTP_AUTH = "enableSmtpAuth"; + + public static final String MAIL_USER = "mail.user"; + public static final String NAME_MAIL_USER = "mailUser"; + + public static final String MAIL_PASSWD = "mail.passwd"; + public static final String NAME_MAIL_PASSWD = "mailPasswd"; + + public static final String MAIL_SMTP_STARTTLS_ENABLE = "mail.smtp.starttls.enable"; + public static final String NAME_MAIL_SMTP_STARTTLS_ENABLE = "starttlsEnable"; + + public static final String MAIL_SMTP_SSL_ENABLE = "mail.smtp.ssl.enable"; + public static final String NAME_MAIL_SMTP_SSL_ENABLE = "sslEnable"; + + public static final String MAIL_SMTP_SSL_TRUST = "mail.smtp.ssl.trust"; + public static final String NAME_MAIL_SMTP_SSL_TRUST = "mailSmtpSslTrust"; + +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/MailSender.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/MailSender.java new file mode 100644 index 0000000000..03765b248d --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/MailSender.java @@ -0,0 +1,429 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import static java.util.Objects.requireNonNull; + +import org.apache.dolphinscheduler.plugin.alert.email.template.AlertTemplate; +import org.apache.dolphinscheduler.plugin.alert.email.template.DefaultHTMLTemplate; +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.AlertResult; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.utils.StringUtils; + +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.mail.EmailException; +import org.apache.commons.mail.HtmlEmail; + +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Properties; + +import javax.mail.Authenticator; +import javax.mail.Message; +import javax.mail.MessagingException; +import javax.mail.PasswordAuthentication; +import javax.mail.Session; +import javax.mail.Transport; +import javax.mail.internet.InternetAddress; +import javax.mail.internet.MimeBodyPart; +import javax.mail.internet.MimeMessage; +import javax.mail.internet.MimeMultipart; +import javax.mail.internet.MimeUtility; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.sun.mail.smtp.SMTPProvider; + +/** + * mail utils + */ +public class MailSender { + + public static final Logger logger = LoggerFactory.getLogger(MailSender.class); + + private List receivers; + private List receiverCcs; + private String mailProtocol = "SMTP"; + private String mailSmtpHost; + private String mailSmtpPort; + private String mailSender; + private String enableSmtpAuth; + private String mailUser; + private String mailPasswd; + private String mailUseStartTLS; + private String mailUseSSL; + private String xlsFilePath; + private String sslTrust; + private String showType; + private AlertTemplate alertTemplate; + + public MailSender(Map config) { + + String receiversConfig = config.get(MailParamsConstants.NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERS); + if (receiversConfig == null || "".equals(receiversConfig)) { + throw new RuntimeException(MailParamsConstants.PLUGIN_DEFAULT_EMAIL_RECEIVERS + "must not be null"); + } + + receivers = Arrays.asList(receiversConfig.split(",")); + + String receiverCcsConfig = config.get(MailParamsConstants.NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERCCS); + + receiverCcs = new ArrayList<>(); + if (receiverCcsConfig != null && !"".equals(receiverCcsConfig)) { + receiverCcs = Arrays.asList(receiverCcsConfig.split(",")); + } + + mailSmtpHost = config.get(MailParamsConstants.NAME_MAIL_SMTP_HOST); + requireNonNull(mailSmtpHost, MailParamsConstants.MAIL_SMTP_HOST + " must not null"); + + mailSmtpPort = config.get(MailParamsConstants.NAME_MAIL_SMTP_PORT); + requireNonNull(mailSmtpPort, MailParamsConstants.MAIL_SMTP_PORT + " must not null"); + + mailSender = config.get(MailParamsConstants.NAME_MAIL_SENDER); + requireNonNull(mailSender, MailParamsConstants.MAIL_SENDER + " must not null"); + + enableSmtpAuth = config.get(MailParamsConstants.NAME_MAIL_SMTP_AUTH); + + mailUser = config.get(MailParamsConstants.NAME_MAIL_USER); + requireNonNull(mailUser, MailParamsConstants.MAIL_USER + " must not null"); + + mailPasswd = config.get(MailParamsConstants.NAME_MAIL_PASSWD); + requireNonNull(mailPasswd, MailParamsConstants.MAIL_PASSWD + " must not null"); + + mailUseStartTLS = config.get(MailParamsConstants.NAME_MAIL_SMTP_STARTTLS_ENABLE); + requireNonNull(mailUseStartTLS, MailParamsConstants.MAIL_SMTP_STARTTLS_ENABLE + " must not null"); + + mailUseSSL = config.get(MailParamsConstants.NAME_MAIL_SMTP_SSL_ENABLE); + requireNonNull(mailUseSSL, MailParamsConstants.MAIL_SMTP_SSL_ENABLE + " must not null"); + + sslTrust = config.get(MailParamsConstants.NAME_MAIL_SMTP_SSL_TRUST); + requireNonNull(sslTrust, MailParamsConstants.MAIL_SMTP_SSL_TRUST + " must not null"); + + showType = config.get(AlertConstants.SHOW_TYPE); + requireNonNull(showType, AlertConstants.SHOW_TYPE + " must not null"); + + xlsFilePath = config.get(EmailConstants.XLS_FILE_PATH); + if (StringUtils.isBlank(xlsFilePath)) { + xlsFilePath = "/tmp/xls"; + } + + alertTemplate = new DefaultHTMLTemplate(); + } + + /** + * send mail to receivers + * + * @param title title + * @param content content + * @return + */ + public AlertResult sendMails(String title, String content) { + return sendMails(this.receivers, this.receiverCcs, title, content); + } + + /** + * send mail to receivers + * + * @param title email title + * @param content email content + * @return + */ + public AlertResult sendMailsToReceiverOnly(String title, String content) { + return sendMails(this.receivers, null, title, content); + } + + /** + * send mail + * + * @param receivers receivers + * @param receiverCcs receiverCcs + * @param title title + * @param content content + * @return + */ + public AlertResult sendMails(List receivers, List receiverCcs, String title, String content) { + AlertResult alertResult = new AlertResult(); + alertResult.setStatus("false"); + + // if there is no receivers && no receiversCc, no need to process + if (CollectionUtils.isEmpty(receivers) && CollectionUtils.isEmpty(receiverCcs)) { + return alertResult; + } + + receivers.removeIf(StringUtils::isEmpty); + + if (showType.equals(ShowType.TABLE.getDescp()) || showType.equals(ShowType.TEXT.getDescp())) { + // send email + HtmlEmail email = new HtmlEmail(); + + try { + Session session = getSession(); + email.setMailSession(session); + email.setFrom(mailSender); + email.setCharset(EmailConstants.UTF_8); + if (CollectionUtils.isNotEmpty(receivers)) { + // receivers mail + for (String receiver : receivers) { + email.addTo(receiver); + } + } + + if (CollectionUtils.isNotEmpty(receiverCcs)) { + //cc + for (String receiverCc : receiverCcs) { + email.addCc(receiverCc); + } + } + // sender mail + return getStringObjectMap(title, content, alertResult, email); + } catch (Exception e) { + handleException(alertResult, e); + } + } else if (showType.equals(ShowType.ATTACHMENT.getDescp()) || showType.equals(ShowType.TABLEATTACHMENT.getDescp())) { + try { + + String partContent = (showType.equals(ShowType.ATTACHMENT.getDescp()) ? "Please see the attachment " + title + EmailConstants.EXCEL_SUFFIX_XLS : htmlTable(content, false)); + + attachment(title, content, partContent); + + alertResult.setStatus("true"); + return alertResult; + } catch (Exception e) { + handleException(alertResult, e); + return alertResult; + } + } + return alertResult; + + } + + /** + * html table content + * + * @param content the content + * @param showAll if show the whole content + * @return the html table form + */ + private String htmlTable(String content, boolean showAll) { + return alertTemplate.getMessageFromTemplate(content, ShowType.TABLE, showAll); + } + + /** + * html table content + * + * @param content the content + * @return the html table form + */ + private String htmlTable(String content) { + return htmlTable(content, true); + } + + /** + * html text content + * + * @param content the content + * @return text in html form + */ + private String htmlText(String content) { + return alertTemplate.getMessageFromTemplate(content, ShowType.TEXT); + } + + /** + * send mail as Excel attachment + * + * @param title + * @param content + * @param partContent + * @throws Exception + */ + private void attachment(String title, String content, String partContent) throws Exception { + MimeMessage msg = getMimeMessage(); + + attachContent(title, content, partContent, msg); + } + + /** + * get MimeMessage + * + * @return + * @throws MessagingException + */ + private MimeMessage getMimeMessage() throws MessagingException { + + // 1. The first step in creating mail: creating session + Session session = getSession(); + // Setting debug mode, can be turned off + session.setDebug(false); + + // 2. creating mail: Creating a MimeMessage + MimeMessage msg = new MimeMessage(session); + // 3. set sender + msg.setFrom(new InternetAddress(mailSender)); + // 4. set receivers + for (String receiver : receivers) { + msg.addRecipients(Message.RecipientType.TO, InternetAddress.parse(receiver)); + } + return msg; + } + + /** + * get session + * + * @return the new Session + */ + private Session getSession() { + Properties props = new Properties(); + props.setProperty(MailParamsConstants.MAIL_SMTP_HOST, mailSmtpHost); + props.setProperty(MailParamsConstants.MAIL_SMTP_PORT, mailSmtpPort); + props.setProperty(MailParamsConstants.MAIL_SMTP_AUTH, enableSmtpAuth); + props.setProperty(EmailConstants.MAIL_TRANSPORT_PROTOCOL, mailProtocol); + props.setProperty(MailParamsConstants.MAIL_SMTP_STARTTLS_ENABLE, mailUseStartTLS); + props.setProperty(MailParamsConstants.MAIL_SMTP_SSL_ENABLE, mailUseSSL); + props.setProperty(MailParamsConstants.MAIL_SMTP_SSL_TRUST, sslTrust); + + Authenticator auth = new Authenticator() { + @Override + protected PasswordAuthentication getPasswordAuthentication() { + // mail username and password + return new PasswordAuthentication(mailUser, mailPasswd); + } + }; + + Session session = Session.getInstance(props, auth); + session.addProvider(new SMTPProvider()); + return session; + } + + /** + * attach content + * + * @param title + * @param content + * @param partContent + * @param msg + * @throws MessagingException + * @throws IOException + */ + private void attachContent(String title, String content, String partContent, MimeMessage msg) throws MessagingException, IOException { + /** + * set receiverCc + */ + if (CollectionUtils.isNotEmpty(receiverCcs)) { + for (String receiverCc : receiverCcs) { + msg.addRecipients(Message.RecipientType.CC, InternetAddress.parse(receiverCc)); + } + } + + // set subject + msg.setSubject(title); + MimeMultipart partList = new MimeMultipart(); + // set signature + MimeBodyPart part1 = new MimeBodyPart(); + part1.setContent(partContent, EmailConstants.TEXT_HTML_CHARSET_UTF_8); + // set attach file + MimeBodyPart part2 = new MimeBodyPart(); + File file = new File(xlsFilePath + EmailConstants.SINGLE_SLASH + title + EmailConstants.EXCEL_SUFFIX_XLS); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + // make excel file + + ExcelUtils.genExcelFile(content, title, xlsFilePath); + + part2.attachFile(file); + part2.setFileName(MimeUtility.encodeText(title + EmailConstants.EXCEL_SUFFIX_XLS, EmailConstants.UTF_8, "B")); + // add components to collection + partList.addBodyPart(part1); + partList.addBodyPart(part2); + msg.setContent(partList); + // 5. send Transport + Transport.send(msg); + // 6. delete saved file + deleteFile(file); + } + + /** + * the string object map + * + * @param title + * @param content + * @param alertResult + * @param email + * @return + * @throws EmailException + */ + private AlertResult getStringObjectMap(String title, String content, AlertResult alertResult, HtmlEmail email) throws EmailException { + + /** + * the subject of the message to be sent + */ + email.setSubject(title); + /** + * to send information, you can use HTML tags in mail content because of the use of HtmlEmail + */ + if (showType.equals(ShowType.TABLE.getDescp())) { + email.setMsg(htmlTable(content)); + } else if (showType.equals(ShowType.TEXT.getDescp())) { + email.setMsg(htmlText(content)); + } + + // send + email.setDebug(true); + Thread.currentThread().setContextClassLoader(getClass().getClassLoader()); + email.send(); + + alertResult.setStatus("true"); + + return alertResult; + } + + /** + * file delete + * + * @param file the file to delete + */ + public void deleteFile(File file) { + if (file.exists()) { + if (file.delete()) { + logger.info("delete success: {}", file.getAbsolutePath() + file.getName()); + } else { + logger.info("delete fail: {}", file.getAbsolutePath() + file.getName()); + } + } else { + logger.info("file not exists: {}", file.getAbsolutePath() + file.getName()); + } + } + + /** + * handle exception + * + * @param alertResult + * @param e + */ + private void handleException(AlertResult alertResult, Exception e) { + logger.error("Send email to {} failed", receivers, e); + alertResult.setMessage("Send email to {" + String.join(",", receivers) + "} failed，" + e.toString()); + } + +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/AlertTemplate.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/template/AlertTemplate.java similarity index 72% rename from dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/AlertTemplate.java rename to dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/template/AlertTemplate.java index 81b5e65f27..dec993d4d0 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/AlertTemplate.java +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/template/AlertTemplate.java @@ -14,9 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.alert.template; -import org.apache.dolphinscheduler.common.enums.ShowType; +package org.apache.dolphinscheduler.plugin.alert.email.template; + +import org.apache.dolphinscheduler.spi.alert.ShowType; /** * alert message template @@ -25,20 +26,22 @@ public interface AlertTemplate { /** * get a message from a specified alert template - * @param content alert message content - * @param showType show type - * @param showAll whether to show all + * + * @param content alert message content + * @param showType show type + * @param showAll whether to show all * @return a message from a specified alert template */ - String getMessageFromTemplate(String content, ShowType showType,boolean showAll); + String getMessageFromTemplate(String content, ShowType showType, boolean showAll); /** * default showAll is true - * @param content alert message content + * + * @param content alert message content * @param showType show type * @return a message from a specified alert template */ - default String getMessageFromTemplate(String content,ShowType showType){ - return getMessageFromTemplate(content,showType,true); + default String getMessageFromTemplate(String content, ShowType showType) { + return getMessageFromTemplate(content, showType, true); } } diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/impl/DefaultHTMLTemplate.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/template/DefaultHTMLTemplate.java similarity index 52% rename from dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/impl/DefaultHTMLTemplate.java rename to dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/template/DefaultHTMLTemplate.java index a01f301a24..06decd6ffc 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/impl/DefaultHTMLTemplate.java +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/main/java/org/apache/dolphinscheduler/plugin/alert/email/template/DefaultHTMLTemplate.java @@ -14,21 +14,27 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.alert.template.impl; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.node.ArrayNode; -import org.apache.dolphinscheduler.alert.template.AlertTemplate; -import org.apache.dolphinscheduler.alert.utils.Constants; -import org.apache.dolphinscheduler.common.enums.ShowType; -import org.apache.dolphinscheduler.common.utils.StringUtils; +package org.apache.dolphinscheduler.plugin.alert.email.template; + +import static java.util.Objects.requireNonNull; + +import org.apache.dolphinscheduler.plugin.alert.email.EmailConstants; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.utils.JSONUtils; +import org.apache.dolphinscheduler.spi.utils.StringUtils; + +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.apache.dolphinscheduler.common.utils.*; -import java.util.*; - -import static org.apache.dolphinscheduler.common.utils.Preconditions.*; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ArrayNode; /** * the default html alert message template @@ -37,33 +43,33 @@ public class DefaultHTMLTemplate implements AlertTemplate { public static final Logger logger = LoggerFactory.getLogger(DefaultHTMLTemplate.class); - @Override - public String getMessageFromTemplate(String content, ShowType showType,boolean showAll) { + public String getMessageFromTemplate(String content, ShowType showType, boolean showAll) { - switch (showType){ + switch (showType) { case TABLE: - return getTableTypeMessage(content,showAll); + return getTableTypeMessage(content, showAll); case TEXT: - return getTextTypeMessage(content,showAll); + return getTextTypeMessage(content, showAll); default: - throw new IllegalArgumentException(String.format("not support showType: %s in DefaultHTMLTemplate",showType)); + throw new IllegalArgumentException(String.format("not support showType: %s in DefaultHTMLTemplate", showType)); } } /** * get alert message which type is TABLE + * * @param content message content * @param showAll weather to show all * @return alert message */ - private String getTableTypeMessage(String content,boolean showAll){ + private String getTableTypeMessage(String content, boolean showAll) { - if (StringUtils.isNotEmpty(content)){ + if (StringUtils.isNotEmpty(content)) { List mapItemsList = JSONUtils.toList(content, LinkedHashMap.class); - if(!showAll && mapItemsList.size() > Constants.NUMBER_1000){ - mapItemsList = mapItemsList.subList(0,Constants.NUMBER_1000); + if (!showAll && mapItemsList.size() > EmailConstants.NUMBER_1000) { + mapItemsList = mapItemsList.subList(0, EmailConstants.NUMBER_1000); } StringBuilder contents = new StringBuilder(200); @@ -71,31 +77,31 @@ public class DefaultHTMLTemplate implements AlertTemplate { boolean flag = true; String title = ""; - for (LinkedHashMap mapItems : mapItemsList){ + for (LinkedHashMap mapItems : mapItemsList) { Set> entries = mapItems.entrySet(); Iterator> iterator = entries.iterator(); - StringBuilder t = new StringBuilder(Constants.TR); - StringBuilder cs = new StringBuilder(Constants.TR); - while (iterator.hasNext()){ + StringBuilder t = new StringBuilder(EmailConstants.TR); + StringBuilder cs = new StringBuilder(EmailConstants.TR); + while (iterator.hasNext()) { Map.Entry entry = iterator.next(); - t.append(Constants.TH).append(entry.getKey()).append(Constants.TH_END); - cs.append(Constants.TD).append(String.valueOf(entry.getValue())).append(Constants.TD_END); + t.append(EmailConstants.TH).append(entry.getKey()).append(EmailConstants.TH_END); + cs.append(EmailConstants.TD).append(String.valueOf(entry.getValue())).append(EmailConstants.TD_END); } - t.append(Constants.TR_END); - cs.append(Constants.TR_END); - if (flag){ + t.append(EmailConstants.TR_END); + cs.append(EmailConstants.TR_END); + if (flag) { title = t.toString(); } flag = false; contents.append(cs); } - return getMessageFromHtmlTemplate(title,contents.toString()); + return getMessageFromHtmlTemplate(title, contents.toString()); } return content; @@ -103,22 +109,23 @@ public class DefaultHTMLTemplate implements AlertTemplate { /** * get alert message which type is TEXT + * * @param content message content * @param showAll weather to show all * @return alert message */ - private String getTextTypeMessage(String content,boolean showAll){ + private String getTextTypeMessage(String content, boolean showAll) { - if (StringUtils.isNotEmpty(content)){ + if (StringUtils.isNotEmpty(content)) { ArrayNode list = JSONUtils.parseArray(content); StringBuilder contents = new StringBuilder(100); - for (JsonNode jsonNode : list){ - contents.append(Constants.TR); - contents.append(Constants.TD).append(jsonNode.toString()).append(Constants.TD_END); - contents.append(Constants.TR_END); + for (JsonNode jsonNode : list) { + contents.append(EmailConstants.TR); + contents.append(EmailConstants.TD).append(jsonNode.toString()).append(EmailConstants.TD_END); + contents.append(EmailConstants.TR_END); } - return getMessageFromHtmlTemplate(null,contents.toString()); + return getMessageFromHtmlTemplate(null, contents.toString()); } @@ -127,16 +134,17 @@ public class DefaultHTMLTemplate implements AlertTemplate { /** * get alert message from a html template - * @param title message title - * @param content message content + * + * @param title message title + * @param content message content * @return alert message which use html template */ - private String getMessageFromHtmlTemplate(String title,String content){ + private String getMessageFromHtmlTemplate(String title, String content) { - checkNotNull(content); - String htmlTableThead = StringUtils.isEmpty(title) ? "" : String.format("%s\n",title); + requireNonNull(content, "content must not null"); + String htmlTableThead = StringUtils.isEmpty(title) ? "" : String.format("%s\n", title); - return Constants.HTML_HEADER_PREFIX +htmlTableThead + content + Constants.TABLE_BODY_HTML_TAIL; + return EmailConstants.HTML_HEADER_PREFIX + htmlTableThead + content + EmailConstants.TABLE_BODY_HTML_TAIL; } } diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelFactoryTest.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelFactoryTest.java new file mode 100644 index 0000000000..91a8df47d9 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelFactoryTest.java @@ -0,0 +1,75 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.spi.alert.AlertChannel; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.utils.JSONUtils; + +import java.util.List; + +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +/** + * EmailAlertChannelFactory Tester. + * + * @version 1.0 + * @since 
Aug 20, 2020
+ */ +public class EmailAlertChannelFactoryTest { + + @Before + public void before() throws Exception { + } + + @After + public void after() throws Exception { + } + + /** + * Method: getName() + */ + @Test + public void testGetName() throws Exception { + } + + /** + * Method: getParams() + */ + @Test + public void testGetParams() throws Exception { + EmailAlertChannelFactory emailAlertChannelFactory = new EmailAlertChannelFactory(); + List params = emailAlertChannelFactory.getParams(); + JSONUtils.toJsonString(params); + Assert.assertEquals(12, params.size()); + } + + /** + * Method: create() + */ + @Test + public void testCreate() throws Exception { + EmailAlertChannelFactory emailAlertChannelFactory = new EmailAlertChannelFactory(); + AlertChannel alertChannel = emailAlertChannelFactory.create(); + Assert.assertNotNull(alertChannel); + } + +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelTest.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelTest.java new file mode 100644 index 0000000000..bc5f2302ea --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/EmailAlertChannelTest.java @@ -0,0 +1,174 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.AlertData; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; +import org.apache.dolphinscheduler.spi.alert.AlertResult; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.params.InputParam; +import org.apache.dolphinscheduler.spi.params.PasswordParam; +import org.apache.dolphinscheduler.spi.params.RadioParam; +import org.apache.dolphinscheduler.spi.params.base.DataType; +import org.apache.dolphinscheduler.spi.params.base.ParamsOptions; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.Validate; +import org.apache.dolphinscheduler.spi.utils.JSONUtils; + +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; + +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +/** + * EmailAlertChannel Tester. + * + * @version 1.0 + * @since 
Aug 20, 2020
+ */ +public class EmailAlertChannelTest { + + @Before + public void before() throws Exception { + } + + @After + public void after() throws Exception { + } + + /** + * Method: process(AlertInfo info) + */ + @Test + public void testProcess() throws Exception { + EmailAlertChannel emailAlertChannel = new EmailAlertChannel(); + AlertData alertData = new AlertData(); + LinkedHashMap map1 = new LinkedHashMap<>(); + map1.put("mysql service name", "mysql200"); + map1.put("mysql address", "192.168.xx.xx"); + map1.put("port", "3306"); + map1.put("no index of number", "80"); + map1.put("database client connections", "190"); + List> maps = new ArrayList<>(); + maps.add(0, map1); + String mapjson = JSONUtils.toJsonString(maps); + + alertData.setId(10) + .setContent(mapjson) + .setLog("10") + .setTitle("test"); + AlertInfo alertInfo = new AlertInfo(); + alertInfo.setAlertData(alertData); + alertInfo.setAlertParams(getEmailAlertParams()); + AlertResult alertResult = emailAlertChannel.process(alertInfo); + Assert.assertNotNull(alertResult); + Assert.assertEquals("false", alertResult.getStatus()); + } + + public String getEmailAlertParams() { + List paramsList = new ArrayList<>(); + InputParam receivesParam = InputParam.newBuilder("receivers", "receivers") + .setValue("540957506@qq.com") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam mailSmtpHost = InputParam.newBuilder("mailServerHost", "mail.smtp.host") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue("smtp.126.com") + .build(); + + InputParam mailSmtpPort = InputParam.newBuilder("mailServerPort", "mail.smtp.port") + .addValidate(Validate.newBuilder() + .setRequired(true) + .setType(DataType.NUMBER.getDataType()) + .build()) + .setValue(25) + .build(); + + InputParam mailSender = InputParam.newBuilder("mailSender", "mail.sender") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue("dolphinscheduler@126.com") + .build(); + + RadioParam enableSmtpAuth = RadioParam.newBuilder("enableSmtpAuth", "mail.smtp.auth") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue(false) + .build(); + + InputParam mailUser = InputParam.newBuilder("mailUser", "mail.user") + .setPlaceholder("if enable use authentication, you need input user") + .setValue("dolphinscheduler@126.com") + .build(); + + PasswordParam mailPassword = PasswordParam.newBuilder("mailPasswd", "mail.passwd") + .setPlaceholder("if enable use authentication, you need input password") + .setValue("escheduler123") + .build(); + + RadioParam enableTls = RadioParam.newBuilder("starttlsEnable", "mail.smtp.starttls.enable") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue(true) + .build(); + + RadioParam enableSsl = RadioParam.newBuilder("sslEnable", "mail.smtp.ssl.enable") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue(true) + .build(); + + InputParam sslTrust = InputParam.newBuilder("mailSmtpSslTrust", "mail.smtp.ssl.trust") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue("smtp.126.com") + .build(); + + List emailShowTypeList = new ArrayList<>(); + emailShowTypeList.add(new ParamsOptions(ShowType.TABLE.getDescp(), ShowType.TABLE.getDescp(), false)); + emailShowTypeList.add(new ParamsOptions(ShowType.TEXT.getDescp(), ShowType.TEXT.getDescp(), false)); + emailShowTypeList.add(new ParamsOptions(ShowType.ATTACHMENT.getDescp(), ShowType.ATTACHMENT.getDescp(), false)); + emailShowTypeList.add(new ParamsOptions(ShowType.TABLEATTACHMENT.getDescp(), ShowType.TABLEATTACHMENT.getDescp(), false)); + RadioParam showType = RadioParam.newBuilder(AlertConstants.SHOW_TYPE, "showType") + .setParamsOptionsList(emailShowTypeList) + .setValue(ShowType.TABLE.getDescp()) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + paramsList.add(receivesParam); + paramsList.add(mailSmtpHost); + paramsList.add(mailSmtpPort); + paramsList.add(mailSender); + paramsList.add(enableSmtpAuth); + paramsList.add(mailUser); + paramsList.add(mailPassword); + paramsList.add(enableTls); + paramsList.add(enableSsl); + paramsList.add(sslTrust); + paramsList.add(showType); + + return JSONUtils.toJsonString(paramsList); + } +} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/ExcelUtilsTest.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/ExcelUtilsTest.java similarity index 89% rename from dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/ExcelUtilsTest.java rename to dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/ExcelUtilsTest.java index 8ee62358dd..5c8b195176 100644 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/ExcelUtilsTest.java +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/ExcelUtilsTest.java @@ -15,7 +15,11 @@ * limitations under the License. */ -package org.apache.dolphinscheduler.alert.utils; +package org.apache.dolphinscheduler.plugin.alert.email; + +import static org.junit.Assert.assertTrue; + +import java.io.File; import org.junit.After; import org.junit.Before; @@ -25,8 +29,6 @@ import org.junit.rules.ExpectedException; import org.junit.rules.TemporaryFolder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.io.File; -import static org.junit.Assert.assertTrue; public class ExcelUtilsTest { @@ -61,7 +63,7 @@ public class ExcelUtilsTest { //Define dest file path String xlsFilePath = rootPath + System.getProperty("file.separator"); - logger.info("xlsFilePath: "+xlsFilePath); + logger.info("xlsFilePath: " + xlsFilePath); //Define correctContent String correctContent = "[{\"name\":\"ds name\",\"value\":\"ds value\"}]"; @@ -76,7 +78,7 @@ public class ExcelUtilsTest { ExcelUtils.genExcelFile(correctContent, title, xlsFilePath); //Test file exists - File xlsFile = new File(xlsFilePath + Constants.SINGLE_SLASH + title + Constants.EXCEL_SUFFIX_XLS); + File xlsFile = new File(xlsFilePath + EmailConstants.SINGLE_SLASH + title + EmailConstants.EXCEL_SUFFIX_XLS); assertTrue(xlsFile.exists()); //Expected RuntimeException @@ -96,7 +98,7 @@ public class ExcelUtilsTest { @Test public void testGenExcelFileByCheckDir() { ExcelUtils.genExcelFile("[{\"a\": \"a\"},{\"a\": \"a\"}]", "t", "/tmp/xls"); - File file = new File("/tmp/xls" + Constants.SINGLE_SLASH + "t" + Constants.EXCEL_SUFFIX_XLS); + File file = new File("/tmp/xls" + EmailConstants.SINGLE_SLASH + "t" + EmailConstants.EXCEL_SUFFIX_XLS); file.delete(); } } \ No newline at end of file diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/MailUtilsTest.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/MailUtilsTest.java new file mode 100644 index 0000000000..e19c819dae --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/MailUtilsTest.java @@ -0,0 +1,136 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email; + +import org.apache.dolphinscheduler.plugin.alert.email.template.AlertTemplate; +import org.apache.dolphinscheduler.plugin.alert.email.template.DefaultHTMLTemplate; +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.utils.JSONUtils; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + */ +public class MailUtilsTest { + private static final Logger logger = LoggerFactory.getLogger(MailUtilsTest.class); + + private static Map emailConfig = new HashMap<>(); + + private static AlertTemplate alertTemplate; + + static MailSender mailSender; + + @BeforeClass + public static void initEmailConfig() { + emailConfig.put(MailParamsConstants.NAME_MAIL_PROTOCOL, "smtp"); + emailConfig.put(MailParamsConstants.NAME_MAIL_SMTP_HOST, "xxx.xxx.com"); + emailConfig.put(MailParamsConstants.NAME_MAIL_SMTP_PORT, "25"); + emailConfig.put(MailParamsConstants.NAME_MAIL_SENDER, "xxx1.xxx.com"); + emailConfig.put(MailParamsConstants.NAME_MAIL_USER, "xxx2.xxx.com"); + emailConfig.put(MailParamsConstants.NAME_MAIL_PASSWD, "111111"); + emailConfig.put(MailParamsConstants.NAME_MAIL_SMTP_STARTTLS_ENABLE, "true"); + emailConfig.put(MailParamsConstants.NAME_MAIL_SMTP_SSL_ENABLE, "false"); + emailConfig.put(MailParamsConstants.NAME_MAIL_SMTP_SSL_TRUST, "false"); + emailConfig.put(MailParamsConstants.NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERS, "347801120@qq.com"); + emailConfig.put(MailParamsConstants.NAME_PLUGIN_DEFAULT_EMAIL_RECEIVERCCS, "347801120@qq.com"); + emailConfig.put(AlertConstants.SHOW_TYPE, ShowType.TEXT.getDescp()); + alertTemplate = new DefaultHTMLTemplate(); + mailSender = new MailSender(emailConfig); + } + + @Test + public void testSendMails() { + + String content = "[\"id:69\"," + + "\"name:UserBehavior-0--1193959466\"," + + "\"Job name: Start workflow\"," + + "\"State: SUCCESS\"," + + "\"Recovery:NO\"," + + "\"Run time: 1\"," + + "\"Start time: 2018-08-06 10:31:34.0\"," + + "\"End time: 2018-08-06 10:31:49.0\"," + + "\"Host: 192.168.xx.xx\"," + + "\"Notify group :4\"]"; + + mailSender.sendMails( + "Mysql Exception", + content); + } + + public String list2String() { + + LinkedHashMap map1 = new LinkedHashMap<>(); + map1.put("mysql service name", "mysql200"); + map1.put("mysql address", "192.168.xx.xx"); + map1.put("port", "3306"); + map1.put("no index of number", "80"); + map1.put("database client connections", "190"); + + LinkedHashMap map2 = new LinkedHashMap<>(); + map2.put("mysql service name", "mysql210"); + map2.put("mysql address", "192.168.xx.xx"); + map2.put("port", "3306"); + map2.put("no index of number", "10"); + map2.put("database client connections", "90"); + + List> maps = new ArrayList<>(); + maps.add(0, map1); + maps.add(1, map2); + String mapjson = JSONUtils.toJsonString(maps); + logger.info(mapjson); + + return mapjson; + + } + + @Test + public void testSendTableMail() { + String title = "Mysql Exception"; + String content = list2String(); + emailConfig.put(AlertConstants.SHOW_TYPE, ShowType.TABLE.getDescp()); + mailSender = new MailSender(emailConfig); + mailSender.sendMails(title, content); + } + + @Test + public void testAttachmentFile() throws Exception { + String content = list2String(); + emailConfig.put(AlertConstants.SHOW_TYPE, ShowType.ATTACHMENT.getDescp()); + mailSender = new MailSender(emailConfig); + mailSender.sendMails("gaojing", content); + } + + @Test + public void testTableAttachmentFile() throws Exception { + String content = list2String(); + emailConfig.put(AlertConstants.SHOW_TYPE, ShowType.TABLEATTACHMENT.getDescp()); + mailSender = new MailSender(emailConfig); + mailSender.sendMails("gaojing", content); + } + +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/template/DefaultHTMLTemplateTest.java b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/template/DefaultHTMLTemplateTest.java new file mode 100644 index 0000000000..3d941962d9 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/src/test/java/org/apache/dolphinscheduler/plugin/alert/email/template/DefaultHTMLTemplateTest.java @@ -0,0 +1,105 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.plugin.alert.email.template; + +import static org.junit.Assert.assertEquals; + +import org.apache.dolphinscheduler.plugin.alert.email.EmailConstants; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.utils.JSONUtils; + +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; + +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * test class for DefaultHTMLTemplate + */ +public class DefaultHTMLTemplateTest { + + private static final Logger logger = LoggerFactory.getLogger(DefaultHTMLTemplateTest.class); + + /** + * only need test method GetMessageFromTemplate + */ + @Test + public void testGetMessageFromTemplate() { + + DefaultHTMLTemplate template = new DefaultHTMLTemplate(); + + String tableTypeMessage = template.getMessageFromTemplate(list2String(), ShowType.TABLE, true); + + assertEquals(tableTypeMessage, generateMockTableTypeResultByHand()); + + String textTypeMessage = template.getMessageFromTemplate(list2String(), ShowType.TEXT, true); + + assertEquals(textTypeMessage, generateMockTextTypeResultByHand()); + } + + /** + * generate some simulation data + */ + private String list2String() { + + LinkedHashMap map1 = new LinkedHashMap<>(); + map1.put("mysql service name", "mysql200"); + map1.put("mysql address", "192.168.xx.xx"); + map1.put("database client connections", "190"); + map1.put("port", "3306"); + map1.put("no index of number", "80"); + + LinkedHashMap map2 = new LinkedHashMap<>(); + map2.put("mysql service name", "mysql210"); + map2.put("mysql address", "192.168.xx.xx"); + map2.put("database client connections", "90"); + map2.put("port", "3306"); + map2.put("no index of number", "10"); + + List> maps = new ArrayList<>(); + maps.add(0, map1); + maps.add(1, map2); + String mapjson = JSONUtils.toJsonString(maps); + logger.info(mapjson); + + return mapjson; + } + + private String generateMockTableTypeResultByHand() { + + return EmailConstants.HTML_HEADER_PREFIX + + "" + + "mysql service namemysql addressdatabase client connectionsportno index of number" + + "\n" + + "mysql200192.168.xx.xx190330680" + + "mysql210192.168.xx.xx90330610" + + EmailConstants.TABLE_BODY_HTML_TAIL; + + } + + private String generateMockTextTypeResultByHand() { + + return EmailConstants.HTML_HEADER_PREFIX + + "{\"mysql service name\":\"mysql200\",\"mysql address\":\"192.168.xx.xx\",\"database client connections\":\"190\",\"port\":\"3306\",\"no index of number\":\"80\"}" + + "{\"mysql service name\":\"mysql210\",\"mysql address\":\"192.168.xx.xx\",\"database client connections\":\"90\",\"port\":\"3306\",\"no index of number\":\"10\"}" + + EmailConstants.TABLE_BODY_HTML_TAIL; + } +} diff --git a/dolphinscheduler-alert-plugin/dolphinscheduler-alert-wechat/pom.xml b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-wechat/pom.xml new file mode 100644 index 0000000000..62ac776660 --- /dev/null +++ b/dolphinscheduler-alert-plugin/dolphinscheduler-alert-wechat/pom.xml @@ -0,0 +1,32 @@ + + + + + dolphinscheduler-alert-plugin + org.apache.dolphinscheduler + 1.3.2-SNAPSHOT + + 4.0.0 + + org.apache.dolphinscheduler + dolphinscheduler-alert-wechat + + + \ No newline at end of file diff --git a/dolphinscheduler-alert-plugin/pom.xml b/dolphinscheduler-alert-plugin/pom.xml new file mode 100644 index 0000000000..d2fbca305d --- /dev/null +++ b/dolphinscheduler-alert-plugin/pom.xml @@ -0,0 +1,39 @@ + + + + + dolphinscheduler + org.apache.dolphinscheduler + 1.3.2-SNAPSHOT + + 4.0.0 + + org.apache.dolphinscheduler + dolphinscheduler-alert-plugin + pom + + + dolphinscheduler-alert-email + dolphinscheduler-alert-wechat + dolphinscheduler-alert-dingtalk + + + + \ No newline at end of file diff --git a/dolphinscheduler-alert/pom.xml b/dolphinscheduler-alert/pom.xml index 215916ddf7..e79c9a2b20 100644 --- a/dolphinscheduler-alert/pom.xml +++ b/dolphinscheduler-alert/pom.xml @@ -32,38 +32,13 @@ - junit - junit - test - - - org.mockito - mockito-core - jar - test - - - - org.powermock - powermock-module-junit4 - test + org.apache.dolphinscheduler + dolphinscheduler-spi - - org.powermock - powermock-api-mockito2 + junit + junit test - - - org.mockito - mockito-core - - - - - - org.apache.commons - commons-email @@ -108,6 +83,53 @@ + + org.sonatype.aether + aether-api + provided + + + + io.airlift.resolver + resolver + provided + + + + org.ow2.asm + asm + provided + + + + org.powermock + powermock-module-junit4 + test + + + + org.mockito + mockito-core + test + + + + mysql + mysql-connector-java + test + + + + org.powermock + powermock-api-mockito2 + test + + + org.mockito + mockito-core + + + diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/AlertServer.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/AlertServer.java index 347336cada..ccd359da18 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/AlertServer.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/AlertServer.java @@ -14,21 +14,28 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert; -import org.apache.dolphinscheduler.alert.plugin.EmailAlertPlugin; +import org.apache.dolphinscheduler.alert.plugin.AlertPluginManager; +import org.apache.dolphinscheduler.alert.plugin.DolphinPluginLoader; +import org.apache.dolphinscheduler.alert.plugin.DolphinPluginManagerConfig; import org.apache.dolphinscheduler.alert.runner.AlertSender; import org.apache.dolphinscheduler.alert.utils.Constants; import org.apache.dolphinscheduler.alert.utils.PropertyUtils; -import org.apache.dolphinscheduler.common.plugin.FilePluginManager; import org.apache.dolphinscheduler.common.thread.Stopper; import org.apache.dolphinscheduler.dao.AlertDao; import org.apache.dolphinscheduler.dao.DaoFactory; +import org.apache.dolphinscheduler.dao.PluginDao; import org.apache.dolphinscheduler.dao.entity.Alert; +import org.apache.dolphinscheduler.spi.utils.StringUtils; + +import java.util.List; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.util.List; +import com.google.common.collect.ImmutableList; /** * alert of start @@ -40,35 +47,59 @@ public class AlertServer { */ private AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); + private PluginDao pluginDao = DaoFactory.getDaoInstance(PluginDao.class); + private AlertSender alertSender; private static AlertServer instance; - private FilePluginManager alertPluginManager; + private AlertPluginManager alertPluginManager; + + private DolphinPluginManagerConfig alertPluginManagerConfig; + + public static final String ALERT_PLUGIN_BINDING = "alert.plugin.binding"; + + public static final String ALERT_PLUGIN_DIR = "alert.plugin.dir"; + + public static final String MAVEN_LOCAL_REPOSITORY = "maven.local.repository"; + + private static class AlertServerHolder { + private static final AlertServer INSTANCE = new AlertServer(); + } + + public static final AlertServer getInstance() { + return AlertServerHolder.INSTANCE; - private static final String[] whitePrefixes = new String[]{"org.apache.dolphinscheduler.plugin.utils."}; + } - private static final String[] excludePrefixes = new String[]{ - "org.apache.dolphinscheduler.plugin.", - "ch.qos.logback.", - "org.slf4j." - }; + private AlertServer() { - public AlertServer() { - alertPluginManager = - new FilePluginManager(PropertyUtils.getString(Constants.PLUGIN_DIR), whitePrefixes, excludePrefixes); - // add default alert plugins - alertPluginManager.addPlugin(new EmailAlertPlugin()); } - public synchronized static AlertServer getInstance() { - if (null == instance) { - instance = new AlertServer(); + private void initPlugin() { + alertPluginManager = new AlertPluginManager(); + alertPluginManagerConfig = new DolphinPluginManagerConfig(); + alertPluginManagerConfig.setPlugins(PropertyUtils.getString(ALERT_PLUGIN_BINDING)); + if (StringUtils.isNotBlank(PropertyUtils.getString(ALERT_PLUGIN_DIR))) { + alertPluginManagerConfig.setInstalledPluginsDir(PropertyUtils.getString(ALERT_PLUGIN_DIR, Constants.ALERT_PLUGIN_PATH).trim()); + } + + if (StringUtils.isNotBlank(PropertyUtils.getString(MAVEN_LOCAL_REPOSITORY))) { + alertPluginManagerConfig.setMavenLocalRepository(PropertyUtils.getString(MAVEN_LOCAL_REPOSITORY).trim()); + } + + DolphinPluginLoader alertPluginLoader = new DolphinPluginLoader(alertPluginManagerConfig, ImmutableList.of(alertPluginManager)); + try { + alertPluginLoader.loadPlugins(); + } catch (Exception e) { + throw new RuntimeException("load Alert Plugin Failed !", e); } - return instance; } public void start() { + + initPlugin(); + logger.info("alert server ready start "); while (Stopper.isRunning()) { try { @@ -77,14 +108,18 @@ public class AlertServer { logger.error(e.getMessage(), e); Thread.currentThread().interrupt(); } - List alerts = alertDao.listWaitExecutionAlert(); - alertSender = new AlertSender(alerts, alertDao, alertPluginManager); - alertSender.run(); + if (alertPluginManager == null || alertPluginManager.getAlertChannelMap().size() == 0) { + logger.warn("No Alert Plugin . Can not send alert info. "); + } else { + List alerts = alertDao.listWaitExecutionAlert(); + alertSender = new AlertSender(alerts, alertDao, alertPluginManager, pluginDao); + alertSender.run(); + } } } - public static void main(String[] args) { + System.out.println(System.getProperty("user.dir")); AlertServer alertServer = AlertServer.getInstance(); alertServer.start(); } diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/DingTalkManager.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/DingTalkManager.java index 6840794026..07de6a05b5 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/DingTalkManager.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/DingTalkManager.java @@ -14,33 +14,35 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.manager; import org.apache.dolphinscheduler.alert.utils.Constants; import org.apache.dolphinscheduler.alert.utils.DingTalkUtils; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; import java.io.IOException; import java.util.HashMap; import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + /** * Ding Talk Manager */ public class DingTalkManager { private static final Logger logger = LoggerFactory.getLogger(EnterpriseWeChatManager.class); - public Map send(AlertInfo alert) { - Map retMap = new HashMap<>(); + public Map send(AlertInfo alert) { + Map retMap = new HashMap<>(); retMap.put(Constants.STATUS, false); logger.info("send message {}", alert.getAlertData().getTitle()); try { String msg = buildMessage(alert); DingTalkUtils.sendDingTalkMsg(msg, Constants.UTF_8); } catch (IOException e) { - logger.error(e.getMessage(),e); + logger.error(e.getMessage(), e); } retMap.put(Constants.STATUS, true); return retMap; diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EmailManager.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EmailManager.java index 22f4b7a27f..874b866759 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EmailManager.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EmailManager.java @@ -1,55 +1,55 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.manager; - -import org.apache.dolphinscheduler.alert.utils.MailUtils; - -import java.util.List; -import java.util.Map; - -/** - * email send manager - */ -public class EmailManager { - /** - * email send - * @param receiversList the receiver list - * @param receiversCcList the cc List - * @param title the title - * @param content the content - * @param showType the showType - * @return the send result - */ - public Map send(List receiversList,List receiversCcList,String title,String content,String showType){ - - return MailUtils.sendMails(receiversList, receiversCcList, title, content, showType); - } - - /** - * msg send - * @param receiversList the receiver list - * @param title the title - * @param content the content - * @param showType the showType - * @return the send result - */ - public Map send(List receiversList,String title,String content,String showType){ - - return MailUtils.sendMails(receiversList,title, content, showType); - } - -} +///* +// * Licensed to the Apache Software Foundation (ASF) under one or more +// * contributor license agreements. See the NOTICE file distributed with +// * this work for additional information regarding copyright ownership. +// * The ASF licenses this file to You under the Apache License, Version 2.0 +// * (the "License"); you may not use this file except in compliance with +// * the License. You may obtain a copy of the License at +// * +// * http://www.apache.org/licenses/LICENSE-2.0 +// * +// * Unless required by applicable law or agreed to in writing, software +// * distributed under the License is distributed on an "AS IS" BASIS, +// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// * See the License for the specific language governing permissions and +// * limitations under the License. +// */ +//package org.apache.dolphinscheduler.alert.manager; +// +//import org.apache.dolphinscheduler.alert.utils.MailUtils; +// +//import java.util.List; +//import java.util.Map; +// +///** +// * email send manager +// */ +//public class EmailManager { +// /** +// * email send +// * @param receiversList the receiver list +// * @param receiversCcList the cc List +// * @param title the title +// * @param content the content +// * @param showType the showType +// * @return the send result +// */ +// public Map send(List receiversList,List receiversCcList,String title,String content,String showType){ +// +// return MailUtils.sendMails(receiversList, receiversCcList, title, content, showType); +// } +// +// /** +// * msg send +// * @param receiversList the receiver list +// * @param title the title +// * @param content the content +// * @param showType the showType +// * @return the send result +// */ +// public Map send(List receiversList,String title,String content,String showType){ +// +// return MailUtils.sendMails(receiversList,title, content, showType); +// } +// +//} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EnterpriseWeChatManager.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EnterpriseWeChatManager.java index 43649d6758..0534d8004f 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EnterpriseWeChatManager.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/EnterpriseWeChatManager.java @@ -14,13 +14,12 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.manager; import org.apache.dolphinscheduler.alert.utils.Constants; import org.apache.dolphinscheduler.alert.utils.EnterpriseWeChatUtils; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; import java.io.IOException; import java.util.Arrays; @@ -28,29 +27,34 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + /** * Enterprise WeChat Manager */ public class EnterpriseWeChatManager { private static final Logger logger = LoggerFactory.getLogger(EnterpriseWeChatManager.class); + /** * Enterprise We Chat send + * * @param alertInfo the alert info - * @param token the token + * @param token the token * @return the send result */ - public Map send(AlertInfo alertInfo, String token){ - Map retMap = new HashMap<>(); + public Map send(AlertInfo alertInfo, String token) { + Map retMap = new HashMap<>(); retMap.put(Constants.STATUS, false); String agentId = EnterpriseWeChatUtils.ENTERPRISE_WE_CHAT_AGENT_ID; String users = EnterpriseWeChatUtils.ENTERPRISE_WE_CHAT_USERS; List userList = Arrays.asList(users.split(",")); logger.info("send message {}", alertInfo.getAlertData().getTitle()); - String msg = EnterpriseWeChatUtils.makeUserSendMsg(userList, agentId,EnterpriseWeChatUtils.markdownByAlert(alertInfo.getAlertData())); + String msg = EnterpriseWeChatUtils.makeUserSendMsg(userList, agentId, EnterpriseWeChatUtils.markdownByAlert(alertInfo)); try { EnterpriseWeChatUtils.sendEnterpriseWeChat(Constants.UTF_8, msg, token); } catch (IOException e) { - logger.error(e.getMessage(),e); + logger.error(e.getMessage(), e); } retMap.put(Constants.STATUS, true); return retMap; diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/MsgManager.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/MsgManager.java index 359492699d..e7fb161162 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/MsgManager.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/manager/MsgManager.java @@ -14,23 +14,27 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.manager; import org.apache.dolphinscheduler.dao.entity.Alert; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * SMS send manager */ -public class MsgManager { +public class MsgManager { private static final Logger logger = LoggerFactory.getLogger(MsgManager.class); + /** * SMS send + * * @param alert the alert */ - public void send(Alert alert){ - logger.info("send message {}",alert); + public void send(Alert alert) { + logger.info("send message {}", alert); } } diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/AbstractDolphinPluginManager.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/AbstractDolphinPluginManager.java new file mode 100644 index 0000000000..9fd847d0e8 --- /dev/null +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/AbstractDolphinPluginManager.java @@ -0,0 +1,29 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import org.apache.dolphinscheduler.dao.DaoFactory; +import org.apache.dolphinscheduler.dao.PluginDao; +import org.apache.dolphinscheduler.spi.DolphinSchedulerPlugin; + +public abstract class AbstractDolphinPluginManager { + + protected PluginDao pluginDao = DaoFactory.getDaoInstance(PluginDao.class); + + public abstract void installPlugin(DolphinSchedulerPlugin dolphinSchedulerPlugin); +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/AlertPluginManager.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/AlertPluginManager.java new file mode 100644 index 0000000000..d9e1906028 --- /dev/null +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/AlertPluginManager.java @@ -0,0 +1,98 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import static java.lang.String.format; +import static java.util.Objects.requireNonNull; + +import static com.google.common.base.Preconditions.checkState; + +import org.apache.dolphinscheduler.dao.entity.PluginDefine; +import org.apache.dolphinscheduler.spi.DolphinSchedulerPlugin; +import org.apache.dolphinscheduler.spi.alert.AlertChannel; +import org.apache.dolphinscheduler.spi.alert.AlertChannelFactory; +import org.apache.dolphinscheduler.spi.classloader.ThreadContextClassLoader; +import org.apache.dolphinscheduler.spi.params.PluginParamsTransfer; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * load the configured alert plugin and manager them + */ +public class AlertPluginManager extends AbstractDolphinPluginManager { + private static final Logger logger = LoggerFactory.getLogger(AlertPluginManager.class); + + private final Map alertChannelFactoryMap = new ConcurrentHashMap<>(); + private final Map alertChannelMap = new ConcurrentHashMap<>(); + + public void addAlertChannelFactory(AlertChannelFactory alertChannelFactory) { + requireNonNull(alertChannelFactory, "alertChannelFactory is null"); + + if (alertChannelFactoryMap.putIfAbsent(alertChannelFactory.getName(), alertChannelFactory) != null) { + throw new IllegalArgumentException(format("Alert Plugin '{}' is already registered", alertChannelFactory.getName())); + } + + try { + loadAlertChannel(alertChannelFactory.getName()); + } catch (Exception e) { + throw new IllegalArgumentException(format("Alert Plugin '{}' is can not load .", alertChannelFactory.getName())); + } + } + + protected void loadAlertChannel(String name) { + requireNonNull(name, "name is null"); + + AlertChannelFactory alertChannelFactory = alertChannelFactoryMap.get(name); + checkState(alertChannelFactory != null, "Alert Plugin {} is not registered", name); + + try (ThreadContextClassLoader ignored = new ThreadContextClassLoader(alertChannelFactory.getClass().getClassLoader())) { + AlertChannel alertChannel = alertChannelFactory.create(); + this.alertChannelMap.put(name, alertChannel); + } + + logger.info("-- Loaded Alert Plugin {} --", name); + } + + public Map getAlertChannelFactoryMap() { + return alertChannelFactoryMap; + } + + public Map getAlertChannelMap() { + return alertChannelMap; + } + + @Override + public void installPlugin(DolphinSchedulerPlugin dolphinSchedulerPlugin) { + for (AlertChannelFactory alertChannelFactory : dolphinSchedulerPlugin.getAlertChannelFactorys()) { + logger.info("Registering Alert Plugin '{}'", alertChannelFactory.getName()); + this.addAlertChannelFactory(alertChannelFactory); + List params = alertChannelFactory.getParams(); + String nameEn = alertChannelFactory.getName(); + String paramsJson = PluginParamsTransfer.transferParamsToJson(params); + + PluginDefine pluginDefine = new PluginDefine(nameEn, "alert", paramsJson); + pluginDao.addOrUpdatePluginDefine(pluginDefine); + } + } +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginClassLoader.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginClassLoader.java new file mode 100644 index 0000000000..80b85894d1 --- /dev/null +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginClassLoader.java @@ -0,0 +1,136 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import static java.util.Objects.requireNonNull; + +import java.io.IOException; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.Enumeration; +import java.util.List; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Iterables; + +class DolphinPluginClassLoader + extends URLClassLoader { + private static final ClassLoader PLATFORM_CLASS_LOADER = findPlatformClassLoader(); + + private final ClassLoader spiClassLoader; + private final List spiPackages; + private final List spiResources; + + public DolphinPluginClassLoader( + List urls, + ClassLoader spiClassLoader, + Iterable spiPackages) { + this(urls, + spiClassLoader, + spiPackages, + Iterables.transform(spiPackages, DolphinPluginClassLoader::classNameToResource)); + } + + private DolphinPluginClassLoader( + List urls, + ClassLoader spiClassLoader, + Iterable spiPackages, + Iterable spiResources) { + // plugins should not have access to the system (application) class loader + super(urls.toArray(new URL[urls.size()]), PLATFORM_CLASS_LOADER); + this.spiClassLoader = requireNonNull(spiClassLoader, "spiClassLoader is null"); + this.spiPackages = ImmutableList.copyOf(spiPackages); + this.spiResources = ImmutableList.copyOf(spiResources); + } + + @Override + protected Class loadClass(String name, boolean resolve) + throws ClassNotFoundException { + // grab the magic lock + synchronized (getClassLoadingLock(name)) { + // Check if class is in the loaded classes cache + Class cachedClass = findLoadedClass(name); + if (cachedClass != null) { + return resolveClass(cachedClass, resolve); + } + + // If this is an SPI class, only check SPI class loader + if (isSpiClass(name)) { + return resolveClass(spiClassLoader.loadClass(name), resolve); + } + + // Look for class locally + return super.loadClass(name, resolve); + } + } + + private Class resolveClass(Class clazz, boolean resolve) { + if (resolve) { + resolveClass(clazz); + } + return clazz; + } + + @Override + public URL getResource(String name) { + // If this is an SPI resource, only check SPI class loader + if (isSpiResource(name)) { + return spiClassLoader.getResource(name); + } + + // Look for resource locally + return super.getResource(name); + } + + @Override + public Enumeration getResources(String name) + throws IOException { + // If this is an SPI resource, use SPI resources + if (isSpiClass(name)) { + return spiClassLoader.getResources(name); + } + + // Use local resources + return super.getResources(name); + } + + private boolean isSpiClass(String name) { + return spiPackages.stream().anyMatch(name::startsWith); + } + + private boolean isSpiResource(String name) { + return spiResources.stream().anyMatch(name::startsWith); + } + + private static String classNameToResource(String className) { + return className.replace('.', '/'); + } + + @SuppressWarnings("JavaReflectionMemberAccess") + private static ClassLoader findPlatformClassLoader() { + try { + // use platform class loader on Java 9 + Method method = ClassLoader.class.getMethod("getPlatformClassLoader"); + return (ClassLoader) method.invoke(null); + } catch (NoSuchMethodException ignored) { + // use null class loader on Java 8 + return null; + } catch (IllegalAccessException | InvocationTargetException e) { + throw new AssertionError(e); + } + } +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginDiscovery.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginDiscovery.java new file mode 100644 index 0000000000..24fe2794d1 --- /dev/null +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginDiscovery.java @@ -0,0 +1,136 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.nio.file.Files.createDirectories; +import static java.nio.file.Files.walkFileTree; + +import static com.google.common.io.ByteStreams.toByteArray; + +import org.apache.dolphinscheduler.spi.DolphinSchedulerPlugin; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStreamWriter; +import java.io.UncheckedIOException; +import java.io.Writer; +import java.nio.file.FileVisitResult; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import org.objectweb.asm.ClassReader; +import org.sonatype.aether.artifact.Artifact; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableSet; + +/** + * The role of this class is to load the plugin class during development + */ +final class DolphinPluginDiscovery { + private static final String JAVA_CLASS_FILE_SUFFIX = ".class"; + private static final String PLUGIN_SERVICES_FILE = "META-INF/services/" + DolphinSchedulerPlugin.class.getName(); + + private DolphinPluginDiscovery() { + } + + public static Set discoverPluginsFromArtifact(Artifact artifact, ClassLoader classLoader) + throws IOException { + if (!artifact.getExtension().equals("dolphinscheduler-plugin")) { + throw new RuntimeException("Unexpected extension for main artifact: " + artifact); + } + + File file = artifact.getFile(); + if (!file.getPath().endsWith("/target/classes")) { + throw new RuntimeException("Unexpected file for main artifact: " + file); + } + if (!file.isDirectory()) { + throw new RuntimeException("Main artifact file is not a directory: " + file); + } + + if (new File(file, PLUGIN_SERVICES_FILE).exists()) { + return ImmutableSet.of(); + } + + return listClasses(file.toPath()).stream() + .filter(name -> classInterfaces(name, classLoader).contains(DolphinSchedulerPlugin.class.getName())) + .collect(Collectors.toSet()); + } + + public static void writePluginServices(Iterable plugins, File root) + throws IOException { + Path path = root.toPath().resolve(PLUGIN_SERVICES_FILE); + createDirectories(path.getParent()); + try (Writer out = new OutputStreamWriter(new FileOutputStream(path.toFile()), UTF_8)) { + for (String plugin : plugins) { + out.write(plugin + "\n"); + } + } + } + + private static List listClasses(Path base) + throws IOException { + ImmutableList.Builder list = ImmutableList.builder(); + walkFileTree(base, new SimpleFileVisitor() { + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attributes) { + if (file.getFileName().toString().endsWith(JAVA_CLASS_FILE_SUFFIX)) { + String name = file.subpath(base.getNameCount(), file.getNameCount()).toString(); + list.add(javaName(name.substring(0, name.length() - JAVA_CLASS_FILE_SUFFIX.length()))); + } + return FileVisitResult.CONTINUE; + } + }); + return list.build(); + } + + private static List classInterfaces(String name, ClassLoader classLoader) { + ImmutableList.Builder list = ImmutableList.builder(); + ClassReader reader = readClass(name, classLoader); + for (String binaryName : reader.getInterfaces()) { + list.add(javaName(binaryName)); + } + if (reader.getSuperName() != null) { + list.addAll(classInterfaces(javaName(reader.getSuperName()), classLoader)); + } + return list.build(); + } + + private static ClassReader readClass(String name, ClassLoader classLoader) { + try (InputStream in = classLoader.getResourceAsStream(binaryName(name) + JAVA_CLASS_FILE_SUFFIX)) { + if (in == null) { + throw new RuntimeException("Failed to read class: " + name); + } + return new ClassReader(toByteArray(in)); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + private static String binaryName(String javaName) { + return javaName.replace('.', '/'); + } + + private static String javaName(String binaryName) { + return binaryName.replace('/', '.'); + } +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginLoader.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginLoader.java new file mode 100644 index 0000000000..940c30d20c --- /dev/null +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginLoader.java @@ -0,0 +1,191 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import static java.lang.String.format; +import static java.util.Objects.requireNonNull; + +import static com.google.common.base.Preconditions.checkState; + +import org.apache.dolphinscheduler.spi.DolphinSchedulerPlugin; +import org.apache.dolphinscheduler.spi.classloader.ThreadContextClassLoader; + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.ServiceLoader; +import java.util.Set; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.sonatype.aether.artifact.Artifact; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Ordering; + +import io.airlift.resolver.ArtifactResolver; + +/** + * Plugin Loader + * Load Plugin from pom when development and run server in IDE + * Load Plugin from the plugin directory when running on the server + */ +public class DolphinPluginLoader { + private static final Logger logger = LoggerFactory.getLogger(DolphinPluginLoader.class); + + /** + * All third-party jar packages used in the classes which in spi package need to be add + */ + private static final ImmutableList DOLPHIN_SPI_PACKAGES = ImmutableList.builder() + .add("org.apache.dolphinscheduler.spi.") + .add("com.fasterxml.jackson.") + .build(); + + private final File installedPluginsDir; + private final List configPlugins; + private ArtifactResolver resolver = null; + private final List dolphinPluginManagerList; + + public DolphinPluginLoader(DolphinPluginManagerConfig config, List dolphinPluginManagerList) { + installedPluginsDir = config.getInstalledPluginsDir(); + if (config.getPlugins() == null) { + this.configPlugins = ImmutableList.of(); + } else { + this.configPlugins = ImmutableList.copyOf(config.getPlugins()); + } + + this.dolphinPluginManagerList = requireNonNull(dolphinPluginManagerList, "dolphinPluginManagerList is null"); + if (configPlugins != null && configPlugins.size() > 0) { + this.resolver = new ArtifactResolver(config.getMavenLocalRepository(), config.getMavenRemoteRepository()); + } + } + + public void loadPlugins() + throws Exception { + for (File file : listPluginDirs(installedPluginsDir)) { + if (file.isDirectory()) { + loadPlugin(file.getAbsolutePath()); + } + } + + for (String plugin : configPlugins) { + loadPlugin(plugin); + } + } + + private void loadPlugin(String plugin) + throws Exception { + logger.info("-- Loading Alert plugin {} --", plugin); + URLClassLoader pluginClassLoader = buildPluginClassLoader(plugin); + try (ThreadContextClassLoader ignored = new ThreadContextClassLoader(pluginClassLoader)) { + loadPlugin(pluginClassLoader); + } + logger.info("-- Finished loading Alert plugin {} --", plugin); + } + + private void loadPlugin(URLClassLoader pluginClassLoader) { + ServiceLoader serviceLoader = ServiceLoader.load(DolphinSchedulerPlugin.class, pluginClassLoader); + List plugins = ImmutableList.copyOf(serviceLoader); + checkState(!plugins.isEmpty(), "No service providers the plugin {}", DolphinSchedulerPlugin.class.getName()); + for (DolphinSchedulerPlugin plugin : plugins) { + logger.info("Installing {}", plugin.getClass().getName()); + for (AbstractDolphinPluginManager dolphinPluginManager : dolphinPluginManagerList) { + dolphinPluginManager.installPlugin(plugin); + } + } + } + + private URLClassLoader buildPluginClassLoader(String plugin) + throws Exception { + File file = new File(plugin); + + if (!file.isDirectory() && (file.getName().equals("pom.xml") || file.getName().endsWith(".pom"))) { + return buildPluginClassLoaderFromPom(file); + } + if (file.isDirectory()) { + return buildPluginClassLoaderFromDirectory(file); + } else { + throw new IllegalArgumentException(format("plugin must be a pom file or directory {} .", plugin)); + } + } + + private URLClassLoader buildPluginClassLoaderFromPom(File pomFile) + throws Exception { + List artifacts = resolver.resolvePom(pomFile); + URLClassLoader classLoader = createClassLoader(artifacts, pomFile.getPath()); + + Artifact artifact = artifacts.get(0); + Set plugins = DolphinPluginDiscovery.discoverPluginsFromArtifact(artifact, classLoader); + if (!plugins.isEmpty()) { + DolphinPluginDiscovery.writePluginServices(plugins, artifact.getFile()); + } + + return classLoader; + } + + private URLClassLoader buildPluginClassLoaderFromDirectory(File dir) + throws Exception { + logger.info("Classpath for {}:", dir.getName()); + List urls = new ArrayList<>(); + for (File file : listPluginDirs(dir)) { + logger.info(" {}", file); + urls.add(file.toURI().toURL()); + } + return createClassLoader(urls); + } + + private URLClassLoader createClassLoader(List artifacts, String name) + throws IOException { + logger.info("Classpath for {}:", name); + List urls = new ArrayList<>(); + for (Artifact artifact : sortArtifacts(artifacts)) { + if (artifact.getFile() == null) { + throw new RuntimeException("Could not resolve artifact: " + artifact); + } + File file = artifact.getFile().getCanonicalFile(); + logger.info(" {}", file); + urls.add(file.toURI().toURL()); + } + return createClassLoader(urls); + } + + private URLClassLoader createClassLoader(List urls) { + ClassLoader parent = getClass().getClassLoader(); + return new DolphinPluginClassLoader(urls, parent, DOLPHIN_SPI_PACKAGES); + } + + private static List listPluginDirs(File installedPluginsDir) { + if (installedPluginsDir != null && installedPluginsDir.isDirectory()) { + File[] files = installedPluginsDir.listFiles(); + if (files != null) { + Arrays.sort(files); + return ImmutableList.copyOf(files); + } + } + return ImmutableList.of(); + } + + private static List sortArtifacts(List artifacts) { + List list = new ArrayList<>(artifacts); + Collections.sort(list, Ordering.natural().nullsLast().onResultOf(Artifact::getFile)); + return list; + } + +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginManagerConfig.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginManagerConfig.java new file mode 100644 index 0000000000..195484db46 --- /dev/null +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginManagerConfig.java @@ -0,0 +1,121 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import static java.lang.String.format; +import static java.util.Objects.requireNonNull; + +import java.io.File; +import java.util.List; + +import com.google.common.base.Splitter; +import com.google.common.collect.ImmutableList; + +/** + * Dolphin Scheduler Plugin Manager Config + */ +public class DolphinPluginManagerConfig { + + /** + * The dir of the Alert Plugin in. + * When AlertServer is running on the server, it will load the Alert Plugin from this directory. + */ + private File installedPluginsDir; + + /** + * The plugin should be load. + * The installedPluginsDir is empty when we development and run server in IDEA. Then we can config which plugin should be load by param name alert.plugin.binding in the alert.properties file + */ + private List plugins; + + /** + * Development, When AlertServer is running on IDE, AlertPluginLoad can load Alert Plugin from local Repository. + */ + private String mavenLocalRepository = System.getProperty("user.home") + "/.m2/repository"; + private List mavenRemoteRepository = ImmutableList.of("http://repo1.maven.org/maven2/"); + + public File getInstalledPluginsDir() { + return installedPluginsDir; + } + + /** + * @param pluginDir + */ + public DolphinPluginManagerConfig setInstalledPluginsDir(String pluginDir) { + requireNonNull(pluginDir, "pluginDir can not be null"); + File pluginDirFile = new File(pluginDir); + if (!pluginDirFile.exists()) { + throw new IllegalArgumentException(format("plugin dir not exists ! {}", pluginDirFile.getPath())); + } + this.installedPluginsDir = pluginDirFile; + return this; + } + + public List getPlugins() { + return plugins; + } + + public DolphinPluginManagerConfig setPlugins(List plugins) { + this.plugins = plugins; + return this; + } + + /** + * When development and run server in IDE, this method can set plugins in alert.properties . + * Then when you start AlertServer in IDE, the plugin can be load. + * eg: + * file: alert.properties + * alert.plugin=\ + * ../dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml, \ + * ../dolphinscheduler-alert-plugin/dolphinscheduler-alert-wechat/pom.xml + * + * @param plugins + * @return + */ + public DolphinPluginManagerConfig setPlugins(String plugins) { + if (plugins == null) { + this.plugins = null; + } else { + this.plugins = ImmutableList.copyOf(Splitter.on(',').omitEmptyStrings().trimResults().split(plugins)); + } + return this; + } + + public String getMavenLocalRepository() { + return mavenLocalRepository; + } + + public DolphinPluginManagerConfig setMavenLocalRepository(String mavenLocalRepository) { + this.mavenLocalRepository = mavenLocalRepository; + return this; + } + + public List getMavenRemoteRepository() { + return mavenRemoteRepository; + } + + public DolphinPluginManagerConfig setMavenRemoteRepository(List mavenRemoteRepository) { + this.mavenRemoteRepository = mavenRemoteRepository; + return this; + } + + public DolphinPluginManagerConfig setMavenRemoteRepository(String mavenRemoteRepository) { + this.mavenRemoteRepository = ImmutableList.copyOf(Splitter.on(',').omitEmptyStrings().trimResults().split(mavenRemoteRepository)); + return this; + } +} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPlugin.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPlugin.java deleted file mode 100644 index fbc600f39e..0000000000 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPlugin.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.plugin; - -import org.apache.dolphinscheduler.alert.manager.DingTalkManager; -import org.apache.dolphinscheduler.alert.manager.EmailManager; -import org.apache.dolphinscheduler.alert.manager.EnterpriseWeChatManager; -import org.apache.dolphinscheduler.alert.utils.Constants; -import org.apache.dolphinscheduler.alert.utils.DingTalkUtils; -import org.apache.dolphinscheduler.alert.utils.EnterpriseWeChatUtils; -import org.apache.dolphinscheduler.common.utils.CollectionUtils; -import org.apache.dolphinscheduler.common.utils.StringUtils; -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; -import org.apache.dolphinscheduler.plugin.model.AlertData; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.apache.dolphinscheduler.plugin.model.PluginName; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.*; - -/** - * EmailAlertPlugin - * - * This plugin is a default plugin, and mix up email and enterprise wechat, because adapt with former alert behavior - */ -public class EmailAlertPlugin implements AlertPlugin { - - private static final Logger logger = LoggerFactory.getLogger(EmailAlertPlugin.class); - - private PluginName pluginName; - - private static final EmailManager emailManager = new EmailManager(); - private static final EnterpriseWeChatManager weChatManager = new EnterpriseWeChatManager(); - private static final DingTalkManager dingTalkManager = new DingTalkManager(); - - public EmailAlertPlugin() { - this.pluginName = new PluginName(); - this.pluginName.setEnglish(Constants.PLUGIN_DEFAULT_EMAIL_EN); - this.pluginName.setChinese(Constants.PLUGIN_DEFAULT_EMAIL_CH); - } - - @Override - public String getId() { - return Constants.PLUGIN_DEFAULT_EMAIL_ID; - } - - @Override - public PluginName getName() { - return pluginName; - } - - @Override - @SuppressWarnings("unchecked") - public Map process(AlertInfo info) { - Map retMaps = new HashMap<>(); - - AlertData alert = info.getAlertData(); - - List receiversList = (List) info.getProp(Constants.PLUGIN_DEFAULT_EMAIL_RECEIVERS); - - // receiving group list - // custom receiver - String receivers = alert.getReceivers(); - if (StringUtils.isNotEmpty(receivers)) { - String[] splits = receivers.split(","); - receiversList.addAll(Arrays.asList(splits)); - } - - List receiversCcList = new ArrayList<>(); - // Custom Copier - String receiversCc = alert.getReceiversCc(); - if (StringUtils.isNotEmpty(receiversCc)) { - String[] splits = receiversCc.split(","); - receiversCcList.addAll(Arrays.asList(splits)); - } - - if (CollectionUtils.isEmpty(receiversList) && CollectionUtils.isEmpty(receiversCcList)) { - logger.warn("alert send error : At least one receiver address required"); - retMaps.put(Constants.STATUS, "false"); - retMaps.put(Constants.MESSAGE, "execution failure,At least one receiver address required."); - return retMaps; - } - - retMaps = emailManager.send(receiversList, receiversCcList, alert.getTitle(), alert.getContent(), - alert.getShowType()); - - //send flag - boolean flag = false; - - if (retMaps == null) { - retMaps = new HashMap<>(); - retMaps.put(Constants.MESSAGE, "alert send error."); - retMaps.put(Constants.STATUS, "false"); - logger.info("alert send error : {}", retMaps.get(Constants.MESSAGE)); - return retMaps; - } - - flag = Boolean.parseBoolean(String.valueOf(retMaps.get(Constants.STATUS))); - - if (flag) { - logger.info("alert send success"); - retMaps.put(Constants.MESSAGE, "email send success."); - if (EnterpriseWeChatUtils.isEnable()) { - logger.info("Enterprise WeChat is enable!"); - try { - String token = EnterpriseWeChatUtils.getToken(); - weChatManager.send(info, token); - } catch (Exception e) { - logger.error(e.getMessage(), e); - } - } - - if (DingTalkUtils.isEnableDingTalk) { - logger.info("Ding Talk is enable."); - dingTalkManager.send(info); - } - - } else { - retMaps.put(Constants.MESSAGE, "alert send error."); - logger.info("alert send error : {}", retMaps.get(Constants.MESSAGE)); - } - - return retMaps; - } - -} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/runner/AlertSender.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/runner/AlertSender.java index 1bae9c7724..4714a76ff1 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/runner/AlertSender.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/runner/AlertSender.java @@ -14,23 +14,24 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.runner; -import org.apache.dolphinscheduler.alert.utils.Constants; +import org.apache.dolphinscheduler.alert.plugin.AlertPluginManager; import org.apache.dolphinscheduler.common.enums.AlertStatus; -import org.apache.dolphinscheduler.common.plugin.PluginManager; import org.apache.dolphinscheduler.dao.AlertDao; +import org.apache.dolphinscheduler.dao.PluginDao; import org.apache.dolphinscheduler.dao.entity.Alert; -import org.apache.dolphinscheduler.dao.entity.User; -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; -import org.apache.dolphinscheduler.plugin.model.AlertData; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +import org.apache.dolphinscheduler.dao.entity.AlertPluginInstance; +import org.apache.dolphinscheduler.spi.alert.AlertChannel; +import org.apache.dolphinscheduler.spi.alert.AlertData; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; +import org.apache.dolphinscheduler.spi.alert.AlertResult; -import java.util.ArrayList; import java.util.List; -import java.util.Map; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * alert sender @@ -41,57 +42,59 @@ public class AlertSender { private List alertList; private AlertDao alertDao; - private PluginManager pluginManager; + private PluginDao pluginDao; + private AlertPluginManager alertPluginManager; - public AlertSender() { + public AlertSender(AlertPluginManager alertPluginManager) { + this.alertPluginManager = alertPluginManager; } - public AlertSender(List alertList, AlertDao alertDao, PluginManager pluginManager) { + public AlertSender(List alertList, AlertDao alertDao, AlertPluginManager alertPluginManager, PluginDao pluginDao) { super(); this.alertList = alertList; this.alertDao = alertDao; - this.pluginManager = pluginManager; + this.pluginDao = pluginDao; + this.alertPluginManager = alertPluginManager; } public void run() { - List users; - Map retMaps = null; for (Alert alert : alertList) { - users = alertDao.listUserByAlertgroupId(alert.getAlertGroupId()); - - // receiving group list - List receiversList = new ArrayList<>(); - for (User user : users) { - receiversList.add(user.getEmail()); - } + //get alert group from alert + int alertGroupId = alert.getAlertGroupId(); + List alertInstanceList = alertDao.listInstanceByAlertGroupId(alertGroupId); AlertData alertData = new AlertData(); alertData.setId(alert.getId()) - .setAlertGroupId(alert.getAlertGroupId()) .setContent(alert.getContent()) .setLog(alert.getLog()) - .setReceivers(alert.getReceivers()) - .setReceiversCc(alert.getReceiversCc()) - .setShowType(alert.getShowType().getDescp()) .setTitle(alert.getTitle()); - AlertInfo alertInfo = new AlertInfo(); - alertInfo.setAlertData(alertData); - - alertInfo.addProp("receivers", receiversList); - - AlertPlugin emailPlugin = pluginManager.findOne(Constants.PLUGIN_DEFAULT_EMAIL_ID); - retMaps = emailPlugin.process(alertInfo); - - if (retMaps == null) { - alertDao.updateAlert(AlertStatus.EXECUTION_FAILURE, "alert send error", alert.getId()); - logger.error("alert send error : return value is null"); - } else if (!Boolean.parseBoolean(String.valueOf(retMaps.get(Constants.STATUS)))) { - alertDao.updateAlert(AlertStatus.EXECUTION_FAILURE, String.valueOf(retMaps.get(Constants.MESSAGE)), alert.getId()); - logger.error("alert send error : {}", retMaps.get(Constants.MESSAGE)); - } else { - alertDao.updateAlert(AlertStatus.EXECUTION_SUCCESS, (String) retMaps.get(Constants.MESSAGE), alert.getId()); - logger.info("alert send success"); + for (AlertPluginInstance instance : alertInstanceList) { + + String pluginName = pluginDao.getPluginDefineById(instance.getPluginDefineId()).getPluginName(); + String pluginInstanceName = instance.getInstanceName(); + AlertInfo alertInfo = new AlertInfo(); + alertInfo.setAlertData(alertData); + alertInfo.setAlertParams(instance.getPluginInstanceParams()); + AlertChannel alertChannel = alertPluginManager.getAlertChannelMap().get(pluginName); + if (alertChannel == null) { + alertDao.updateAlert(AlertStatus.EXECUTION_FAILURE, "Alert send error, not found plugin " + pluginName, alert.getId()); + logger.error("Alert Plugin {} send error : not found plugin {}", pluginInstanceName, pluginName); + continue; + } + + AlertResult alertResult = alertChannel.process(alertInfo); + + if (alertResult == null) { + alertDao.updateAlert(AlertStatus.EXECUTION_FAILURE, "alert send error", alert.getId()); + logger.info("Alert Plugin {} send error : return value is null", pluginInstanceName); + } else if (!Boolean.parseBoolean(String.valueOf(alertResult.getStatus()))) { + alertDao.updateAlert(AlertStatus.EXECUTION_FAILURE, String.valueOf(alertResult.getMessage()), alert.getId()); + logger.info("Alert Plugin {} send error : {}", pluginInstanceName, alertResult.getMessage()); + } else { + alertDao.updateAlert(AlertStatus.EXECUTION_SUCCESS, alertResult.getMessage(), alert.getId()); + logger.info("Alert Plugin {} send success", pluginInstanceName); + } } } diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/Constants.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/Constants.java index 465d9bf895..de48828c8c 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/Constants.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/Constants.java @@ -14,6 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.utils; /** @@ -23,11 +24,15 @@ public class Constants { private Constants() { throw new IllegalStateException("Constants class"); } + /** * alert properties path */ public static final String ALERT_PROPERTIES_PATH = "/alert.properties"; + /** default alert plugin dir **/ + public static final String ALERT_PLUGIN_PATH = "./lib/plugin/alert"; + public static final String DATA_SOURCE_PROPERTIES_PATH = "/dao/data_source.properties"; public static final String SINGLE_SLASH = "/"; @@ -41,41 +46,7 @@ public class Constants { public static final String MESSAGE = "message"; - public static final String MAIL_PROTOCOL = "mail.protocol"; - - public static final String MAIL_SERVER_HOST = "mail.server.host"; - - public static final String MAIL_SERVER_PORT = "mail.server.port"; - - public static final String MAIL_SENDER = "mail.sender"; - - public static final String MAIL_USER = "mail.user"; - - public static final String MAIL_PASSWD = "mail.passwd"; - - public static final String XLS_FILE_PATH = "xls.file.path"; - - public static final String MAIL_HOST = "mail.smtp.host"; - - public static final String MAIL_PORT = "mail.smtp.port"; - - public static final String MAIL_SMTP_AUTH = "mail.smtp.auth"; - - public static final String MAIL_TRANSPORT_PROTOCOL = "mail.transport.protocol"; - - public static final String MAIL_SMTP_STARTTLS_ENABLE = "mail.smtp.starttls.enable"; - - public static final String MAIL_SMTP_SSL_ENABLE = "mail.smtp.ssl.enable"; - - public static final String MAIL_SMTP_SSL_TRUST="mail.smtp.ssl.trust"; - - public static final String TEXT_HTML_CHARSET_UTF_8 = "text/html;charset=utf-8"; - - public static final String STRING_TRUE = "true"; - - public static final String EXCEL_SUFFIX_XLS = ".xls"; - - public static final int NUMBER_1000 = 1000; + public static final String SPRING_DATASOURCE_DRIVER_CLASS_NAME = "spring.datasource.driver-class-name"; @@ -174,25 +145,11 @@ public class Constants { public static final String DINGTALK_ENABLE = "dingtalk.isEnable"; - public static final String HTML_HEADER_PREFIX = "dolphinscheduler "; - public static final String TABLE_BODY_HTML_TAIL = "
"; /** * plugin config */ - public static final String PLUGIN_DIR = "plugin.dir"; - - public static final String PLUGIN_DEFAULT_EMAIL_ID = "email"; - - public static final String PLUGIN_DEFAULT_EMAIL_CH = "邮件"; - - public static final String PLUGIN_DEFAULT_EMAIL_EN = "email"; - - public static final String PLUGIN_DEFAULT_EMAIL_RECEIVERS = "receivers"; - - public static final String PLUGIN_DEFAULT_EMAIL_RECEIVERCCS = "receiverCcs"; - - public static final String RETMAP_MSG = "msg"; + } diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtils.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtils.java index 455d5de834..abac8ae8b7 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtils.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtils.java @@ -14,10 +14,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.utils; +import org.apache.dolphinscheduler.common.utils.JSONUtils; -import org.apache.dolphinscheduler.common.utils.*; import org.apache.commons.codec.binary.StringUtils; import org.apache.http.HttpEntity; import org.apache.http.HttpHost; @@ -32,13 +33,14 @@ import org.apache.http.impl.client.BasicCredentialsProvider; import org.apache.http.impl.client.CloseableHttpClient; import org.apache.http.impl.client.HttpClients; import org.apache.http.util.EntityUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import java.io.IOException; import java.util.HashMap; import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + /** * DingTalkUtils utils * support send msg to ding talk by robot message push function. @@ -59,9 +61,10 @@ public class DingTalkUtils { /** * send message interface * only support text message format now. - * @param msg message context to send + * + * @param msg message context to send * @param charset charset type - * @return result of sending msg + * @return result of sending msg * @throws IOException the IOException */ public static String sendDingTalkMsg(String msg, String charset) throws IOException { @@ -89,20 +92,19 @@ public class DingTalkUtils { } logger.info("Ding Talk send [{}], resp:{%s}", msg, resp); return resp; - } finally { + } finally { httpClient.close(); } } public static HttpPost constructHttpPost(String msg, String charset) { - HttpPost post = new HttpPost(dingTaskUrl); + HttpPost post = new HttpPost(dingTaskUrl); StringEntity entity = new StringEntity(msg, charset); post.setEntity(entity); post.addHeader("Content-Type", "application/json; charset=utf-8"); return post; } - public static CloseableHttpClient getProxyClient() { HttpHost httpProxy = new HttpHost(proxy, port); CredentialsProvider provider = new BasicCredentialsProvider(); diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtils.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtils.java index ef1022755f..17a49e3277 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtils.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtils.java @@ -17,10 +17,12 @@ package org.apache.dolphinscheduler.alert.utils; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.common.utils.JSONUtils; import org.apache.dolphinscheduler.common.utils.StringUtils; -import org.apache.dolphinscheduler.plugin.model.AlertData; +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.params.PluginParamsTransfer; import org.apache.http.HttpEntity; import org.apache.http.client.methods.CloseableHttpResponse; @@ -119,7 +121,7 @@ public class EnterpriseWeChatUtils { * * @param toParty the toParty * @param agentId the agentId - * @param msg the msg + * @param msg the msg * @return Enterprise WeChat send message */ public static String makeTeamSendMsg(String toParty, String agentId, String msg) { @@ -133,7 +135,7 @@ public class EnterpriseWeChatUtils { * * @param toParty the toParty * @param agentId the agentId - * @param msg the msg + * @param msg the msg * @return Enterprise WeChat send message */ public static String makeTeamSendMsg(Collection toParty, String agentId, String msg) { @@ -146,9 +148,9 @@ public class EnterpriseWeChatUtils { /** * make team single user message * - * @param toUser the toUser + * @param toUser the toUser * @param agentId the agentId - * @param msg the msg + * @param msg the msg * @return Enterprise WeChat send message */ public static String makeUserSendMsg(String toUser, String agentId, String msg) { @@ -160,9 +162,9 @@ public class EnterpriseWeChatUtils { /** * make team multi user message * - * @param toUser the toUser + * @param toUser the toUser * @param agentId the agentId - * @param msg the msg + * @param msg the msg * @return Enterprise WeChat send message */ public static String makeUserSendMsg(Collection toUser, String agentId, String msg) { @@ -176,8 +178,8 @@ public class EnterpriseWeChatUtils { * send Enterprise WeChat * * @param charset the charset - * @param data the data - * @param token the token + * @param data the data + * @param token the token * @return Enterprise WeChat resp, demo: {"errcode":0,"errmsg":"ok","invaliduser":""} * @throws IOException the IOException */ @@ -208,7 +210,7 @@ public class EnterpriseWeChatUtils { /** * convert table to markdown style * - * @param title the title + * @param title the title * @param content the content * @return markdown table content */ @@ -238,7 +240,7 @@ public class EnterpriseWeChatUtils { /** * convert text to markdown style * - * @param title the title + * @param title the title * @param content the content * @return markdown text */ @@ -272,12 +274,14 @@ public class EnterpriseWeChatUtils { * * @return the markdown alert table/text */ - public static String markdownByAlert(AlertData alert) { + public static String markdownByAlert(AlertInfo alertInfo) { String result = ""; - if (alert.getShowType().equals(ShowType.TABLE.getDescp())) { - result = markdownTable(alert.getTitle(), alert.getContent()); - } else if (alert.getShowType().equals(ShowType.TEXT.getDescp())) { - result = markdownText(alert.getTitle(), alert.getContent()); + Map paramsMap = PluginParamsTransfer.getPluginParamsMap(alertInfo.getAlertParams()); + String showType = paramsMap.get(AlertConstants.SHOW_TYPE); + if (showType.equals(ShowType.TABLE.getDescp())) { + result = markdownTable(alertInfo.getAlertData().getTitle(), alertInfo.getAlertData().getContent()); + } else if (showType.equals(ShowType.TEXT.getDescp())) { + result = markdownText(alertInfo.getAlertData().getTitle(), alertInfo.getAlertData().getContent()); } return result; diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/ExcelUtils.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/ExcelUtils.java deleted file mode 100644 index 08256860e2..0000000000 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/ExcelUtils.java +++ /dev/null @@ -1,140 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.utils; - -import org.apache.dolphinscheduler.common.utils.CollectionUtils; -import org.apache.poi.hssf.usermodel.HSSFCell; -import org.apache.poi.hssf.usermodel.HSSFRow; -import org.apache.poi.hssf.usermodel.HSSFSheet; -import org.apache.poi.hssf.usermodel.HSSFWorkbook; -import org.apache.poi.ss.usermodel.CellStyle; -import org.apache.poi.ss.usermodel.HorizontalAlignment; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.util.*; -import org.apache.dolphinscheduler.common.utils.*; - -/** - * excel utils - */ -public class ExcelUtils { - - private static final Logger logger = LoggerFactory.getLogger(ExcelUtils.class); - /** - * generate excel file - * @param content the content - * @param title the title - * @param xlsFilePath the xls path - */ - public static void genExcelFile(String content,String title,String xlsFilePath){ - List itemsList; - - //The JSONUtils.toList has been try catch ex - itemsList = JSONUtils.toList(content, LinkedHashMap.class); - - if (CollectionUtils.isEmpty(itemsList)){ - logger.error("itemsList is null"); - throw new RuntimeException("itemsList is null"); - } - - LinkedHashMap headerMap = itemsList.get(0); - - List headerList = new ArrayList<>(); - - Iterator> iter = headerMap.entrySet().iterator(); - while (iter.hasNext()){ - Map.Entry en = iter.next(); - headerList.add(en.getKey()); - } - - HSSFWorkbook wb = null; - FileOutputStream fos = null; - try { - // declare a workbook - wb = new HSSFWorkbook(); - // generate a table - HSSFSheet sheet = wb.createSheet(); - HSSFRow row = sheet.createRow(0); - //set the height of the first line - row.setHeight((short)500); - - //set Horizontal right - CellStyle cellStyle = wb.createCellStyle(); - cellStyle.setAlignment(HorizontalAlignment.RIGHT); - - //setting excel headers - for (int i = 0; i < headerList.size(); i++) { - HSSFCell cell = row.createCell(i); - cell.setCellStyle(cellStyle); - cell.setCellValue(headerList.get(i)); - } - - //setting excel body - int rowIndex = 1; - for (LinkedHashMap itemsMap : itemsList){ - Object[] values = itemsMap.values().toArray(); - row = sheet.createRow(rowIndex); - //setting excel body height - row.setHeight((short)500); - rowIndex++; - for (int j = 0 ; j < values.length ; j++){ - HSSFCell cell1 = row.createCell(j); - cell1.setCellStyle(cellStyle); - cell1.setCellValue(String.valueOf(values[j])); - } - } - - for (int i = 0; i < headerList.size(); i++) { - sheet.setColumnWidth(i, headerList.get(i).length() * 800); - } - - File file = new File(xlsFilePath); - if (!file.exists()) { - file.mkdirs(); - } - - //setting file output - fos = new FileOutputStream(xlsFilePath + Constants.SINGLE_SLASH + title + Constants.EXCEL_SUFFIX_XLS); - - wb.write(fos); - - }catch (Exception e){ - logger.error("generate excel error",e); - throw new RuntimeException("generate excel error",e); - }finally { - if (wb != null){ - try { - wb.close(); - } catch (IOException e) { - logger.error(e.getMessage(),e); - } - } - if (fos != null){ - try { - fos.close(); - } catch (IOException e) { - logger.error(e.getMessage(),e); - } - } - } - } - -} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/FuncUtils.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/FuncUtils.java index d68532a82b..5d28742d12 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/FuncUtils.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/FuncUtils.java @@ -14,6 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.utils; import org.apache.dolphinscheduler.common.utils.StringUtils; @@ -22,7 +23,7 @@ public class FuncUtils { public static String mkString(Iterable list, String split) { - if (null == list || StringUtils.isEmpty(split)){ + if (null == list || StringUtils.isEmpty(split)) { return null; } diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/MailUtils.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/MailUtils.java index 888c9dbb26..1132b172d8 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/MailUtils.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/MailUtils.java @@ -1,352 +1,352 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.utils; - -import org.apache.dolphinscheduler.alert.template.AlertTemplate; -import org.apache.dolphinscheduler.alert.template.AlertTemplateFactory; -import org.apache.dolphinscheduler.common.enums.ShowType; -import org.apache.commons.mail.EmailException; -import org.apache.commons.mail.HtmlEmail; -import org.apache.dolphinscheduler.common.utils.CollectionUtils; -import org.apache.dolphinscheduler.common.utils.StringUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.mail.*; -import javax.mail.internet.*; -import java.io.*; -import java.util.*; - - -/** - * mail utils - */ -public class MailUtils { - - public static final Logger logger = LoggerFactory.getLogger(MailUtils.class); - - public static final String MAIL_PROTOCOL = PropertyUtils.getString(Constants.MAIL_PROTOCOL); - - public static final String MAIL_SERVER_HOST = PropertyUtils.getString(Constants.MAIL_SERVER_HOST); - - public static final Integer MAIL_SERVER_PORT = PropertyUtils.getInt(Constants.MAIL_SERVER_PORT); - - public static final String MAIL_SENDER = PropertyUtils.getString(Constants.MAIL_SENDER); - - public static final String MAIL_USER = PropertyUtils.getString(Constants.MAIL_USER); - - public static final String MAIL_PASSWD = PropertyUtils.getString(Constants.MAIL_PASSWD); - - public static final Boolean MAIL_USE_START_TLS = PropertyUtils.getBoolean(Constants.MAIL_SMTP_STARTTLS_ENABLE); - - public static final Boolean MAIL_USE_SSL = PropertyUtils.getBoolean(Constants.MAIL_SMTP_SSL_ENABLE); - - public static final String xlsFilePath = PropertyUtils.getString(Constants.XLS_FILE_PATH,"/tmp/xls"); - - public static final String STARTTLS_ENABLE = PropertyUtils.getString(Constants.MAIL_SMTP_STARTTLS_ENABLE); - - public static final Boolean SSL_ENABLE = PropertyUtils.getBoolean(Constants.MAIL_SMTP_SSL_ENABLE); - - public static final String SSL_TRUST = PropertyUtils.getString(Constants.MAIL_SMTP_SSL_TRUST); - - public static final AlertTemplate alertTemplate = AlertTemplateFactory.getMessageTemplate(); - - //Solve the problem of messy Chinese name in excel attachment - static { - System.setProperty("mail.mime.splitlongparameters","false"); - } - - /** - * send mail to receivers - * @param receivers the receiver list - * @param title the title - * @param content the content - * @param showType the show type - * @return the result map - */ - public static Map sendMails(Collection receivers, String title, String content,String showType) { - return sendMails(receivers, null, title, content, showType); - } - - /** - * send mail - * @param receivers the receiver list - * @param receiversCc cc list - * @param title the title - * @param content the content - * @param showType the show type - * @return the send result - */ - public static Map sendMails(Collection receivers, Collection receiversCc, String title, String content, String showType) { - Map retMap = new HashMap<>(); - retMap.put(Constants.STATUS, false); - - // if there is no receivers && no receiversCc, no need to process - if (CollectionUtils.isEmpty(receivers) && CollectionUtils.isEmpty(receiversCc)) { - return retMap; - } - - receivers.removeIf(StringUtils::isEmpty); - - if (showType.equals(ShowType.TABLE.getDescp()) || showType.equals(ShowType.TEXT.getDescp())) { - // send email - HtmlEmail email = new HtmlEmail(); - - try { - Session session = getSession(); - email.setMailSession(session); - email.setFrom(MAIL_SENDER); - email.setCharset(Constants.UTF_8); - if (CollectionUtils.isNotEmpty(receivers)){ - // receivers mail - for (String receiver : receivers) { - email.addTo(receiver); - } - } - - if (CollectionUtils.isNotEmpty(receiversCc)){ - //cc - for (String receiverCc : receiversCc) { - email.addCc(receiverCc); - } - } - // sender mail - return getStringObjectMap(title, content, showType, retMap, email); - } catch (Exception e) { - handleException(receivers, retMap, e); - } - }else if (showType.equals(ShowType.ATTACHMENT.getDescp()) || showType.equals(ShowType.TABLEATTACHMENT.getDescp())) { - try { - - String partContent = (showType.equals(ShowType.ATTACHMENT.getDescp()) ? "Please see the attachment " + title + Constants.EXCEL_SUFFIX_XLS : htmlTable(content,false)); - - attachment(receivers,receiversCc,title,content,partContent); - - retMap.put(Constants.STATUS, true); - return retMap; - }catch (Exception e){ - handleException(receivers, retMap, e); - return retMap; - } - } - return retMap; - - } - - /** - * html table content - * @param content the content - * @param showAll if show the whole content - * @return the html table form - */ - private static String htmlTable(String content, boolean showAll){ - return alertTemplate.getMessageFromTemplate(content,ShowType.TABLE,showAll); - } - - /** - * html table content - * @param content the content - * @return the html table form - */ - private static String htmlTable(String content){ - return htmlTable(content,true); - } - - /** - * html text content - * @param content the content - * @return text in html form - */ - private static String htmlText(String content){ - return alertTemplate.getMessageFromTemplate(content,ShowType.TEXT); - } - - /** - * send mail as Excel attachment - * @param receivers the receiver list - * @param title the title - * @throws Exception - */ - private static void attachment(Collection receivers,Collection receiversCc,String title,String content,String partContent)throws Exception{ - MimeMessage msg = getMimeMessage(receivers); - - attachContent(receiversCc, title, content,partContent, msg); - } - - /** - * get MimeMessage - * @param receivers receivers - * @return the MimeMessage - * @throws MessagingException - */ - private static MimeMessage getMimeMessage(Collection receivers) throws MessagingException { - - // 1. The first step in creating mail: creating session - Session session = getSession(); - // Setting debug mode, can be turned off - session.setDebug(false); - - // 2. creating mail: Creating a MimeMessage - MimeMessage msg = new MimeMessage(session); - // 3. set sender - msg.setFrom(new InternetAddress(MAIL_SENDER)); - // 4. set receivers - for (String receiver : receivers) { - msg.addRecipients(Message.RecipientType.TO, InternetAddress.parse(receiver)); - } - return msg; - } - - /** - * get session - * - * @return the new Session - */ - private static Session getSession() { - Properties props = new Properties(); - props.setProperty(Constants.MAIL_HOST, MAIL_SERVER_HOST); - props.setProperty(Constants.MAIL_PORT, String.valueOf(MAIL_SERVER_PORT)); - props.setProperty(Constants.MAIL_SMTP_AUTH, Constants.STRING_TRUE); - props.setProperty(Constants.MAIL_TRANSPORT_PROTOCOL, MAIL_PROTOCOL); - props.setProperty(Constants.MAIL_SMTP_STARTTLS_ENABLE, STARTTLS_ENABLE); - if (SSL_ENABLE) { - props.setProperty(Constants.MAIL_SMTP_SSL_ENABLE, "true"); - props.setProperty(Constants.MAIL_SMTP_SSL_TRUST, SSL_TRUST); - } - - Authenticator auth = new Authenticator() { - @Override - protected PasswordAuthentication getPasswordAuthentication() { - // mail username and password - return new PasswordAuthentication(MAIL_USER, MAIL_PASSWD); - } - }; - - return Session.getInstance(props, auth); - } - - /** - * attach content - * @param receiversCc the cc list - * @param title the title - * @param content the content - * @param partContent the partContent - * @param msg the message - * @throws MessagingException - * @throws IOException - */ - private static void attachContent(Collection receiversCc, String title, String content, String partContent,MimeMessage msg) throws MessagingException, IOException { - /** - * set receiverCc - */ - if(CollectionUtils.isNotEmpty(receiversCc)){ - for (String receiverCc : receiversCc){ - msg.addRecipients(Message.RecipientType.CC, InternetAddress.parse(receiverCc)); - } - } - - // set subject - msg.setSubject(title); - MimeMultipart partList = new MimeMultipart(); - // set signature - MimeBodyPart part1 = new MimeBodyPart(); - part1.setContent(partContent, Constants.TEXT_HTML_CHARSET_UTF_8); - // set attach file - MimeBodyPart part2 = new MimeBodyPart(); - File file = new File(xlsFilePath + Constants.SINGLE_SLASH + title + Constants.EXCEL_SUFFIX_XLS); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - // make excel file - - ExcelUtils.genExcelFile(content,title,xlsFilePath); - - part2.attachFile(file); - part2.setFileName(MimeUtility.encodeText(title + Constants.EXCEL_SUFFIX_XLS,Constants.UTF_8,"B")); - // add components to collection - partList.addBodyPart(part1); - partList.addBodyPart(part2); - msg.setContent(partList); - // 5. send Transport - Transport.send(msg); - // 6. delete saved file - deleteFile(file); - } - - /** - * the string object map - * @param title the title - * @param content the content - * @param showType the showType - * @param retMap the result map - * @param email the email - * @return the result map - * @throws EmailException - */ - private static Map getStringObjectMap(String title, String content, String showType, Map retMap, HtmlEmail email) throws EmailException { - - /** - * the subject of the message to be sent - */ - email.setSubject(title); - /** - * to send information, you can use HTML tags in mail content because of the use of HtmlEmail - */ - if (showType.equals(ShowType.TABLE.getDescp())) { - email.setMsg(htmlTable(content)); - } else if (showType.equals(ShowType.TEXT.getDescp())) { - email.setMsg(htmlText(content)); - } - - // send - email.send(); - - retMap.put(Constants.STATUS, true); - - return retMap; - } - - /** - * file delete - * @param file the file to delete - */ - public static void deleteFile(File file){ - if(file.exists()){ - if(file.delete()){ - logger.info("delete success: {}",file.getAbsolutePath() + file.getName()); - }else{ - logger.info("delete fail: {}", file.getAbsolutePath() + file.getName()); - } - }else{ - logger.info("file not exists: {}", file.getAbsolutePath() + file.getName()); - } - } - - - /** - * handle exception - * @param receivers the receiver list - * @param retMap the result map - * @param e the exception - */ - private static void handleException(Collection receivers, Map retMap, Exception e) { - logger.error("Send email to {} failed", receivers, e); - retMap.put(Constants.MESSAGE, "Send email to {" + String.join(",", receivers) + "} failed，" + e.toString()); - } - - -} +///* +// * Licensed to the Apache Software Foundation (ASF) under one or more +// * contributor license agreements. See the NOTICE file distributed with +// * this work for additional information regarding copyright ownership. +// * The ASF licenses this file to You under the Apache License, Version 2.0 +// * (the "License"); you may not use this file except in compliance with +// * the License. You may obtain a copy of the License at +// * +// * http://www.apache.org/licenses/LICENSE-2.0 +// * +// * Unless required by applicable law or agreed to in writing, software +// * distributed under the License is distributed on an "AS IS" BASIS, +// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// * See the License for the specific language governing permissions and +// * limitations under the License. +// */ +//package org.apache.dolphinscheduler.alert.utils; +// +//import org.apache.dolphinscheduler.alert.template.AlertTemplate; +//import org.apache.dolphinscheduler.alert.template.AlertTemplateFactory; +//import org.apache.dolphinscheduler.common.enums.ShowType; +//import org.apache.commons.mail.EmailException; +//import org.apache.commons.mail.HtmlEmail; +//import org.apache.dolphinscheduler.common.utils.CollectionUtils; +//import org.apache.dolphinscheduler.common.utils.StringUtils; +//import org.slf4j.Logger; +//import org.slf4j.LoggerFactory; +// +//import javax.mail.*; +//import javax.mail.internet.*; +//import java.io.*; +//import java.util.*; +// +// +///** +// * mail utils +// */ +//public class MailUtils { +// +// public static final Logger logger = LoggerFactory.getLogger(MailUtils.class); +// +// public static final String MAIL_PROTOCOL = PropertyUtils.getString(Constants.MAIL_PROTOCOL); +// +// public static final String MAIL_SERVER_HOST = PropertyUtils.getString(Constants.MAIL_SERVER_HOST); +// +// public static final Integer MAIL_SERVER_PORT = PropertyUtils.getInt(Constants.MAIL_SERVER_PORT); +// +// public static final String MAIL_SENDER = PropertyUtils.getString(Constants.MAIL_SENDER); +// +// public static final String MAIL_USER = PropertyUtils.getString(Constants.MAIL_USER); +// +// public static final String MAIL_PASSWD = PropertyUtils.getString(Constants.MAIL_PASSWD); +// +// public static final Boolean MAIL_USE_START_TLS = PropertyUtils.getBoolean(Constants.MAIL_SMTP_STARTTLS_ENABLE); +// +// public static final Boolean MAIL_USE_SSL = PropertyUtils.getBoolean(Constants.MAIL_SMTP_SSL_ENABLE); +// +// public static final String xlsFilePath = PropertyUtils.getString(Constants.XLS_FILE_PATH,"/tmp/xls"); +// +// public static final String STARTTLS_ENABLE = PropertyUtils.getString(Constants.MAIL_SMTP_STARTTLS_ENABLE); +// +// public static final Boolean SSL_ENABLE = PropertyUtils.getBoolean(Constants.MAIL_SMTP_SSL_ENABLE); +// +// public static final String SSL_TRUST = PropertyUtils.getString(Constants.MAIL_SMTP_SSL_TRUST); +// +// public static final AlertTemplate alertTemplate = AlertTemplateFactory.getMessageTemplate(); +// +// //Solve the problem of messy Chinese name in excel attachment +// static { +// System.setProperty("mail.mime.splitlongparameters","false"); +// } +// +// /** +// * send mail to receivers +// * @param receivers the receiver list +// * @param title the title +// * @param content the content +// * @param showType the show type +// * @return the result map +// */ +// public static Map sendMails(Collection receivers, String title, String content,String showType) { +// return sendMails(receivers, null, title, content, showType); +// } +// +// /** +// * send mail +// * @param receivers the receiver list +// * @param receiversCc cc list +// * @param title the title +// * @param content the content +// * @param showType the show type +// * @return the send result +// */ +// public static Map sendMails(Collection receivers, Collection receiversCc, String title, String content, String showType) { +// Map retMap = new HashMap<>(); +// retMap.put(Constants.STATUS, false); +// +// // if there is no receivers && no receiversCc, no need to process +// if (CollectionUtils.isEmpty(receivers) && CollectionUtils.isEmpty(receiversCc)) { +// return retMap; +// } +// +// receivers.removeIf(StringUtils::isEmpty); +// +// if (showType.equals(ShowType.TABLE.getDescp()) || showType.equals(ShowType.TEXT.getDescp())) { +// // send email +// HtmlEmail email = new HtmlEmail(); +// +// try { +// Session session = getSession(); +// email.setMailSession(session); +// email.setFrom(MAIL_SENDER); +// email.setCharset(Constants.UTF_8); +// if (CollectionUtils.isNotEmpty(receivers)){ +// // receivers mail +// for (String receiver : receivers) { +// email.addTo(receiver); +// } +// } +// +// if (CollectionUtils.isNotEmpty(receiversCc)){ +// //cc +// for (String receiverCc : receiversCc) { +// email.addCc(receiverCc); +// } +// } +// // sender mail +// return getStringObjectMap(title, content, showType, retMap, email); +// } catch (Exception e) { +// handleException(receivers, retMap, e); +// } +// }else if (showType.equals(ShowType.ATTACHMENT.getDescp()) || showType.equals(ShowType.TABLEATTACHMENT.getDescp())) { +// try { +// +// String partContent = (showType.equals(ShowType.ATTACHMENT.getDescp()) ? "Please see the attachment " + title + Constants.EXCEL_SUFFIX_XLS : htmlTable(content,false)); +// +// attachment(receivers,receiversCc,title,content,partContent); +// +// retMap.put(Constants.STATUS, true); +// return retMap; +// }catch (Exception e){ +// handleException(receivers, retMap, e); +// return retMap; +// } +// } +// return retMap; +// +// } +// +// /** +// * html table content +// * @param content the content +// * @param showAll if show the whole content +// * @return the html table form +// */ +// private static String htmlTable(String content, boolean showAll){ +// return alertTemplate.getMessageFromTemplate(content,ShowType.TABLE,showAll); +// } +// +// /** +// * html table content +// * @param content the content +// * @return the html table form +// */ +// private static String htmlTable(String content){ +// return htmlTable(content,true); +// } +// +// /** +// * html text content +// * @param content the content +// * @return text in html form +// */ +// private static String htmlText(String content){ +// return alertTemplate.getMessageFromTemplate(content,ShowType.TEXT); +// } +// +// /** +// * send mail as Excel attachment +// * @param receivers the receiver list +// * @param title the title +// * @throws Exception +// */ +// private static void attachment(Collection receivers,Collection receiversCc,String title,String content,String partContent)throws Exception{ +// MimeMessage msg = getMimeMessage(receivers); +// +// attachContent(receiversCc, title, content,partContent, msg); +// } +// +// /** +// * get MimeMessage +// * @param receivers receivers +// * @return the MimeMessage +// * @throws MessagingException +// */ +// private static MimeMessage getMimeMessage(Collection receivers) throws MessagingException { +// +// // 1. The first step in creating mail: creating session +// Session session = getSession(); +// // Setting debug mode, can be turned off +// session.setDebug(false); +// +// // 2. creating mail: Creating a MimeMessage +// MimeMessage msg = new MimeMessage(session); +// // 3. set sender +// msg.setFrom(new InternetAddress(MAIL_SENDER)); +// // 4. set receivers +// for (String receiver : receivers) { +// msg.addRecipients(Message.RecipientType.TO, InternetAddress.parse(receiver)); +// } +// return msg; +// } +// +// /** +// * get session +// * +// * @return the new Session +// */ +// private static Session getSession() { +// Properties props = new Properties(); +// props.setProperty(Constants.MAIL_HOST, MAIL_SERVER_HOST); +// props.setProperty(Constants.MAIL_PORT, String.valueOf(MAIL_SERVER_PORT)); +// props.setProperty(Constants.MAIL_SMTP_AUTH, Constants.STRING_TRUE); +// props.setProperty(Constants.MAIL_TRANSPORT_PROTOCOL, MAIL_PROTOCOL); +// props.setProperty(Constants.MAIL_SMTP_STARTTLS_ENABLE, STARTTLS_ENABLE); +// if (SSL_ENABLE) { +// props.setProperty(Constants.MAIL_SMTP_SSL_ENABLE, "true"); +// props.setProperty(Constants.MAIL_SMTP_SSL_TRUST, SSL_TRUST); +// } +// +// Authenticator auth = new Authenticator() { +// @Override +// protected PasswordAuthentication getPasswordAuthentication() { +// // mail username and password +// return new PasswordAuthentication(MAIL_USER, MAIL_PASSWD); +// } +// }; +// +// return Session.getInstance(props, auth); +// } +// +// /** +// * attach content +// * @param receiversCc the cc list +// * @param title the title +// * @param content the content +// * @param partContent the partContent +// * @param msg the message +// * @throws MessagingException +// * @throws IOException +// */ +// private static void attachContent(Collection receiversCc, String title, String content, String partContent,MimeMessage msg) throws MessagingException, IOException { +// /** +// * set receiverCc +// */ +// if(CollectionUtils.isNotEmpty(receiversCc)){ +// for (String receiverCc : receiversCc){ +// msg.addRecipients(Message.RecipientType.CC, InternetAddress.parse(receiverCc)); +// } +// } +// +// // set subject +// msg.setSubject(title); +// MimeMultipart partList = new MimeMultipart(); +// // set signature +// MimeBodyPart part1 = new MimeBodyPart(); +// part1.setContent(partContent, Constants.TEXT_HTML_CHARSET_UTF_8); +// // set attach file +// MimeBodyPart part2 = new MimeBodyPart(); +// File file = new File(xlsFilePath + Constants.SINGLE_SLASH + title + Constants.EXCEL_SUFFIX_XLS); +// if (!file.getParentFile().exists()) { +// file.getParentFile().mkdirs(); +// } +// // make excel file +// +// ExcelUtils.genExcelFile(content,title,xlsFilePath); +// +// part2.attachFile(file); +// part2.setFileName(MimeUtility.encodeText(title + Constants.EXCEL_SUFFIX_XLS,Constants.UTF_8,"B")); +// // add components to collection +// partList.addBodyPart(part1); +// partList.addBodyPart(part2); +// msg.setContent(partList); +// // 5. send Transport +// Transport.send(msg); +// // 6. delete saved file +// deleteFile(file); +// } +// +// /** +// * the string object map +// * @param title the title +// * @param content the content +// * @param showType the showType +// * @param retMap the result map +// * @param email the email +// * @return the result map +// * @throws EmailException +// */ +// private static Map getStringObjectMap(String title, String content, String showType, Map retMap, HtmlEmail email) throws EmailException { +// +// /** +// * the subject of the message to be sent +// */ +// email.setSubject(title); +// /** +// * to send information, you can use HTML tags in mail content because of the use of HtmlEmail +// */ +// if (showType.equals(ShowType.TABLE.getDescp())) { +// email.setMsg(htmlTable(content)); +// } else if (showType.equals(ShowType.TEXT.getDescp())) { +// email.setMsg(htmlText(content)); +// } +// +// // send +// email.send(); +// +// retMap.put(Constants.STATUS, true); +// +// return retMap; +// } +// +// /** +// * file delete +// * @param file the file to delete +// */ +// public static void deleteFile(File file){ +// if(file.exists()){ +// if(file.delete()){ +// logger.info("delete success: {}",file.getAbsolutePath() + file.getName()); +// }else{ +// logger.info("delete fail: {}", file.getAbsolutePath() + file.getName()); +// } +// }else{ +// logger.info("file not exists: {}", file.getAbsolutePath() + file.getName()); +// } +// } +// +// +// /** +// * handle exception +// * @param receivers the receiver list +// * @param retMap the result map +// * @param e the exception +// */ +// private static void handleException(Collection receivers, Map retMap, Exception e) { +// logger.error("Send email to {} failed", receivers, e); +// retMap.put(Constants.MESSAGE, "Send email to {" + String.join(",", receivers) + "} failed，" + e.toString()); +// } +// +// +//} diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/PropertyUtils.java b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/PropertyUtils.java index 91f7261db2..1f78cedb1a 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/PropertyUtils.java +++ b/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/utils/PropertyUtils.java @@ -14,19 +14,21 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.utils; +import static org.apache.dolphinscheduler.alert.utils.Constants.ALERT_PROPERTIES_PATH; + import org.apache.dolphinscheduler.common.utils.IOUtils; import org.apache.dolphinscheduler.common.utils.StringUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import java.io.IOException; import java.io.InputStream; import java.util.Properties; import java.util.regex.PatternSyntaxException; -import static org.apache.dolphinscheduler.alert.utils.Constants.ALERT_PROPERTIES_PATH; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * property utils @@ -43,11 +45,11 @@ public class PropertyUtils { private static final PropertyUtils propertyUtils = new PropertyUtils(); - private PropertyUtils(){ + private PropertyUtils() { init(); } - private void init(){ + private void init() { String[] propertyFiles = new String[]{ALERT_PROPERTIES_PATH}; for (String fileName : propertyFiles) { InputStream fis = null; @@ -69,6 +71,7 @@ public class PropertyUtils { /** * get property value + * * @param key property name * @return the value */ @@ -82,7 +85,7 @@ public class PropertyUtils { /** * get property value * - * @param key property name + * @param key property name * @param defaultVal default value * @return property value */ @@ -95,7 +98,7 @@ public class PropertyUtils { * get property value * * @param key property name - * @return get property int value , if key == null, then return -1 + * @return get property int value , if key == null, then return -1 */ public static int getInt(String key) { @@ -104,7 +107,8 @@ public class PropertyUtils { /** * get int value - * @param key the key + * + * @param key the key * @param defaultValue the default value * @return the value related the key or the default value if the key not existed */ @@ -117,15 +121,16 @@ public class PropertyUtils { try { return Integer.parseInt(value); } catch (NumberFormatException e) { - logger.info(e.getMessage(),e); + logger.info(e.getMessage(), e); } return defaultValue; } /** * get property value + * * @param key property name - * @return the boolean result value + * @return the boolean result value */ public static Boolean getBoolean(String key) { @@ -134,7 +139,7 @@ public class PropertyUtils { } String value = properties.getProperty(key.trim()); - if(null != value){ + if (null != value) { return Boolean.parseBoolean(value); } @@ -143,16 +148,18 @@ public class PropertyUtils { /** * get long value + * * @param key the key * @return if the value not existed, return -1, or will return the related value */ public static long getLong(String key) { - return getLong(key,-1); + return getLong(key, -1); } /** * get long value - * @param key the key + * + * @param key the key * @param defaultVal the default value * @return the value related the key or the default value if the key not existed */ @@ -166,7 +173,7 @@ public class PropertyUtils { try { return Long.parseLong(val); } catch (NumberFormatException e) { - logger.info(e.getMessage(),e); + logger.info(e.getMessage(), e); } return defaultVal; @@ -174,17 +181,19 @@ public class PropertyUtils { /** * get double value + * * @param key the key * @return if the value not existed, return -1.0, or will return the related value */ public static double getDouble(String key) { String val = getString(key); - return getDouble(key,-1.0); + return getDouble(key, -1.0); } /** * get double value - * @param key the key + * + * @param key the key * @param defaultVal the default value * @return the value related the key or the default value if the key not existed */ @@ -198,17 +207,17 @@ public class PropertyUtils { try { return Double.parseDouble(val); } catch (NumberFormatException e) { - logger.info(e.getMessage(),e); + logger.info(e.getMessage(), e); } return defaultVal; } - /** - * get array - * @param key property name - * @param splitStr separator + * get array + * + * @param key property name + * @param splitStr separator * @return the result array */ public static String[] getArray(String key, String splitStr) { @@ -219,21 +228,22 @@ public class PropertyUtils { try { return value.split(splitStr); } catch (PatternSyntaxException e) { - logger.info(e.getMessage(),e); + logger.info(e.getMessage(), e); } return null; } /** * get enum - * @param key the key - * @param type the class type + * + * @param key the key + * @param type the class type * @param defaultValue the default value - * @param the generic class type - * @return get enum value + * @param the generic class type + * @return get enum value */ public static > T getEnum(String key, Class type, - T defaultValue) { + T defaultValue) { String val = getString(key); if (val == null) { return defaultValue; @@ -242,7 +252,7 @@ public class PropertyUtils { try { return Enum.valueOf(type, val); } catch (IllegalArgumentException e) { - logger.info(e.getMessage(),e); + logger.info(e.getMessage(), e); } return defaultValue; diff --git a/dolphinscheduler-alert/src/main/resources/alert.properties b/dolphinscheduler-alert/src/main/resources/alert.properties index 6eb701841c..46827e42d5 100644 --- a/dolphinscheduler-alert/src/main/resources/alert.properties +++ b/dolphinscheduler-alert/src/main/resources/alert.properties @@ -15,46 +15,19 @@ # limitations under the License. # -#alert type is EMAIL/SMS -alert.type=EMAIL +#This configuration file configures the configuration parameters related to the AlertServer. +#These parameters are only related to the AlertServer, and it has nothing to do with the specific Alert Plugin. +#eg : max retry num. +#eg : Alert Server Listener port -# mail server configuration -mail.protocol=SMTP -mail.server.host=xxx.xxx.com -mail.server.port=25 -mail.sender=xxx@xxx.com -mail.user=xxx@xxx.com -mail.passwd=111111 -# TLS -mail.smtp.starttls.enable=true -# SSL -mail.smtp.ssl.enable=false -mail.smtp.ssl.trust=xxx.xxx.com +#alert.plugin.dir config the Alert Plugin dir . AlertServer while find and load the Alert Plugin Jar from this dir when deploy and start AlertServer on the server . +#eg : +#alert.plugin.dir=/root/dolphinscheduler/lib/plugin/alert -#xls file path,need create if not exist -#xls.file.path=/tmp/xls +#maven.local.repository=/Users/gaojun/Documents/jianguoyun/localRepository -# Enterprise WeChat configuration -enterprise.wechat.enable=false +#alert.plugin.binding config the Alert Plugin need be load when development and run in IDE +#alert.plugin.binding=\ +# ./dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml -#enterprise.wechat.corp.id=xxxxxxx -#enterprise.wechat.secret=xxxxxxx -#enterprise.wechat.agent.id=xxxxxxx -#enterprise.wechat.users=xxxxxxx -#enterprise.wechat.token.url=https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid={corpId}&corpsecret={secret} -#enterprise.wechat.push.url=https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token={token} -#enterprise.wechat.team.send.msg={\"toparty\":\"{toParty}\",\"agentid\":\"{agentId}\",\"msgtype\":\"text\",\"text\":{\"content\":\"{msg}\"},\"safe\":\"0\"} -#enterprise.wechat.user.send.msg={\"touser\":\"{toUser}\",\"agentid\":\"{agentId}\",\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"{msg}\"}} - -plugin.dir=/Users/xx/your/path/to/plugin/dir - -#ding talk configuration -dingtalk.isEnable=flase -dingtalk.webhook=https://oapi.dingtalk.com/robot/send?access_token=xxxxx -dingtalk.keyword= -dingtalk.proxy= -dingtalk.port=80 -dingtalk.user= -dingtalk.password= -dingtalk.isEnableProxy=false diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/AlertPluginManagerTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/AlertPluginManagerTest.java new file mode 100644 index 0000000000..ea78f6b12a --- /dev/null +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/AlertPluginManagerTest.java @@ -0,0 +1,63 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import org.apache.dolphinscheduler.alert.AlertServer; +import org.apache.dolphinscheduler.alert.utils.Constants; +import org.apache.dolphinscheduler.alert.utils.PropertyUtils; +import org.apache.dolphinscheduler.spi.utils.StringUtils; + +import org.junit.Assert; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.google.common.collect.ImmutableList; + +/** + * AlertPluginManager Tester. + */ +public class AlertPluginManagerTest { + + private static final Logger logger = LoggerFactory.getLogger(AlertPluginManagerTest.class); + + @Test + public void testLoadPlugins() throws Exception { + logger.info("begin test AlertPluginManagerTest"); + AlertPluginManager alertPluginManager = new AlertPluginManager(); + DolphinPluginManagerConfig alertPluginManagerConfig = new DolphinPluginManagerConfig(); + String path = DolphinPluginLoader.class.getClassLoader().getResource("").getPath(); + alertPluginManagerConfig.setPlugins(path + "../../../dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml"); + if (StringUtils.isNotBlank(PropertyUtils.getString(AlertServer.ALERT_PLUGIN_DIR))) { + alertPluginManagerConfig.setInstalledPluginsDir(org.apache.dolphinscheduler.alert.utils.PropertyUtils.getString(AlertServer.ALERT_PLUGIN_DIR, Constants.ALERT_PLUGIN_PATH).trim()); + } + + if (StringUtils.isNotBlank(PropertyUtils.getString(AlertServer.MAVEN_LOCAL_REPOSITORY))) { + alertPluginManagerConfig.setMavenLocalRepository(PropertyUtils.getString(AlertServer.MAVEN_LOCAL_REPOSITORY).trim()); + } + + DolphinPluginLoader alertPluginLoader = new DolphinPluginLoader(alertPluginManagerConfig, ImmutableList.of(alertPluginManager)); + try { + alertPluginLoader.loadPlugins(); + } catch (Exception e) { + throw new RuntimeException("load Alert Plugin Failed !", e); + } + + Assert.assertNotNull(alertPluginManager.getAlertChannelFactoryMap().get("email alert")); + } +} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginLoaderTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginLoaderTest.java new file mode 100644 index 0000000000..b9d3d1a0ae --- /dev/null +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/DolphinPluginLoaderTest.java @@ -0,0 +1,58 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.alert.plugin; + +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +import com.google.common.collect.ImmutableList; + +/** + * DolphinPluginLoader Tester. + */ +public class DolphinPluginLoaderTest { + + @Before + public void before() throws Exception { + } + + @After + public void after() throws Exception { + } + + /** + * Method: loadPlugins() + */ + @Test + public void testLoadPlugins() throws Exception { + AlertPluginManager alertPluginManager = new AlertPluginManager(); + DolphinPluginManagerConfig alertPluginManagerConfig = new DolphinPluginManagerConfig(); + String path = DolphinPluginLoader.class.getClassLoader().getResource("").getPath(); + alertPluginManagerConfig.setPlugins(path + "../../../dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml"); + DolphinPluginLoader alertPluginLoader = new DolphinPluginLoader(alertPluginManagerConfig, ImmutableList.of(alertPluginManager)); + try { + alertPluginLoader.loadPlugins(); + } catch (Exception e) { + throw new RuntimeException("load Alert Plugin Failed !", e); + } + + Assert.assertNotNull(alertPluginManager.getAlertChannelFactoryMap().get("email alert")); + } +} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPluginTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPluginTest.java index c2f4006752..6558419160 100644 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPluginTest.java +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/plugin/EmailAlertPluginTest.java @@ -14,67 +14,228 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.plugin; +import org.apache.dolphinscheduler.alert.AlertServer; +import org.apache.dolphinscheduler.alert.runner.AlertSender; import org.apache.dolphinscheduler.alert.utils.Constants; -import org.apache.dolphinscheduler.common.enums.ShowType; -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; -import org.apache.dolphinscheduler.plugin.model.AlertData; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.apache.dolphinscheduler.plugin.model.PluginName; -import org.junit.Before; -import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +import org.apache.dolphinscheduler.alert.utils.PropertyUtils; +import org.apache.dolphinscheduler.common.enums.AlertStatus; +import org.apache.dolphinscheduler.common.enums.AlertType; +import org.apache.dolphinscheduler.common.utils.JSONUtils; +import org.apache.dolphinscheduler.dao.AlertDao; +import org.apache.dolphinscheduler.dao.DaoFactory; +import org.apache.dolphinscheduler.dao.PluginDao; +import org.apache.dolphinscheduler.dao.entity.Alert; +import org.apache.dolphinscheduler.dao.entity.AlertGroup; +import org.apache.dolphinscheduler.dao.entity.AlertPluginInstance; +import org.apache.dolphinscheduler.dao.entity.PluginDefine; +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.params.InputParam; +import org.apache.dolphinscheduler.spi.params.PasswordParam; +import org.apache.dolphinscheduler.spi.params.PluginParamsTransfer; +import org.apache.dolphinscheduler.spi.params.RadioParam; +import org.apache.dolphinscheduler.spi.params.base.DataType; +import org.apache.dolphinscheduler.spi.params.base.ParamsOptions; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.Validate; +import org.apache.dolphinscheduler.spi.utils.StringUtils; import java.util.ArrayList; +import java.util.Date; +import java.util.LinkedHashMap; import java.util.List; -import java.util.Map; -import static org.junit.Assert.*; +import org.junit.Assert; +import org.junit.Test; +import com.google.common.collect.ImmutableList; + +/** + * test load and use alert plugin + */ public class EmailAlertPluginTest { - private static final Logger logger = LoggerFactory.getLogger(EmailAlertPluginTest.class); + AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); + PluginDao pluginDao = DaoFactory.getDaoInstance(PluginDao.class); - private AlertPlugin plugin; + @Test + public void testRunSend() throws Exception { - @Before - public void before() { - plugin = new EmailAlertPlugin(); - } + //create alert group + AlertGroup alertGroup = new AlertGroup(); + alertGroup.setDescription("test alert group 1"); + alertGroup.setGroupName("testalertg1"); + //TODO AlertType is neet delete from AlertGroup + alertGroup.setGroupType(AlertType.EMAIL); + alertDao.getAlertGroupMapper().insert(alertGroup); - @Test - public void getId() { - String id = plugin.getId(); - assertEquals(Constants.PLUGIN_DEFAULT_EMAIL_ID, id); - } + //add alert + Alert alert1 = new Alert(); + alert1.setTitle("test alert"); + LinkedHashMap map1 = new LinkedHashMap<>(); + map1.put("mysql service name", "mysql200"); + map1.put("mysql address", "192.168.xx.xx"); + map1.put("port", "3306"); + map1.put(AlertConstants.SHOW_TYPE, ShowType.TEXT.getDescp()); + map1.put("no index of number", "80"); + map1.put("database client connections", "190"); + + LinkedHashMap map2 = new LinkedHashMap<>(); + map2.put("mysql service name", "mysql210"); + map2.put("mysql address", "192.168.xx.xx"); + map2.put("port", "3306"); + map2.put("no index of number", "10"); + map1.put(AlertConstants.SHOW_TYPE, ShowType.TABLE.getDescp()); + map2.put("database client connections", "90"); + + List> maps = new ArrayList<>(); + maps.add(0, map1); + maps.add(1, map2); + String mapjson = JSONUtils.toJsonString(maps); + alert1.setContent(mapjson); + alert1.setLog("log log"); + alert1.setAlertGroupId(alertGroup.getId()); + alertDao.addAlert(alert1); + + List alertList = new ArrayList<>(); + alertList.add(alert1); + + //load email alert plugin + AlertPluginManager alertPluginManager = new AlertPluginManager(); + DolphinPluginManagerConfig alertPluginManagerConfig = new DolphinPluginManagerConfig(); + String path = DolphinPluginLoader.class.getClassLoader().getResource("").getPath(); + alertPluginManagerConfig.setPlugins(path + "../../../dolphinscheduler-alert-plugin/dolphinscheduler-alert-email/pom.xml"); + if (StringUtils.isNotBlank(PropertyUtils.getString(AlertServer.ALERT_PLUGIN_DIR))) { + alertPluginManagerConfig.setInstalledPluginsDir(PropertyUtils.getString(AlertServer.ALERT_PLUGIN_DIR, Constants.ALERT_PLUGIN_PATH).trim()); + } + + if (StringUtils.isNotBlank(PropertyUtils.getString(AlertServer.MAVEN_LOCAL_REPOSITORY))) { + alertPluginManagerConfig.setMavenLocalRepository(PropertyUtils.getString(AlertServer.MAVEN_LOCAL_REPOSITORY).trim()); + } + + DolphinPluginLoader alertPluginLoader = new DolphinPluginLoader(alertPluginManagerConfig, ImmutableList.of(alertPluginManager)); + try { + alertPluginLoader.loadPlugins(); + } catch (Exception e) { + throw new RuntimeException("load Alert Plugin Failed !", e); + } + + //create email alert plugin instance + AlertPluginInstance alertPluginInstance = new AlertPluginInstance(); + alertPluginInstance.setAlertGroupId(alertGroup.getId()); + alertPluginInstance.setCreateTime(new Date()); + alertPluginInstance.setInstanceName("test email alert"); + + List pluginDefineList = pluginDao.getPluginDefineMapper().queryByNameAndType("email alert", "alert"); + if (pluginDefineList == null || pluginDefineList.size() == 0) { + throw new RuntimeException("no alert plugin be load"); + } + PluginDefine pluginDefine = pluginDefineList.get(0); + alertPluginInstance.setPluginDefineId(pluginDefine.getId()); + alertPluginInstance.setPluginInstanceParams(getEmailAlertParams()); + alertDao.getAlertPluginInstanceMapper().insert(alertPluginInstance); + + AlertSender alertSender = new AlertSender(alertList, alertDao, alertPluginManager, pluginDao); + alertSender.run(); + + Alert alertResult = alertDao.getAlertMapper().selectById(alert1.getId()); + Assert.assertNotNull(alertResult); + Assert.assertEquals(alertResult.getAlertStatus(), AlertStatus.EXECUTION_FAILURE); + + alertDao.getAlertGroupMapper().deleteById(alertGroup.getId()); + alertDao.getAlertPluginInstanceMapper().deleteById(alertPluginInstance.getId()); + alertDao.getAlertMapper().deleteById(alert1.getId()); - @Test - public void getName() { - PluginName pluginName = plugin.getName(); - assertEquals(Constants.PLUGIN_DEFAULT_EMAIL_CH, pluginName.getChinese()); - assertEquals(Constants.PLUGIN_DEFAULT_EMAIL_EN, pluginName.getEnglish()); } - @Test - public void process() { - AlertInfo alertInfo = new AlertInfo(); - AlertData alertData = new AlertData(); - alertData.setId(1) - .setAlertGroupId(1) - .setContent("[\"alarm time：2018-02-05\", \"service name：MYSQL_ALTER\", \"alarm name：MYSQL_ALTER_DUMP\", " + - "\"get the alarm exception.！，interface error，exception information：timed out\", \"request address：http://blog.csdn.net/dreamInTheWorld/article/details/78539286\"]") - .setLog("test log") - .setReceivers("xx@xx.com") - .setReceiversCc("xx@xx.com") - .setShowType(ShowType.TEXT.getDescp()) - .setTitle("test title"); - - alertInfo.setAlertData(alertData); - List list = new ArrayList(){{ add("xx@xx.com"); }}; - alertInfo.addProp("receivers", list); - Map ret = plugin.process(alertInfo); - assertFalse(Boolean.parseBoolean(String.valueOf(ret.get(Constants.STATUS)))); + public String getEmailAlertParams() { + + List paramsList = new ArrayList<>(); + InputParam receivesParam = InputParam.newBuilder("receivers", "receivers") + .setValue("540957506@qq.com") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam mailSmtpHost = InputParam.newBuilder("mailServerHost", "mail.smtp.host") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue("smtp.exmail.qq.com") + .build(); + + InputParam mailSmtpPort = InputParam.newBuilder("mailServerPort", "mail.smtp.port") + .addValidate(Validate.newBuilder() + .setRequired(true) + .setType(DataType.NUMBER.getDataType()) + .build()) + .setValue(25) + .build(); + + InputParam mailSender = InputParam.newBuilder("mailSender", "mail.sender") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue("easyscheduler@analysys.com.cn") + .build(); + + RadioParam enableSmtpAuth = RadioParam.newBuilder("enableSmtpAuth", "mail.smtp.auth") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue(true) + .build(); + + InputParam mailUser = InputParam.newBuilder("mailUser", "mail.user") + .setPlaceholder("if enable use authentication, you need input user") + .setValue("easyscheduler@analysys.com.cn") + .build(); + + PasswordParam mailPassword = PasswordParam.newBuilder("mailPasswd", "mail.passwd") + .setPlaceholder("if enable use authentication, you need input password") + .setValue("xxxxxxx") + .build(); + + RadioParam enableTls = RadioParam.newBuilder("starttlsEnable", "mail.smtp.starttls.enable") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue(true) + .build(); + + RadioParam enableSsl = RadioParam.newBuilder("sslEnable", "mail.smtp.ssl.enable") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue(false) + .build(); + + InputParam sslTrust = InputParam.newBuilder("mailSmtpSslTrust", "mail.smtp.ssl.trust") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .setValue("smtp.exmail.qq.com") + .build(); + + List emailShowTypeList = new ArrayList<>(); + emailShowTypeList.add(new ParamsOptions(ShowType.TABLE.getDescp(), ShowType.TABLE.getDescp(), false)); + emailShowTypeList.add(new ParamsOptions(ShowType.TEXT.getDescp(), ShowType.TEXT.getDescp(), false)); + emailShowTypeList.add(new ParamsOptions(ShowType.ATTACHMENT.getDescp(), ShowType.ATTACHMENT.getDescp(), false)); + emailShowTypeList.add(new ParamsOptions(ShowType.TABLEATTACHMENT.getDescp(), ShowType.TABLEATTACHMENT.getDescp(), false)); + RadioParam showType = RadioParam.newBuilder(AlertConstants.SHOW_TYPE, "showType") + .setParamsOptionsList(emailShowTypeList) + .setValue(ShowType.TABLE.getDescp()) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + paramsList.add(receivesParam); + paramsList.add(mailSmtpHost); + paramsList.add(mailSmtpPort); + paramsList.add(mailSender); + paramsList.add(enableSmtpAuth); + paramsList.add(mailUser); + paramsList.add(mailPassword); + paramsList.add(enableTls); + paramsList.add(enableSsl); + paramsList.add(sslTrust); + paramsList.add(showType); + + return PluginParamsTransfer.transferParamsToJson(paramsList); } -} \ No newline at end of file +} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/template/AlertTemplateFactoryTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/template/AlertTemplateFactoryTest.java deleted file mode 100644 index 32201e6011..0000000000 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/template/AlertTemplateFactoryTest.java +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.template; - -import org.apache.dolphinscheduler.alert.template.impl.DefaultHTMLTemplate; -import org.apache.dolphinscheduler.alert.utils.Constants; -import org.apache.dolphinscheduler.alert.utils.PropertyUtils; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.mockito.Mockito; -import org.powermock.api.mockito.PowerMockito; -import org.powermock.core.classloader.annotations.PrepareForTest; -import org.powermock.modules.junit4.PowerMockRunner; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import static org.mockito.Mockito.*; -import static org.junit.Assert.*; - -/** - * test class for AlertTemplateFactory - */ -@RunWith(PowerMockRunner.class) -@PrepareForTest(PropertyUtils.class) -public class AlertTemplateFactoryTest { - - private static final Logger logger = LoggerFactory.getLogger(AlertTemplateFactoryTest.class); - - /** - * GetMessageTemplate method test - */ - @Test - public void testGetMessageTemplate(){ - - PowerMockito.mockStatic(PropertyUtils.class); - - AlertTemplate defaultTemplate = AlertTemplateFactory.getMessageTemplate(); - - assertTrue(defaultTemplate instanceof DefaultHTMLTemplate); - } - - /** - * GetMessageTemplate method throw Exception test - */ - @Test - public void testGetMessageTemplateException(){ - - AlertTemplate defaultTemplate = AlertTemplateFactory.getMessageTemplate(); - assertTrue(defaultTemplate instanceof DefaultHTMLTemplate); - } -} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/template/impl/DefaultHTMLTemplateTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/template/impl/DefaultHTMLTemplateTest.java deleted file mode 100644 index c88f69224d..0000000000 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/template/impl/DefaultHTMLTemplateTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.template.impl; - -import org.apache.dolphinscheduler.common.utils.*; -import org.apache.dolphinscheduler.alert.utils.Constants; -import org.apache.dolphinscheduler.common.enums.ShowType; -import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.ArrayList; -import java.util.LinkedHashMap; -import java.util.List; - -import static org.junit.Assert.*; - -/** - * test class for DefaultHTMLTemplate - */ -public class DefaultHTMLTemplateTest{ - - private static final Logger logger = LoggerFactory.getLogger(DefaultHTMLTemplateTest.class); - - /** - * only need test method GetMessageFromTemplate - */ - @Test - public void testGetMessageFromTemplate(){ - - DefaultHTMLTemplate template = new DefaultHTMLTemplate(); - - String tableTypeMessage = template.getMessageFromTemplate(list2String(), ShowType.TABLE,true); - - assertEquals(tableTypeMessage,generateMockTableTypeResultByHand()); - - String textTypeMessage = template.getMessageFromTemplate(list2String(), ShowType.TEXT,true); - - assertEquals(textTypeMessage,generateMockTextTypeResultByHand()); - } - - /** - * generate some simulation data - */ - private String list2String(){ - - LinkedHashMap map1 = new LinkedHashMap<>(); - map1.put("mysql service name","mysql200"); - map1.put("mysql address","192.168.xx.xx"); - map1.put("database client connections","190"); - map1.put("port","3306"); - map1.put("no index of number","80"); - - LinkedHashMap map2 = new LinkedHashMap<>(); - map2.put("mysql service name","mysql210"); - map2.put("mysql address","192.168.xx.xx"); - map2.put("database client connections","90"); - map2.put("port","3306"); - map2.put("no index of number","10"); - - List> maps = new ArrayList<>(); - maps.add(0,map1); - maps.add(1,map2); - String mapjson = JSONUtils.toJsonString(maps); - logger.info(mapjson); - - return mapjson; - } - - private String generateMockTableTypeResultByHand(){ - - return Constants.HTML_HEADER_PREFIX + - "mysql service namemysql addressdatabase client connectionsportno index of number\n" + - "mysql200192.168.xx.xx190330680mysql210192.168.xx.xx90330610" + Constants.TABLE_BODY_HTML_TAIL; - - } - - private String generateMockTextTypeResultByHand(){ - - return Constants.HTML_HEADER_PREFIX + "{\"mysql service name\":\"mysql200\",\"mysql address\":\"192.168.xx.xx\",\"database client connections\":\"190\",\"port\":\"3306\",\"no index of number\":\"80\"}{\"mysql service name\":\"mysql210\",\"mysql address\":\"192.168.xx.xx\",\"database client connections\":\"90\",\"port\":\"3306\",\"no index of number\":\"10\"}" + Constants.TABLE_BODY_HTML_TAIL; - } -} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtilsTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtilsTest.java index 049881c087..27c481e11f 100644 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtilsTest.java +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/DingTalkUtilsTest.java @@ -14,10 +14,14 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.alert.utils; import org.apache.http.client.config.RequestConfig; import org.apache.http.impl.client.CloseableHttpClient; + +import java.io.IOException; + import org.junit.Assert; import org.junit.Before; import org.junit.Test; @@ -30,10 +34,6 @@ import org.powermock.modules.junit4.PowerMockRunner; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.io.IOException; - -import static org.junit.Assert.*; - @PrepareForTest(PropertyUtils.class) @RunWith(PowerMockRunner.class) @PowerMockIgnore("javax.net.ssl.*") @@ -45,7 +45,7 @@ public class DingTalkUtilsTest { private static final String msg = "ding talk test"; @Before - public void init(){ + public void init() { PowerMockito.mockStatic(PropertyUtils.class); Mockito.when(PropertyUtils.getString(Constants.DINGTALK_WEBHOOK)).thenReturn(mockUrl); Mockito.when(PropertyUtils.getString(Constants.DINGTALK_KEYWORD)).thenReturn(mockKeyWords); @@ -56,32 +56,18 @@ public class DingTalkUtilsTest { Mockito.when(PropertyUtils.getInt(Constants.DINGTALK_PORT)).thenReturn(80); } -// @Test -// @Ignore -// public void testSendMsg() { -// try { -// String msgTosend = "msg to send"; -// logger.info(PropertyUtils.getString(Constants.DINGTALK_WEBHOOK)); -// String rsp = DingTalkUtils.sendDingTalkMsg(msgTosend, Constants.UTF_8); -// logger.info("send msg result:{}",rsp); -// String errmsg = JSONUtils.parseObject(rsp).getString("errmsg"); -// Assert.assertEquals("ok", errmsg); -// } catch (Exception e) { -// e.printStackTrace(); -// } -// } - @Test public void testCreateDefaultClient() { - CloseableHttpClient client = DingTalkUtils.getDefaultClient();; + CloseableHttpClient client = DingTalkUtils.getDefaultClient(); try { Assert.assertNotNull(client); client.close(); } catch (IOException ex) { - logger.info("close exception",ex.getMessage()); + logger.info("close exception", ex.getMessage()); new Throwable(); } } + @Test public void testCreateProxyClient() { CloseableHttpClient client = DingTalkUtils.getProxyClient(); @@ -89,11 +75,12 @@ public class DingTalkUtilsTest { Assert.assertNotNull(client); client.close(); } catch (IOException ex) { - logger.info("close exception",ex.getMessage()); + logger.info("close exception", ex.getMessage()); new Throwable(); } } + @Test public void testProxyConfig() { RequestConfig rc = DingTalkUtils.getProxyConfig(); @@ -109,6 +96,7 @@ public class DingTalkUtilsTest { String expect = "{\"text\":{\"content\":\"this is test\"},\"msgtype\":\"text\"}"; Assert.assertEquals(expect, jsonString); } + @Test public void testDingTalkMsgUtf8() { String msg = DingTalkUtils.textToJsonString("this is test:中文"); diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtilsTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtilsTest.java index 1a70c5becb..d528d2cb84 100644 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtilsTest.java +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/EnterpriseWeChatUtilsTest.java @@ -18,10 +18,15 @@ package org.apache.dolphinscheduler.alert.utils; import org.apache.dolphinscheduler.common.enums.AlertType; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.common.utils.JSONUtils; import org.apache.dolphinscheduler.dao.entity.Alert; -import org.apache.dolphinscheduler.plugin.model.AlertData; +import org.apache.dolphinscheduler.spi.alert.AlertConstants; +import org.apache.dolphinscheduler.spi.alert.AlertData; +import org.apache.dolphinscheduler.spi.alert.AlertInfo; +import org.apache.dolphinscheduler.spi.alert.ShowType; +import org.apache.dolphinscheduler.spi.params.PluginParamsTransfer; +import org.apache.dolphinscheduler.spi.params.RadioParam; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; import java.util.ArrayList; import java.util.LinkedHashMap; @@ -47,6 +52,7 @@ import org.powermock.modules.junit4.PowerMockRunner; * enterprise.wechat.agent.id * enterprise.wechat.users */ + @PrepareForTest(PropertyUtils.class) @RunWith(PowerMockRunner.class) public class EnterpriseWeChatUtilsTest { @@ -125,10 +131,19 @@ public class EnterpriseWeChatUtilsTest { public void testMarkdownByAlertForText() { Alert alertForText = createAlertForText(); AlertData alertData = new AlertData(); + AlertInfo alertInfo = new AlertInfo(); + //TODO: + List paramsList = new ArrayList<>(); + RadioParam showType = new RadioParam.Builder(AlertConstants.SHOW_TYPE, AlertConstants.SHOW_TYPE) + .setValue(ShowType.TEXT) + .build(); + paramsList.add(showType); + alertInfo.setAlertParams(PluginParamsTransfer.transferParamsToJson(paramsList)); + alertInfo.setAlertData(alertData); alertData.setTitle(alertForText.getTitle()) - .setShowType(alertForText.getShowType().getDescp()) + //.setShowType(alertForText.getShowType().getDescp()) .setContent(alertForText.getContent()); - String result = EnterpriseWeChatUtils.markdownByAlert(alertData); + String result = EnterpriseWeChatUtils.markdownByAlert(alertInfo); Assert.assertNotNull(result); } @@ -136,10 +151,19 @@ public class EnterpriseWeChatUtilsTest { public void testMarkdownByAlertForTable() { Alert alertForText = createAlertForTable(); AlertData alertData = new AlertData(); + AlertInfo alertInfo = new AlertInfo(); + //TODO: + List paramsList = new ArrayList<>(); + RadioParam showType = new RadioParam.Builder(AlertConstants.SHOW_TYPE, AlertConstants.SHOW_TYPE) + .setValue(ShowType.TABLE) + .build(); + paramsList.add(showType); + alertInfo.setAlertParams(PluginParamsTransfer.transferParamsToJson(paramsList)); + alertInfo.setAlertData(alertData); alertData.setTitle(alertForText.getTitle()) - .setShowType(alertForText.getShowType().getDescp()) + //.setShowType(alertForText.getShowType().getDescp()) .setContent(alertForText.getContent()); - String result = EnterpriseWeChatUtils.markdownByAlert(alertData); + String result = EnterpriseWeChatUtils.markdownByAlert(alertInfo); Assert.assertNotNull(result); } @@ -166,7 +190,7 @@ public class EnterpriseWeChatUtilsTest { Alert alert = new Alert(); alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TEXT); + //alert.setShowType(ShowType.TEXT); alert.setContent(content); alert.setAlertType(AlertType.EMAIL); alert.setAlertGroupId(4); @@ -200,7 +224,7 @@ public class EnterpriseWeChatUtilsTest { private Alert createAlertForTable() { Alert alert = new Alert(); alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TABLE); + //alert.setShowType(ShowType.TABLE.getDescp()); String content = list2String(); alert.setContent(content); alert.setAlertType(AlertType.EMAIL); diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/FuncUtilsTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/FuncUtilsTest.java index a4aeea9c0c..818fac98b6 100644 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/FuncUtilsTest.java +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/FuncUtilsTest.java @@ -17,14 +17,14 @@ package org.apache.dolphinscheduler.alert.utils; -import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; import java.util.Arrays; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNull; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class FuncUtilsTest { diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/MailUtilsTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/MailUtilsTest.java deleted file mode 100644 index 26a69c43ba..0000000000 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/MailUtilsTest.java +++ /dev/null @@ -1,190 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.alert.utils; - - -import org.apache.dolphinscheduler.common.enums.AlertType; -import org.apache.dolphinscheduler.common.enums.ShowType; -import org.apache.dolphinscheduler.dao.AlertDao; -import org.apache.dolphinscheduler.dao.DaoFactory; -import org.apache.dolphinscheduler.dao.entity.Alert; -import org.apache.dolphinscheduler.dao.entity.User; -import org.junit.Assert; -import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.*; -import org.apache.dolphinscheduler.common.utils.*; - - -/** - */ -public class MailUtilsTest { - private static final Logger logger = LoggerFactory.getLogger(MailUtilsTest.class); - @Test - public void testSendMails() { - String[] receivers = new String[]{"347801120@qq.com"}; - String[] receiversCc = new String[]{"347801120@qq.com"}; - - String content ="[\"id:69\"," + - "\"name:UserBehavior-0--1193959466\"," + - "\"Job name: Start workflow\"," + - "\"State: SUCCESS\"," + - "\"Recovery:NO\"," + - "\"Run time: 1\"," + - "\"Start time: 2018-08-06 10:31:34.0\"," + - "\"End time: 2018-08-06 10:31:49.0\"," + - "\"Host: 192.168.xx.xx\"," + - "\"Notify group :4\"]"; - - Alert alert = new Alert(); - alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TEXT); - alert.setContent(content); - alert.setAlertType(AlertType.EMAIL); - alert.setAlertGroupId(4); - - MailUtils.sendMails(Arrays.asList(receivers),Arrays.asList(receiversCc),alert.getTitle(),alert.getContent(), ShowType.TEXT.getDescp()); - } - - - @Test - public void testQuery(){ - AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); - List alerts = alertDao.listWaitExecutionAlert(); - - String[] mails = new String[]{"xx@xx.com"}; - - for(Alert alert : alerts){ - MailUtils.sendMails(Arrays.asList(mails),"gaojing", alert.getContent(), ShowType.TABLE.getDescp()); - } - - } - - public String list2String(){ - - LinkedHashMap map1 = new LinkedHashMap<>(); - map1.put("mysql service name","mysql200"); - map1.put("mysql address","192.168.xx.xx"); - map1.put("port","3306"); - map1.put("no index of number","80"); - map1.put("database client connections","190"); - - LinkedHashMap map2 = new LinkedHashMap<>(); - map2.put("mysql service name","mysql210"); - map2.put("mysql address","192.168.xx.xx"); - map2.put("port","3306"); - map2.put("no index of number","10"); - map2.put("database client connections","90"); - - List> maps = new ArrayList<>(); - maps.add(0,map1); - maps.add(1,map2); - String mapjson = JSONUtils.toJsonString(maps); - logger.info(mapjson); - - return mapjson; - - } - - @Test - public void testSendTableMail(){ - String[] mails = new String[]{"347801120@qq.com"}; - Alert alert = new Alert(); - alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TABLE); - String content= list2String(); - alert.setContent(content); - alert.setAlertType(AlertType.EMAIL); - alert.setAlertGroupId(1); - MailUtils.sendMails(Arrays.asList(mails),"gaojing", alert.getContent(), ShowType.TABLE.getDescp()); - } - - /** - * Used to test add alarm information, mail sent - * Text - */ - @Test - public void addAlertText(){ - AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); - Alert alert = new Alert(); - alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TEXT); - alert.setContent("[\"alarm time：2018-02-05\", \"service name：MYSQL_ALTER\", \"alarm name：MYSQL_ALTER_DUMP\", " + - "\"get the alarm exception.！，interface error，exception information：timed out\", \"request address：http://blog.csdn.net/dreamInTheWorld/article/details/78539286\"]"); - alert.setAlertType(AlertType.EMAIL); - alert.setAlertGroupId(1); - alertDao.addAlert(alert); - } - - - /** - * Used to test add alarm information, mail sent - * Table - */ - @Test - public void testAddAlertTable(){ - logger.info("testAddAlertTable"); - AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); - Assert.assertNotNull(alertDao); - Alert alert = new Alert(); - alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TABLE); - - String content = list2String(); - alert.setContent(content); - alert.setAlertType(AlertType.EMAIL); - alert.setAlertGroupId(1); - alertDao.addAlert(alert); - logger.info("" +alert); - } - - @Test - public void testAlertDao(){ - AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); - List users = alertDao.listUserByAlertgroupId(3); - logger.info(users.toString()); - } - - @Test - public void testAttachmentFile()throws Exception{ - String[] mails = new String[]{"xx@xx.com"}; - Alert alert = new Alert(); - alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.ATTACHMENT); - String content = list2String(); - alert.setContent(content); - alert.setAlertType(AlertType.EMAIL); - alert.setAlertGroupId(1); - MailUtils.sendMails(Arrays.asList(mails),"gaojing",alert.getContent(),ShowType.ATTACHMENT.getDescp()); - } - - @Test - public void testTableAttachmentFile()throws Exception{ - String[] mails = new String[]{"xx@xx.com"}; - Alert alert = new Alert(); - alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TABLEATTACHMENT); - String content = list2String(); - alert.setContent(content); - alert.setAlertType(AlertType.EMAIL); - alert.setAlertGroupId(1); - MailUtils.sendMails(Arrays.asList(mails),"gaojing",alert.getContent(),ShowType.TABLEATTACHMENT.getDescp()); - } - -} diff --git a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/PropertyUtilsTest.java b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/PropertyUtilsTest.java index 2a300c9d57..94859d09ef 100644 --- a/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/PropertyUtilsTest.java +++ b/dolphinscheduler-alert/src/test/java/org/apache/dolphinscheduler/alert/utils/PropertyUtilsTest.java @@ -17,13 +17,18 @@ package org.apache.dolphinscheduler.alert.utils; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; + import org.apache.dolphinscheduler.common.enums.ZKNodeType; + import org.junit.Test; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import static org.junit.Assert.*; - /** * Test PropertyUtils * and the resource path is src/test/resources/alert.properties. @@ -196,19 +201,19 @@ public class PropertyUtilsTest { public void testGetEnum() { //Expected MASTER - ZKNodeType zkNodeType = PropertyUtils.getEnum("test.server.enum1", ZKNodeType.class,ZKNodeType.WORKER); + ZKNodeType zkNodeType = PropertyUtils.getEnum("test.server.enum1", ZKNodeType.class, ZKNodeType.WORKER); assertEquals(zkNodeType, ZKNodeType.MASTER); //Expected DEAD_SERVER - zkNodeType = PropertyUtils.getEnum("test.server.enum2", ZKNodeType.class,ZKNodeType.WORKER); + zkNodeType = PropertyUtils.getEnum("test.server.enum2", ZKNodeType.class, ZKNodeType.WORKER); assertEquals(zkNodeType, ZKNodeType.DEAD_SERVER); //If key is null, then return defaultval - zkNodeType = PropertyUtils.getEnum(null, ZKNodeType.class,ZKNodeType.WORKER); + zkNodeType = PropertyUtils.getEnum(null, ZKNodeType.class, ZKNodeType.WORKER); assertEquals(zkNodeType, ZKNodeType.WORKER); //If the value doesn't define in enum ,it will log the error and return -1 - zkNodeType = PropertyUtils.getEnum("test.server.enum3", ZKNodeType.class,ZKNodeType.WORKER); + zkNodeType = PropertyUtils.getEnum("test.server.enum3", ZKNodeType.class, ZKNodeType.WORKER); assertEquals(zkNodeType, ZKNodeType.WORKER); } diff --git a/dolphinscheduler-common/pom.xml b/dolphinscheduler-common/pom.xml index 2ade59550f..504dddc553 100644 --- a/dolphinscheduler-common/pom.xml +++ b/dolphinscheduler-common/pom.xml @@ -32,11 +32,6 @@ 3.1.0 - - org.apache.dolphinscheduler - dolphinscheduler-plugin-api - - org.apache.httpcomponents httpclient diff --git a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/Constants.java b/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/Constants.java index 85066cc55a..a8d04ced46 100644 --- a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/Constants.java +++ b/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/Constants.java @@ -844,10 +844,7 @@ public final class Constants { ExecutionStatus.WAITTING_DEPEND.ordinal() }; - /** - * status - */ - public static final String STATUS = "status"; + /** * message @@ -982,6 +979,10 @@ public final class Constants { */ public static final String PLUGIN_JAR_SUFFIX = ".jar"; + /** + * status + */ + public static final String STATUS = "status"; public static final int NORAML_NODE_STATUS = 0; public static final int ABNORMAL_NODE_STATUS = 1; @@ -998,6 +999,8 @@ public final class Constants { public static final String DOLPHIN_SCHEDULER_PREFERRED_NETWORK_INTERFACE = "dolphin.scheduler.network.interface.preferred"; + public static final String EXCEL_SUFFIX_XLS = ".xls"; + /** * datasource encryption salt */ diff --git a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/FilePluginManager.java b/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/FilePluginManager.java deleted file mode 100644 index cde299f9dd..0000000000 --- a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/FilePluginManager.java +++ /dev/null @@ -1,107 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.common.plugin; - -import org.apache.dolphinscheduler.common.Constants; -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; -import org.apache.dolphinscheduler.plugin.spi.AlertPluginProvider; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.File; -import java.net.MalformedURLException; -import java.net.URL; -import java.util.Map; -import java.util.ServiceLoader; -import java.util.concurrent.ConcurrentHashMap; - -/** - * FilePluginManager - */ -public class FilePluginManager implements PluginManager { - - private static final Logger logger = LoggerFactory.getLogger(FilePluginManager.class); - - private Map pluginMap = new ConcurrentHashMap<>(); - - private Map> pluginLoaderMap = new ConcurrentHashMap<>(); - - private Map classLoaderMap = new ConcurrentHashMap<>(); - - private String[] whitePrefixes; - - private String[] excludePrefixes; - - public FilePluginManager(String dirPath, String[] whitePrefixes, String[] excludePrefixes) { - this.whitePrefixes = whitePrefixes; - this.excludePrefixes = excludePrefixes; - try { - load(dirPath); - } catch (MalformedURLException e) { - logger.error("load plugins failed.", e); - } - } - - private void load(String dirPath) throws MalformedURLException { - logger.info("start to load jar files in {}", dirPath); - if (dirPath == null) { - logger.error("not a valid path - {}", dirPath); - return; - } - File[] files = new File(dirPath).listFiles(); - if (files == null) { - logger.error("not a valid path - {}", dirPath); - return; - } - for (File file : files) { - if (file.isDirectory() && !file.getPath().endsWith(Constants.PLUGIN_JAR_SUFFIX)) { - continue; - } - String pluginName = file.getName() - .substring(0, file.getName().length() - Constants.PLUGIN_JAR_SUFFIX.length()); - URL[] urls = new URL[]{ file.toURI().toURL() }; - PluginClassLoader classLoader = - new PluginClassLoader(urls, Thread.currentThread().getContextClassLoader(), whitePrefixes, excludePrefixes); - classLoaderMap.put(pluginName, classLoader); - - ServiceLoader loader = ServiceLoader.load(AlertPluginProvider.class, classLoader); - pluginLoaderMap.put(pluginName, loader); - - loader.forEach(provider -> { - AlertPlugin plugin = provider.createPlugin(); - pluginMap.put(plugin.getId(), plugin); - logger.info("loaded plugin - {}", plugin.getId()); - }); - } - } - - @Override - public AlertPlugin findOne(String pluginId) { - return pluginMap.get(pluginId); - } - - @Override - public Map findAll() { - return pluginMap; - } - - @Override - public void addPlugin(AlertPlugin plugin) { - pluginMap.put(plugin.getId(), plugin); - } - -} diff --git a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/PluginClassLoader.java b/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/PluginClassLoader.java deleted file mode 100644 index 528e83a59c..0000000000 --- a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/PluginClassLoader.java +++ /dev/null @@ -1,154 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.common.plugin; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.net.URL; -import java.net.URLClassLoader; -import java.util.Enumeration; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.List; - -/** - * Plugin Class Loader - */ -public class PluginClassLoader extends URLClassLoader { - - private static final Logger logger = LoggerFactory.getLogger(PluginClassLoader.class); - - private static final String JAVA_PACKAGE_PREFIX = "java."; - private static final String JAVAX_PACKAGE_PREFIX = "javax."; - - private final String[] whitePrefixes; - - private final String[] excludePrefixes; - - public PluginClassLoader(URL[] urls, ClassLoader parent, String[] whitePrefix, String[] excludePreifx) { - super(urls, parent); - this.whitePrefixes = whitePrefix; - this.excludePrefixes = excludePreifx; - } - - @Override - public Class loadClass(String name) throws ClassNotFoundException { - logger.trace("Received request to load class '{}'", name); - synchronized (getClassLoadingLock(name)) { - if (name.startsWith(JAVA_PACKAGE_PREFIX) || name.startsWith(JAVAX_PACKAGE_PREFIX)) { - return findSystemClass(name); - } - - boolean isWhitePrefixes = fromWhitePrefix(name); - boolean isExcludePrefixed = fromExcludePrefix(name); - - // if the class is part of the plugin engine use parent class loader - if (!isWhitePrefixes && isExcludePrefixed) { - return getParent().loadClass(name); - } - - // check whether it's already been loaded - Class loadedClass = findLoadedClass(name); - if (loadedClass != null) { - logger.debug("Found loaded class '{}'", name); - return loadedClass; - } - - // nope, try to load locally - try { - loadedClass = findClass(name); - logger.debug("Found class '{}' in plugin classpath", name); - return loadedClass; - } catch (ClassNotFoundException e) { - // try next step - } - - // use the standard ClassLoader (which follows normal parent delegation) - return super.loadClass(name); - } - } - - private boolean fromWhitePrefix(String name) { - if (this.whitePrefixes == null) { - return false; - } - for (String whitePrefix : this.whitePrefixes) { - if (name.startsWith(whitePrefix)) { - return true; - } - } - return false; - } - - private boolean fromExcludePrefix(String name) { - if (this.excludePrefixes == null) { - return false; - } - for (String excludePrefix : this.excludePrefixes) { - if (name.startsWith(excludePrefix)) { - return true; - } - } - return false; - } - - @Override - public Enumeration getResources(String name) throws IOException { - List allRes = new LinkedList<>(); - - Enumeration thisRes = findResources(name); - if (thisRes != null) { - while (thisRes.hasMoreElements()) { - allRes.add(thisRes.nextElement()); - } - } - - Enumeration parentRes = super.findResources(name); - if (parentRes != null) { - while (parentRes.hasMoreElements()) { - allRes.add(parentRes.nextElement()); - } - } - - return new Enumeration() { - Iterator it = allRes.iterator(); - - @Override - public boolean hasMoreElements() { - return it.hasNext(); - } - - @Override - public URL nextElement() { - return it.next(); - } - }; - } - - @Override - public URL getResource(String name) { - URL res = null; - - res = findResource(name); - if (res == null) { - res = super.getResource(name); - } - return res; - } -} diff --git a/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/plugin/FilePluginManagerTest.java b/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/plugin/FilePluginManagerTest.java deleted file mode 100644 index 1a57cb10fa..0000000000 --- a/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/plugin/FilePluginManagerTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.common.plugin; - -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.apache.dolphinscheduler.plugin.model.PluginName; -import org.junit.Before; -import org.junit.Test; - -import java.util.HashMap; -import java.util.Map; - -import static org.junit.Assert.*; - -public class FilePluginManagerTest { - - private FilePluginManager filePluginManager; - private AlertPlugin alertPlugin; - - @Before - public void before() { - filePluginManager = new FilePluginManager(null, null, null); - alertPlugin = new AlertPlugin() { - @Override - public String getId() { - return "test"; - } - - @Override - public PluginName getName() { - return new PluginName().setChinese("ch").setEnglish("en"); - } - - @Override - public Map process(AlertInfo info) { - return new HashMap<>(); - } - }; - } - - @Test - public void findOne() { - filePluginManager.addPlugin(alertPlugin); - assertEquals(alertPlugin, filePluginManager.findOne(alertPlugin.getId())); - } - - @Test - public void findAll() { - assertNotNull(filePluginManager.findAll()); - } - - @Test - public void addPlugin() { - filePluginManager.addPlugin(alertPlugin); - assertNotNull(filePluginManager.findAll()); - } -} \ No newline at end of file diff --git a/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/plugin/PluginClassLoaderTest.java b/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/plugin/PluginClassLoaderTest.java deleted file mode 100644 index 8a6bfaee13..0000000000 --- a/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/plugin/PluginClassLoaderTest.java +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.common.plugin; - -import org.junit.Before; -import org.junit.Test; - -import java.net.URL; - -import static org.junit.Assert.*; - -public class PluginClassLoaderTest { - - private PluginClassLoader pluginClassLoader; - private ClassLoader parent; - - @Before - public void setUp() { - parent = Thread.currentThread().getContextClassLoader(); - pluginClassLoader = new PluginClassLoader( - new URL[]{}, parent, - null, null); - } - - @Test - public void loadClassNull() { - Class clazz = null; - try { - clazz = pluginClassLoader.loadClass("java.lang.Object"); - } catch (ClassNotFoundException e) { - e.printStackTrace(); - } - assertEquals(null, clazz.getClassLoader()); - } - - @Test - public void loadClassApp() { - Class clazz = null; - try { - clazz = pluginClassLoader.loadClass("org.apache.dolphinscheduler.common.Constants"); - } catch (ClassNotFoundException e) { - e.printStackTrace(); - } - assertEquals(parent, clazz.getClassLoader()); - } - -} \ No newline at end of file diff --git a/dolphinscheduler-dao/pom.xml b/dolphinscheduler-dao/pom.xml index c474f6d992..2ebe234fc6 100644 --- a/dolphinscheduler-dao/pom.xml +++ b/dolphinscheduler-dao/pom.xml @@ -17,138 +17,138 @@ --> - 4.0.0 - - org.apache.dolphinscheduler - dolphinscheduler - 1.3.2-SNAPSHOT - - dolphinscheduler-dao - ${project.artifactId} + 4.0.0 + + org.apache.dolphinscheduler + dolphinscheduler + 1.3.2-SNAPSHOT + + dolphinscheduler-dao + ${project.artifactId} - - UTF-8 - - - - junit - junit - test - - - com.baomidou - mybatis-plus - ${mybatis-plus.version} - - - com.baomidou - mybatis-plus-boot-starter - ${mybatis-plus.version} - - - org.apache.logging.log4j - log4j-to-slf4j - - - - - org.postgresql - postgresql - - - - org.springframework.boot - spring-boot-starter-test - test - - - org.ow2.asm - asm - - - org.springframework.boot - spring-boot - - - org.springframework.boot - spring-boot-autoconfigure - - - log4j-api - org.apache.logging.log4j - - - org.springframework.boot - spring-boot-starter-tomcat - - - org.apache.logging.log4j - log4j-to-slf4j - - - + + UTF-8 + + + + junit + junit + test + + + com.baomidou + mybatis-plus + ${mybatis-plus.version} + + + com.baomidou + mybatis-plus-boot-starter + ${mybatis-plus.version} + + + org.apache.logging.log4j + log4j-to-slf4j + + + + + org.postgresql + postgresql + - - mysql - mysql-connector-java - - - com.h2database - h2 - - - com.alibaba - druid - + + org.springframework.boot + spring-boot-starter-test + test + + + org.ow2.asm + asm + + + org.springframework.boot + spring-boot + + + org.springframework.boot + spring-boot-autoconfigure + + + log4j-api + org.apache.logging.log4j + + + org.springframework.boot + spring-boot-starter-tomcat + + + org.apache.logging.log4j + log4j-to-slf4j + + + - - ch.qos.logback - logback-classic - - - com.fasterxml.jackson.core - jackson-annotations - - - com.fasterxml.jackson.core - jackson-databind - - - org.apache.httpcomponents - httpclient - - - commons-httpclient - commons-httpclient - + + mysql + mysql-connector-java + + + com.h2database + h2 + + + com.alibaba + druid + - - com.cronutils - cron-utils - + + ch.qos.logback + logback-classic + + + com.fasterxml.jackson.core + jackson-annotations + + + com.fasterxml.jackson.core + jackson-databind + + + org.apache.httpcomponents + httpclient + + + commons-httpclient + commons-httpclient + + + + com.cronutils + cron-utils + commons-configuration commons-configuration - - org.apache.dolphinscheduler - dolphinscheduler-common - - - protobuf-java - com.google.protobuf - - - + + org.apache.dolphinscheduler + dolphinscheduler-common + + + protobuf-java + com.google.protobuf + + + org.springframework spring-test test - - org.yaml - snakeyaml - - - + + org.yaml + snakeyaml + + + \ No newline at end of file diff --git a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/AlertDao.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/AlertDao.java index cd101f06b6..4a5c7be8a3 100644 --- a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/AlertDao.java +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/AlertDao.java @@ -21,17 +21,19 @@ import org.apache.dolphinscheduler.common.enums.AlertEvent; import org.apache.dolphinscheduler.common.enums.AlertStatus; import org.apache.dolphinscheduler.common.enums.AlertType; import org.apache.dolphinscheduler.common.enums.AlertWarnLevel; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.common.utils.JSONUtils; import org.apache.dolphinscheduler.common.utils.StringUtils; import org.apache.dolphinscheduler.dao.datasource.ConnectionFactory; import org.apache.dolphinscheduler.dao.entity.Alert; +import org.apache.dolphinscheduler.dao.entity.AlertPluginInstance; import org.apache.dolphinscheduler.dao.entity.ProcessAlertContent; import org.apache.dolphinscheduler.dao.entity.ProcessDefinition; import org.apache.dolphinscheduler.dao.entity.ProcessInstance; import org.apache.dolphinscheduler.dao.entity.ServerAlertContent; import org.apache.dolphinscheduler.dao.entity.User; +import org.apache.dolphinscheduler.dao.mapper.AlertGroupMapper; import org.apache.dolphinscheduler.dao.mapper.AlertMapper; +import org.apache.dolphinscheduler.dao.mapper.AlertPluginInstanceMapper; import org.apache.dolphinscheduler.dao.mapper.UserAlertGroupMapper; import java.util.ArrayList; @@ -54,10 +56,18 @@ public class AlertDao extends AbstractBaseDao { @Autowired private UserAlertGroupMapper userAlertGroupMapper; + @Autowired + private AlertPluginInstanceMapper alertPluginInstanceMapper; + + @Autowired + private AlertGroupMapper alertGroupMapper; + @Override protected void init() { alertMapper = ConnectionFactory.getInstance().getMapper(AlertMapper.class); userAlertGroupMapper = ConnectionFactory.getInstance().getMapper(UserAlertGroupMapper.class); + alertPluginInstanceMapper = ConnectionFactory.getInstance().getMapper(AlertPluginInstanceMapper.class); + alertGroupMapper = ConnectionFactory.getInstance().getMapper(AlertGroupMapper.class); } /** @@ -74,8 +84,8 @@ public class AlertDao extends AbstractBaseDao { * update alert * * @param alertStatus alertStatus - * @param log log - * @param id id + * @param log log + * @param id id * @return update alert result */ public int updateAlert(AlertStatus alertStatus, String log, int id) { @@ -101,8 +111,8 @@ public class AlertDao extends AbstractBaseDao { * MasterServer or WorkerServer stoped * * @param alertgroupId alertgroupId - * @param host host - * @param serverType serverType + * @param host host + * @param serverType serverType */ public void sendServerStopedAlert(int alertgroupId, String host, String serverType) { Alert alert = new Alert(); @@ -119,7 +129,7 @@ public class AlertDao extends AbstractBaseDao { /** * process time out alert * - * @param processInstance processInstance + * @param processInstance processInstance * @param processDefinition processDefinition */ public void sendProcessTimeoutAlert(ProcessInstance processInstance, ProcessDefinition processDefinition) { @@ -140,9 +150,8 @@ public class AlertDao extends AbstractBaseDao { saveTaskTimeoutAlert(alert, content, alertgroupId, receivers, receiversCc); } - private void saveTaskTimeoutAlert(Alert alert, String content, int alertgroupId, - String receivers, String receiversCc) { - alert.setShowType(ShowType.TABLE); + private void saveTaskTimeoutAlert(Alert alert, String content, int alertgroupId, String receivers, String receiversCc) { + //alert.setShowType(ShowType.TABLE); alert.setContent(content); alert.setAlertType(AlertType.EMAIL); alert.setAlertGroupId(alertgroupId); @@ -160,13 +169,13 @@ public class AlertDao extends AbstractBaseDao { /** * task timeout warn * - * @param alertgroupId alertgroupId - * @param receivers receivers - * @param receiversCc receiversCc - * @param processInstanceId processInstanceId + * @param alertgroupId alertgroupId + * @param receivers receivers + * @param receiversCc receiversCc + * @param processInstanceId processInstanceId * @param processInstanceName processInstanceName - * @param taskId taskId - * @param taskName taskName + * @param taskId taskId + * @param taskName taskName */ public void sendTaskTimeoutAlert(int alertgroupId, String receivers, String receiversCc, int processInstanceId, String processInstanceName, int taskId, String taskName) { @@ -214,4 +223,29 @@ public class AlertDao extends AbstractBaseDao { return alertMapper; } + /** + * list all alert plugin instance by alert group id + * + * @param alertGroupId alert group id + * @return AlertPluginInstance list + */ + public List listInstanceByAlertGroupId(int alertGroupId) { + return alertPluginInstanceMapper.queryByAlertGroupId(alertGroupId); + } + + public AlertPluginInstanceMapper getAlertPluginInstanceMapper() { + return alertPluginInstanceMapper; + } + + public void setAlertPluginInstanceMapper(AlertPluginInstanceMapper alertPluginInstanceMapper) { + this.alertPluginInstanceMapper = alertPluginInstanceMapper; + } + + public AlertGroupMapper getAlertGroupMapper() { + return alertGroupMapper; + } + + public void setAlertGroupMapper(AlertGroupMapper alertGroupMapper) { + this.alertGroupMapper = alertGroupMapper; + } } diff --git a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/PluginDao.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/PluginDao.java new file mode 100644 index 0000000000..ab82997bc2 --- /dev/null +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/PluginDao.java @@ -0,0 +1,96 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.dao; + +import static java.util.Objects.requireNonNull; + +import org.apache.dolphinscheduler.dao.datasource.ConnectionFactory; +import org.apache.dolphinscheduler.dao.entity.PluginDefine; +import org.apache.dolphinscheduler.dao.mapper.PluginDefineMapper; + +import java.util.List; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +@Component +public class PluginDao extends AbstractBaseDao { + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + @Autowired + private PluginDefineMapper pluginDefineMapper; + + @Override + protected void init() { + pluginDefineMapper = ConnectionFactory.getInstance().getMapper(PluginDefineMapper.class); + } + + /** + * add pluginDefine + * + * @param pluginDefine plugin define entiy + * @return plugin define id + */ + public int addPluginDefine(PluginDefine pluginDefine) { + return pluginDefineMapper.insert(pluginDefine); + } + + /** + * add or update plugin define + * + * @param pluginDefine new pluginDefine + */ + public void addOrUpdatePluginDefine(PluginDefine pluginDefine) { + requireNonNull(pluginDefine, "pluginDefine is null"); + requireNonNull(pluginDefine.getPluginName(), "pluginName is null"); + requireNonNull(pluginDefine.getPluginType(), "pluginType is null"); + + List pluginDefineList = pluginDefineMapper.queryByNameAndType(pluginDefine.getPluginName(), pluginDefine.getPluginType()); + if (pluginDefineList == null || pluginDefineList.size() == 0) { + pluginDefineMapper.insert(pluginDefine); + } else { + PluginDefine currPluginDefine = pluginDefineList.get(0); + if (!currPluginDefine.getPluginParams().equals(pluginDefine.getPluginParams())) { + currPluginDefine.setUpdateTime(pluginDefine.getUpdateTime()); + currPluginDefine.setPluginParams(pluginDefine.getPluginParams()); + pluginDefineMapper.updateById(currPluginDefine); + } + } + } + + /** + * query plugin define by id + * + * @param pluginDefineId plugin define id + * @return PluginDefine + */ + public PluginDefine getPluginDefineById(int pluginDefineId) { + return pluginDefineMapper.selectById(pluginDefineId); + } + + public PluginDefineMapper getPluginDefineMapper() { + return pluginDefineMapper; + } + + public void setPluginDefineMapper(PluginDefineMapper pluginDefineMapper) { + this.pluginDefineMapper = pluginDefineMapper; + } +} diff --git a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/Alert.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/Alert.java index cfd4995a2b..5f0796c19d 100644 --- a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/Alert.java +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/Alert.java @@ -14,20 +14,21 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.dao.entity; -import com.baomidou.mybatisplus.annotation.IdType; -import com.baomidou.mybatisplus.annotation.TableField; -import com.baomidou.mybatisplus.annotation.TableId; -import com.baomidou.mybatisplus.annotation.TableName; import org.apache.dolphinscheduler.common.enums.AlertStatus; import org.apache.dolphinscheduler.common.enums.AlertType; -import org.apache.dolphinscheduler.common.enums.ShowType; import java.util.Date; import java.util.HashMap; import java.util.Map; +import com.baomidou.mybatisplus.annotation.IdType; +import com.baomidou.mybatisplus.annotation.TableField; +import com.baomidou.mybatisplus.annotation.TableId; +import com.baomidou.mybatisplus.annotation.TableName; + @TableName("t_ds_alert") public class Alert { /** @@ -43,8 +44,9 @@ public class Alert { /** * show_type */ + //TODO ShowType should be delete from Alert, Because showType is move to the plugin params @TableField(value = "show_type") - private ShowType showType; + private String showType; /** * content */ @@ -53,6 +55,7 @@ public class Alert { /** * alert_type */ + //TODO alertType should be delete from Alert, because alert type is decide by the AlertPlugin instance @TableField(value = "alert_type") private AlertType alertType; /** @@ -73,11 +76,13 @@ public class Alert { /** * receivers */ + //TODO receivers should be delete from Alert, because only email alert need receivers . And receivers is move to Email Alert Plugin params. @TableField("receivers") private String receivers; /** * receivers_cc */ + //TODO receivers_cc should be delete from Alert, because only email alert need receivers_cc . And receivers_cc is move to Email Alert Plugin params. @TableField("receivers_cc") private String receiversCc; /** @@ -112,13 +117,13 @@ public class Alert { this.title = title; } - public ShowType getShowType() { - return showType; - } - - public void setShowType(ShowType showType) { - this.showType = showType; - } + // public String getShowType() { + // return showType; + // } + // + // public void setShowType(String showType) { + // this.showType = showType; + // } public String getContent() { return content; @@ -268,20 +273,37 @@ public class Alert { @Override public String toString() { - return "Alert{" + - "id=" + id + - ", title='" + title + '\'' + - ", showType=" + showType + - ", content='" + content + '\'' + - ", alertType=" + alertType + - ", alertStatus=" + alertStatus + - ", log='" + log + '\'' + - ", alertGroupId=" + alertGroupId + - ", receivers='" + receivers + '\'' + - ", receiversCc='" + receiversCc + '\'' + - ", createTime=" + createTime + - ", updateTime=" + updateTime + - ", info=" + info + - '}'; + return "Alert{" + + "id=" + + id + + ", title='" + + title + '\'' + + ", showType=" + + showType + + ", content='" + + content + + '\'' + + ", alertType=" + + alertType + + ", alertStatus=" + + alertStatus + + ", log='" + + log + + '\'' + + ", alertGroupId=" + + alertGroupId + + ", receivers='" + + receivers + + '\'' + + ", receiversCc='" + + receiversCc + + '\'' + + ", createTime=" + + createTime + + ", updateTime=" + + updateTime + + ", info=" + + info + + '}'; } } diff --git a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/AlertPluginInstance.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/AlertPluginInstance.java new file mode 100644 index 0000000000..c5918ce09a --- /dev/null +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/AlertPluginInstance.java @@ -0,0 +1,145 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.dao.entity; + +import java.util.Date; + +import com.baomidou.mybatisplus.annotation.IdType; +import com.baomidou.mybatisplus.annotation.TableField; +import com.baomidou.mybatisplus.annotation.TableId; +import com.baomidou.mybatisplus.annotation.TableName; + +/** + * t_ds_alert_plugin_instance + */ +@TableName("t_ds_alert_plugin_instance") +public class AlertPluginInstance { + + /** + * id + */ + @TableId(value = "id", type = IdType.AUTO) + private int id; + + /** + * alert group id + */ + @TableField("alert_group_id") + private int alertGroupId; + + /** + * plugin_define_id + */ + @TableField("plugin_define_id") + private int pluginDefineId; + + /** + * alert plugin instance name + */ + @TableField("instance_name") + private String instanceName; + + /** + * plugin_instance_params + */ + @TableField("plugin_instance_params") + private String pluginInstanceParams; + + /** + * create_time + */ + @TableField("create_time") + private Date createTime; + + /** + * update_time + */ + @TableField("update_time") + private Date updateTime; + + public AlertPluginInstance() { + this.createTime = new Date(); + this.updateTime = new Date(); + } + + public AlertPluginInstance(int pluginDefineId, String pluginInstanceParams, int alertGroupId, String instanceName) { + this.pluginDefineId = pluginDefineId; + this.pluginInstanceParams = pluginInstanceParams; + this.alertGroupId = alertGroupId; + this.createTime = new Date(); + this.updateTime = new Date(); + this.instanceName = instanceName; + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + public int getPluginDefineId() { + return pluginDefineId; + } + + public void setPluginDefineId(int pluginDefineId) { + this.pluginDefineId = pluginDefineId; + } + + public String getPluginInstanceParams() { + return pluginInstanceParams; + } + + public void setPluginInstanceParams(String pluginInstanceParams) { + this.pluginInstanceParams = pluginInstanceParams; + } + + public Date getCreateTime() { + return createTime; + } + + public void setCreateTime(Date createTime) { + this.createTime = createTime; + } + + public Date getUpdateTime() { + return updateTime; + } + + public void setUpdateTime(Date updateTime) { + this.updateTime = updateTime; + } + + public int getAlertGroupId() { + return alertGroupId; + } + + public void setAlertGroupId(int alertGroupId) { + this.alertGroupId = alertGroupId; + } + + public String getInstanceName() { + return instanceName; + } + + public void setInstanceName(String instanceName) { + this.instanceName = instanceName; + } +} + diff --git a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/PluginDefine.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/PluginDefine.java new file mode 100644 index 0000000000..2be8988a08 --- /dev/null +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/PluginDefine.java @@ -0,0 +1,125 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.dao.entity; + +import java.util.Date; + +import com.baomidou.mybatisplus.annotation.IdType; +import com.baomidou.mybatisplus.annotation.TableField; +import com.baomidou.mybatisplus.annotation.TableId; +import com.baomidou.mybatisplus.annotation.TableName; + +/** + * t_ds_plugin_define + */ +@TableName("t_ds_plugin_define") +public class PluginDefine { + + /** + * id + */ + @TableId(value = "id", type = IdType.AUTO) + private int id; + + /** + * plugin name + */ + @TableField("plugin_name") + private String pluginName; + + /** + * plugin_type + */ + @TableField("plugin_type") + private String pluginType; + + /** + * plugin_params + */ + @TableField("plugin_params") + private String pluginParams; + + /** + * create_time + */ + @TableField("create_time") + private Date createTime; + + /** + * update_time + */ + @TableField("update_time") + private Date updateTime; + + public PluginDefine(String pluginName, String pluginType, String pluginParams) { + this.pluginName = pluginName; + this.pluginType = pluginType; + this.pluginParams = pluginParams; + this.createTime = new Date(); + this.updateTime = new Date(); + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + public String getPluginName() { + return pluginName; + } + + public void setPluginName(String pluginName) { + this.pluginName = pluginName; + } + + public String getPluginType() { + return pluginType; + } + + public void setPluginType(String pluginType) { + this.pluginType = pluginType; + } + + public String getPluginParams() { + return pluginParams; + } + + public void setPluginParams(String pluginParams) { + this.pluginParams = pluginParams; + } + + public Date getCreateTime() { + return createTime; + } + + public void setCreateTime(Date createTime) { + this.createTime = createTime; + } + + public Date getUpdateTime() { + return updateTime; + } + + public void setUpdateTime(Date updateTime) { + this.updateTime = updateTime; + } +} + diff --git a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/AlertTemplateFactory.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapper.java similarity index 54% rename from dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/AlertTemplateFactory.java rename to dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapper.java index 965677e7e1..8c7a4d058f 100644 --- a/dolphinscheduler-alert/src/main/java/org/apache/dolphinscheduler/alert/template/AlertTemplateFactory.java +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapper.java @@ -14,26 +14,31 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.alert.template; -import org.apache.dolphinscheduler.alert.template.impl.DefaultHTMLTemplate; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +package org.apache.dolphinscheduler.dao.mapper; -/** - * the alert template factory - */ -public class AlertTemplateFactory { +import org.apache.dolphinscheduler.dao.entity.AlertPluginInstance; + +import org.apache.ibatis.annotations.Param; + +import java.util.List; - private static final Logger logger = LoggerFactory.getLogger(AlertTemplateFactory.class); +import com.baomidou.mybatisplus.core.mapper.BaseMapper; - private AlertTemplateFactory(){} +public interface AlertPluginInstanceMapper extends BaseMapper { + + /** + * query all alert plugin instance + * + * @return AlertPluginInstance list + */ + List queryAllAlertPluginInstanceList(); /** - * get a template from alert.properties conf file - * @return a template, default is DefaultHTMLTemplate + * query by alert group id + * + * @param alertGroupId + * @return AlertPluginInstance list */ - public static AlertTemplate getMessageTemplate() { - return new DefaultHTMLTemplate(); - } + List queryByAlertGroupId(@Param("alertGroupId") int alertGroupId); } diff --git a/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/mapper/PluginDefineMapper.java b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/mapper/PluginDefineMapper.java new file mode 100644 index 0000000000..14e4681c43 --- /dev/null +++ b/dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/mapper/PluginDefineMapper.java @@ -0,0 +1,53 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.dao.mapper; + +import org.apache.dolphinscheduler.dao.entity.PluginDefine; + +import org.apache.ibatis.annotations.Param; + +import java.util.List; + +import com.baomidou.mybatisplus.core.mapper.BaseMapper; + +public interface PluginDefineMapper extends BaseMapper { + + /** + * query all plugin define + * + * @return PluginDefine list + */ + List queryAllPluginDefineList(); + + /** + * query by plugin type + * + * @param pluginType pluginType + * @return PluginDefine list + */ + List queryByPluginType(@Param("pluginType") String pluginType); + + /** + * query by name and type + * + * @param pluginName + * @param pluginType + * @return + */ + List queryByNameAndType(@Param("pluginName") String pluginName, @Param("pluginType") String pluginType); +} diff --git a/dolphinscheduler-dao/src/main/resources/datasource.properties b/dolphinscheduler-dao/src/main/resources/datasource.properties index 25ac220312..d55e36addc 100644 --- a/dolphinscheduler-dao/src/main/resources/datasource.properties +++ b/dolphinscheduler-dao/src/main/resources/datasource.properties @@ -15,9 +15,15 @@ # limitations under the License. # +# mysql +#spring.datasource.driver-class-name=com.mysql.jdbc.Driver +#spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8 +#spring.datasource.username=root +#spring.datasource.password=123456 + # postgresql spring.datasource.driver-class-name=org.postgresql.Driver -spring.datasource.url=jdbc:postgresql://localhost:5432/dolphinscheduler +spring.datasource.url=jdbc:postgresql://127.0.0.1:5432/dolphinscheduler spring.datasource.username=test spring.datasource.password=test diff --git a/dolphinscheduler-dao/src/main/resources/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapper.xml b/dolphinscheduler-dao/src/main/resources/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapper.xml new file mode 100644 index 0000000000..1fc0f6b77b --- /dev/null +++ b/dolphinscheduler-dao/src/main/resources/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapper.xml @@ -0,0 +1,32 @@ + + + + + + + + + \ No newline at end of file diff --git a/dolphinscheduler-dao/src/main/resources/org/apache/dolphinscheduler/dao/mapper/PluginDefineMapper.xml b/dolphinscheduler-dao/src/main/resources/org/apache/dolphinscheduler/dao/mapper/PluginDefineMapper.xml new file mode 100644 index 0000000000..f4a6f137d9 --- /dev/null +++ b/dolphinscheduler-dao/src/main/resources/org/apache/dolphinscheduler/dao/mapper/PluginDefineMapper.xml @@ -0,0 +1,38 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/AlertDaoTest.java b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/AlertDaoTest.java index ef3f0ffbb9..0b5c516dee 100644 --- a/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/AlertDaoTest.java +++ b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/AlertDaoTest.java @@ -14,27 +14,26 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.dao; import org.apache.dolphinscheduler.common.enums.AlertStatus; import org.apache.dolphinscheduler.common.enums.AlertType; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.dao.entity.Alert; -import org.junit.Assert; -import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import java.util.Arrays; import java.util.List; +import org.junit.Assert; +import org.junit.Test; + public class AlertDaoTest { + @Test - public void testAlertDao(){ + public void testAlertDao() { AlertDao alertDao = DaoFactory.getDaoInstance(AlertDao.class); Alert alert = new Alert(); alert.setTitle("Mysql Exception"); - alert.setShowType(ShowType.TEXT); + //alert.setShowType(ShowType.TEXT); alert.setContent("[\"alarm time：2018-02-05\", \"service name：MYSQL_ALTER\", \"alarm name：MYSQL_ALTER_DUMP\", " + "\"get the alarm exception.！，interface error，exception information：timed out\", \"request address：http://blog.csdn.net/dreamInTheWorld/article/details/78539286\"]"); alert.setAlertType(AlertType.EMAIL); @@ -42,7 +41,6 @@ public class AlertDaoTest { alert.setAlertStatus(AlertStatus.WAIT_EXECUTION); alertDao.addAlert(alert); - List alerts = alertDao.listWaitExecutionAlert(); Assert.assertNotNull(alerts); Assert.assertNotEquals(0, alerts.size()); diff --git a/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertMapperTest.java b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertMapperTest.java index 064305d33b..24b9719a3e 100644 --- a/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertMapperTest.java +++ b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertMapperTest.java @@ -14,14 +14,23 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.dao.mapper; +import static org.hamcrest.Matchers.greaterThan; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThat; + import org.apache.dolphinscheduler.common.enums.AlertStatus; import org.apache.dolphinscheduler.common.enums.AlertType; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.common.utils.DateUtils; import org.apache.dolphinscheduler.dao.entity.Alert; -import org.junit.Assert; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; @@ -30,13 +39,8 @@ import org.springframework.test.annotation.Rollback; import org.springframework.test.context.junit4.SpringRunner; import org.springframework.transaction.annotation.Transactional; -import java.util.*; - -import static org.hamcrest.Matchers.*; -import static org.junit.Assert.*; - /** - * alert mapper test + * alert mapper test */ @RunWith(SpringRunner.class) @SpringBootTest @@ -49,21 +53,22 @@ public class AlertMapperTest { /** * test insert + * * @return */ @Test - public void testInsert(){ + public void testInsert() { Alert expectedAlert = createAlert(); assertThat(expectedAlert.getId(), greaterThan(0)); } - /** * test select by id + * * @return */ @Test - public void testSelectById(){ + public void testSelectById() { Alert expectedAlert = createAlert(); Alert actualAlert = alertMapper.selectById(expectedAlert.getId()); assertEquals(expectedAlert, actualAlert); @@ -73,7 +78,7 @@ public class AlertMapperTest { * test update */ @Test - public void testUpdate(){ + public void testUpdate() { Alert expectedAlert = createAlert(); @@ -92,7 +97,7 @@ public class AlertMapperTest { * test delete */ @Test - public void testDelete(){ + public void testDelete() { Alert expectedAlert = createAlert(); alertMapper.deleteById(expectedAlert.getId()); @@ -102,7 +107,6 @@ public class AlertMapperTest { assertNull(actualAlert); } - /** * test list alert by status */ @@ -111,54 +115,54 @@ public class AlertMapperTest { Integer count = 10; AlertStatus waitExecution = AlertStatus.WAIT_EXECUTION; - Map expectedAlertMap = createAlertMap(count, waitExecution); + Map expectedAlertMap = createAlertMap(count, waitExecution); List actualAlerts = alertMapper.listAlertByStatus(waitExecution); - for (Alert actualAlert : actualAlerts){ + for (Alert actualAlert : actualAlerts) { Alert expectedAlert = expectedAlertMap.get(actualAlert.getId()); - if (expectedAlert != null){ - assertEquals(expectedAlert,actualAlert); + if (expectedAlert != null) { + assertEquals(expectedAlert, actualAlert); } } } /** - * create alert map - * @param count alert count + * create alert map + * + * @param count alert count * @param alertStatus alert status * @return alert map */ - private Map createAlertMap(Integer count,AlertStatus alertStatus){ - Map alertMap = new HashMap<>(); + private Map createAlertMap(Integer count, AlertStatus alertStatus) { + Map alertMap = new HashMap<>(); - for (int i = 0 ; i < count ;i++){ + for (int i = 0; i < count; i++) { Alert alert = createAlert(alertStatus); - alertMap.put(alert.getId(),alert); + alertMap.put(alert.getId(), alert); } - return alertMap; - } - /** * create alert + * * @return alert * @throws Exception */ - private Alert createAlert(){ + private Alert createAlert() { return createAlert(AlertStatus.WAIT_EXECUTION); } /** * create alert + * * @param alertStatus alert status * @return alert */ - private Alert createAlert(AlertStatus alertStatus){ + private Alert createAlert(AlertStatus alertStatus) { Alert alert = new Alert(); - alert.setShowType(ShowType.TABLE); + //alert.setShowType(ShowType.TABLE); alert.setTitle("test alert"); alert.setContent("[{'type':'WORKER','host':'192.168.xx.xx','event':'server down','warning level':'serious'}]"); alert.setAlertType(AlertType.EMAIL); diff --git a/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapperTest.java b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapperTest.java new file mode 100644 index 0000000000..3fa5fcc56e --- /dev/null +++ b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/AlertPluginInstanceMapperTest.java @@ -0,0 +1,118 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.dao.mapper; + +import org.apache.dolphinscheduler.common.enums.AlertType; +import org.apache.dolphinscheduler.common.utils.DateUtils; +import org.apache.dolphinscheduler.dao.entity.AlertGroup; +import org.apache.dolphinscheduler.dao.entity.AlertPluginInstance; +import org.apache.dolphinscheduler.dao.entity.PluginDefine; + +import java.util.List; + +import org.junit.Assert; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.Rollback; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.transaction.annotation.Transactional; + +/** + * AlertPluginInstanceMapper mapper test + */ +@RunWith(SpringRunner.class) +@SpringBootTest +@Transactional +@Rollback(true) +public class AlertPluginInstanceMapperTest { + + @Autowired + AlertPluginInstanceMapper alertPluginInstanceMapper; + + @Autowired + PluginDefineMapper pluginDefineMapper; + + @Autowired + AlertGroupMapper alertGroupMapper; + + @Test + public void testQueryAllAlertPluginInstanceList() { + AlertPluginInstance alertPluginInstance = createAlertPluginInstance(); + List alertPluginInstanceList = alertPluginInstanceMapper.queryAllAlertPluginInstanceList(); + Assert.assertTrue(alertPluginInstanceList.size() > 0); + } + + @Test + public void testQueryByAlertGroupId() { + createAlertPluginInstance(); + List testAlertGroupList = alertGroupMapper.queryByGroupName("test_group_01"); + Assert.assertNotNull(testAlertGroupList); + Assert.assertTrue(testAlertGroupList.size() > 0); + AlertGroup alertGroup = testAlertGroupList.get(0); + List alertPluginInstances = alertPluginInstanceMapper.queryByAlertGroupId(alertGroup.getId()); + Assert.assertNotNull(alertPluginInstances); + Assert.assertTrue(alertPluginInstances.size() > 0); + Assert.assertEquals("test_instance", alertPluginInstances.get(0).getInstanceName()); + } + + /** + * insert + * + * @return AlertPluginInstance + */ + private AlertPluginInstance createAlertPluginInstance() { + + PluginDefine pluginDefine = createPluginDefine(); + AlertGroup alertGroup = createAlertGroup("test_group_01"); + AlertPluginInstance alertPluginInstance = new AlertPluginInstance(pluginDefine.getId(), "", alertGroup.getId(), "test_instance"); + alertPluginInstanceMapper.insert(alertPluginInstance); + return alertPluginInstance; + } + + /** + * insert + * + * @return PluginDefine + */ + private PluginDefine createPluginDefine() { + PluginDefine pluginDefine = new PluginDefine("test plugin", "alert", ""); + pluginDefineMapper.insert(pluginDefine); + return pluginDefine; + } + + /** + * insert + * + * @return AlertGroup + */ + private AlertGroup createAlertGroup(String groupName) { + AlertGroup alertGroup = new AlertGroup(); + alertGroup.setGroupName(groupName); + alertGroup.setDescription("alert group 1"); + alertGroup.setGroupType(AlertType.EMAIL); + + alertGroup.setCreateTime(DateUtils.getCurrentDate()); + alertGroup.setUpdateTime(DateUtils.getCurrentDate()); + + alertGroupMapper.insert(alertGroup); + + return alertGroup; + } +} diff --git a/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/PluginDefineTest.java b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/PluginDefineTest.java new file mode 100644 index 0000000000..d8636a6fbc --- /dev/null +++ b/dolphinscheduler-dao/src/test/java/org/apache/dolphinscheduler/dao/mapper/PluginDefineTest.java @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.dao.mapper; + +import org.apache.dolphinscheduler.dao.entity.PluginDefine; + +import java.util.List; + +import org.junit.Assert; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.Rollback; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.transaction.annotation.Transactional; + +@RunWith(SpringRunner.class) +@SpringBootTest +@Transactional +@Rollback(true) + +public class PluginDefineTest { + + @Autowired + PluginDefineMapper pluginDefineMapper; + + @Test + public void testQueryAllPluginDefineList() { + createPluginDefine(); + List pluginDefines = pluginDefineMapper.queryAllPluginDefineList(); + Assert.assertTrue(pluginDefines.size() > 0); + } + + @Test + public void testQeryByPluginType() { + PluginDefine pluginDefine = createPluginDefine(); + List pluginDefines = pluginDefineMapper.queryByPluginType(pluginDefine.getPluginType()); + Assert.assertTrue(pluginDefines.size() > 0); + Assert.assertEquals(pluginDefines.get(0).getPluginType(), pluginDefine.getPluginType()); + } + + @Test + public void testQueryByNameAndType() { + PluginDefine pluginDefine = createPluginDefine(); + List pluginDefines = pluginDefineMapper.queryByNameAndType(pluginDefine.getPluginName(), pluginDefine.getPluginType()); + Assert.assertTrue(pluginDefines.size() > 0); + Assert.assertEquals(pluginDefines.get(0).getPluginType(), pluginDefine.getPluginType()); + Assert.assertEquals(pluginDefines.get(0).getPluginName(), pluginDefine.getPluginName()); + } + + /** + * insert + * + * @return PluginDefine + */ + private PluginDefine createPluginDefine() { + PluginDefine pluginDefine = new PluginDefine("test plugin", "alert", ""); + pluginDefineMapper.insert(pluginDefine); + return pluginDefine; + } +} diff --git a/dolphinscheduler-dist/release-docs/LICENSE b/dolphinscheduler-dist/release-docs/LICENSE index 9a0fdae649..6fa1ea9279 100644 --- a/dolphinscheduler-dist/release-docs/LICENSE +++ b/dolphinscheduler-dist/release-docs/LICENSE @@ -1,4 +1,4 @@ - Apache License + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -237,7 +237,6 @@ The text of each license is also included at licenses/LICENSE-[project].txt. commons-configuration 1.10: https://mvnrepository.com/artifact/commons-configuration/commons-configuration/1.10, Apache 2.0 commons-daemon 1.0.13 https://mvnrepository.com/artifact/commons-daemon/commons-daemon/1.0.13, Apache 2.0 commons-dbcp 1.4: https://github.com/apache/commons-dbcp, Apache 2.0 - commons-email 1.5: https://github.com/apache/commons-email, Apache 2.0 commons-httpclient 3.0.1: https://mvnrepository.com/artifact/commons-httpclient/commons-httpclient/3.0.1, Apache 2.0 commons-io 2.4: https://github.com/apache/commons-io, Apache 2.0 commons-lang 2.6: https://github.com/apache/commons-lang, Apache 2.0 @@ -254,8 +253,9 @@ The text of each license is also included at licenses/LICENSE-[project].txt. datanucleus-rdbms 4.1.7: https://mvnrepository.com/artifact/org.datanucleus/datanucleus-rdbms/4.1.7, Apache 2.0 derby 10.14.2.0: https://github.com/apache/derby, Apache 2.0 druid 1.1.14: https://mvnrepository.com/artifact/com.alibaba/druid/1.1.14, Apache 2.0 + error_prone_annotations 2.1.3 https://mvnrepository.com/artifact/com.google.errorprone/error_prone_annotations/2.1.3, Apache 2.0 gson 2.8.5: https://github.com/google/gson, Apache 2.0 - guava 20.0: https://mvnrepository.com/artifact/com.google.guava/guava/20.0, Apache 2.0 + guava 24.1-jre: https://mvnrepository.com/artifact/com.google.guava/guava/24.1-jre, Apache 2.0 guice 3.0: https://mvnrepository.com/artifact/com.google.inject/guice/3.0, Apache 2.0 guice-servlet 3.0: https://mvnrepository.com/artifact/com.google.inject.extensions/guice-servlet/3.0, Apache 2.0 hadoop-annotations 2.7.3:https://mvnrepository.com/artifact/org.apache.hadoop/hadoop-annotations/2.7.3, Apache 2.0 @@ -323,6 +323,7 @@ The text of each license is also included at licenses/LICENSE-[project].txt. jsqlparser 2.1: https://github.com/JSQLParser/JSqlParser, Apache 2.0 or LGPL 2.1 jsp-api-2.1 6.1.14: https://mvnrepository.com/artifact/org.mortbay.jetty/jsp-api-2.1/6.1.14, Apache 2.0 jsr305 3.0.0: https://mvnrepository.com/artifact/com.google.code.findbugs/jsr305, Apache 2.0 + j2objc-annotations 1.1 https://mvnrepository.com/artifact/com.google.j2objc/j2objc-annotations/1.1, Apache 2.0 libfb303 0.9.3: https://mvnrepository.com/artifact/org.apache.thrift/libfb303/0.9.3, Apache 2.0 libthrift 0.9.3: https://mvnrepository.com/artifact/org.apache.thrift/libthrift/0.9.3, Apache 2.0 log4j-api 2.11.2: https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api/2.11.2, Apache 2.0 @@ -414,10 +415,8 @@ CDDL licenses The following components are provided under the CDDL License. See project link for details. The text of each license is also included at licenses/LICENSE-[project].txt. - activation 1.1: https://mvnrepository.com/artifact/javax.activation/activation/1.1 CDDL 1.0 javax.activation-api 1.2.0: https://mvnrepository.com/artifact/javax.activation/javax.activation-api/1.2.0, CDDL and LGPL 2.0 javax.annotation-api 1.3.2: https://mvnrepository.com/artifact/javax.annotation/javax.annotation-api/1.3.2, CDDL + GPLv2 - javax.mail 1.6.2: https://mvnrepository.com/artifact/com.sun.mail/javax.mail/1.6.2, CDDL/GPLv2 javax.servlet-api 3.1.0: https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api/3.1.0, CDDL + GPLv2 jaxb-api 2.3.1: https://mvnrepository.com/artifact/javax.xml.bind/jaxb-api/2.3.1, CDDL 1.1 jaxb-impl 2.2.3-1: https://mvnrepository.com/artifact/com.sun.xml.bind/jaxb-impl/2.2.3-1, CDDL and GPL 1.1 @@ -456,6 +455,8 @@ The text of each license is also included at licenses/LICENSE-[project].txt. jul-to-slf4j 1.7.25: https://mvnrepository.com/artifact/org.slf4j/jul-to-slf4j/1.7.25, MIT mssql-jdbc 6.1.0.jre8: https://mvnrepository.com/artifact/com.microsoft.sqlserver/mssql-jdbc/6.1.0.jre8, MIT slf4j-api 1.7.5: https://mvnrepository.com/artifact/org.slf4j/slf4j-api/1.7.5, MIT + animal-sniffer-annotations 1.14 https://mvnrepository.com/artifact/org.codehaus.mojo/animal-sniffer-annotations/1.14, MIT + checker-compat-qual 2.0.0 https://mvnrepository.com/artifact/org.checkerframework/checker-compat-qual/2.0.0, MIT + GPLv2 ======================================================================== MPL 1.1 licenses @@ -515,4 +516,4 @@ Apache 2.0 licenses ======================================== BSD licenses ======================================== - d3 3.5.17: https://github.com/d3/d3 BSD-3-Clause + d3 3.5.17: https://github.com/d3/d3 BSD-3-Clause \ No newline at end of file diff --git a/dolphinscheduler-dist/release-docs/NOTICE b/dolphinscheduler-dist/release-docs/NOTICE index 901659e689..61076b9780 100644 --- a/dolphinscheduler-dist/release-docs/NOTICE +++ b/dolphinscheduler-dist/release-docs/NOTICE @@ -1917,26 +1917,3 @@ ANT NOTICE Please read the different LICENSE files present in the root directory of this distribution. - - - - - - - - - - - - - - - - - - - - - - - diff --git a/dolphinscheduler-dist/release-docs/licenses/LICENSE-aether-api.txt b/dolphinscheduler-dist/release-docs/licenses/LICENSE-aether-api.txt new file mode 100644 index 0000000000..3fa00836fa --- /dev/null +++ b/dolphinscheduler-dist/release-docs/licenses/LICENSE-aether-api.txt @@ -0,0 +1,86 @@ +Eclipse Public License - v 1.0 +THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + +a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and + +b) in the case of each subsequent Contributor: + +i) changes to the Program, and + +ii) additions to the Program; + +where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program. + +"Contributor" means any person or entity that distributes the Program. + +"Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program. + +"Program" means the Contributions distributed in accordance with this Agreement. + +"Recipient" means anyone who receives the Program under this Agreement, including all Contributors. + +2. GRANT OF RIGHTS + +a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form. + +b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder. + +c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program. + +d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement. + +3. REQUIREMENTS + +A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that: + +a) it complies with the terms and conditions of this Agreement; and + +b) its license agreement: + +i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose; + +ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits; + +iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and + +iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange. + +When the Program is made available in source code form: + +a) it must be made available under this Agreement; and + +b) a copy of this Agreement must be included with each copy of the Program. + +Contributors may not remove or alter any copyright notices contained within the Program. + +Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement , including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. + +If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed. + +All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive. + +Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. + +This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation. \ No newline at end of file diff --git a/dolphinscheduler-dist/release-docs/licenses/LICENSE-animal-sniffer-annotations.txt b/dolphinscheduler-dist/release-docs/licenses/LICENSE-animal-sniffer-annotations.txt new file mode 100644 index 0000000000..2062eb88b4 --- /dev/null +++ b/dolphinscheduler-dist/release-docs/licenses/LICENSE-animal-sniffer-annotations.txt @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2009 codehaus.org. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/dolphinscheduler-dist/release-docs/licenses/LICENSE-checker-compat-qual.txt b/dolphinscheduler-dist/release-docs/licenses/LICENSE-checker-compat-qual.txt new file mode 100644 index 0000000000..7b59b5c982 --- /dev/null +++ b/dolphinscheduler-dist/release-docs/licenses/LICENSE-checker-compat-qual.txt @@ -0,0 +1,22 @@ +Checker Framework qualifiers +Copyright 2004-present by the Checker Framework developers + +MIT License: + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/dolphinscheduler-dist/release-docs/licenses/LICENSE-j2objc-annotations.txt b/dolphinscheduler-dist/release-docs/licenses/LICENSE-j2objc-annotations.txt new file mode 100644 index 0000000000..989e2c59e9 --- /dev/null +++ b/dolphinscheduler-dist/release-docs/licenses/LICENSE-j2objc-annotations.txt @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/dolphinscheduler-dist/release-docs/licenses/LICENSE-javax.mail.txt b/dolphinscheduler-dist/release-docs/licenses/LICENSE-javax.mail.txt deleted file mode 100644 index 5ad62c442b..0000000000 --- a/dolphinscheduler-dist/release-docs/licenses/LICENSE-javax.mail.txt +++ /dev/null @@ -1,759 +0,0 @@ -COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.1 - -1. Definitions. - - 1.1. "Contributor" means each individual or entity that creates or - contributes to the creation of Modifications. - - 1.2. "Contributor Version" means the combination of the Original - Software, prior Modifications used by a Contributor (if any), and - the Modifications made by that particular Contributor. - - 1.3. "Covered Software" means (a) the Original Software, or (b) - Modifications, or (c) the combination of files containing Original - Software with files containing Modifications, in each case including - portions thereof. - - 1.4. "Executable" means the Covered Software in any form other than - Source Code. - - 1.5. "Initial Developer" means the individual or entity that first - makes Original Software available under this License. - - 1.6. "Larger Work" means a work which combines Covered Software or - portions thereof with code not governed by the terms of this License. - - 1.7. "License" means this document. - - 1.8. "Licensable" means having the right to grant, to the maximum - extent possible, whether at the time of the initial grant or - subsequently acquired, any and all of the rights conveyed herein. - - 1.9. "Modifications" means the Source Code and Executable form of - any of the following: - - A. Any file that results from an addition to, deletion from or - modification of the contents of a file containing Original Software - or previous Modifications; - - B. Any new file that contains any part of the Original Software or - previous Modification; or - - C. Any new file that is contributed or otherwise made available - under the terms of this License. - - 1.10. "Original Software" means the Source Code and Executable form - of computer software code that is originally released under this - License. - - 1.11. "Patent Claims" means any patent claim(s), now owned or - hereafter acquired, including without limitation, method, process, - and apparatus claims, in any patent Licensable by grantor. - - 1.12. "Source Code" means (a) the common form of computer software - code in which modifications are made and (b) associated - documentation included in or with such code. - - 1.13. "You" (or "Your") means an individual or a legal entity - exercising rights under, and complying with all of the terms of, - this License. For legal entities, "You" includes any entity which - controls, is controlled by, or is under common control with You. For - purposes of this definition, "control" means (a) the power, direct - or indirect, to cause the direction or management of such entity, - whether by contract or otherwise, or (b) ownership of more than - fifty percent (50%) of the outstanding shares or beneficial - ownership of such entity. - -2. License Grants. - - 2.1. The Initial Developer Grant. - - Conditioned upon Your compliance with Section 3.1 below and subject - to third party intellectual property claims, the Initial Developer - hereby grants You a world-wide, royalty-free, non-exclusive license: - - (a) under intellectual property rights (other than patent or - trademark) Licensable by Initial Developer, to use, reproduce, - modify, display, perform, sublicense and distribute the Original - Software (or portions thereof), with or without Modifications, - and/or as part of a Larger Work; and - - (b) under Patent Claims infringed by the making, using or selling of - Original Software, to make, have made, use, practice, sell, and - offer for sale, and/or otherwise dispose of the Original Software - (or portions thereof). - - (c) The licenses granted in Sections 2.1(a) and (b) are effective on - the date Initial Developer first distributes or otherwise makes the - Original Software available to a third party under the terms of this - License. - - (d) Notwithstanding Section 2.1(b) above, no patent license is - granted: (1) for code that You delete from the Original Software, or - (2) for infringements caused by: (i) the modification of the - Original Software, or (ii) the combination of the Original Software - with other software or devices. - - 2.2. Contributor Grant. - - Conditioned upon Your compliance with Section 3.1 below and subject - to third party intellectual property claims, each Contributor hereby - grants You a world-wide, royalty-free, non-exclusive license: - - (a) under intellectual property rights (other than patent or - trademark) Licensable by Contributor to use, reproduce, modify, - display, perform, sublicense and distribute the Modifications - created by such Contributor (or portions thereof), either on an - unmodified basis, with other Modifications, as Covered Software - and/or as part of a Larger Work; and - - (b) under Patent Claims infringed by the making, using, or selling - of Modifications made by that Contributor either alone and/or in - combination with its Contributor Version (or portions of such - combination), to make, use, sell, offer for sale, have made, and/or - otherwise dispose of: (1) Modifications made by that Contributor (or - portions thereof); and (2) the combination of Modifications made by - that Contributor with its Contributor Version (or portions of such - combination). - - (c) The licenses granted in Sections 2.2(a) and 2.2(b) are effective - on the date Contributor first distributes or otherwise makes the - Modifications available to a third party. - - (d) Notwithstanding Section 2.2(b) above, no patent license is - granted: (1) for any code that Contributor has deleted from the - Contributor Version; (2) for infringements caused by: (i) third - party modifications of Contributor Version, or (ii) the combination - of Modifications made by that Contributor with other software - (except as part of the Contributor Version) or other devices; or (3) - under Patent Claims infringed by Covered Software in the absence of - Modifications made by that Contributor. - -3. Distribution Obligations. - - 3.1. Availability of Source Code. - - Any Covered Software that You distribute or otherwise make available - in Executable form must also be made available in Source Code form - and that Source Code form must be distributed only under the terms - of this License. You must include a copy of this License with every - copy of the Source Code form of the Covered Software You distribute - or otherwise make available. You must inform recipients of any such - Covered Software in Executable form as to how they can obtain such - Covered Software in Source Code form in a reasonable manner on or - through a medium customarily used for software exchange. - - 3.2. Modifications. - - The Modifications that You create or to which You contribute are - governed by the terms of this License. You represent that You - believe Your Modifications are Your original creation(s) and/or You - have sufficient rights to grant the rights conveyed by this License. - - 3.3. Required Notices. - - You must include a notice in each of Your Modifications that - identifies You as the Contributor of the Modification. You may not - remove or alter any copyright, patent or trademark notices contained - within the Covered Software, or any notices of licensing or any - descriptive text giving attribution to any Contributor or the - Initial Developer. - - 3.4. Application of Additional Terms. - - You may not offer or impose any terms on any Covered Software in - Source Code form that alters or restricts the applicable version of - this License or the recipients' rights hereunder. You may choose to - offer, and to charge a fee for, warranty, support, indemnity or - liability obligations to one or more recipients of Covered Software. - However, you may do so only on Your own behalf, and not on behalf of - the Initial Developer or any Contributor. You must make it - absolutely clear that any such warranty, support, indemnity or - liability obligation is offered by You alone, and You hereby agree - to indemnify the Initial Developer and every Contributor for any - liability incurred by the Initial Developer or such Contributor as a - result of warranty, support, indemnity or liability terms You offer. - - 3.5. Distribution of Executable Versions. - - You may distribute the Executable form of the Covered Software under - the terms of this License or under the terms of a license of Your - choice, which may contain terms different from this License, - provided that You are in compliance with the terms of this License - and that the license for the Executable form does not attempt to - limit or alter the recipient's rights in the Source Code form from - the rights set forth in this License. If You distribute the Covered - Software in Executable form under a different license, You must make - it absolutely clear that any terms which differ from this License - are offered by You alone, not by the Initial Developer or - Contributor. You hereby agree to indemnify the Initial Developer and - every Contributor for any liability incurred by the Initial - Developer or such Contributor as a result of any such terms You offer. - - 3.6. Larger Works. - - You may create a Larger Work by combining Covered Software with - other code not governed by the terms of this License and distribute - the Larger Work as a single product. In such a case, You must make - sure the requirements of this License are fulfilled for the Covered - Software. - -4. Versions of the License. - - 4.1. New Versions. - - Oracle is the initial license steward and may publish revised and/or - new versions of this License from time to time. Each version will be - given a distinguishing version number. Except as provided in Section - 4.3, no one other than the license steward has the right to modify - this License. - - 4.2. Effect of New Versions. - - You may always continue to use, distribute or otherwise make the - Covered Software available under the terms of the version of the - License under which You originally received the Covered Software. If - the Initial Developer includes a notice in the Original Software - prohibiting it from being distributed or otherwise made available - under any subsequent version of the License, You must distribute and - make the Covered Software available under the terms of the version - of the License under which You originally received the Covered - Software. Otherwise, You may also choose to use, distribute or - otherwise make the Covered Software available under the terms of any - subsequent version of the License published by the license steward. - - 4.3. Modified Versions. - - When You are an Initial Developer and You want to create a new - license for Your Original Software, You may create and use a - modified version of this License if You: (a) rename the license and - remove any references to the name of the license steward (except to - note that the license differs from this License); and (b) otherwise - make it clear that the license contains terms which differ from this - License. - -5. DISCLAIMER OF WARRANTY. - - COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, - INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE - IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR - NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF - THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY COVERED SOFTWARE PROVE - DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY - OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, - REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN - ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED SOFTWARE IS - AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER. - -6. TERMINATION. - - 6.1. This License and the rights granted hereunder will terminate - automatically if You fail to comply with terms herein and fail to - cure such breach within 30 days of becoming aware of the breach. - Provisions which, by their nature, must remain in effect beyond the - termination of this License shall survive. - - 6.2. If You assert a patent infringement claim (excluding - declaratory judgment actions) against Initial Developer or a - Contributor (the Initial Developer or Contributor against whom You - assert such claim is referred to as "Participant") alleging that the - Participant Software (meaning the Contributor Version where the - Participant is a Contributor or the Original Software where the - Participant is the Initial Developer) directly or indirectly - infringes any patent, then any and all rights granted directly or - indirectly to You by such Participant, the Initial Developer (if the - Initial Developer is not the Participant) and all Contributors under - Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice - from Participant terminate prospectively and automatically at the - expiration of such 60 day notice period, unless if within such 60 - day period You withdraw Your claim with respect to the Participant - Software against such Participant either unilaterally or pursuant to - a written agreement with Participant. - - 6.3. If You assert a patent infringement claim against Participant - alleging that the Participant Software directly or indirectly - infringes any patent where such claim is resolved (such as by - license or settlement) prior to the initiation of patent - infringement litigation, then the reasonable value of the licenses - granted by such Participant under Sections 2.1 or 2.2 shall be taken - into account in determining the amount or value of any payment or - license. - - 6.4. In the event of termination under Sections 6.1 or 6.2 above, - all end user licenses that have been validly granted by You or any - distributor hereunder prior to termination (excluding licenses - granted to You by any distributor) shall survive termination. - -7. LIMITATION OF LIABILITY. - - UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT - (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE - INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF - COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE - TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR - CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT - LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER - FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR - LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE - POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT - APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH - PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH - LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR - LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION - AND LIMITATION MAY NOT APPLY TO YOU. - -8. U.S. GOVERNMENT END USERS. - - The Covered Software is a "commercial item," as that term is defined - in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer - software" (as that term is defined at 48 C.F.R. - 252.227-7014(a)(1)) and "commercial computer software documentation" - as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent - with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 - (June 1995), all U.S. Government End Users acquire Covered Software - with only those rights set forth herein. This U.S. Government Rights - clause is in lieu of, and supersedes, any other FAR, DFAR, or other - clause or provision that addresses Government rights in computer - software under this License. - -9. MISCELLANEOUS. - - This License represents the complete agreement concerning subject - matter hereof. If any provision of this License is held to be - unenforceable, such provision shall be reformed only to the extent - necessary to make it enforceable. This License shall be governed by - the law of the jurisdiction specified in a notice contained within - the Original Software (except to the extent applicable law, if any, - provides otherwise), excluding such jurisdiction's conflict-of-law - provisions. Any litigation relating to this License shall be subject - to the jurisdiction of the courts located in the jurisdiction and - venue specified in a notice contained within the Original Software, - with the losing party responsible for costs, including, without - limitation, court costs and reasonable attorneys' fees and expenses. - The application of the United Nations Convention on Contracts for - the International Sale of Goods is expressly excluded. Any law or - regulation which provides that the language of a contract shall be - construed against the drafter shall not apply to this License. You - agree that You alone are responsible for compliance with the United - States export administration regulations (and the export control - laws and regulation of any other countries) when You use, distribute - or otherwise make available any Covered Software. - -10. RESPONSIBILITY FOR CLAIMS. - - As between Initial Developer and the Contributors, each party is - responsible for claims and damages arising, directly or indirectly, - out of its utilization of rights under this License and You agree to - work with Initial Developer and Contributors to distribute such - responsibility on an equitable basis. Nothing herein is intended or - shall be deemed to constitute any admission of liability. - ------------------------------------------------------------------------- - -NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION -LICENSE (CDDL) - -The code released under the CDDL shall be governed by the laws of the -State of California (excluding conflict-of-law provisions). Any -litigation relating to this License shall be subject to the jurisdiction -of the Federal Courts of the Northern District of California and the -state courts of the State of California, with venue lying in Santa Clara -County, California. - - - - The GNU General Public License (GPL) Version 2, June 1991 - -Copyright (C) 1989, 1991 Free Software Foundation, Inc. -51 Franklin Street, Fifth Floor -Boston, MA 02110-1335 -USA - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. - -Preamble - -The licenses for most software are designed to take away your freedom to -share and change it. By contrast, the GNU General Public License is -intended to guarantee your freedom to share and change free software--to -make sure the software is free for all its users. This General Public -License applies to most of the Free Software Foundation's software and -to any other program whose authors commit to using it. (Some other Free -Software Foundation software is covered by the GNU Library General -Public License instead.) You can apply it to your programs, too. - -When we speak of free software, we are referring to freedom, not price. -Our General Public Licenses are designed to make sure that you have the -freedom to distribute copies of free software (and charge for this -service if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs; and that you know you can do these things. - -To protect your rights, we need to make restrictions that forbid anyone -to deny you these rights or to ask you to surrender the rights. These -restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - -For example, if you distribute copies of such a program, whether gratis -or for a fee, you must give the recipients all the rights that you have. -You must make sure that they, too, receive or can get the source code. -And you must show them these terms so they know their rights. - -We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - -Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - -Finally, any free program is threatened constantly by software patents. -We wish to avoid the danger that redistributors of a free program will -individually obtain patent licenses, in effect making the program -proprietary. To prevent this, we have made it clear that any patent must -be licensed for everyone's free use or not licensed at all. - -The precise terms and conditions for copying, distribution and -modification follow. - -TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - -0. This License applies to any program or other work which contains a -notice placed by the copyright holder saying it may be distributed under -the terms of this General Public License. The "Program", below, refers -to any such program or work, and a "work based on the Program" means -either the Program or any derivative work under copyright law: that is -to say, a work containing the Program or a portion of it, either -verbatim or with modifications and/or translated into another language. -(Hereinafter, translation is included without limitation in the term -"modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of running -the Program is not restricted, and the output from the Program is -covered only if its contents constitute a work based on the Program -(independent of having been made by running the Program). Whether that -is true depends on what the Program does. - -1. You may copy and distribute verbatim copies of the Program's source -code as you receive it, in any medium, provided that you conspicuously -and appropriately publish on each copy an appropriate copyright notice -and disclaimer of warranty; keep intact all the notices that refer to -this License and to the absence of any warranty; and give any other -recipients of the Program a copy of this License along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - -2. You may modify your copy or copies of the Program or any portion of -it, thus forming a work based on the Program, and copy and distribute -such modifications or work under the terms of Section 1 above, provided -that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any part - thereof, to be licensed as a whole at no charge to all third parties - under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a notice - that there is no warranty (or else, saying that you provide a - warranty) and that users may redistribute the program under these - conditions, and telling the user how to view a copy of this License. - (Exception: if the Program itself is interactive but does not - normally print such an announcement, your work based on the Program - is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, and -can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based on -the Program, the distribution of the whole must be on the terms of this -License, whose permissions for other licensees extend to the entire -whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of a -storage or distribution medium does not bring the other work under the -scope of this License. - -3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections 1 - and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your cost - of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer to - distribute corresponding source code. (This alternative is allowed - only for noncommercial distribution and only if you received the - program in object code or executable form with such an offer, in - accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source code -means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to control -compilation and installation of the executable. However, as a special -exception, the source code distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies the -executable. - -If distribution of executable or object code is made by offering access -to copy from a designated place, then offering equivalent access to copy -the source code from the same place counts as distribution of the source -code, even though third parties are not compelled to copy the source -along with the object code. - -4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt otherwise -to copy, modify, sublicense or distribute the Program is void, and will -automatically terminate your rights under this License. However, parties -who have received copies, or rights, from you under this License will -not have their licenses terminated so long as such parties remain in -full compliance. - -5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and all -its terms and conditions for copying, distributing or modifying the -Program or works based on it. - -6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further restrictions -on the recipients' exercise of the rights granted herein. You are not -responsible for enforcing compliance by third parties to this License. - -7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot distribute -so as to satisfy simultaneously your obligations under this License and -any other pertinent obligations, then as a consequence you may not -distribute the Program at all. For example, if a patent license would -not permit royalty-free redistribution of the Program by all those who -receive copies directly or indirectly through you, then the only way you -could satisfy both it and this License would be to refrain entirely from -distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is implemented -by public license practices. Many people have made generous -contributions to the wide range of software distributed through that -system in reliance on consistent application of that system; it is up to -the author/donor to decide if he or she is willing to distribute -software through any other system and a licensee cannot impose that choice. - -This section is intended to make thoroughly clear what is believed to be -a consequence of the rest of this License. - -8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License may -add an explicit geographical distribution limitation excluding those -countries, so that distribution is permitted only in or among countries -not thus excluded. In such case, this License incorporates the -limitation as if written in the body of this License. - -9. The Free Software Foundation may publish revised and/or new -versions of the General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Program does not specify a version -number of this License, you may choose any version ever published by the -Free Software Foundation. - -10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the -author to ask for permission. For software which is copyrighted by the -Free Software Foundation, write to the Free Software Foundation; we -sometimes make exceptions for this. Our decision will be guided by the -two goals of preserving the free status of all derivatives of our free -software and of promoting the sharing and reuse of software generally. - -NO WARRANTY - -11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, -EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE -ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH -YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL -NECESSARY SERVICING, REPAIR OR CORRECTION. - -12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR -DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL -DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM -(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED -INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF -THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR -OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -END OF TERMS AND CONDITIONS - -How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively convey -the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - One line to give the program's name and a brief idea of what it does. - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type - `show w'. This is free software, and you are welcome to redistribute - it under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the -appropriate parts of the General Public License. Of course, the commands -you use may be called something other than `show w' and `show c'; they -could even be mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - program `Gnomovision' (which makes passes at compilers) written by - James Hacker. - - signature of Ty Coon, 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications -with the library. If this is what you want to do, use the GNU Library -General Public License instead of this License. - -# - -Certain source files distributed by Oracle America, Inc. and/or its -affiliates are subject to the following clarification and special -exception to the GPLv2, based on the GNU Project exception for its -Classpath libraries, known as the GNU Classpath Exception, but only -where Oracle has expressly included in the particular source file's -header the words "Oracle designates this particular file as subject to -the "Classpath" exception as provided by Oracle in the LICENSE file -that accompanied this code." - -You should also note that Oracle includes multiple, independent -programs in this software package. Some of those programs are provided -under licenses deemed incompatible with the GPLv2 by the Free Software -Foundation and others. For example, the package includes programs -licensed under the Apache License, Version 2.0. Such programs are -licensed to you under their original licenses. - -Oracle facilitates your further distribution of this package by adding -the Classpath Exception to the necessary parts of its GPLv2 code, which -permits you to use that code in combination with other independent -modules not licensed under the GPLv2. However, note that this would -not permit you to commingle code under an incompatible license with -Oracle's GPLv2 licensed code by, for example, cutting and pasting such -code into a file also containing Oracle's GPLv2 licensed code and then -distributing the result. Additionally, if you were to remove the -Classpath Exception from any of the files to which it applies and -distribute the result, you would likely be required to license some or -all of the other code in that distribution under the GPLv2 as well, and -since the GPLv2 is incompatible with the license terms of some items -included in the distribution by Oracle, removing the Classpath -Exception could therefore effectively compromise your ability to -further distribute the package. - -Proceed with caution and we recommend that you obtain the advice of a -lawyer skilled in open source matters before removing the Classpath -Exception or making modifications to this package which may -subsequently be redistributed and/or involve the use of third party -software. - -CLASSPATH EXCEPTION -Linking this library statically or dynamically with other modules is -making a combined work based on this library. Thus, the terms and -conditions of the GNU General Public License version 2 cover the whole -combination. - -As a special exception, the copyright holders of this library give you -permission to link this library with independent modules to produce an -executable, regardless of the license terms of these independent -modules, and to copy and distribute the resulting executable under -terms of your choice, provided that you also meet, for each linked -independent module, the terms and conditions of the license of that -module. An independent module is a module which is not derived from or -based on this library. If you modify this library, you may extend this -exception to your version of the library, but you are not obligated to -do so. If you do not wish to do so, delete this exception statement -from your version. diff --git a/dolphinscheduler-dist/release-docs/licenses/LICENSE-resolver.txt b/dolphinscheduler-dist/release-docs/licenses/LICENSE-resolver.txt new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/dolphinscheduler-dist/release-docs/licenses/LICENSE-resolver.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/utils/PropertyUtils.java b/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/utils/PropertyUtils.java deleted file mode 100644 index a244dd491e..0000000000 --- a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/utils/PropertyUtils.java +++ /dev/null @@ -1,190 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.plugin.utils; - -import org.apache.commons.io.IOUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Properties; - -/** - * property utils - * single instance - */ -public class PropertyUtils { - - private static final Logger logger = LoggerFactory.getLogger(PropertyUtils.class); - - private static final Properties properties = new Properties(); - - private PropertyUtils() { - throw new IllegalStateException("PropertyUtils class"); - } - - static { - String propertyFiles = "/plugin.properties"; - InputStream fis = null; - try { - fis = PropertyUtils.class.getResourceAsStream(propertyFiles); - properties.load(fis); - } catch (IOException e) { - logger.error(e.getMessage(), e); - if (fis != null) { - IOUtils.closeQuietly(fis); - } - } finally { - IOUtils.closeQuietly(fis); - } - } - - /** - * get property value - * - * @param key property name - * @param defaultVal default value - * @return property value - */ - public static String getString(String key, String defaultVal) { - String val = properties.getProperty(key.trim()); - return val == null ? defaultVal : val; - } - - /** - * get property value - * - * @param key property name - * @return property value - */ - public static String getString(String key) { - if (key == null) { - return null; - } - return properties.getProperty(key.trim()); - } - - /** - * get property value - * - * @param key property name - * @return get property int value , if key == null, then return -1 - */ - public static int getInt(String key) { - return getInt(key, -1); - } - - /** - * get int - * - * @param key key - * @param defaultValue default value - * @return property value - */ - public static int getInt(String key, int defaultValue) { - String value = properties.getProperty(key.trim()); - if (value == null) { - return defaultValue; - } - try { - return Integer.parseInt(value); - } catch (NumberFormatException e) { - logger.info(e.getMessage(), e); - } - return defaultValue; - } - - /** - * get property value - * - * @param key property name - * @return property value - */ - public static boolean getBoolean(String key) { - String value = properties.getProperty(key.trim()); - if (value == null) { - return false; - } - - return Boolean.parseBoolean(value); - } - - /** - * get property value - * - * @param key property name - * @param defaultValue default value - * @return property value - */ - public static Boolean getBoolean(String key, boolean defaultValue) { - String value = properties.getProperty(key.trim()); - if (value == null) { - return defaultValue; - } - - return Boolean.parseBoolean(value); - } - - /** - * get property long value - * - * @param key key - * @param defaultVal default value - * @return property value - */ - public static long getLong(String key, long defaultVal) { - String val = getString(key); - return val == null ? defaultVal : Long.parseLong(val); - } - - /** - * get long - * - * @param key key - * @return property value - */ - public static long getLong(String key) { - return getLong(key, -1); - } - - /** - * get double - * - * @param key key - * @param defaultVal default value - * @return property value - */ - public static double getDouble(String key, double defaultVal) { - String val = properties.getProperty(key.trim()); - return val == null ? defaultVal : Double.parseDouble(val); - } - - /** - * @param key key - * @param type type - * @param defaultValue default value - * @param T - * @return get enum value - */ - public > T getEnum(String key, Class type, - T defaultValue) { - String val = properties.getProperty(key.trim()); - return val == null ? defaultValue : Enum.valueOf(type, val); - } - -} diff --git a/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/model/AlertDataTest.java b/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/model/AlertDataTest.java deleted file mode 100644 index c19b5bc29a..0000000000 --- a/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/model/AlertDataTest.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.plugin.model; - -import org.junit.Before; -import org.junit.Test; - -import static org.junit.Assert.*; - -public class AlertDataTest { - - private AlertData alertData; - - @Before - public void before() { - alertData = new AlertData(); - alertData.setId(1) - .setContent("content") - .setShowType("email") - .setTitle("title") - .setReceivers("receivers") - .setReceiversCc("cc") - .setLog("log") - .setAlertGroupId(1); - } - - @Test - public void getId() { - assertEquals(1, alertData.getId()); - } - - @Test - public void getTitle() { - assertEquals("title", alertData.getTitle()); - } - - @Test - public void getContent() { - assertEquals("content", alertData.getContent()); - } - - @Test - public void getLog() { - assertEquals("log", alertData.getLog()); - } - - @Test - public void getAlertGroupId() { - assertEquals(1, alertData.getAlertGroupId()); - } - - @Test - public void getReceivers() { - assertEquals("receivers", alertData.getReceivers()); - } - - @Test - public void getReceiversCc() { - assertEquals("cc", alertData.getReceiversCc()); - } - - @Test - public void getShowType() { - assertEquals("email", alertData.getShowType()); - } -} \ No newline at end of file diff --git a/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/model/AlertInfoTest.java b/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/model/AlertInfoTest.java deleted file mode 100644 index 13eb595ac3..0000000000 --- a/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/model/AlertInfoTest.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.plugin.model; - -import org.junit.Before; -import org.junit.Test; - -import java.util.HashMap; -import java.util.Map; - -import static org.junit.Assert.*; - -public class AlertInfoTest { - - private AlertInfo alertInfo; - - @Before - public void before() { - alertInfo = new AlertInfo(); - } - - @Test - public void getAlertProps() { - Map map = new HashMap<>(); - alertInfo.setAlertProps(map); - assertNotNull(alertInfo.getAlertProps()); - } - - @Test - public void getProp() { - alertInfo.addProp("k", "v"); - assertEquals("v", alertInfo.getProp("k")); - } - - @Test - public void getAlertData() { - alertInfo.setAlertData(new AlertData()); - assertNotNull(alertInfo.getAlertData()); - } -} \ No newline at end of file diff --git a/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/utils/PropertyUtilsTest.java b/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/utils/PropertyUtilsTest.java deleted file mode 100644 index 614a7c009c..0000000000 --- a/dolphinscheduler-plugin-api/src/test/java/org/apache/dolphinscheduler/plugin/utils/PropertyUtilsTest.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.dolphinscheduler.plugin.utils; - -import org.junit.Test; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import static org.junit.Assert.*; - -public class PropertyUtilsTest { - - private static final Logger logger = LoggerFactory.getLogger(PropertyUtilsTest.class); - - /** - * Test getString - */ - @Test - public void testGetString() { - - String result = PropertyUtils.getString("test.string"); - logger.info(result); - assertEquals("teststring", result); - - //If key is null, then return null - result = PropertyUtils.getString(null); - assertNull(result); - } - - - /** - * Test getBoolean - */ - @Test - public void testGetBoolean() { - - //Expected true - Boolean result = PropertyUtils.getBoolean("test.true"); - assertTrue(result); - - //Expected false - result = PropertyUtils.getBoolean("test.false"); - assertFalse(result); - } - - /** - * Test getLong - */ - @Test - public void testGetLong() { - long result = PropertyUtils.getLong("test.long"); - assertSame(100L, result); - } - - /** - * Test getDouble - */ - @Test - public void testGetDouble() { - - //If key is undefine in alert.properties, and there is a defaultval, then return defaultval - double result = PropertyUtils.getDouble("abc", 5.0); - assertEquals(5.0, result, 0); - - result = PropertyUtils.getDouble("cba", 5.0); - assertEquals(3.1, result, 0.01); - } - -} \ No newline at end of file diff --git a/dolphinscheduler-plugin-api/src/test/resources/plugin.properties b/dolphinscheduler-plugin-api/src/test/resources/plugin.properties deleted file mode 100644 index d2ea3831be..0000000000 --- a/dolphinscheduler-plugin-api/src/test/resources/plugin.properties +++ /dev/null @@ -1,22 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -test.string=teststring -test.false=false -test.true=true -cba=3.1 -test.long=100 \ No newline at end of file diff --git a/dolphinscheduler-server/pom.xml b/dolphinscheduler-server/pom.xml index 4cbce0ab47..18283a5bc7 100644 --- a/dolphinscheduler-server/pom.xml +++ b/dolphinscheduler-server/pom.xml @@ -16,177 +16,182 @@ ~ limitations under the License. --> - - 4.0.0 - - org.apache.dolphinscheduler - dolphinscheduler - 1.3.2-SNAPSHOT - - dolphinscheduler-server - dolphinscheduler-server + + 4.0.0 + + org.apache.dolphinscheduler + dolphinscheduler + 1.3.2-SNAPSHOT + + dolphinscheduler-server + dolphinscheduler-server - jar - - UTF-8 - + jar + + UTF-8 + - - - org.apache.dolphinscheduler - dolphinscheduler-common - - - io.netty - netty - - - io.netty - netty-all - - - com.google - netty - - - log4j-slf4j-impl - org.apache.logging.log4j - - - - - org.apache.dolphinscheduler - dolphinscheduler-dao - - - spring-boot-starter-logging - org.springframework.boot - - - + + + org.apache.dolphinscheduler + dolphinscheduler-spi + + + org.apache.dolphinscheduler + dolphinscheduler-common + + + io.netty + netty + + + io.netty + netty-all + + + com.google + netty + + + log4j-slf4j-impl + org.apache.logging.log4j + + + + + org.apache.dolphinscheduler + dolphinscheduler-dao + + + spring-boot-starter-logging + org.springframework.boot + + + - - org.apache.dolphinscheduler - dolphinscheduler-service - - - org.apache.curator - curator-framework - - - org.apache.zookeeper - zookeeper - - - - - org.apache.curator - curator-recipes - - - org.apache.zookeeper - zookeeper - - - - - org.apache.zookeeper - zookeeper - + + org.apache.dolphinscheduler + dolphinscheduler-service + + + org.apache.curator + curator-framework + + + org.apache.zookeeper + zookeeper + + + + + org.apache.curator + curator-recipes + + + org.apache.zookeeper + zookeeper + + + + + org.apache.zookeeper + zookeeper + - - org.apache.httpcomponents - httpclient - - - org.apache.httpcomponents - httpcore - - - junit - junit - test - + + org.apache.httpcomponents + httpclient + + + org.apache.httpcomponents + httpcore + + + junit + junit + test + - - org.apache.dolphinscheduler - dolphinscheduler-alert - + + org.apache.dolphinscheduler + dolphinscheduler-alert + - - org.powermock - powermock-module-junit4 - test - - - org.powermock - powermock-api-mockito2 - test - - - org.mockito - mockito-core - - - - - org.mockito - mockito-core - test - + + org.powermock + powermock-module-junit4 + test + + + org.powermock + powermock-api-mockito2 + test + + + org.mockito + mockito-core + + + + + org.mockito + mockito-core + test + org.springframework spring-test - + - - - - - - - - - - - - - - - - - - - - - org.apache.maven.plugins - maven-compiler-plugin - - ${java.version} - ${java.version} - ${project.build.sourceEncoding} - - - - + + + + + + + + + + + + + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + ${java.version} + ${java.version} + ${project.build.sourceEncoding} + + + + diff --git a/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/utils/AlertManager.java b/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/utils/AlertManager.java index 58ade83d68..073c0750b2 100644 --- a/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/utils/AlertManager.java +++ b/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/utils/AlertManager.java @@ -19,7 +19,6 @@ package org.apache.dolphinscheduler.server.utils; import org.apache.dolphinscheduler.common.enums.AlertType; import org.apache.dolphinscheduler.common.enums.CommandType; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.common.enums.WarningType; import org.apache.dolphinscheduler.common.utils.JSONUtils; import org.apache.dolphinscheduler.dao.AlertDao; @@ -29,6 +28,7 @@ import org.apache.dolphinscheduler.dao.entity.ProcessAlertContent; import org.apache.dolphinscheduler.dao.entity.ProcessDefinition; import org.apache.dolphinscheduler.dao.entity.ProcessInstance; import org.apache.dolphinscheduler.dao.entity.TaskInstance; +import org.apache.dolphinscheduler.spi.alert.ShowType; import java.util.ArrayList; import java.util.Date; @@ -89,7 +89,7 @@ public class AlertManager { * get process instance content * * @param processInstance process instance - * @param taskInstances task instance list + * @param taskInstances task instance list * @return process instance format content */ public String getContentProcessInstance(ProcessInstance processInstance, @@ -141,7 +141,7 @@ public class AlertManager { /** * getting worker fault tolerant content * - * @param processInstance process instance + * @param processInstance process instance * @param toleranceTaskList tolerance task list * @return worker tolerance content */ @@ -164,14 +164,14 @@ public class AlertManager { /** * send worker alert fault tolerance * - * @param processInstance process instance + * @param processInstance process instance * @param toleranceTaskList tolerance task list */ public void sendAlertWorkerToleranceFault(ProcessInstance processInstance, List toleranceTaskList) { try { Alert alert = new Alert(); alert.setTitle("worker fault tolerance"); - alert.setShowType(ShowType.TABLE); + //alert.setShowType(ShowType.TABLE); String content = getWorkerToleranceContent(processInstance, toleranceTaskList); alert.setContent(content); alert.setAlertType(AlertType.EMAIL); @@ -192,7 +192,7 @@ public class AlertManager { * send process instance alert * * @param processInstance process instance - * @param taskInstances task instance list + * @param taskInstances task instance list */ public void sendAlertProcessInstance(ProcessInstance processInstance, List taskInstances) { @@ -226,7 +226,7 @@ public class AlertManager { String success = processInstance.getState().typeIsSuccess() ? "success" : "failed"; alert.setTitle(cmdName + " " + success); ShowType showType = processInstance.getState().typeIsSuccess() ? ShowType.TEXT : ShowType.TABLE; - alert.setShowType(showType); + //alert.setShowType(showType); String content = getContentProcessInstance(processInstance, taskInstances); alert.setContent(content); alert.setAlertType(AlertType.EMAIL); @@ -242,7 +242,7 @@ public class AlertManager { /** * send process timeout alert * - * @param processInstance process instance + * @param processInstance process instance * @param processDefinition process definition */ public void sendProcessTimeoutAlert(ProcessInstance processInstance, ProcessDefinition processDefinition) { diff --git a/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/worker/task/sql/SqlTask.java b/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/worker/task/sql/SqlTask.java index f28f5804b0..cba7a488c1 100644 --- a/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/worker/task/sql/SqlTask.java +++ b/dolphinscheduler-server/src/main/java/org/apache/dolphinscheduler/server/worker/task/sql/SqlTask.java @@ -14,23 +14,30 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.apache.dolphinscheduler.server.worker.task.sql; -import com.fasterxml.jackson.databind.node.ArrayNode; -import com.fasterxml.jackson.databind.node.ObjectNode; -import org.apache.commons.lang.StringUtils; -import org.apache.dolphinscheduler.alert.utils.MailUtils; +import static org.apache.dolphinscheduler.common.Constants.COMMA; +import static org.apache.dolphinscheduler.common.Constants.HIVE_CONF; +import static org.apache.dolphinscheduler.common.Constants.PASSWORD; +import static org.apache.dolphinscheduler.common.Constants.SEMICOLON; +import static org.apache.dolphinscheduler.common.Constants.USER; +import static org.apache.dolphinscheduler.common.enums.DbType.HIVE; + import org.apache.dolphinscheduler.common.Constants; -import org.apache.dolphinscheduler.common.enums.*; +import org.apache.dolphinscheduler.common.enums.CommandType; import org.apache.dolphinscheduler.common.enums.DbType; -import org.apache.dolphinscheduler.common.enums.ShowType; import org.apache.dolphinscheduler.common.enums.TaskTimeoutStrategy; import org.apache.dolphinscheduler.common.process.Property; import org.apache.dolphinscheduler.common.task.AbstractParameters; import org.apache.dolphinscheduler.common.task.sql.SqlBinds; import org.apache.dolphinscheduler.common.task.sql.SqlParameters; import org.apache.dolphinscheduler.common.task.sql.SqlType; -import org.apache.dolphinscheduler.common.utils.*; +import org.apache.dolphinscheduler.common.utils.CollectionUtils; +import org.apache.dolphinscheduler.common.utils.CommonUtils; +import org.apache.dolphinscheduler.common.utils.JSONUtils; +import org.apache.dolphinscheduler.common.utils.ParameterUtils; +import org.apache.dolphinscheduler.common.utils.StringUtils; import org.apache.dolphinscheduler.dao.AlertDao; import org.apache.dolphinscheduler.dao.datasource.BaseDataSource; import org.apache.dolphinscheduler.dao.datasource.DataSourceFactory; @@ -41,27 +48,40 @@ import org.apache.dolphinscheduler.server.utils.ParamUtils; import org.apache.dolphinscheduler.server.utils.UDFUtils; import org.apache.dolphinscheduler.server.worker.task.AbstractTask; import org.apache.dolphinscheduler.service.bean.SpringApplicationContext; -import org.slf4j.Logger; -import java.sql.*; -import java.util.*; +import java.sql.Connection; +import java.sql.DriverManager; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.ResultSetMetaData; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Properties; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.stream.Collectors; -import static org.apache.dolphinscheduler.common.Constants.*; -import static org.apache.dolphinscheduler.common.enums.DbType.HIVE; +import org.slf4j.Logger; + +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; + /** * sql task */ public class SqlTask extends AbstractTask { /** - * sql parameters + * sql parameters */ private SqlParameters sqlParameters; /** - * alert dao + * alert dao */ private AlertDao alertDao; /** @@ -148,15 +168,15 @@ public class SqlTask extends AbstractTask { /** * ready to execute SQL and parameter entity Map + * * @return SqlBinds */ private SqlBinds getSqlAndSqlParamsMap(String sql) { - Map sqlParamsMap = new HashMap<>(); + Map sqlParamsMap = new HashMap<>(); StringBuilder sqlBuilder = new StringBuilder(); // find process instance by task id - Map paramsMap = ParamUtils.convert(ParamUtils.getUserDefParamsMap(taskExecutionContext.getDefinedParams()), taskExecutionContext.getDefinedParams(), sqlParameters.getLocalParametersMap(), @@ -164,18 +184,18 @@ public class SqlTask extends AbstractTask { taskExecutionContext.getScheduleTime()); // spell SQL according to the final user-defined variable - if(paramsMap == null){ + if (paramsMap == null) { sqlBuilder.append(sql); return new SqlBinds(sqlBuilder.toString(), sqlParamsMap); } - if (StringUtils.isNotEmpty(sqlParameters.getTitle())){ + if (StringUtils.isNotEmpty(sqlParameters.getTitle())) { String title = ParameterUtils.convertParameterPlaceholders(sqlParameters.getTitle(), ParamUtils.convert(paramsMap)); - logger.info("SQL title : {}",title); + logger.info("SQL title : {}", title); sqlParameters.setTitle(title); } - + //new //replace variable TIME with $[YYYYmmddd...] in sql when history run job and batch complement job sql = ParameterUtils.replaceScheduleTime(sql, taskExecutionContext.getScheduleTime()); @@ -199,15 +219,16 @@ public class SqlTask extends AbstractTask { /** * execute function and sql - * @param mainSqlBinds main sql binds - * @param preStatementsBinds pre statements binds - * @param postStatementsBinds post statements binds - * @param createFuncs create functions + * + * @param mainSqlBinds main sql binds + * @param preStatementsBinds pre statements binds + * @param postStatementsBinds post statements binds + * @param createFuncs create functions */ public void executeFuncAndSql(SqlBinds mainSqlBinds, - List preStatementsBinds, - List postStatementsBinds, - List createFuncs){ + List preStatementsBinds, + List postStatementsBinds, + List createFuncs) { Connection connection = null; PreparedStatement stmt = null; ResultSet resultSet = null; @@ -218,11 +239,11 @@ public class SqlTask extends AbstractTask { connection = createConnection(); // create temp function if (CollectionUtils.isNotEmpty(createFuncs)) { - createTempFunction(connection,createFuncs); + createTempFunction(connection, createFuncs); } // pre sql - preSql(connection,preStatementsBinds); + preSql(connection, preStatementsBinds); stmt = prepareStatementAndBind(connection, mainSqlBinds); // decide whether to executeQuery or executeUpdate based on sqlType @@ -236,13 +257,13 @@ public class SqlTask extends AbstractTask { stmt.executeUpdate(); } - postSql(connection,postStatementsBinds); + postSql(connection, postStatementsBinds); } catch (Exception e) { - logger.error("execute sql error",e); + logger.error("execute sql error", e); throw new RuntimeException("execute sql error"); } finally { - close(resultSet,stmt,connection); + close(resultSet, stmt, connection); } } @@ -252,7 +273,7 @@ public class SqlTask extends AbstractTask { * @param resultSet resultSet * @throws Exception Exception */ - private void resultProcess(ResultSet resultSet) throws Exception{ + private void resultProcess(ResultSet resultSet) throws Exception { ArrayNode resultJSONArray = JSONUtils.createArrayNode(); ResultSetMetaData md = resultSet.getMetaData(); int num = md.getColumnCount(); @@ -270,23 +291,24 @@ public class SqlTask extends AbstractTask { String result = JSONUtils.toJsonString(resultJSONArray); logger.debug("execute sql : {}", result); - sendAttachment(StringUtils.isNotEmpty(sqlParameters.getTitle()) ? - sqlParameters.getTitle(): taskExecutionContext.getTaskName() + " query result sets", + sendAttachment(StringUtils.isNotEmpty(sqlParameters.getTitle()) + ? sqlParameters.getTitle() : taskExecutionContext.getTaskName() + + " query result sets", JSONUtils.toJsonString(resultJSONArray)); } /** - * pre sql + * pre sql * - * @param connection connection + * @param connection connection * @param preStatementsBinds preStatementsBinds */ private void preSql(Connection connection, - List preStatementsBinds) throws Exception{ - for (SqlBinds sqlBind: preStatementsBinds) { - try (PreparedStatement pstmt = prepareStatementAndBind(connection, sqlBind)){ + List preStatementsBinds) throws Exception { + for (SqlBinds sqlBind : preStatementsBinds) { + try (PreparedStatement pstmt = prepareStatementAndBind(connection, sqlBind)) { int result = pstmt.executeUpdate(); - logger.info("pre statement execute result: {}, for sql: {}",result,sqlBind.getSql()); + logger.info("pre statement execute result: {}, for sql: {}", result, sqlBind.getSql()); } } @@ -295,28 +317,29 @@ public class SqlTask extends AbstractTask { /** * post sql * - * @param connection connection + * @param connection connection * @param postStatementsBinds postStatementsBinds * @throws Exception */ private void postSql(Connection connection, - List postStatementsBinds) throws Exception{ - for (SqlBinds sqlBind: postStatementsBinds) { - try (PreparedStatement pstmt = prepareStatementAndBind(connection, sqlBind)){ + List postStatementsBinds) throws Exception { + for (SqlBinds sqlBind : postStatementsBinds) { + try (PreparedStatement pstmt = prepareStatementAndBind(connection, sqlBind)) { int result = pstmt.executeUpdate(); - logger.info("post statement execute result: {},for sql: {}",result,sqlBind.getSql()); + logger.info("post statement execute result: {},for sql: {}", result, sqlBind.getSql()); } } } + /** * create temp function * - * @param connection connection + * @param connection connection * @param createFuncs createFuncs * @throws Exception */ private void createTempFunction(Connection connection, - List createFuncs) throws Exception{ + List createFuncs) throws Exception { try (Statement funcStmt = connection.createStatement()) { for (String createFunc : createFuncs) { logger.info("hive create function sql: {}", createFunc); @@ -324,14 +347,14 @@ public class SqlTask extends AbstractTask { } } } - + /** * create connection * * @return connection * @throws Exception Exception */ - private Connection createConnection() throws Exception{ + private Connection createConnection() throws Exception { // if hive , load connection params if exists Connection connection = null; if (HIVE == DbType.valueOf(sqlParameters.getType())) { @@ -345,7 +368,7 @@ public class SqlTask extends AbstractTask { connection = DriverManager.getConnection(baseDataSource.getJdbcUrl(), paramProp); - }else{ + } else { connection = DriverManager.getConnection(baseDataSource.getJdbcUrl(), baseDataSource.getUser(), baseDataSource.getPassword()); @@ -354,57 +377,58 @@ public class SqlTask extends AbstractTask { } /** - * close jdbc resource + * close jdbc resource * - * @param resultSet resultSet - * @param pstmt pstmt + * @param resultSet resultSet + * @param pstmt pstmt * @param connection connection */ private void close(ResultSet resultSet, PreparedStatement pstmt, - Connection connection){ - if (resultSet != null){ + Connection connection) { + if (resultSet != null) { try { resultSet.close(); } catch (SQLException e) { - logger.error("close result set error : {}",e.getMessage(),e); + logger.error("close result set error : {}", e.getMessage(), e); } } - if (pstmt != null){ + if (pstmt != null) { try { pstmt.close(); } catch (SQLException e) { - logger.error("close prepared statement error : {}",e.getMessage(),e); + logger.error("close prepared statement error : {}", e.getMessage(), e); } } - if (connection != null){ + if (connection != null) { try { connection.close(); } catch (SQLException e) { - logger.error("close connection error : {}",e.getMessage(),e); + logger.error("close connection error : {}", e.getMessage(), e); } } } /** * preparedStatement bind + * * @param connection connection - * @param sqlBinds sqlBinds + * @param sqlBinds sqlBinds * @return PreparedStatement * @throws Exception Exception */ private PreparedStatement prepareStatementAndBind(Connection connection, SqlBinds sqlBinds) throws Exception { // is the timeout set - boolean timeoutFlag = TaskTimeoutStrategy.of(taskExecutionContext.getTaskTimeoutStrategy()) == TaskTimeoutStrategy.FAILED || - TaskTimeoutStrategy.of(taskExecutionContext.getTaskTimeoutStrategy()) == TaskTimeoutStrategy.WARNFAILED; + boolean timeoutFlag = TaskTimeoutStrategy.of(taskExecutionContext.getTaskTimeoutStrategy()) == TaskTimeoutStrategy.FAILED + || TaskTimeoutStrategy.of(taskExecutionContext.getTaskTimeoutStrategy()) == TaskTimeoutStrategy.WARNFAILED; PreparedStatement stmt = connection.prepareStatement(sqlBinds.getSql()); - if(timeoutFlag){ + if (timeoutFlag) { stmt.setQueryTimeout(taskExecutionContext.getTaskTimeout()); } Map params = sqlBinds.getParamsMap(); - if(params != null) { + if (params != null) { for (Map.Entry entry : params.entrySet()) { Property prop = entry.getValue(); ParameterUtils.setInParameter(entry.getKey(), stmt, prop.getType(), prop.getValue()); @@ -416,23 +440,24 @@ public class SqlTask extends AbstractTask { /** * send mail as an attachment - * @param title title - * @param content content + * + * @param title title + * @param content content */ - public void sendAttachment(String title,String content){ + public void sendAttachment(String title, String content) { List users = alertDao.queryUserByAlertGroupId(taskExecutionContext.getSqlTaskExecutionContext().getWarningGroupId()); // receiving group list List receiversList = new ArrayList<>(); - for(User user:users){ + for (User user : users) { receiversList.add(user.getEmail().trim()); } // custom receiver String receivers = sqlParameters.getReceivers(); - if (StringUtils.isNotEmpty(receivers)){ + if (StringUtils.isNotEmpty(receivers)) { String[] splits = receivers.split(COMMA); - for (String receiver : splits){ + for (String receiver : splits) { receiversList.add(receiver.trim()); } } @@ -441,60 +466,64 @@ public class SqlTask extends AbstractTask { List receiversCcList = new ArrayList<>(); // Custom Copier String receiversCc = sqlParameters.getReceiversCc(); - if (StringUtils.isNotEmpty(receiversCc)){ + if (StringUtils.isNotEmpty(receiversCc)) { String[] splits = receiversCc.split(COMMA); - for (String receiverCc : splits){ + for (String receiverCc : splits) { receiversCcList.add(receiverCc.trim()); } } - String showTypeName = sqlParameters.getShowType().replace(COMMA,"").trim(); + String showTypeName = sqlParameters.getShowType().replace(COMMA, "").trim(); + /* if(EnumUtils.isValidEnum(ShowType.class,showTypeName)){ - Map mailResult = MailUtils.sendMails(receiversList, - receiversCcList, title, content, ShowType.valueOf(showTypeName).getDescp()); + Map mailResult = MailUtils.sendMails(receviersList, + receviersCcList, title, content, ShowType.valueOf(showTypeName).getDescp()); if(!(boolean) mailResult.get(STATUS)){ throw new RuntimeException("send mail failed!"); } + //TODO AlertServer should provide a grpc interface, which is called when other services need to send alerts }else{ logger.error("showType: {} is not valid " ,showTypeName); throw new RuntimeException(String.format("showType: %s is not valid ",showTypeName)); - } + }*/ } /** * regular expressions match the contents between two specified strings - * @param content content - * @param rgex rgex - * @param sqlParamsMap sql params map - * @param paramsPropsMap params props map + * + * @param content content + * @param rgex rgex + * @param sqlParamsMap sql params map + * @param paramsPropsMap params props map */ - public void setSqlParamsMap(String content, String rgex, Map sqlParamsMap, Map paramsPropsMap){ + public void setSqlParamsMap(String content, String rgex, Map sqlParamsMap, Map paramsPropsMap) { Pattern pattern = Pattern.compile(rgex); Matcher m = pattern.matcher(content); int index = 1; while (m.find()) { String paramName = m.group(1); - Property prop = paramsPropsMap.get(paramName); + Property prop = paramsPropsMap.get(paramName); - sqlParamsMap.put(index,prop); - index ++; + sqlParamsMap.put(index, prop); + index++; } } /** * print replace sql - * @param content content - * @param formatSql format sql - * @param rgex rgex - * @param sqlParamsMap sql params map + * + * @param content content + * @param formatSql format sql + * @param rgex rgex + * @param sqlParamsMap sql params map */ - public void printReplacedSql(String content, String formatSql,String rgex, Map sqlParamsMap){ + public void printReplacedSql(String content, String formatSql, String rgex, Map sqlParamsMap) { //parameter print style - logger.info("after replace sql , preparing : {}" , formatSql); + logger.info("after replace sql , preparing : {}", formatSql); StringBuilder logPrint = new StringBuilder("replaced sql , parameters:"); - for(int i=1;i<=sqlParamsMap.size();i++){ - logPrint.append(sqlParamsMap.get(i).getValue()+"("+sqlParamsMap.get(i).getType()+")"); + for (int i = 1; i <= sqlParamsMap.size(); i++) { + logPrint.append(sqlParamsMap.get(i).getValue() + "(" + sqlParamsMap.get(i).getType() + ")"); } logger.info("Sql Params are {}", logPrint); } diff --git a/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/registry/DependencyConfig.java b/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/registry/DependencyConfig.java index 30f1053d3a..4d7b50f9ca 100644 --- a/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/registry/DependencyConfig.java +++ b/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/registry/DependencyConfig.java @@ -18,10 +18,26 @@ package org.apache.dolphinscheduler.server.registry; import org.apache.dolphinscheduler.dao.AlertDao; -import org.apache.dolphinscheduler.dao.mapper.*; +import org.apache.dolphinscheduler.dao.mapper.AlertGroupMapper; +import org.apache.dolphinscheduler.dao.mapper.AlertMapper; +import org.apache.dolphinscheduler.dao.mapper.AlertPluginInstanceMapper; +import org.apache.dolphinscheduler.dao.mapper.CommandMapper; +import org.apache.dolphinscheduler.dao.mapper.DataSourceMapper; +import org.apache.dolphinscheduler.dao.mapper.ErrorCommandMapper; +import org.apache.dolphinscheduler.dao.mapper.PluginDefineMapper; +import org.apache.dolphinscheduler.dao.mapper.ProcessDefinitionMapper; +import org.apache.dolphinscheduler.dao.mapper.ProcessInstanceMapMapper; +import org.apache.dolphinscheduler.dao.mapper.ProcessInstanceMapper; +import org.apache.dolphinscheduler.dao.mapper.ProjectMapper; +import org.apache.dolphinscheduler.dao.mapper.ResourceMapper; +import org.apache.dolphinscheduler.dao.mapper.ScheduleMapper; +import org.apache.dolphinscheduler.dao.mapper.TaskInstanceMapper; +import org.apache.dolphinscheduler.dao.mapper.TenantMapper; +import org.apache.dolphinscheduler.dao.mapper.UdfFuncMapper; +import org.apache.dolphinscheduler.dao.mapper.UserAlertGroupMapper; +import org.apache.dolphinscheduler.dao.mapper.UserMapper; import org.apache.dolphinscheduler.server.master.cache.impl.TaskInstanceCacheManagerImpl; import org.apache.dolphinscheduler.server.master.config.MasterConfig; -import org.apache.dolphinscheduler.server.master.dispatch.ExecutorDispatcher; import org.apache.dolphinscheduler.server.master.dispatch.host.HostManager; import org.apache.dolphinscheduler.server.master.dispatch.host.RandomHostManager; import org.apache.dolphinscheduler.server.master.processor.queue.TaskResponseService; @@ -29,6 +45,7 @@ import org.apache.dolphinscheduler.server.worker.processor.TaskCallbackService; import org.apache.dolphinscheduler.service.process.ProcessService; import org.apache.dolphinscheduler.service.queue.TaskPriorityQueue; import org.apache.dolphinscheduler.service.queue.TaskPriorityQueueImpl; + import org.mockito.Mockito; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -55,103 +72,119 @@ public class DependencyConfig { } @Bean - public TaskInstanceCacheManagerImpl taskInstanceCacheManagerImpl(){ + public TaskInstanceCacheManagerImpl taskInstanceCacheManagerImpl() { return Mockito.mock(TaskInstanceCacheManagerImpl.class); } @Bean - public ProcessService processService(){ + public ProcessService processService() { return Mockito.mock(ProcessService.class); } @Bean - public MasterConfig masterConfig(){ + public MasterConfig masterConfig() { return Mockito.mock(MasterConfig.class); } + @Bean - public UserMapper userMapper(){ + public UserMapper userMapper() { return Mockito.mock(UserMapper.class); } @Bean - public ProcessDefinitionMapper processDefineMapper(){ + public ProcessDefinitionMapper processDefineMapper() { return Mockito.mock(ProcessDefinitionMapper.class); } @Bean - public ProcessInstanceMapper processInstanceMapper(){ + public ProcessInstanceMapper processInstanceMapper() { return Mockito.mock(ProcessInstanceMapper.class); } @Bean - public DataSourceMapper dataSourceMapper(){ + public DataSourceMapper dataSourceMapper() { return Mockito.mock(DataSourceMapper.class); } @Bean - public ProcessInstanceMapMapper processInstanceMapMapper(){ + public ProcessInstanceMapMapper processInstanceMapMapper() { return Mockito.mock(ProcessInstanceMapMapper.class); } @Bean - public TaskInstanceMapper taskInstanceMapper(){ + public TaskInstanceMapper taskInstanceMapper() { return Mockito.mock(TaskInstanceMapper.class); } @Bean - public CommandMapper commandMapper(){ + public CommandMapper commandMapper() { return Mockito.mock(CommandMapper.class); } @Bean - public ScheduleMapper scheduleMapper(){ + public ScheduleMapper scheduleMapper() { return Mockito.mock(ScheduleMapper.class); } @Bean - public UdfFuncMapper udfFuncMapper(){ + public UdfFuncMapper udfFuncMapper() { return Mockito.mock(UdfFuncMapper.class); } @Bean - public ResourceMapper resourceMapper(){ + public ResourceMapper resourceMapper() { return Mockito.mock(ResourceMapper.class); } - @Bean - public ErrorCommandMapper errorCommandMapper(){ + public ErrorCommandMapper errorCommandMapper() { return Mockito.mock(ErrorCommandMapper.class); } @Bean - public TenantMapper tenantMapper(){ + public TenantMapper tenantMapper() { return Mockito.mock(TenantMapper.class); } @Bean - public ProjectMapper projectMapper(){ + public ProjectMapper projectMapper() { return Mockito.mock(ProjectMapper.class); } @Bean - public TaskCallbackService taskCallbackService(){ + public TaskCallbackService taskCallbackService() { return Mockito.mock(TaskCallbackService.class); } @Bean - public HostManager hostManager(){ + public HostManager hostManager() { return new RandomHostManager(); } @Bean - public TaskResponseService taskResponseService(){ + public TaskResponseService taskResponseService() { return Mockito.mock(TaskResponseService.class); } @Bean - public TaskPriorityQueue taskPriorityQueue(){ + public TaskPriorityQueue taskPriorityQueue() { return new TaskPriorityQueueImpl(); } + + @Bean + public AlertPluginInstanceMapper alertPluginInstanceMapper() { + return Mockito.mock(AlertPluginInstanceMapper.class); + } + + @Bean + public AlertGroupMapper alertGroupMapper() { + return Mockito.mock(AlertGroupMapper.class); + } + + @Bean + public PluginDefineMapper pluginDefineMapper() { + return Mockito.mock(PluginDefineMapper.class); + } + } diff --git a/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/worker/processor/TaskCallbackServiceTestConfig.java b/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/worker/processor/TaskCallbackServiceTestConfig.java index 942a2d52bb..8bdc07bae2 100644 --- a/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/worker/processor/TaskCallbackServiceTestConfig.java +++ b/dolphinscheduler-server/src/test/java/org/apache/dolphinscheduler/server/worker/processor/TaskCallbackServiceTestConfig.java @@ -18,9 +18,27 @@ package org.apache.dolphinscheduler.server.worker.processor; import org.apache.dolphinscheduler.dao.AlertDao; -import org.apache.dolphinscheduler.dao.mapper.*; +import org.apache.dolphinscheduler.dao.mapper.AlertGroupMapper; +import org.apache.dolphinscheduler.dao.mapper.AlertMapper; +import org.apache.dolphinscheduler.dao.mapper.AlertPluginInstanceMapper; +import org.apache.dolphinscheduler.dao.mapper.CommandMapper; +import org.apache.dolphinscheduler.dao.mapper.DataSourceMapper; +import org.apache.dolphinscheduler.dao.mapper.ErrorCommandMapper; +import org.apache.dolphinscheduler.dao.mapper.PluginDefineMapper; +import org.apache.dolphinscheduler.dao.mapper.ProcessDefinitionMapper; +import org.apache.dolphinscheduler.dao.mapper.ProcessInstanceMapMapper; +import org.apache.dolphinscheduler.dao.mapper.ProcessInstanceMapper; +import org.apache.dolphinscheduler.dao.mapper.ProjectMapper; +import org.apache.dolphinscheduler.dao.mapper.ResourceMapper; +import org.apache.dolphinscheduler.dao.mapper.ScheduleMapper; +import org.apache.dolphinscheduler.dao.mapper.TaskInstanceMapper; +import org.apache.dolphinscheduler.dao.mapper.TenantMapper; +import org.apache.dolphinscheduler.dao.mapper.UdfFuncMapper; +import org.apache.dolphinscheduler.dao.mapper.UserAlertGroupMapper; +import org.apache.dolphinscheduler.dao.mapper.UserMapper; import org.apache.dolphinscheduler.server.master.cache.impl.TaskInstanceCacheManagerImpl; import org.apache.dolphinscheduler.service.process.ProcessService; + import org.mockito.Mockito; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -48,79 +66,94 @@ public class TaskCallbackServiceTestConfig { } @Bean - public TaskInstanceCacheManagerImpl taskInstanceCacheManagerImpl(){ + public TaskInstanceCacheManagerImpl taskInstanceCacheManagerImpl() { return Mockito.mock(TaskInstanceCacheManagerImpl.class); } @Bean - public ProcessService processService(){ + public ProcessService processService() { return Mockito.mock(ProcessService.class); } @Bean - public UserMapper userMapper(){ + public UserMapper userMapper() { return Mockito.mock(UserMapper.class); } @Bean - public ProcessDefinitionMapper processDefineMapper(){ + public ProcessDefinitionMapper processDefineMapper() { return Mockito.mock(ProcessDefinitionMapper.class); } @Bean - public ProcessInstanceMapper processInstanceMapper(){ + public ProcessInstanceMapper processInstanceMapper() { return Mockito.mock(ProcessInstanceMapper.class); } @Bean - public DataSourceMapper dataSourceMapper(){ + public DataSourceMapper dataSourceMapper() { return Mockito.mock(DataSourceMapper.class); } @Bean - public ProcessInstanceMapMapper processInstanceMapMapper(){ + public ProcessInstanceMapMapper processInstanceMapMapper() { return Mockito.mock(ProcessInstanceMapMapper.class); } @Bean - public TaskInstanceMapper taskInstanceMapper(){ + public TaskInstanceMapper taskInstanceMapper() { return Mockito.mock(TaskInstanceMapper.class); } @Bean - public CommandMapper commandMapper(){ + public CommandMapper commandMapper() { return Mockito.mock(CommandMapper.class); } @Bean - public ScheduleMapper scheduleMapper(){ + public ScheduleMapper scheduleMapper() { return Mockito.mock(ScheduleMapper.class); } @Bean - public UdfFuncMapper udfFuncMapper(){ + public UdfFuncMapper udfFuncMapper() { return Mockito.mock(UdfFuncMapper.class); } @Bean - public ResourceMapper resourceMapper(){ + public ResourceMapper resourceMapper() { return Mockito.mock(ResourceMapper.class); } @Bean - public ErrorCommandMapper errorCommandMapper(){ + public ErrorCommandMapper errorCommandMapper() { return Mockito.mock(ErrorCommandMapper.class); } @Bean - public TenantMapper tenantMapper(){ + public TenantMapper tenantMapper() { return Mockito.mock(TenantMapper.class); } @Bean - public ProjectMapper projectMapper(){ + public ProjectMapper projectMapper() { return Mockito.mock(ProjectMapper.class); } + @Bean + public AlertPluginInstanceMapper alertPluginInstanceMapper() { + return Mockito.mock(AlertPluginInstanceMapper.class); + } + + @Bean + public AlertGroupMapper alertGroupMapper() { + return Mockito.mock(AlertGroupMapper.class); + } + + @Bean + public PluginDefineMapper pluginDefineMapper() { + return Mockito.mock(PluginDefineMapper.class); + } + } diff --git a/dolphinscheduler-plugin-api/pom.xml b/dolphinscheduler-spi/pom.xml similarity index 65% rename from dolphinscheduler-plugin-api/pom.xml rename to dolphinscheduler-spi/pom.xml index 7db15e73c3..50ed17e457 100644 --- a/dolphinscheduler-plugin-api/pom.xml +++ b/dolphinscheduler-spi/pom.xml @@ -1,4 +1,4 @@ - + - - + 4.0.0 org.apache.dolphinscheduler dolphinscheduler 1.3.2-SNAPSHOT - dolphinscheduler-plugin-api + dolphinscheduler-spi ${project.artifactId} - jar - UTF-8 + + + + com.fasterxml.jackson.core + jackson-annotations + + + com.fasterxml.jackson.core + jackson-databind + + + com.fasterxml.jackson.core + jackson-core + + org.slf4j slf4j-api + provided + junit junit test - - commons-io - commons-io - - + \ No newline at end of file diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/DolphinSchedulerPlugin.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/DolphinSchedulerPlugin.java new file mode 100644 index 0000000000..157c1af6bc --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/DolphinSchedulerPlugin.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi; + +import static java.util.Collections.emptyList; + +import org.apache.dolphinscheduler.spi.alert.AlertChannelFactory; + +/** + * Dolphinscheduler plugin interface + * All plugin need implements this interface. + * Each plugin needs a factory. This factory has at least two methods. + * one called AlertChannelFactory#getId(), used to return the name of the plugin implementation, + * so that the 'PluginLoad' module can find the plugin implementation class by the name in the configuration file. + * The other method is called create(Map config). This method contains at least one parameter Map config. + * Config contains custom parameters read from the plug-in configuration file. + */ +public interface DolphinSchedulerPlugin { + + default Iterable getAlertChannelFactorys() { + return emptyList(); + } +} diff --git a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/spi/AlertPluginProvider.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertChannel.java similarity index 74% rename from dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/spi/AlertPluginProvider.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertChannel.java index 594636f4eb..a429a4ca02 100644 --- a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/spi/AlertPluginProvider.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertChannel.java @@ -14,20 +14,15 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.plugin.spi; -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; +package org.apache.dolphinscheduler.spi.alert; /** - * PluginProvider + * alert channel interface . + * + * @author gaojun */ -public interface AlertPluginProvider { - - /** - * create an alert plugin - * - * @return an alert plugin - */ - AlertPlugin createPlugin(); +public interface AlertChannel { + AlertResult process(AlertInfo info); } diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertChannelFactory.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertChannelFactory.java new file mode 100644 index 0000000000..d23aa379a1 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertChannelFactory.java @@ -0,0 +1,52 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.alert; + +import org.apache.dolphinscheduler.spi.params.base.PluginParams; + +import java.util.List; + +/** + * Each AlertPlugin need implement this interface + */ +public interface AlertChannelFactory { + + /** + * plugin name + * Must be UNIQUE . + * This alert plugin name eg: email , message ... + * Name can often be displayed on the page ui eg : email , message , MR , spark , hive ... + * + * @return this alert plugin name + */ + String getName(); + + /** + * Returns the configurable parameters that this plugin needs to display on the web ui + * + * @return this alert plugin params + */ + List getParams(); + + /** + * The parameters configured in the alert / xxx.properties file will be in the config map + * + * @return AlertChannel + */ + AlertChannel create(); +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertConstants.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertConstants.java new file mode 100644 index 0000000000..b1eee2a0ba --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertConstants.java @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.alert; + +public class AlertConstants { + + /** the field name of alert show type **/ + public static final String SHOW_TYPE = "show_type"; +} diff --git a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/AlertData.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertData.java similarity index 61% rename from dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/AlertData.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertData.java index 89ab5c4279..5e0abf299c 100644 --- a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/AlertData.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertData.java @@ -14,7 +14,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.plugin.model; + +package org.apache.dolphinscheduler.spi.alert; /** * AlertData @@ -37,22 +38,6 @@ public class AlertData { * log */ private String log; - /** - * alertgroup_id - */ - private int alertGroupId; - /** - * receivers - */ - private String receivers; - /** - * show_type - */ - private String showType; - /** - * receivers_cc - */ - private String receiversCc; public int getId() { return id; @@ -89,41 +74,4 @@ public class AlertData { this.log = log; return this; } - - public int getAlertGroupId() { - return alertGroupId; - } - - public AlertData setAlertGroupId(int alertGroupId) { - this.alertGroupId = alertGroupId; - return this; - } - - public String getReceivers() { - return receivers; - } - - public AlertData setReceivers(String receivers) { - this.receivers = receivers; - return this; - } - - public String getReceiversCc() { - return receiversCc; - } - - public AlertData setReceiversCc(String receiversCc) { - this.receiversCc = receiversCc; - return this; - } - - public String getShowType() { - return showType; - } - - public AlertData setShowType(String showType) { - this.showType = showType; - return this; - } - } diff --git a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/api/AlertPlugin.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertInfo.java similarity index 60% rename from dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/api/AlertPlugin.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertInfo.java index deb7ff6aa4..c91428ce12 100644 --- a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/api/AlertPlugin.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertInfo.java @@ -14,32 +14,37 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.plugin.api; -import org.apache.dolphinscheduler.plugin.model.AlertInfo; -import org.apache.dolphinscheduler.plugin.model.PluginName; - -import java.util.Map; +package org.apache.dolphinscheduler.spi.alert; /** - * Plugin + * AlertInfo */ -public interface AlertPlugin { +public class AlertInfo { /** - * Get alert plugin id - * - * @return alert plugin id, which should be unique + * all params this plugin need is in alertProps */ - String getId(); + private String alertParams; /** - * Get alert plugin name, which will show in front end portal - * - * @return plugin name + * the alert content */ - PluginName getName(); + private AlertData alertData; + + public String getAlertParams() { + return alertParams; + } + + public void setAlertParams(String alertParams) { + this.alertParams = alertParams; + } - Map process(AlertInfo info); + public AlertData getAlertData() { + return alertData; + } + public void setAlertData(AlertData alertData) { + this.alertData = alertData; + } } diff --git a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/PluginName.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertResult.java similarity index 63% rename from dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/PluginName.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertResult.java index 8066e45f1d..a327d09403 100644 --- a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/PluginName.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/AlertResult.java @@ -14,32 +14,28 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.plugin.model; -/** - * PluginName - */ -public class PluginName { +package org.apache.dolphinscheduler.spi.alert; + +public class AlertResult { - private String chinese; + private String status; - private String english; + private String message; - public String getChinese() { - return chinese; + public String getStatus() { + return status; } - public PluginName setChinese(String chinese) { - this.chinese = chinese; - return this; + public void setStatus(String status) { + this.status = status; } - public String getEnglish() { - return english; + public String getMessage() { + return message; } - public PluginName setEnglish(String english) { - this.english = english; - return this; + public void setMessage(String message) { + this.message = message; } } diff --git a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/enums/ShowType.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/ShowType.java similarity index 89% rename from dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/enums/ShowType.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/ShowType.java index 19e552d765..a95e73ff7f 100644 --- a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/enums/ShowType.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/alert/ShowType.java @@ -14,12 +14,12 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.common.enums; -import com.baomidou.mybatisplus.annotation.EnumValue; +package org.apache.dolphinscheduler.spi.alert; /** * show type for email + * all alert plugin can use ShowType , so let it in spi package */ public enum ShowType { /** @@ -33,13 +33,11 @@ public enum ShowType { ATTACHMENT(2, "attachment"), TABLEATTACHMENT(3, "table attachment"); - - ShowType(int code, String descp){ + ShowType(int code, String descp) { this.code = code; this.descp = descp; } - @EnumValue private final int code; private final String descp; diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/classloader/ThreadContextClassLoader.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/classloader/ThreadContextClassLoader.java new file mode 100644 index 0000000000..b905ef72b7 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/classloader/ThreadContextClassLoader.java @@ -0,0 +1,35 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.classloader; + +import java.io.Closeable; + +public class ThreadContextClassLoader + implements Closeable { + private final ClassLoader threadContextClassLoader; + + public ThreadContextClassLoader(ClassLoader newThreadContextClassLoader) { + this.threadContextClassLoader = Thread.currentThread().getContextClassLoader(); + Thread.currentThread().setContextClassLoader(newThreadContextClassLoader); + } + + @Override + public void close() { + Thread.currentThread().setContextClassLoader(threadContextClassLoader); + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/InputParam.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/InputParam.java new file mode 100644 index 0000000000..8553dec18c --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/InputParam.java @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params; + +import org.apache.dolphinscheduler.spi.params.base.FormType; +import org.apache.dolphinscheduler.spi.params.base.ParamsProps; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.Validate; + +import java.util.ArrayList; +import java.util.List; + +/** + * Text param + */ +public class InputParam extends PluginParams { + + private InputParam(Builder builder) { + super(builder); + } + + public static Builder newBuilder(String name, String title) { + return new InputParam.Builder(name, title); + } + + public static class Builder extends PluginParams.Builder { + + public Builder(String name, String title) { + super(name, FormType.INPUT, title); + } + + public Builder setPlaceholder(String placeholder) { + if (this.props == null) { + this.setProps(new ParamsProps()); + } + + this.props.setPlaceholder(placeholder); + return this; + } + + public Builder addValidate(Validate validate) { + if (this.validateList == null) { + this.validateList = new ArrayList<>(); + } + this.validateList.add(validate); + return this; + } + + public Builder setName(String name) { + this.name = name; + return this; + } + + public Builder setProps(ParamsProps props) { + this.props = props; + return this; + } + + public Builder setTitle(String title) { + this.title = title; + return this; + } + + public Builder setValue(Object value) { + this.value = value; + return this; + } + + public Builder setValidateList(List validateList) { + this.validateList = validateList; + return this; + } + + @Override + public InputParam build() { + return new InputParam(this); + } + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/PasswordParam.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/PasswordParam.java new file mode 100644 index 0000000000..7311d52267 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/PasswordParam.java @@ -0,0 +1,89 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params; + +import org.apache.dolphinscheduler.spi.params.base.FormType; +import org.apache.dolphinscheduler.spi.params.base.ParamsProps; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.PropsType; +import org.apache.dolphinscheduler.spi.params.base.Validate; + +import java.util.ArrayList; +import java.util.List; + +/** + * password param + */ +public class PasswordParam extends PluginParams { + + private PasswordParam(Builder builder) { + super(builder); + } + + public static Builder newBuilder(String name, String title) { + return new PasswordParam.Builder(name, title); + } + + public static class Builder extends PluginParams.Builder { + + public Builder(String name, String title) { + super(name, FormType.INPUT, title); + ParamsProps paramsProps = new ParamsProps(); + paramsProps.setPropsType(PropsType.PASSWORD); + this.props = paramsProps; + } + + public Builder setPlaceholder(String placeholder) { + this.props.setPlaceholder(placeholder); + return this; + } + + public Builder addValidate(Validate validate) { + if (this.validateList == null) { + this.validateList = new ArrayList<>(); + } + this.validateList.add(validate); + return this; + } + + public Builder setName(String name) { + this.name = name; + return this; + } + + public Builder setTitle(String title) { + this.title = title; + return this; + } + + public Builder setValue(Object value) { + this.value = value; + return this; + } + + public Builder setValidateList(List validateList) { + this.validateList = validateList; + return this; + } + + @Override + public PasswordParam build() { + return new PasswordParam(this); + } + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/PluginParamsTransfer.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/PluginParamsTransfer.java new file mode 100644 index 0000000000..53edb6aa34 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/PluginParamsTransfer.java @@ -0,0 +1,53 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params; + +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.utils.JSONUtils; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * plugin params pojo and json transfer tool + */ +public class PluginParamsTransfer { + + public static String transferParamsToJson(List list) { + return JSONUtils.toJsonString(list); + } + + public static List transferJsonToParamsList(String str) { + return JSONUtils.toList(str, PluginParams.class); + } + + /** + * return the plugin params map + * @param paramsJsonStr + * @return + */ + public static Map getPluginParamsMap(String paramsJsonStr) { + List pluginParams = transferJsonToParamsList(paramsJsonStr); + Map paramsMap = new HashMap<>(); + for (PluginParams param : pluginParams) { + paramsMap.put(param.getName(), param.getValue().toString()); + } + return paramsMap; + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/RadioParam.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/RadioParam.java new file mode 100644 index 0000000000..824c7fe6f3 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/RadioParam.java @@ -0,0 +1,106 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params; + +import org.apache.dolphinscheduler.spi.params.base.FormType; +import org.apache.dolphinscheduler.spi.params.base.ParamsOptions; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.Validate; + +import java.util.ArrayList; +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * radio + */ +public class RadioParam extends PluginParams { + + @JsonProperty("options") + private List paramsOptionsList; + + private RadioParam(Builder builder) { + super(builder); + this.paramsOptionsList = builder.paramsOptionsList; + } + + public static Builder newBuilder(String name, String title) { + return new RadioParam.Builder(name, title); + } + + public static class Builder extends PluginParams.Builder { + + private List paramsOptionsList; + + public Builder(String name, String title) { + super(name, FormType.RADIO, title); + } + + public Builder addValidate(Validate validate) { + if (this.validateList == null) { + this.validateList = new ArrayList<>(); + } + this.validateList.add(validate); + return this; + } + + public Builder setName(String name) { + this.name = name; + return this; + } + + public Builder setTitle(String title) { + this.title = title; + return this; + } + + public Builder setValue(Object value) { + this.value = value; + return this; + } + + public Builder setValidateList(List validateList) { + this.validateList = validateList; + return this; + } + + public Builder setParamsOptionsList(List paramsOptionsList) { + this.paramsOptionsList = paramsOptionsList; + return this; + } + + public Builder addParamsOptions(ParamsOptions paramsOptions) { + if (this.paramsOptionsList == null) { + this.paramsOptionsList = new ArrayList<>(); + } + + this.paramsOptionsList.add(paramsOptions); + return this; + } + + @Override + public RadioParam build() { + return new RadioParam(this); + } + } + + public List getParamsOptionsList() { + return paramsOptionsList; + } +} diff --git a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/PluginManager.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/DataType.java similarity index 72% rename from dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/PluginManager.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/DataType.java index f8078841e4..2b94ac1a73 100644 --- a/dolphinscheduler-common/src/main/java/org/apache/dolphinscheduler/common/plugin/PluginManager.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/DataType.java @@ -14,20 +14,26 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.common.plugin; -import org.apache.dolphinscheduler.plugin.api.AlertPlugin; - -import java.util.Map; +package org.apache.dolphinscheduler.spi.params.base; /** - * PluginManager + * param datetype */ -public interface PluginManager { +public enum DataType { + + STRING("string"), + + NUMBER("number"); + + private String dataType; - AlertPlugin findOne(String name); + DataType(String dataType) { + this.dataType = dataType; + } - Map findAll(); + public String getDataType() { + return this.dataType; + } - void addPlugin(AlertPlugin plugin); } diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/FormType.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/FormType.java new file mode 100644 index 0000000000..5d6234e753 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/FormType.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params.base; + +import com.fasterxml.jackson.annotation.JsonValue; + +public enum FormType { + + INPUT("input"), + + RADIO("radio"); + + private String formType; + + FormType(String formType) { + this.formType = formType; + } + + @JsonValue + public String getFormType() { + return this.formType; + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/ParamsOptions.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/ParamsOptions.java new file mode 100644 index 0000000000..6b3fc25eb1 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/ParamsOptions.java @@ -0,0 +1,72 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params.base; + +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * The options field in form-create`s json rule + * Set radio, select, checkbox and other component option options + */ +public class ParamsOptions { + + private String label; + + private Object value; + + /** + * is can be select + */ + private boolean disabled; + + public ParamsOptions(String label, Object value, boolean disabled) { + this.label = label; + this.value = value; + this.disabled = disabled; + } + + @JsonProperty("label") + public String getLabel() { + return label; + } + + public ParamsOptions setLabel(String label) { + this.label = label; + return this; + } + + @JsonProperty("value") + public Object getValue() { + return value; + } + + public ParamsOptions setValue(Object value) { + this.value = value; + return this; + } + + @JsonProperty("disabled") + public boolean isDisabled() { + return disabled; + } + + public ParamsOptions setDisabled(boolean disabled) { + this.disabled = disabled; + return this; + } +} diff --git a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/AlertInfo.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/ParamsProps.java similarity index 53% rename from dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/AlertInfo.java rename to dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/ParamsProps.java index 1d71ed7d8a..7854c613c3 100644 --- a/dolphinscheduler-plugin-api/src/main/java/org/apache/dolphinscheduler/plugin/model/AlertInfo.java +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/ParamsProps.java @@ -14,48 +14,48 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dolphinscheduler.plugin.model; -import java.util.HashMap; -import java.util.Map; +package org.apache.dolphinscheduler.spi.params.base; + +import com.fasterxml.jackson.annotation.JsonProperty; /** - * AlertInfo + * the props field in form-create`s json rule */ -public class AlertInfo { - - private Map alertProps; +public class ParamsProps { + private PropsType propsType; - private AlertData alertData; + private String placeholder; - public AlertInfo() { - this.alertProps = new HashMap<>(); - } + private int rows; - public Map getAlertProps() { - return alertProps; + @JsonProperty("type") + public PropsType getPropsType() { + return propsType; } - public AlertInfo setAlertProps(Map alertProps) { - this.alertProps = alertProps; + public ParamsProps setPropsType(PropsType propsType) { + this.propsType = propsType; return this; } - public AlertInfo addProp(String key, Object value) { - this.alertProps.put(key, value); - return this; + @JsonProperty("placeholder") + public String getPlaceholder() { + return placeholder; } - public Object getProp(String key) { - return this.alertProps.get(key); + public ParamsProps setPlaceholder(String placeholder) { + this.placeholder = placeholder; + return this; } - public AlertData getAlertData() { - return alertData; + @JsonProperty("rows") + public int getRows() { + return rows; } - public AlertInfo setAlertData(AlertData alertData) { - this.alertData = alertData; + public ParamsProps setRows(int rows) { + this.rows = rows; return this; } } diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/PluginParams.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/PluginParams.java new file mode 100644 index 0000000000..90a635a41f --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/PluginParams.java @@ -0,0 +1,155 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params.base; + +import static java.util.Objects.requireNonNull; + +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; + +/** + * plugin params + */ +@JsonDeserialize(builder = PluginParams.Builder.class) +public class PluginParams { + + /** + * param name + */ + @JsonProperty("field") + protected String name; + + @JsonProperty("props") + protected ParamsProps props; + + @JsonProperty("type") + protected String formType; + + /** + * Name displayed on the page + */ + @JsonProperty("title") + protected String title; + + /** + * default value or value input by user in the page + */ + @JsonProperty("value") + protected Object value; + + @JsonProperty("validate") + protected List validateList; + + protected PluginParams(Builder builder) { + + requireNonNull(builder, "builder is null"); + requireNonNull(builder.name, "name is null"); + requireNonNull(builder.formType, "formType is null"); + requireNonNull(builder.title, "title is null"); + + this.name = builder.name; + this.formType = builder.formType.getFormType(); + this.title = builder.title; + this.props = builder.props; + this.value = builder.value; + this.validateList = builder.validateList; + + } + + @JsonPOJOBuilder(buildMethodName = "build", withPrefix = "set") + public static class Builder { + //Must have + protected String name; + + protected FormType formType; + + protected String title; + + //option params + protected ParamsProps props; + + protected Object value; + + protected List validateList; + + public Builder(String name, + FormType formType, + String title) { + requireNonNull(name, "name is null"); + requireNonNull(formType, "formType is null"); + requireNonNull(title, "title is null"); + this.name = name; + this.formType = formType; + this.title = title; + } + + //for json deserialize to POJO + @JsonCreator + public Builder(@JsonProperty("field") String name, + @JsonProperty("type") FormType formType, + @JsonProperty("title") String title, + @JsonProperty("props") ParamsProps props, + @JsonProperty("value") Object value, + @JsonProperty("validate") List validateList + ) { + requireNonNull(name, "name is null"); + requireNonNull(formType, "formType is null"); + requireNonNull(title, "title is null"); + this.name = name; + this.formType = formType; + this.title = title; + this.props = props; + this.value = value; + this.validateList = validateList; + } + + public PluginParams build() { + return new PluginParams(this); + } + } + + public String getName() { + return name; + } + + public ParamsProps getProps() { + return props; + } + + public String getFormType() { + return formType; + } + + public String getTitle() { + return title; + } + + public Object getValue() { + return value; + } + + public List getValidateList() { + return validateList; + } +} + + diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/PropsType.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/PropsType.java new file mode 100644 index 0000000000..00e8770490 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/PropsType.java @@ -0,0 +1,37 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params.base; + +public enum PropsType { + + INPUT("input"), + + PASSWORD("password"), + + TEXTAREA("textarea"); + + private String propsType; + + PropsType(String propsType) { + this.propsType = propsType; + } + + public String getPropsType() { + return this.propsType; + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/TriggerType.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/TriggerType.java new file mode 100644 index 0000000000..ad964263fc --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/TriggerType.java @@ -0,0 +1,36 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params.base; + +public enum TriggerType { + + BLUR("blur"), + + CHANGE("change"); + + private String triggerType; + + TriggerType(String triggerType) { + this.triggerType = triggerType; + } + + public String getTriggerType() { + return this.triggerType; + } + +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/Validate.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/Validate.java new file mode 100644 index 0000000000..289f5b3f2e --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/params/base/Validate.java @@ -0,0 +1,137 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params.base; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder; + +/** + * form validate + */ +@JsonDeserialize(builder = Validate.Builder.class) +public class Validate { + + @JsonProperty("required") + private boolean required; + + @JsonProperty("message") + private String message; + + @JsonProperty("type") + private String type; + + @JsonProperty("trigger") + private String trigger; + + @JsonProperty("min") + private Double min; + + @JsonProperty("max") + private Double max; + + private Validate() { + + } + + private Validate(Builder builder) { + this.required = builder.required; + this.message = builder.message; + this.type = builder.type; + this.trigger = builder.trigger; + this.min = builder.min; + this.max = builder.max; + } + + public static Builder newBuilder() { + return new Validate.Builder(); + } + + @JsonPOJOBuilder(buildMethodName = "build", withPrefix = "set") + public static class Builder { + private boolean required = false; + + private String message; + + private String type = DataType.STRING.getDataType(); + + private String trigger = TriggerType.BLUR.getTriggerType(); + + private Double min; + + private Double max; + + public Builder setRequired(boolean required) { + this.required = required; + return this; + } + + public Builder setMessage(String message) { + this.message = message; + return this; + } + + public Builder setTrigger(String trigger) { + this.trigger = trigger; + return this; + } + + public Builder setMin(Double min) { + this.min = min; + return this; + } + + public Builder setMax(Double max) { + this.max = max; + return this; + } + + public Builder setType(String type) { + this.type = type; + return this; + } + + public Validate build() { + return new Validate(this); + } + } + + public boolean isRequired() { + return required; + } + + public String getMessage() { + return message; + } + + public String getType() { + return type; + } + + public String getTrigger() { + return trigger; + } + + public Double getMin() { + return min; + } + + public Double getMax() { + return max; + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/utils/JSONUtils.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/utils/JSONUtils.java new file mode 100644 index 0000000000..e48686e9f9 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/utils/JSONUtils.java @@ -0,0 +1,156 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.utils; + +import static com.fasterxml.jackson.databind.DeserializationFeature.ACCEPT_EMPTY_ARRAY_AS_NULL_OBJECT; +import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES; +import static com.fasterxml.jackson.databind.DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.TimeZone; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.ObjectWriter; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.fasterxml.jackson.databind.type.CollectionType; + +/** + * json utils + */ +public class JSONUtils { + + private static final Logger logger = LoggerFactory.getLogger(JSONUtils.class); + + /** + * can use static singleton, inject: just make sure to reuse! + */ + private static final ObjectMapper objectMapper = new ObjectMapper() + .configure(FAIL_ON_UNKNOWN_PROPERTIES, false) + .configure(ACCEPT_EMPTY_ARRAY_AS_NULL_OBJECT, true) + .configure(READ_UNKNOWN_ENUM_VALUES_AS_NULL, true) + .setTimeZone(TimeZone.getDefault()); + + private JSONUtils() { + } + + /** + * json representation of object + * + * @param object object + * @param feature feature + * @return object to json string + */ + public static String toJsonString(Object object, SerializationFeature feature) { + try { + ObjectWriter writer = objectMapper.writer(feature); + return writer.writeValueAsString(object); + } catch (Exception e) { + logger.error("object to json exception!", e); + } + + return null; + } + + /** + * This method deserializes the specified Json into an object of the specified class. It is not + * suitable to use if the specified class is a generic type since it will not have the generic + * type information because of the Type Erasure feature of Java. Therefore, this method should not + * be used if the desired type is a generic type. Note that this method works fine if the any of + * the fields of the specified object are generics, just the object itself should not be a + * generic type. + * + * @param json the string from which the object is to be deserialized + * @param clazz the class of T + * @param T + * @return an object of type T from the string + * classOfT + */ + public static T parseObject(String json, Class clazz) { + if (StringUtils.isEmpty(json)) { + return null; + } + + try { + return objectMapper.readValue(json, clazz); + } catch (Exception e) { + logger.error("parse object exception!", e); + } + return null; + } + + /** + * json to list + * + * @param json json string + * @param clazz class + * @param T + * @return list + */ + public static List toList(String json, Class clazz) { + if (StringUtils.isEmpty(json)) { + return Collections.emptyList(); + } + + try { + + CollectionType listType = objectMapper.getTypeFactory().constructCollectionType(ArrayList.class, clazz); + return objectMapper.readValue(json, listType); + } catch (Exception e) { + logger.error("parse list exception!", e); + } + + return Collections.emptyList(); + } + + /** + * object to json string + * + * @param object object + * @return json string + */ + public static String toJsonString(Object object) { + try { + return objectMapper.writeValueAsString(object); + } catch (Exception e) { + throw new RuntimeException("Object json deserialization exception.", e); + } + } + + public static ObjectNode parseObject(String text) { + try { + return (ObjectNode) objectMapper.readTree(text); + } catch (Exception e) { + throw new RuntimeException("String json deserialization exception.", e); + } + } + + public static ArrayNode parseArray(String text) { + try { + return (ArrayNode) objectMapper.readTree(text); + } catch (Exception e) { + throw new RuntimeException("Json deserialization exception.", e); + } + } +} diff --git a/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/utils/StringUtils.java b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/utils/StringUtils.java new file mode 100644 index 0000000000..fe0306b169 --- /dev/null +++ b/dolphinscheduler-spi/src/main/java/org/apache/dolphinscheduler/spi/utils/StringUtils.java @@ -0,0 +1,41 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.utils; + +public class StringUtils { + public static final String EMPTY = ""; + + public static boolean isEmpty(final CharSequence cs) { + return cs == null || cs.length() == 0; + } + + public static boolean isNotEmpty(final CharSequence cs) { + return !isEmpty(cs); + } + + public static boolean isBlank(String s) { + if (isEmpty(s)) { + return true; + } + return s.trim().length() == 0; + } + + public static boolean isNotBlank(String s) { + return !isBlank(s); + } +} diff --git a/dolphinscheduler-spi/src/test/java/org/apache/dolphinscheduler/spi/params/PluginParamsTransferTest.java b/dolphinscheduler-spi/src/test/java/org/apache/dolphinscheduler/spi/params/PluginParamsTransferTest.java new file mode 100644 index 0000000000..d9a238420a --- /dev/null +++ b/dolphinscheduler-spi/src/test/java/org/apache/dolphinscheduler/spi/params/PluginParamsTransferTest.java @@ -0,0 +1,202 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.dolphinscheduler.spi.params; + +import org.apache.dolphinscheduler.spi.params.base.DataType; +import org.apache.dolphinscheduler.spi.params.base.ParamsOptions; +import org.apache.dolphinscheduler.spi.params.base.PluginParams; +import org.apache.dolphinscheduler.spi.params.base.Validate; + +import java.util.ArrayList; +import java.util.List; + +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; + +/** + * PluginParamsTransfer Tester. + */ +public class PluginParamsTransferTest { + + @Before + public void before() throws Exception { + } + + @After + public void after() throws Exception { + } + + /** + * Method: getAlpacajsJson(List pluginParamsList) + */ + @Test + public void testGetParamsJson() throws Exception { + List paramsList = new ArrayList<>(); + InputParam receivesParam = InputParam.newBuilder("field1", "field1") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam receiveCcsParam = new InputParam.Builder("field2", "field2").build(); + + InputParam mailSmtpHost = new InputParam.Builder("field3", "field3") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam mailSmtpPort = new InputParam.Builder("field4", "field4") + .addValidate(Validate.newBuilder() + .setRequired(true) + .setType(DataType.NUMBER.getDataType()) + .build()) + .build(); + + InputParam mailSender = new InputParam.Builder("field5", "field5") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + RadioParam enableSmtpAuth = new RadioParam.Builder("field6", "field6") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .setValue(true) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam mailUser = new InputParam.Builder("field7", "field7") + .setPlaceholder("if enable use authentication, you need input user") + .build(); + + PasswordParam mailPassword = new PasswordParam.Builder("field8", "field8") + .setPlaceholder("if enable use authentication, you need input password") + .build(); + + RadioParam enableTls = new RadioParam.Builder("field9", "field9") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .setValue(false) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + RadioParam enableSsl = new RadioParam.Builder("field10", "field10") + .addParamsOptions(new ParamsOptions("YES", true, false)) + .addParamsOptions(new ParamsOptions("NO", false, false)) + .setValue(false) + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + InputParam sslTrust = new InputParam.Builder("field11", "field11") + .setValue("*") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + List emailShowTypeList = new ArrayList<>(); + emailShowTypeList.add(new ParamsOptions("table", "table", false)); + emailShowTypeList.add(new ParamsOptions("text", "text", false)); + emailShowTypeList.add(new ParamsOptions("attachment", "attachment", false)); + emailShowTypeList.add(new ParamsOptions("tableattachment", "tableattachment", false)); + RadioParam showType = new RadioParam.Builder("showType", "showType") + .setParamsOptionsList(emailShowTypeList) + .setValue("table") + .addValidate(Validate.newBuilder().setRequired(true).build()) + .build(); + + paramsList.add(receivesParam); + paramsList.add(receiveCcsParam); + paramsList.add(mailSmtpHost); + paramsList.add(mailSmtpPort); + paramsList.add(mailSender); + paramsList.add(enableSmtpAuth); + paramsList.add(mailUser); + paramsList.add(mailPassword); + paramsList.add(enableTls); + paramsList.add(enableSsl); + paramsList.add(sslTrust); + paramsList.add(showType); + + String paramsJson = PluginParamsTransfer.transferParamsToJson(paramsList); + System.out.println(paramsJson); + String paramsJsonAssert = "[{\"field\":\"field1\",\"props\":null,\"type\":\"input\",\"title\":\"field1\",\"value\":null,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]}" + + ",{\"field\":\"field2\",\"props\":null,\"type\":\"input\",\"title\":\"field2\",\"value\":null,\"validate\":null}," + + "{\"field\":\"field3\",\"props\":null,\"type\":\"input\",\"title\":\"field3\",\"value\":null,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]}," + + "{\"field\":\"field4\",\"props\":null,\"type\":\"input\",\"title\":\"field4\",\"value\":null,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"number\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]}," + + "{\"field\":\"field5\",\"props\":null,\"type\":\"input\",\"title\":\"field5\",\"value\":null,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]}," + + "{\"field\":\"field6\",\"props\":null,\"type\":\"radio\",\"title\":\"field6\",\"value\":true,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]," + + "\"options\":[{\"label\":\"YES\",\"value\":true,\"disabled\":false},{\"label\":\"NO\",\"value\":false,\"disabled\":false}]}," + + "{\"field\":\"field7\",\"props\":{\"type\":null,\"placeholder\":\"if enable use authentication, you need input user\",\"rows\":0}," + + "\"type\":\"input\",\"title\":\"field7\",\"value\":null,\"validate\":null}," + + "{\"field\":\"field8\",\"props\":{\"type\":\"PASSWORD\",\"placeholder\":\"if enable use authentication, you need input password\",\"rows\":0}," + + "\"type\":\"input\",\"title\":\"field8\",\"value\":null,\"validate\":null}," + + "{\"field\":\"field9\",\"props\":null,\"type\":\"radio\",\"title\":\"field9\",\"value\":false,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]," + + "\"options\":[{\"label\":\"YES\",\"value\":true,\"disabled\":false},{\"label\":\"NO\",\"value\":false,\"disabled\":false}]}," + + "{\"field\":\"field10\",\"props\":null,\"type\":\"radio\",\"title\":\"field10\",\"value\":false,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]," + + "\"options\":[{\"label\":\"YES\",\"value\":true,\"disabled\":false},{\"label\":\"NO\",\"value\":false,\"disabled\":false}]}," + + "{\"field\":\"field11\",\"props\":null,\"type\":\"input\",\"title\":\"field11\",\"value\":\"*\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}]}," + + "{\"field\":\"showType\",\"props\":null,\"type\":\"radio\",\"title\":\"showType\",\"value\":\"table\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":null,\"max\":null}],\"options\":[" + + "{\"label\":\"table\",\"value\":\"table\",\"disabled\":false},{\"label\":\"text\",\"value\":\"text\",\"disabled\":false}," + + "{\"label\":\"attachment\",\"value\":\"attachment\",\"disabled\":false},{\"label\":\"tableattachment\",\"value\":\"tableattachment\",\"disabled\":false}]}]"; + Assert.assertEquals(paramsJsonAssert, paramsJson); + } + + @Test + public void testGetPluginParams() { + String paramsJsonAssert = "[{\"field\":\"field1\",\"props\":null,\"type\":\"input\",\"title\":\"field1\",\"value\":\"v1\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}]}," + + "{\"field\":\"field2\",\"props\":null,\"type\":\"input\",\"title\":\"field2\",\"value\":\"v2\",\"validate\":null}," + + "{\"field\":\"field3\",\"props\":null,\"type\":\"input\",\"title\":\"field3\",\"value\":\"v3\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}]}," + + "{\"field\":\"field4\",\"props\":null,\"type\":\"input\",\"title\":\"field4\",\"value\":\"v4\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"number\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}]}," + + "{\"field\":\"field5\",\"props\":null,\"type\":\"input\",\"title\":\"field5\",\"value\":\"v5\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}]}," + + "{\"field\":\"field6\",\"props\":null,\"type\":\"radio\",\"title\":\"field6\",\"value\":true,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}],\"options\":[" + + "{\"label\":\"YES\",\"value\":true,\"disabled\":false},{\"label\":\"NO\",\"value\":false,\"disabled\":false}]}," + + "{\"field\":\"field7\",\"props\":{\"type\":null,\"placeholder\":\"if enable use authentication, you need input user\",\"rows\":0}," + + "\"type\":\"input\",\"title\":\"field7\",\"value\":\"v6\",\"validate\":null},{\"field\":\"field8\",\"props\":{" + + "\"type\":\"PASSWORD\",\"placeholder\":\"if enable use authentication, you need input password\",\"rows\":0}," + + "\"type\":\"input\",\"title\":\"field8\",\"value\":\"v7\",\"validate\":null},{\"field\":\"field9\"," + + "\"props\":null,\"type\":\"radio\",\"title\":\"field9\",\"value\":false,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}],\"options\":[" + + "{\"label\":\"YES\",\"value\":true,\"disabled\":false},{\"label\":\"NO\",\"value\":false,\"disabled\":false}]}," + + "{\"field\":\"field10\",\"props\":null,\"type\":\"radio\",\"title\":\"field10\",\"value\":false,\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}]," + + "\"options\":[{\"label\":\"YES\",\"value\":true,\"disabled\":false},{\"label\":\"NO\",\"value\":false,\"disabled\":false}]}," + + "{\"field\":\"field11\",\"props\":null,\"type\":\"input\",\"title\":\"field11\",\"value\":\"*\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}]}," + + "{\"field\":\"showType\",\"props\":null,\"type\":\"radio\",\"title\":\"showType\",\"value\":\"table\",\"validate\":[" + + "{\"required\":true,\"message\":null,\"type\":\"string\",\"trigger\":\"blur\",\"min\":0.0,\"max\":0.0}],\"options\":[" + + "{\"label\":\"table\",\"value\":\"table\",\"disabled\":false},{\"label\":\"text\",\"value\":\"text\",\"disabled\":false}," + + "{\"label\":\"attachment\",\"value\":\"attachment\",\"disabled\":false},{\"label\":\"tableattachment\",\"value\":\"tableattachment\",\"disabled\":false}]}]"; + List pluginParams = PluginParamsTransfer.transferJsonToParamsList(paramsJsonAssert); + String[] results = new String[]{"v1", "v2", "v3", "v4", "v5", "true", "v6", "v7", "false", "false", "*", "table", "v1"}; + Assert.assertEquals(12, pluginParams.size()); + for (int i = 0; i < pluginParams.size(); i++) { + PluginParams param = pluginParams.get(i); + Assert.assertEquals(param.getValue().toString(), results[i]); + } + } +} diff --git a/pom.xml b/pom.xml index 9e4934e833..c2cb96e27a 100644 --- a/pom.xml +++ b/pom.xml @@ -87,7 +87,7 @@ 3.17 3.1.0 4.1 - 20.0 + 24.1-jre 42.1.4 2.1.0 2.4 @@ -202,12 +202,12 @@ org.apache.dolphinscheduler - dolphinscheduler-plugin-api + dolphinscheduler-common ${project.version} org.apache.dolphinscheduler - dolphinscheduler-common + dolphinscheduler-alert-plugin ${project.version} @@ -235,6 +235,12 @@ dolphinscheduler-alert ${project.version} + + org.apache.dolphinscheduler + dolphinscheduler-spi + ${project.version} + + org.apache.curator curator-framework @@ -552,6 +558,40 @@ guava-retrying ${guava-retry.version} + + + org.sonatype.aether + aether-api + 1.13.1 + provided + + + + io.airlift.resolver + resolver + 1.5 + provided + + + + org.ow2.asm + asm + 6.2.1 + provided + + + + javax.activation + activation + 1.1 + + + + com.sun.mail + javax.mail + 1.6.2 + + @@ -562,7 +602,19 @@ + + org.apache.dolphinscheduler + dolphinscheduler-maven-plugin + 1.0.0 + true + + + ca.vanzyl.maven.plugins + provisio-maven-plugin + 1.0.4 + true + org.codehaus.mojo @@ -630,6 +682,22 @@ + + org.apache.dolphinscheduler + dolphinscheduler-maven-plugin + true + + + + + + + + + ca.vanzyl.maven.plugins + provisio-maven-plugin + true + org.apache.maven.plugins maven-source-plugin @@ -700,15 +768,6 @@ ${maven-surefire-plugin.version} - **/alert/utils/DingTalkUtilsTest.java - **/alert/template/AlertTemplateFactoryTest.java - **/alert/template/impl/DefaultHTMLTemplateTest.java - **/alert/utils/EnterpriseWeChatUtilsTest.java - **/alert/utils/ExcelUtilsTest.java - **/alert/utils/FuncUtilsTest.java - **/alert/utils/JSONUtilsTest.java - - **/alert/plugin/EmailAlertPluginTest.java **/api/controller/ProcessDefinitionControllerTest.java **/api/dto/resources/filter/ResourceFilterTest.java **/api/dto/resources/visitor/ResourceTreeVisitorTest.java @@ -877,6 +936,8 @@ **/dao/mapper/UDFUserMapperTest.java **/dao/mapper/UserAlertGroupMapperTest.java **/dao/mapper/UserMapperTest.java + **/dao/mapper/AlertPluginInstanceMapperTest.java + **/dao/mapper/PluginDefineTest.java **/dao/utils/DagHelperTest.java **/dao/AlertDaoTest.java **/dao/datasource/OracleDataSourceTest.java @@ -884,9 +945,18 @@ **/dao/upgrade/ProcessDefinitionDaoTest.java **/dao/upgrade/WokrerGrouopDaoTest.java **/dao/upgrade/UpgradeDaoTest.java - **/plugin/model/AlertDataTest.java - **/plugin/model/AlertInfoTest.java - **/plugin/utils/PropertyUtilsTest.java + **/plugin/alert/email/EmailAlertChannelFactoryTest.java + **/plugin/alert/email/EmailAlertChannelTest.java + **/plugin/alert/email/ExcelUtilsTest.java + **/plugin/alert/email/MailUtilsTest.java + **/plugin/alert/email/template/DefaultHTMLTemplateTest.java + **/spi/params/PluginParamsTransferTest.java + **/alert/plugin/EmailAlertPluginTest.java + **/alert/plugin/AlertPluginManagerTest.java + **/alert/plugin/DolphinPluginLoaderTest.java + **/alert/utils/DingTalkUtilsTest.java + **/alert/utils/EnterpriseWeChatUtilsTest.java + **/alert/utils/FuncUtilsTest.java @@ -939,6 +1009,9 @@ + **/alert/plugin/DolphinPluginClassLoader.java + **/alert/plugin/DolphinPluginDiscovery.java + **/alert/plugin/DolphinPluginLoader.java **/node_modules/** **/node/** **/dist/** @@ -956,6 +1029,7 @@ **/*.eslintrc **/.mvn/jvm.config **/.mvn/wrapper/** + **/*.iml true @@ -1036,6 +1110,7 @@ + dolphinscheduler-alert-plugin dolphinscheduler-ui dolphinscheduler-server dolphinscheduler-common @@ -1045,7 +1120,7 @@ dolphinscheduler-dist dolphinscheduler-remote dolphinscheduler-service - dolphinscheduler-plugin-api + dolphinscheduler-spi dolphinscheduler-microbench diff --git a/sql/dolphinscheduler-postgre.sql b/sql/dolphinscheduler-postgre.sql index e2f5ebd91f..2149b6c67c 100644 --- a/sql/dolphinscheduler-postgre.sql +++ b/sql/dolphinscheduler-postgre.sql @@ -794,4 +794,34 @@ INSERT INTO t_ds_relation_user_alertgroup(alertgroup_id,user_id,create_time,upda INSERT INTO t_ds_queue(queue_name,queue,create_time,update_time) VALUES ('default', 'default','2018-11-29 10:22:33', '2018-11-29 10:22:33'); -- Records of t_ds_queue,default queue name : default -INSERT INTO t_ds_version(version) VALUES ('1.3.0'); \ No newline at end of file +INSERT INTO t_ds_version(version) VALUES ('1.3.0'); + +-- +-- Table structure for table t_ds_plugin_define +-- +DROP TABLE IF EXISTS t_ds_plugin_define; +CREATE TABLE t_ds_plugin_define ( + id serial NOT NULL, + plugin_name varchar(100) NOT NULL, + plugin_type varchar(100) NOT NULL, + plugin_params text NULL, + create_time timestamp NULL, + update_time timestamp NULL, + CONSTRAINT t_ds_plugin_define_pk PRIMARY KEY (id), + CONSTRAINT t_ds_plugin_define_un UNIQUE (plugin_name, plugin_type) +); + +-- +-- Table structure for table t_ds_alert_plugin_instance +-- +DROP TABLE IF EXISTS t_ds_alert_plugin_instance; +CREATE TABLE t_ds_alert_plugin_instance ( + id serial NOT NULL, + plugin_define_id int4 NOT NULL, + plugin_instance_params text NULL, + create_time timestamp NULL, + update_time timestamp NULL, + alert_group_id int4 NOT NULL, + instance_name varchar(200) NULL, + CONSTRAINT t_ds_alert_plugin_instance_pk PRIMARY KEY (id) +); \ No newline at end of file diff --git a/sql/dolphinscheduler_mysql.sql b/sql/dolphinscheduler_mysql.sql index 9039a19084..7abdd39613 100644 --- a/sql/dolphinscheduler_mysql.sql +++ b/sql/dolphinscheduler_mysql.sql @@ -848,3 +848,34 @@ INSERT INTO `t_ds_relation_user_alertgroup` VALUES ('1', '1', '1', '2018-11-29 1 -- Records of t_ds_user -- ---------------------------- INSERT INTO `t_ds_user` VALUES ('1', 'admin', '7ad2410b2f4c074479a8937a28a22b8f', '0', 'xxx@qq.com', '', '0', '2018-03-27 15:48:50', '2018-10-24 17:40:22', null, 1); + +-- ---------------------------- +-- Table structure for t_ds_plugin_define +-- ---------------------------- +SET sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY','')); +DROP TABLE IF EXISTS `t_ds_plugin_define`; +CREATE TABLE `t_ds_plugin_define` ( + `id` int NOT NULL AUTO_INCREMENT, + `plugin_name` varchar(100) NOT NULL COMMENT 'the name of plugin eg: email', + `plugin_type` varchar(100) NOT NULL COMMENT 'plugin type . alert=alert plugin, job=job plugin', + `plugin_params` text COMMENT 'plugin params', + `create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, + `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + PRIMARY KEY (`id`), + UNIQUE KEY `t_ds_plugin_define_UN` (`plugin_name`,`plugin_type`) +) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8; + +-- ---------------------------- +-- Table structure for t_ds_alert_plugin_instance +-- ---------------------------- +DROP TABLE IF EXISTS `t_ds_alert_plugin_instance`; +CREATE TABLE `t_ds_alert_plugin_instance` ( + `id` int NOT NULL AUTO_INCREMENT, + `plugin_define_id` int NOT NULL, + `plugin_instance_params` text COMMENT 'plugin instance params. Also contain the params value which user input in web ui.', + `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP, + `update_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + `alert_group_id` int DEFAULT NULL, + `instance_name` varchar(200) DEFAULT NULL COMMENT 'alert instance name', + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; \ No newline at end of file diff --git a/sql/upgrade/1.4.0_schema/mysql/dolphinscheduler_ddl.sql b/sql/upgrade/1.4.0_schema/mysql/dolphinscheduler_ddl.sql new file mode 100644 index 0000000000..42e62fba17 --- /dev/null +++ b/sql/upgrade/1.4.0_schema/mysql/dolphinscheduler_ddl.sql @@ -0,0 +1,43 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. +*/ + +SET sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY','')); +DROP TABLE IF EXISTS `t_ds_plugin_define`; +CREATE TABLE `t_ds_plugin_define` ( + `id` int NOT NULL AUTO_INCREMENT, + `plugin_name` varchar(100) NOT NULL COMMENT 'the name of plugin eg: email', + `plugin_type` varchar(100) NOT NULL COMMENT 'plugin type . alert=alert plugin, job=job plugin', + `plugin_params` text COMMENT 'plugin params', + `create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, + `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + PRIMARY KEY (`id`), + UNIQUE KEY `t_ds_plugin_define_UN` (`plugin_name`,`plugin_type`) +) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8; + +DROP TABLE IF EXISTS `t_ds_alert_plugin_instance`; +CREATE TABLE `t_ds_alert_plugin_instance` ( + `id` int NOT NULL AUTO_INCREMENT, + `plugin_define_id` int NOT NULL, + `plugin_instance_params` text COMMENT 'plugin instance params. Also contain the params value which user input in web ui.', + `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP, + `update_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + `alert_group_id` int DEFAULT NULL, + `instance_name` varchar(200) DEFAULT NULL COMMENT 'alert instance name', + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; + + diff --git a/sql/upgrade/1.4.0_schema/mysql/dolphinscheduler_dml.sql b/sql/upgrade/1.4.0_schema/mysql/dolphinscheduler_dml.sql new file mode 100644 index 0000000000..57ed4d97e8 --- /dev/null +++ b/sql/upgrade/1.4.0_schema/mysql/dolphinscheduler_dml.sql @@ -0,0 +1,18 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. +*/ +SET sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY','')); +SET FOREIGN_KEY_CHECKS=0; diff --git a/sql/upgrade/1.4.0_schema/postgresql/dolphinscheduler_ddl.sql b/sql/upgrade/1.4.0_schema/postgresql/dolphinscheduler_ddl.sql new file mode 100644 index 0000000000..90de08ff8e --- /dev/null +++ b/sql/upgrade/1.4.0_schema/postgresql/dolphinscheduler_ddl.sql @@ -0,0 +1,40 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. +*/ +DROP TABLE IF EXISTS t_ds_plugin_define; +CREATE TABLE t_ds_plugin_define ( + id serial NOT NULL, + plugin_name varchar(100) NOT NULL, + plugin_type varchar(100) NOT NULL, + plugin_params text NULL, + create_time timestamp NULL, + update_time timestamp NULL, + CONSTRAINT t_ds_plugin_define_pk PRIMARY KEY (id), + CONSTRAINT t_ds_plugin_define_un UNIQUE (plugin_name, plugin_type) +); + + +DROP TABLE IF EXISTS t_ds_alert_plugin_instance; +CREATE TABLE t_ds_alert_plugin_instance ( + id serial NOT NULL, + plugin_define_id int4 NOT NULL, + plugin_instance_params text NULL, + create_time timestamp NULL, + update_time timestamp NULL, + alert_group_id int4 NOT NULL, + instance_name varchar(200) NULL, + CONSTRAINT t_ds_alert_plugin_instance_pk PRIMARY KEY (id) +); diff --git a/sql/upgrade/1.4.0_schema/postgresql/dolphinscheduler_dml.sql b/sql/upgrade/1.4.0_schema/postgresql/dolphinscheduler_dml.sql new file mode 100644 index 0000000000..4a14f326b9 --- /dev/null +++ b/sql/upgrade/1.4.0_schema/postgresql/dolphinscheduler_dml.sql @@ -0,0 +1,16 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. +*/ diff --git a/style/checkstyle.xml b/style/checkstyle.xml index d7283abafa..675d82133e 100644 --- a/style/checkstyle.xml +++ b/style/checkstyle.xml @@ -6,9 +6,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -197,7 +195,7 @@ @@ -284,4 +282,4 @@ - + \ No newline at end of file diff --git a/style/intellij-java-code-style.xml b/style/intellij-java-code-style.xml index 42286025b0..80dc27d5f4 100644 --- a/style/intellij-java-code-style.xml +++ b/style/intellij-java-code-style.xml @@ -6,9 +6,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. diff --git a/tools/dependencies/known-dependencies.txt b/tools/dependencies/known-dependencies.txt index 4a7f1662f0..9cb67dd505 100755 --- a/tools/dependencies/known-dependencies.txt +++ b/tools/dependencies/known-dependencies.txt @@ -1,5 +1,5 @@ HikariCP-3.2.0.jar -activation-1.1.jar +animal-sniffer-annotations-1.14.jar ant-1.6.5.jar aopalliance-1.0.jar apache-el-8.5.35.1.jar @@ -14,6 +14,7 @@ avro-1.7.4.jar aws-java-sdk-1.7.4.jar bonecp-0.8.0.RELEASE.jar byte-buddy-1.9.10.jar +checker-compat-qual-2.0.0.jar classmate-1.4.0.jar clickhouse-jdbc-0.1.52.jar commons-cli-1.2.jar @@ -26,7 +27,6 @@ commons-configuration-1.10.jar commons-daemon-1.0.13.jar commons-beanutils-1.7.0.jar commons-dbcp-1.4.jar -commons-email-1.5.jar commons-httpclient-3.0.1.jar commons-io-2.4.jar commons-lang-2.6.jar @@ -43,9 +43,11 @@ datanucleus-api-jdo-4.2.1.jar datanucleus-core-4.1.6.jar datanucleus-rdbms-4.1.7.jar derby-10.14.2.0.jar +error_prone_annotations-2.1.3.jar druid-1.1.22.jar gson-2.8.5.jar -guava-20.0.jar +guava-24.1-jre.jar +guava-retrying-2.0.0.jar guice-3.0.jar guice-servlet-3.0.jar h2-1.4.200.jar @@ -78,6 +80,7 @@ htrace-core-3.1.0-incubating.jar httpclient-4.4.1.jar httpcore-4.4.1.jar httpmime-4.5.7.jar +j2objc-annotations-1.1.jar jackson-annotations-2.9.8.jar jackson-core-2.9.8.jar jackson-core-asl-1.9.13.jar @@ -95,7 +98,6 @@ javax.activation-api-1.2.0.jar javax.annotation-api-1.3.2.jar javax.inject-1.jar javax.jdo-3.2.0-m3.jar -javax.mail-1.6.2.jar javax.servlet-api-3.1.0.jar javolution-5.5.1.jar jaxb-api-2.3.1.jar @@ -162,6 +164,7 @@ paranamer-2.3.jar parquet-hadoop-bundle-1.8.1.jar poi-3.17.jar postgresql-42.1.4.jar +presto-jdbc-0.238.1.jar protobuf-java-2.5.0.jar quartz-2.2.3.jar quartz-jobs-2.2.3.jar @@ -208,6 +211,4 @@ xercesImpl-2.9.1.jar xml-apis-1.4.01.jar xmlenc-0.52.jar xz-1.0.jar -zookeeper-3.4.14.jar -guava-retrying-2.0.0.jar -presto-jdbc-0.238.1.jar \ No newline at end of file +zookeeper-3.4.14.jar \ No newline at end of file