Merge pull request jertel#1369 from bitqiu/master

add workwechat msgtype

CHANGELOG.md

@@ -7,7 +7,7 @@
 - None
 
 ## Other changes
-- None
+- [workwechat] add workwechat msgtype - [#1369](https://github.com/jertel/elastalert2/pull/1369) - @bitqiu
 
 # 2.17.0
 

docs/source/alerts.rst

@@ -2281,12 +2281,14 @@ WorkWechat alerter will send notification to a predefined bot in WorkWechat appl
 Required:
 
 ``work_wechat_bot_id``:  WorkWechat bot id.
+``work_wechat_msgtype``:  WorkWechat msgtype. default to ``text``. ``markdown``
 
 Example usage::
 
     alert:
       - "workwechat"
     work_wechat_bot_id: "your workwechat bot id"
+    work_wechat_msgtype: "text"
 
 Zabbix
 ~~~~~~

elastalert/alerters/workwechat.py

@@ -15,8 +15,7 @@ def __init__(self, rule):
         super(WorkWechatAlerter, self).__init__(rule)
         self.work_wechat_bot_id = self.rule.get('work_wechat_bot_id', None)
         self.work_wechat_webhook_url = f'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key={self.work_wechat_bot_id}'
-        self.work_wechat_msg_type = 'text'
-
+        self.work_wechat_msgtype = self.rule.get('work_wechat_msgtype', 'text')
     def alert(self, matches):
         title = self.create_title(matches)
         body = self.create_alert_body(matches)
@@ -26,12 +25,22 @@ def alert(self, matches):
             'Accept': 'application/json;charset=utf-8'
         }
 
-        payload = {
-            'msgtype': self.work_wechat_msg_type,
-            "text": {
-                "content": body
-            },
-        }
+        if self.work_wechat_msgtype == 'text':
+            # text
+            payload = {
+                'msgtype': self.work_wechat_msgtype,
+                'text': {
+                    'content': body
+                }
+            }
+        if self.work_wechat_msgtype == 'markdown':
+            # markdown
+            payload = {
+                'msgtype': self.work_wechat_msgtype,
+                'markdown': {
+                    'content': body
+                }
+            }
 
         try:
             response = requests.post(

elastalert/schema.yaml

@@ -795,6 +795,7 @@ properties:
 
   ### WorkWechat
   work_wechat_bot_id: { type: string }
+  work_wechat_msgtype: { type: string }
 
   ### Zabbix
   zbx_sender_host: {type: string}

tests/alerters/workwechat_test.py

@@ -16,6 +16,7 @@ def test_work_wechat_text(caplog):
         'name': 'Test WorkWechat Rule',
         'type': 'any',
         'work_wechat_bot_id': 'xxxxxxx',
+        'work_wechat_msgtype': 'text',
         'alert': [],
     }
     rules_loader = FileRulesLoader({})
@@ -55,6 +56,7 @@ def test_work_wechat_ea_exception():
             'name': 'Test WorkWechat Rule',
             'type': 'any',
             'work_wechat_bot_id': 'xxxxxxx',
+            'work_wechat_msgtype': 'text',
             'alert': [],
         }
         rules_loader = FileRulesLoader({})
@@ -75,6 +77,7 @@ def test_work_wechat_getinfo():
         'name': 'Test WorkWechat Rule',
         'type': 'any',
         'work_wechat_bot_id': 'xxxxxxx',
+        'work_wechat_msgtype': 'text',
         'alert': [],
     }
     rules_loader = FileRulesLoader({})
@@ -89,15 +92,15 @@ def test_work_wechat_getinfo():
     assert expected_data == actual_data
 
 
-@pytest.mark.parametrize('work_wechat_bot_id, expected_data', [
-    ('', 'Missing required option(s): work_wechat_bot_id'),
-    ('xxxxxxx',
+@pytest.mark.parametrize('work_wechat_bot_id, work_wechat_msgtype, expected_data', [
+    ('', '', 'Missing required option(s): work_wechat_bot_id, work_wechat_msgtype'),
+    ('xxxxxxx', 'yyyyyy',
      {
          'type': 'workwechat',
          'work_wechat_webhook_url': 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxx'
      }),
 ])
-def test_work_wechat_required_error(work_wechat_bot_id, expected_data):
+def test_work_wechat_required_error(work_wechat_bot_id, work_wechat_msgtype, expected_data):
     try:
         rule = {
             'name': 'Test WorkWechat Rule',
@@ -108,6 +111,9 @@ def test_work_wechat_required_error(work_wechat_bot_id, expected_data):
         if work_wechat_bot_id:
             rule['work_wechat_bot_id'] = work_wechat_bot_id
 
+        if work_wechat_msgtype:
+            rule['work_wechat_msgtype'] = work_wechat_msgtype
+
         rules_loader = FileRulesLoader({})
         rules_loader.load_modules(rule)
         alert = WorkWechatAlerter(rule)