[feature] Added notification support from openwisp_notifications #191

- Added openwisp-notification as requirement
- Added notifications to be sent for following events:
  - A new device is registered automatically
  - Congiguration status has changed to "error"
- Added ingore notification widget to "DeviceAdmin"
Closes #191

Author: pandafy

.travis.yml

@@ -13,6 +13,10 @@ addons:
       - spatialite-bin
       - libsqlite3-mod-spatialite
 
+services:
+  - docker
+  - redis-server
+
 python:
   - "3.6"
   - "3.7"

README.rst

@@ -61,6 +61,8 @@ Other popular building blocks that are part of the OpenWISP ecosystem are:
   of the state of the network
 - `openwisp-ipam <https://github.com/openwisp/openwisp-ipam>`_:
   it allows to manage the IP address space of networks
+- `openwisp-notifications <https://github.com/openwisp/openwisp-notifications>`_:
+  it allows to create and manage notifications from the network.
 
 .. image:: https://raw.githubusercontent.com/openwisp/openwisp2-docs/master/assets/design/openwisp-logo-black.svg
   :target: http://openwisp.org
@@ -561,6 +563,17 @@ their hardware ID instead of their name.
 
 If you still want to reference devices by their name, set this to ``False``.
 
+Default Alerts / Notifications
+------------------------------
+
++-----------------------+---------------------------------------------------------------------+
+| Notification Type     | Use                                                                 |
++-----------------------+---------------------------------------------------------------------+
+| ``config_error``      | Fires when status of a device configuration changes to  ``error``.  |
++-----------------------+---------------------------------------------------------------------+
+| ``device_registered`` | Fires when a new device is registered automatically on the network. |
++-----------------------+---------------------------------------------------------------------+
+
 Installing for development
 --------------------------
 
@@ -879,15 +892,31 @@ This signal is emitted once the device gets registered automatically through the
 Setup (Integrate into other Apps)
 ---------------------------------
 
-Add ``openwisp_controller`` to ``INSTALLED_APPS``:
+Add ``openwisp_controller`` applications to ``INSTALLED_APPS``:
 
 .. code-block:: python
 
     INSTALLED_APPS = [
-        # other apps
-        'openwisp_controller',
+        ...
+        # openwisp2 modules
+        'openwisp_controller.config',
+        'openwisp_controller.pki',
+        'openwisp_controller.geo',
+        'openwisp_controller.connection',
+        'openwisp_controller.notifications',
+        'openwisp_users',
+        'openwisp_notifications',
+        # openwisp2 admin theme
+        # (must be loaded here)
+        'openwisp_utils.admin_theme',
+        'django.contrib.admin',
+        'django.forms',
+        ...
     ]
 
+**Note**: The order of applications in ``INSTALLED_APPS`` should be maintained,
+otherwise it might not work properly.
+
 Add the URLs to your main ``urls.py``:
 
 .. code-block:: python
@@ -904,6 +933,9 @@ Then run:
 
     ./manage.py migrate
 
+**Note**: In order to properly configure notifications for your project,
+please follow `setup guide of openwisp-notifications <https://github.com/openwisp/openwisp-notifications#setup-integrate-into-an-existing-django-project>`_.
+
 Extending openwisp-controller
 -----------------------------
 
@@ -1442,6 +1474,17 @@ Remember to change ``geo_views`` location in ``urls.py`` in point 11 for extendi
 
 For more information about django views, please refer to the `views section in the django documentation <https://docs.djangoproject.com/en/dev/topics/http/views/>`_.
 
+Registering new notification types
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can define your own notification types using ``register_notification_type`` function from OpenWISP
+Notifications. For more information, see the relevant
+`documentation section about registering notification types in openwisp-notifications <https://github.com/openwisp/openwisp-notifications#registering--unregistering-notification-types>`_.
+
+Once a new notification type is registered, you have to use the `"notify" signal provided in
+openwisp-notifications <https://github.com/openwisp/openwisp-notifications#sending-notifications>`_
+to send notifications for this type.
+
 Talks
 -----
 

install-dev.sh

@@ -1,5 +1,9 @@
 #!/bin/bash
 set -e
+
+# TODO: remove when openwisp-notifications 0.2 is released
+pip install -U https://github.com/openwisp/openwisp-notifications/tarball/issues/38-disable-object-notification
+
 # TODO: can be remove when openwisp-users 0.4.1 is released
 # Commit needed for failures in tests:
 # https://github.com/openwisp/openwisp-users/commit/ef347927136ddb4676479cb54cdc7cd08049e2e5

openwisp_controller/config/apps.py

@@ -1,7 +1,12 @@
 from django.apps import AppConfig
 from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
 from django.db.models.signals import m2m_changed, post_delete
 from django.utils.translation import ugettext_lazy as _
+from openwisp_notifications.types import (
+    register_notification_type,
+    unregister_notification_type,
+)
 from swapper import get_model_name, load_model
 
 from . import settings as app_settings
@@ -20,17 +25,22 @@ def ready(self, *args, **kwargs):
         self.__setmodels__()
         self.connect_signals()
         self.add_default_menu_items()
+        self.register_notification_types()
+        self.add_ignore_notification_widget()
 
     def __setmodels__(self):
         self.config_model = load_model('config', 'Config')
         self.vpnclient_model = load_model('config', 'VpnClient')
 
     def connect_signals(self):
         """
+        * handlers for creating notifications
         * m2m validation before templates are added/removed to a config
         * automatic vpn client management on m2m_changed
         * automatic vpn client removal
         """
+        from . import handlers  # noqa
+
         m2m_changed.connect(
             self.config_model.clean_templates,
             sender=self.config_model.templates.through,
@@ -64,3 +74,62 @@ def add_default_menu_items(self):
         else:
             current_menu = getattr(settings, menu_setting)
             current_menu += items
+
+    def register_notification_types(self):
+        register_notification_type(
+            'config_error',
+            {
+                'verbose_name': _('Configuration ERROR'),
+                'verb': _('encountered an error'),
+                'level': 'error',
+                'email_subject': _(
+                    '[{site.name}] ERROR: "{notification.target}" configuration '
+                    '{notification.verb}'
+                ),
+                'message': _(
+                    'The configuration of [{notification.target}]'
+                    '({notification.target_link}) has {notification.verb}. '
+                    'The last working configuration has been restored from a backup '
+                    'present on the filesystem of the device.'
+                ),
+            },
+        )
+
+        register_notification_type(
+            'device_registered',
+            {
+                'verbose_name': _('Device Registration'),
+                'verb': _('registered successfully'),
+                'level': 'success',
+                'email_subject': _(
+                    '[{site.name}] SUCCESS: "{notification.target}"'
+                    ' {notification.verb}'
+                ),
+                'message': _(
+                    'A new device [{notification.target}]'
+                    '({notification.target_link}) has {notification.verb}.'
+                ),
+            },
+        )
+
+        #  Unregister default notification type
+        try:
+            unregister_notification_type('default')
+        except ImproperlyConfigured:
+            pass
+
+    def add_ignore_notification_widget(self):
+        """
+        Adds ingore notification widget from openwisp-notifications to DeviceAdmin.
+        """
+        obj_notification_widget = getattr(
+            settings, 'OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN', []
+        )
+        device_admin = 'openwisp_controller.config.admin.DeviceAdmin'
+        if device_admin not in obj_notification_widget:
+            obj_notification_widget.append(device_admin)
+            setattr(
+                settings,
+                'OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN',
+                obj_notification_widget,
+            )

openwisp_controller/config/handlers.py

@@ -0,0 +1,32 @@
+from django.dispatch import receiver
+from openwisp_notifications.signals import notify
+from swapper import load_model
+
+from .signals import config_status_changed, device_registered
+
+Config = load_model('config', 'Config')
+Device = load_model('config', 'Device')
+
+
+@receiver(
+    config_status_changed,
+    sender=Config,
+    dispatch_uid='config_status_error_notification',
+)
+def config_status_error_notification(sender, instance, **kwargs):
+    """
+    Creates notification when status of a configuration changes to "error".
+    """
+    if instance.status == 'error':
+        notify.send(sender=instance, type='config_error', target=instance.device)
+
+
+@receiver(
+    device_registered, sender=Config, dispatch_uid='device_registered_notification'
+)
+def device_registered_notification(sender, instance, **kwargs):
+    """
+    Creates notification when a new device is registered automatically
+    through controller.
+    """
+    notify.send(sender=instance, type='device_registered', target=instance)

openwisp_controller/config/tests/test_notifications.py

@@ -0,0 +1,69 @@
+from django.apps.registry import apps
+from django.test import TestCase
+from openwisp_notifications.types import unregister_notification_type
+from swapper import load_model
+
+from openwisp_controller.config.tests.utils import CreateConfigMixin
+from openwisp_users.tests.utils import TestOrganizationMixin
+
+from ..signals import device_registered
+
+Config = load_model('config', 'Config')
+Notification = load_model('openwisp_notifications', 'Notification')
+
+notification_qs = Notification.objects.all()
+
+
+class TestNotifications(CreateConfigMixin, TestOrganizationMixin, TestCase):
+    def setUp(self):
+        self.admin = self._get_admin()
+
+    def test_config_problem_notification(self):
+        config = self._create_config()
+        config.set_status_error()
+
+        self.assertEqual(config.status, 'error')
+        self.assertEqual(notification_qs.count(), 1)
+        notification = notification_qs.first()
+        self.assertEqual(notification.actor, config)
+        self.assertEqual(notification.target, config.device)
+        self.assertEqual(notification.type, 'config_error')
+        self.assertEqual(
+            notification.email_subject,
+            f'[example.com] ERROR: "{config.device}"'
+            ' configuration encountered an error',
+        )
+        self.assertIn('encountered an error', notification.message)
+
+    def test_device_registered(self):
+        # To avoid adding repetitive code for registering a device,
+        # we simulate that "device_registered" signal is emitted
+        config = self._create_config()
+        device = config.device
+        device_registered.send(sender=Config, instance=config.device)
+
+        self.assertEqual(notification_qs.count(), 1)
+        notification = notification_qs.first()
+        self.assertEqual(notification.actor, device)
+        self.assertEqual(notification.target, device)
+        self.assertEqual(notification.type, 'device_registered')
+        self.assertEqual(
+            notification.email_subject,
+            f'[example.com] SUCCESS: "{device}" registered successfully',
+        )
+        self.assertIn('registered successfully', notification.message)
+
+    def test_default_notification_type_already_unregistered(self):
+        # Simulates if 'default notification type is already unregistered
+        # by some other module
+
+        # Unregister "config_error" and "device_registered" notification
+        # types to avoid getting rasing ImproperlyConfigured exceptions
+        unregister_notification_type('config_error')
+        unregister_notification_type('device_registered')
+
+        # This will try to unregister 'default' notification type
+        # which is already got unregistered when Django loaded.
+        # No exception should be raised as the exception is already handled.
+        app = apps.get_app_config('config')
+        app.ready()

openwisp_controller/geo/channels/routing.py

@@ -3,6 +3,7 @@
 from channels.security.websocket import AllowedHostsOriginValidator
 from django.conf.urls import url
 from django_loci.channels.base import location_broadcast_path
+from openwisp_notifications.websockets.routing import get_routes
 
 from .consumers import LocationBroadcast
 
@@ -11,7 +12,7 @@
 channel_routing = ProtocolTypeRouter(
     {
         'websocket': AllowedHostsOriginValidator(
-            AuthMiddlewareStack(URLRouter(geo_routes)),
+            AuthMiddlewareStack(URLRouter(get_routes() + geo_routes)),
         )
     }
 )

openwisp_controller/tests/test_users_integration.py

@@ -10,5 +10,18 @@ class TestUsersIntegration(TestUsersAdmin):
     test_only_superuser_has_add_delete_org_perm = None
     test_can_change_inline_org_owner = None
 
+    @property
+    def add_user_inline_params(self):
+        params = super().add_user_inline_params
+        params.update(
+            {
+                'notificationsetting_set-TOTAL_FORMS': 0,
+                'notificationsetting_set-INITIAL_FORMS': 0,
+                'notificationsetting_set-MIN_NUM_FORMS': 0,
+                'notificationsetting_set-MAX_NUM_FORMS': 0,
+            }
+        )
+        return params
+
 
 del TestUsersAdmin

requirements-test.txt

@@ -1,4 +1,6 @@
 coveralls
+channels_redis~=3.1
+django_redis~=4.12
 openwisp-utils[qa]~=0.6.0
 pytest~=6.0
 pytest-django>=3.8.0,<4.0.0

requirements.txt

@@ -15,3 +15,5 @@ celery>=4.4.3,<4.5.0
 redis>=3.4.1,<4.0.0
 swapper~=1.1.0
 django-flat-json-widget~=0.1
+# TODO: uncomment when openwisp-notifications is released
+# 'openwisp_notifications~=0.1',