Add tests for services

While adding some tests, minor issues with individual service plugins
have been fixed. At the same time, this drops official support for
Python 2.

Author: amotl

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["2.7", "3.6", "3.7", "3.8", "3.9"]
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
         include:
         - os: ubuntu-latest
           path: ~/.cache/pip

CHANGES.rst

@@ -10,6 +10,9 @@ in progress
 - Fix "http" service plugin
 - Improve machinery to launch a notification service plugin standalone.
   Now, it works without any ``mqttwarn.ini`` configuration file at all.
+- Begin adding tests for services
+- Drop official support for Python 2
+
 
 2021-06-12 0.24.0
 =================
@@ -18,6 +21,7 @@ in progress
 - [core] Make "functions" setting in configuration file optional
 - [ci] Build and publish Docker multi-platform images
 
+
 2021-06-08 0.23.1
 =================
 

README.rst

@@ -215,7 +215,7 @@ Requirements
 ============
 You'll need at least the following components:
 
-* Python. The program should work on Python 2, Python 3 and PyPy.
+* Python. The program should work on Python 3 and PyPy3.
 * An MQTT broker. We recommend Mosquitto_.
 * Some more Python modules to satisfy service dependencies defined in the ``setup.py`` file.
 

mqttwarn/services/alexa-notify-me.py

@@ -29,12 +29,13 @@ def plugin(srv, item):
             "accessCode": item.addrs[0]
         })
 
-        requests.post(url="https://api.notifymyecho.com/v1/NotifyMe", data=body)
+        response = requests.post(url="https://api.notifymyecho.com/v1/NotifyMe", data=body)
+        response.raise_for_status()
 
         srv.logging.debug("Successfully sent to NotifyMe service.")
 
     except Exception as e:
-        srv.logging.warning("Failed to send message to NotifyMe service." % e)
+        srv.logging.warning("Failed to send message to NotifyMe service: %s" % e)
         return False
 
     return True

mqttwarn/services/amqp.py

@@ -36,7 +36,7 @@ def plugin(srv, item):
 
         srv.logging.debug("Successfully published AMQP notification")
     except Exception as e:
-        srv.logging.warn("Error on AMQP publish to %s [%s/%s]: %s" % (item.target, exchange, routing_key, e))
+        srv.logging.warning("Error on AMQP publish to %s [%s/%s]: %s" % (item.target, exchange, routing_key, e))
         return False
 
     return True

mqttwarn/services/apns.py

@@ -19,18 +19,18 @@ def plugin(srv, item):
     try:
         cert_file, key_file = addrs
     except:
-        srv.logging.warn("Incorrect service configuration")
+        srv.logging.warning("Incorrect service configuration")
         return False
 
-    if 'payload' not in data or 'apns_token' not in data:
-        srv.logging.warn("Cannot notify via APNS: payload or apns_token are missing")
+    if 'apns_token' not in data:
+        srv.logging.warning("Cannot notify via APNS: apns_token is missing")
         return False
 
     apns_token = data['apns_token']
-    payload = data['payload']
 
     custom = {}
     try:
+        payload = data['payload']
         mdata = json.loads(payload)
         if 'custom' in mdata:
             custom = mdata['custom']
@@ -42,4 +42,6 @@ def plugin(srv, item):
     pload = Payload(alert=text, custom=custom, sound="default", badge=1)
     apns.gateway_server.send_notification(apns_token, pload)
 
+    srv.logging.debug("Successfully published APNS notification to %s" % apns_token)
+
     return True

mqttwarn/services/apprise.py

@@ -16,8 +16,8 @@ def plugin(srv, item):
     addresses = item.addrs
 
     if not addresses:
-        srv.logging.warn("Skipped sending notification to Apprise %s, "
-                         "no addresses configured" % (item.target))
+        srv.logging.warning("Skipped sending notification to Apprise %s, "
+                            "no addresses configured" % (item.target))
         return False
 
     sender = item.config.get('sender')

mqttwarn/services/asterisk.py

@@ -36,17 +36,20 @@ def plugin(srv, item):
         srv.logging.info("Call {}".format(response))
         manager.logoff()
     except asterisk.manager.ManagerSocketException as e:
-        srv.logging.error("Error connecting to the manage: {}".format(e))
+        srv.logging.error("Error connecting to the manager: {}".format(e))
+        return False
     except asterisk.manager.ManagerAuthException as e:
         srv.logging.error("Error logging in to the manager: {}".format(e))
+        return False
     except asterisk.manager.ManagerException as e:
         srv.logging.error("Error: {}".format(e))
+        return False
 
+    # Remember to clean up
     finally:
-    # remember to clean up
         try:
             manager.close()
-        except asterisk.manager.ManagerSocketException:
+        except asterisk.manager.ManagerSocketException:  # pragma: no cover
             pass
 
     return True

mqttwarn/services/autoremote.py

@@ -36,7 +36,7 @@ def plugin(srv, item):
         srv.logging.debug("Successfully sent to autoremote service")
 
     except Exception as e:
-        srv.logging.warning("Failed to send message to autoremote service" % e)
+        srv.logging.warning("Failed to send message to autoremote service: %s" % e)
         return False
 
     return True

mqttwarn/services/carbon.py

@@ -35,20 +35,22 @@ def plugin(srv, item):
         srv.logging.error("target `carbon': cannot split string")
         return False
 
-    if len(parts) == 1:
+    parts_count = len(parts)
+    if parts_count == 1:
         metric_name = item.data.get('topic', 'ohno').replace('/', '.')
         value = parts[0]
         tics = int(time.time())
+    elif parts_count == 2:
+        metric_name = parts[0]
+        value = parts[1]
+        tics = int(time.time())
+    elif parts_count == 3:
+        metric_name = parts[0]
+        value = parts[1]
+        tics = int(parts[2])
     else:
-        if len(parts) == 2:
-            metric_name = parts[0]
-            value = parts[1]
-            tics = int(time.time())
-        else:
-            if len(parts) == 3:
-                metric_name = parts[0]
-                value = parts[1]
-                tics = int(parts[2])
+        srv.logging.error("target `carbon': error decoding message")
+        return False
 
     if metric_name.startswith('.'):     # omit dot there caused by useless leading slash in topic
         metric_name = metric_name[1:]