Browse Source
* Create TextMessage.java * Create DingTalkUtils.java * Update alert.properties * Update Constants.java * Update Constants.java * Create DingTalkMsgFormatter.java * Update alert.properties * Create DingTalkMsgFormatterTest.java * Create DingTalkUtilsTest.java * Update DingTalkUtils.java * Create DingTalkManager.java * Update EmailAlertPlugin.java * feature: test send msg with proxy * fix:delete comment and add exception info * Update DingTalkUtilsTest.java * Update DingTalkUtils.java * Update DingTalkManager.java * Update EmailAlertPlugin.java * Update DingTalkUtilsTest.java * Update DingTalkMsgFormatter.java * Update DingTalkUtils.java * Update DingTalkMsgFormatterTest.java * Update DingTalkUtilsTest.java * Update TextMessage.java * Update DingTalkManager.java * Delete TextMessage.java * fix: add test case * fix:add http client test case * fix:delete ignore test case * Update pom.xml Co-authored-by: dailidong <dailidong66@gmail.com>pull/2/head
xiaozhaoying
5 years ago
committed by
GitHub
7 changed files with 352 additions and 0 deletions
@ -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.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 java.io.IOException; |
||||||
|
import java.util.HashMap; |
||||||
|
import java.util.Map; |
||||||
|
|
||||||
|
/** |
||||||
|
* Ding Talk Manager |
||||||
|
*/ |
||||||
|
public class DingTalkManager { |
||||||
|
private static final Logger logger = LoggerFactory.getLogger(EnterpriseWeChatManager.class); |
||||||
|
|
||||||
|
public Map<String,Object> send(AlertInfo alert) { |
||||||
|
Map<String,Object> 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); |
||||||
|
} |
||||||
|
retMap.put(Constants.STATUS, true); |
||||||
|
return retMap; |
||||||
|
} |
||||||
|
|
||||||
|
private String buildMessage(AlertInfo alert) { |
||||||
|
String msg = alert.getAlertData().getContent(); |
||||||
|
return msg; |
||||||
|
} |
||||||
|
} |
||||||
@ -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.alert.utils; |
||||||
|
|
||||||
|
|
||||||
|
import com.alibaba.fastjson.JSON; |
||||||
|
import org.apache.commons.codec.binary.StringUtils; |
||||||
|
import org.apache.http.HttpEntity; |
||||||
|
import org.apache.http.HttpHost; |
||||||
|
import org.apache.http.auth.AuthScope; |
||||||
|
import org.apache.http.auth.UsernamePasswordCredentials; |
||||||
|
import org.apache.http.client.CredentialsProvider; |
||||||
|
import org.apache.http.client.config.RequestConfig; |
||||||
|
import org.apache.http.client.methods.CloseableHttpResponse; |
||||||
|
import org.apache.http.client.methods.HttpPost; |
||||||
|
import org.apache.http.entity.StringEntity; |
||||||
|
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; |
||||||
|
|
||||||
|
/** |
||||||
|
* DingTalkUtils utils |
||||||
|
* support send msg to ding talk by robot message push function. |
||||||
|
* support proxy setting |
||||||
|
*/ |
||||||
|
public class DingTalkUtils { |
||||||
|
public static final Logger logger = LoggerFactory.getLogger(DingTalkUtils.class); |
||||||
|
|
||||||
|
public static final boolean isEnableDingTalk = PropertyUtils.getBoolean(Constants.DINGTALK_ENABLE); |
||||||
|
private static final String dingTaskUrl = PropertyUtils.getString(Constants.DINGTALK_WEBHOOK); |
||||||
|
private static final String keyword = PropertyUtils.getString(Constants.DINGTALK_KEYWORD); |
||||||
|
private static final Boolean isEnableProxy = PropertyUtils.getBoolean(Constants.DINGTALK_PROXY_ENABLE); |
||||||
|
private static final String proxy = PropertyUtils.getString(Constants.DINGTALK_PROXY); |
||||||
|
private static final String user = PropertyUtils.getString(Constants.DINGTALK_USER); |
||||||
|
private static final String passwd = PropertyUtils.getString(Constants.DINGTALK_PASSWORD); |
||||||
|
private static final Integer port = PropertyUtils.getInt(Constants.DINGTALK_PORT); |
||||||
|
|
||||||
|
/** |
||||||
|
* send message interface
|
||||||
|
* only support text message format now. |
||||||
|
* @param msg message context to send |
||||||
|
* @param charset charset type |
||||||
|
* @return result of sending msg |
||||||
|
* @throws IOException the IOException |
||||||
|
*/ |
||||||
|
public static String sendDingTalkMsg(String msg, String charset) throws IOException { |
||||||
|
String msgToJson = textToJsonString(msg + "#" + keyword); |
||||||
|
HttpPost httpPost = constructHttpPost(msgToJson, charset); |
||||||
|
|
||||||
|
CloseableHttpClient httpClient; |
||||||
|
if (isEnableProxy) { |
||||||
|
httpClient = getProxyClient(); |
||||||
|
RequestConfig rcf = getProxyConfig(); |
||||||
|
httpPost.setConfig(rcf); |
||||||
|
} else { |
||||||
|
httpClient = getDefaultClient(); |
||||||
|
} |
||||||
|
|
||||||
|
try { |
||||||
|
CloseableHttpResponse response = httpClient.execute(httpPost); |
||||||
|
String resp; |
||||||
|
try { |
||||||
|
HttpEntity entity = response.getEntity(); |
||||||
|
resp = EntityUtils.toString(entity, charset); |
||||||
|
EntityUtils.consume(entity); |
||||||
|
} finally { |
||||||
|
response.close(); |
||||||
|
} |
||||||
|
logger.info("Ding Talk send [{}], resp:{%s}", msg, resp); |
||||||
|
return resp; |
||||||
|
} finally { |
||||||
|
httpClient.close(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
public static HttpPost constructHttpPost(String msg, String charset) { |
||||||
|
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(); |
||||||
|
provider.setCredentials(new AuthScope(httpProxy), new UsernamePasswordCredentials(user, passwd)); |
||||||
|
CloseableHttpClient httpClient = HttpClients.custom().setDefaultCredentialsProvider(provider).build(); |
||||||
|
return httpClient; |
||||||
|
} |
||||||
|
|
||||||
|
public static CloseableHttpClient getDefaultClient() { |
||||||
|
return HttpClients.createDefault(); |
||||||
|
} |
||||||
|
|
||||||
|
public static RequestConfig getProxyConfig() { |
||||||
|
HttpHost httpProxy = new HttpHost(proxy, port); |
||||||
|
return RequestConfig.custom().setProxy(httpProxy).build(); |
||||||
|
} |
||||||
|
|
||||||
|
public static String textToJsonString(String text) { |
||||||
|
Map<String, Object> items = new HashMap<String, Object>(); |
||||||
|
items.put("msgtype", "text"); |
||||||
|
Map<String, String> textContent = new HashMap<String, String>(); |
||||||
|
byte[] byt = StringUtils.getBytesUtf8(text); |
||||||
|
String txt = StringUtils.newStringUtf8(byt); |
||||||
|
textContent.put("content", txt); |
||||||
|
items.put("text", textContent); |
||||||
|
|
||||||
|
return JSON.toJSONString(items); |
||||||
|
|
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
@ -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.alert.utils; |
||||||
|
|
||||||
|
import com.alibaba.fastjson.JSON; |
||||||
|
import org.apache.http.client.config.RequestConfig; |
||||||
|
import org.apache.http.client.methods.HttpPost; |
||||||
|
import org.apache.http.impl.client.CloseableHttpClient; |
||||||
|
import org.junit.Assert; |
||||||
|
import org.junit.Before; |
||||||
|
import org.junit.Ignore; |
||||||
|
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.PowerMockIgnore; |
||||||
|
import org.powermock.core.classloader.annotations.PrepareForTest; |
||||||
|
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.*") |
||||||
|
public class DingTalkUtilsTest { |
||||||
|
Logger logger = LoggerFactory.getLogger(DingTalkUtilsTest.class); |
||||||
|
|
||||||
|
private static final String mockUrl = "https://oapi.dingtalk.com/robot/send?access_token=test"; |
||||||
|
private static final String mockKeyWords = "onway"; |
||||||
|
private static final String msg = "ding talk test"; |
||||||
|
|
||||||
|
@Before |
||||||
|
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); |
||||||
|
Mockito.when(PropertyUtils.getBoolean(Constants.DINGTALK_PROXY_ENABLE)).thenReturn(true); |
||||||
|
Mockito.when(PropertyUtils.getString(Constants.DINGTALK_PROXY)).thenReturn("proxy.com.cn"); |
||||||
|
Mockito.when(PropertyUtils.getString(Constants.DINGTALK_USER)).thenReturn("user"); |
||||||
|
Mockito.when(PropertyUtils.getString(Constants.DINGTALK_PASSWORD)).thenReturn("pswd"); |
||||||
|
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 = JSON.parseObject(rsp).getString("errmsg");
|
||||||
|
// Assert.assertEquals("ok", errmsg);
|
||||||
|
// } catch (Exception e) {
|
||||||
|
// e.printStackTrace();
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
|
||||||
|
@Test |
||||||
|
public void testCreateDefaultClient() { |
||||||
|
CloseableHttpClient client = DingTalkUtils.getDefaultClient();; |
||||||
|
try { |
||||||
|
Assert.assertNotNull(client); |
||||||
|
client.close(); |
||||||
|
} catch (IOException ex) { |
||||||
|
logger.info("close exception",ex.getMessage()); |
||||||
|
new Throwable(); |
||||||
|
} |
||||||
|
} |
||||||
|
@Test |
||||||
|
public void testCreateProxyClient() { |
||||||
|
CloseableHttpClient client = DingTalkUtils.getProxyClient(); |
||||||
|
try { |
||||||
|
Assert.assertNotNull(client); |
||||||
|
client.close(); |
||||||
|
} catch (IOException ex) { |
||||||
|
logger.info("close exception",ex.getMessage()); |
||||||
|
new Throwable(); |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
|
@Test |
||||||
|
public void testProxyConfig() { |
||||||
|
RequestConfig rc = DingTalkUtils.getProxyConfig(); |
||||||
|
Assert.assertEquals(rc.getProxy().getPort(), 80); |
||||||
|
Assert.assertEquals(rc.getProxy().getHostName(), "proxy.com.cn"); |
||||||
|
} |
||||||
|
|
||||||
|
@Test |
||||||
|
public void testDingTalkMsgToJson() { |
||||||
|
String jsonString = DingTalkUtils.textToJsonString("this is test"); |
||||||
|
|
||||||
|
logger.info(jsonString); |
||||||
|
String expect = "{\"text\":{\"content\":\"this is test\"},\"msgtype\":\"text\"}"; |
||||||
|
Assert.assertEquals(expect, jsonString); |
||||||
|
} |
||||||
|
@Test |
||||||
|
public void testDingTalkMsgUtf8() { |
||||||
|
String msg = DingTalkUtils.textToJsonString("this is test:中文"); |
||||||
|
|
||||||
|
logger.info("test support utf8, actual:" + msg); |
||||||
|
logger.info("test support utf8, actual:" + DingTalkUtils.isEnableDingTalk); |
||||||
|
String expect = "{\"text\":{\"content\":\"this is test:中文\"},\"msgtype\":\"text\"}"; |
||||||
|
Assert.assertEquals(expect, msg); |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
Loading…
Reference in new issue