Browse Source
* refactor Alert Template * refactor alert template(remove freemarker) * add license * update abstract class to interface * make test into root pom * fix powermock static * fix powermock static * remove custom exception * remove custom exceptionpull/2/head
DK.Pino
5 years ago
committed by
qiaozhanwei
12 changed files with 484 additions and 185 deletions
@ -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.alert.template; |
||||
|
||||
import org.apache.dolphinscheduler.common.enums.ShowType; |
||||
|
||||
/** |
||||
* alert message template |
||||
*/ |
||||
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 |
||||
* @return a message from a specified alert template |
||||
*/ |
||||
String getMessageFromTemplate(String content, ShowType showType,boolean showAll); |
||||
|
||||
/** |
||||
* default showAll is true |
||||
*/ |
||||
default String getMessageFromTemplate(String content,ShowType showType){ |
||||
return getMessageFromTemplate(content,showType,true); |
||||
} |
||||
} |
||||
@ -0,0 +1,54 @@
|
||||
/* |
||||
* 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.apache.dolphinscheduler.common.utils.StringUtils; |
||||
import org.slf4j.Logger; |
||||
import org.slf4j.LoggerFactory; |
||||
|
||||
/** |
||||
* the alert template factory |
||||
*/ |
||||
public class AlertTemplateFactory { |
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(AlertTemplateFactory.class); |
||||
|
||||
private static final String alertTemplate = PropertyUtils.getString(Constants.ALERT_TEMPLATE); |
||||
|
||||
private AlertTemplateFactory(){} |
||||
|
||||
/** |
||||
* get a template from alert.properties conf file |
||||
* @return a template, default is DefaultHTMLTemplate |
||||
*/ |
||||
public static AlertTemplate getMessageTemplate() { |
||||
|
||||
if(StringUtils.isEmpty(alertTemplate)){ |
||||
return new DefaultHTMLTemplate(); |
||||
} |
||||
|
||||
switch (alertTemplate){ |
||||
case "html": |
||||
return new DefaultHTMLTemplate(); |
||||
default: |
||||
throw new IllegalArgumentException(String.format("not support alert template: %s",alertTemplate)); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,161 @@
|
||||
/* |
||||
* 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.alert.template.AlertTemplate; |
||||
import org.apache.dolphinscheduler.alert.utils.Constants; |
||||
import org.apache.dolphinscheduler.alert.utils.JSONUtils; |
||||
import org.apache.dolphinscheduler.alert.utils.MailUtils; |
||||
import org.apache.dolphinscheduler.common.enums.ShowType; |
||||
import org.apache.dolphinscheduler.common.utils.StringUtils; |
||||
import org.slf4j.Logger; |
||||
import org.slf4j.LoggerFactory; |
||||
|
||||
import java.util.*; |
||||
|
||||
import static org.apache.dolphinscheduler.common.utils.Preconditions.*; |
||||
|
||||
/** |
||||
* the default html alert message template |
||||
*/ |
||||
public class DefaultHTMLTemplate implements AlertTemplate { |
||||
|
||||
public static final Logger logger = LoggerFactory.getLogger(DefaultHTMLTemplate.class); |
||||
|
||||
@Override |
||||
public String getMessageFromTemplate(String content, ShowType showType,boolean showAll) { |
||||
|
||||
switch (showType){ |
||||
case TABLE: |
||||
return getTableTypeMessage(content,showAll); |
||||
case TEXT: |
||||
return getTextTypeMessage(content,showAll); |
||||
default: |
||||
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){ |
||||
|
||||
if (StringUtils.isNotEmpty(content)){ |
||||
List<LinkedHashMap> mapItemsList = JSONUtils.toList(content, LinkedHashMap.class); |
||||
|
||||
if(!showAll && mapItemsList.size() > Constants.NUMBER_1000){ |
||||
mapItemsList = mapItemsList.subList(0,Constants.NUMBER_1000); |
||||
} |
||||
|
||||
StringBuilder contents = new StringBuilder(200); |
||||
|
||||
boolean flag = true; |
||||
|
||||
String title = ""; |
||||
for (LinkedHashMap mapItems : mapItemsList){ |
||||
|
||||
Set<Map.Entry<String, Object>> entries = mapItems.entrySet(); |
||||
|
||||
Iterator<Map.Entry<String, Object>> iterator = entries.iterator(); |
||||
|
||||
StringBuilder t = new StringBuilder(Constants.TR); |
||||
StringBuilder cs = new StringBuilder(Constants.TR); |
||||
while (iterator.hasNext()){ |
||||
|
||||
Map.Entry<String, Object> 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(Constants.TR_END); |
||||
cs.append(Constants.TR_END); |
||||
if (flag){ |
||||
title = t.toString(); |
||||
} |
||||
flag = false; |
||||
contents.append(cs); |
||||
} |
||||
|
||||
return getMessageFromHtmlTemplate(title,contents.toString()); |
||||
} |
||||
|
||||
return content; |
||||
} |
||||
|
||||
/** |
||||
* 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){ |
||||
|
||||
if (StringUtils.isNotEmpty(content)){ |
||||
List<String> list; |
||||
try { |
||||
list = JSONUtils.toList(content,String.class); |
||||
}catch (Exception e){ |
||||
logger.error("json format exception",e); |
||||
return null; |
||||
} |
||||
|
||||
StringBuilder contents = new StringBuilder(100); |
||||
for (String str : list){ |
||||
contents.append(Constants.TR); |
||||
contents.append(Constants.TD).append(str).append(Constants.TD_END); |
||||
contents.append(Constants.TR_END); |
||||
} |
||||
|
||||
return getMessageFromHtmlTemplate(null,contents.toString()); |
||||
|
||||
} |
||||
|
||||
return content; |
||||
} |
||||
|
||||
/** |
||||
* get alert message from a html template |
||||
* @param title message title |
||||
* @param content message content |
||||
* @return alert message which use html template |
||||
*/ |
||||
private String getMessageFromHtmlTemplate(String title,String content){ |
||||
|
||||
checkNotNull(content); |
||||
String htmlTableThead = StringUtils.isEmpty(title) ? "" : String.format("<thead>%s</thead>\n",title); |
||||
|
||||
return "<html>\n" + |
||||
" <head>\n" + |
||||
" <title>dolphinscheduler</title>\n" + |
||||
" <meta name='Keywords' content=''>\n" + |
||||
" <meta name='Description' content=''>\n" + |
||||
" <style type=\"text/css\">\n" + |
||||
" table {margin-top:0px;padding-top:0px;border:1px solid;font-size: 14px;color: #333333;border-width: 1px;border-color: #666666;border-collapse: collapse;}\n" + |
||||
" table th {border-width: 1px;padding: 8px;border-style: solid;border-color: #666666;background-color: #dedede;text-align: right;}\n" + |
||||
" table td {border-width: 1px;padding: 8px;border-style: solid;border-color: #666666;background-color: #ffffff;text-align: right;}\n" + |
||||
" </style>\n" + |
||||
" </head>\n" + |
||||
" <body style=\"margin:0;padding:0\">\n" + |
||||
" <table border=\"1px\" cellpadding=\"5px\" cellspacing=\"-10px\">\n" + htmlTableThead + content + |
||||
" </table>\n" + |
||||
" </body>\n" + |
||||
"</html>"; |
||||
} |
||||
} |
||||
@ -1,17 +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. |
||||
--> |
||||
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'><html><head><title> dolphinscheduler</title><meta name='Keywords' content=''><meta name='Description' content=''><style type="text/css">table { margin-top:0px; padding-top:0px; border:1px solid; font-size: 14px; color: #333333; border-width: 1px; border-color: #666666; border-collapse: collapse; } table th { border-width: 1px; padding: 8px; border-style: solid; border-color: #666666; background-color: #dedede; text-align: right;} table td { border-width: 1px; padding: 8px; border-style: solid; border-color: #666666; background-color: #ffffff; text-align: right;}</style></head><body style="margin:0;padding:0"><table border="1px" cellpadding="5px" cellspacing="-10px"><thead><#if title??> ${title}</#if></thead><#if content??> ${content}</#if></table></body></html> |
||||
@ -0,0 +1,66 @@
|
||||
/* |
||||
* 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); |
||||
when(PropertyUtils.getString(Constants.ALERT_TEMPLATE)).thenReturn("html"); |
||||
|
||||
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); |
||||
} |
||||
} |
||||
@ -0,0 +1,123 @@
|
||||
/* |
||||
* 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.alert.utils.JSONUtils; |
||||
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<String, Object> 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<String, Object> 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<LinkedHashMap<String, Object>> 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 "<html>\n" + |
||||
" <head>\n" + |
||||
" <title>dolphinscheduler</title>\n" + |
||||
" <meta name='Keywords' content=''>\n" + |
||||
" <meta name='Description' content=''>\n" + |
||||
" <style type=\"text/css\">\n" + |
||||
" table {margin-top:0px;padding-top:0px;border:1px solid;font-size: 14px;color: #333333;border-width: 1px;border-color: #666666;border-collapse: collapse;}\n" + |
||||
" table th {border-width: 1px;padding: 8px;border-style: solid;border-color: #666666;background-color: #dedede;text-align: right;}\n" + |
||||
" table td {border-width: 1px;padding: 8px;border-style: solid;border-color: #666666;background-color: #ffffff;text-align: right;}\n" + |
||||
" </style>\n" + |
||||
" </head>\n" + |
||||
" <body style=\"margin:0;padding:0\">\n" + |
||||
" <table border=\"1px\" cellpadding=\"5px\" cellspacing=\"-10px\">\n" + |
||||
"<thead><tr><th>mysql service name</th><th>mysql address</th><th>port</th><th>no index of number</th><th>database client connections</th></tr></thead>\n" + |
||||
"<tr><td>mysql200</td><td>192.168.xx.xx</td><td>3306</td><td>80</td><td>190</td></tr><tr><td>mysql210</td><td>192.168.xx.xx</td><td>3306</td><td>10</td><td>90</td></tr> </table>\n" + |
||||
" </body>\n" + |
||||
"</html>"; |
||||
} |
||||
|
||||
private String generateMockTextTypeResultByHand(){ |
||||
|
||||
return "<html>\n" + |
||||
" <head>\n" + |
||||
" <title>dolphinscheduler</title>\n" + |
||||
" <meta name='Keywords' content=''>\n" + |
||||
" <meta name='Description' content=''>\n" + |
||||
" <style type=\"text/css\">\n" + |
||||
" table {margin-top:0px;padding-top:0px;border:1px solid;font-size: 14px;color: #333333;border-width: 1px;border-color: #666666;border-collapse: collapse;}\n" + |
||||
" table th {border-width: 1px;padding: 8px;border-style: solid;border-color: #666666;background-color: #dedede;text-align: right;}\n" + |
||||
" table td {border-width: 1px;padding: 8px;border-style: solid;border-color: #666666;background-color: #ffffff;text-align: right;}\n" + |
||||
" </style>\n" + |
||||
" </head>\n" + |
||||
" <body style=\"margin:0;padding:0\">\n" + |
||||
" <table border=\"1px\" cellpadding=\"5px\" cellspacing=\"-10px\">\n" + |
||||
"<tr><td>{\"mysql service name\":\"mysql200\",\"mysql address\":\"192.168.xx.xx\",\"database client connections\":\"190\",\"port\":\"3306\",\"no index of number\":\"80\"}</td></tr><tr><td>{\"mysql service name\":\"mysql210\",\"mysql address\":\"192.168.xx.xx\",\"database client connections\":\"90\",\"port\":\"3306\",\"no index of number\":\"10\"}</td></tr> </table>\n" + |
||||
" </body>\n" + |
||||
"</html>"; |
||||
} |
||||
} |
||||
Loading…
Reference in new issue