Merge lp:~allenap/maas/notifications-triggers into lp:~maas-committers/maas/trunk

[Gavin Panella]

Database triggers for the Notification and NotificationDismissal models.

[Lee Trager (ltrager)]

review: Approve

[MAAS Lander (maas-lander)]

The attempt to merge lp:~allenap/maas/notifications-triggers into lp:maas failed. Below is the output from the failed tests.

Get:1 http://security.ubuntu.com/ubuntu xenial-security InRelease [102 kB]
Hit:2 http://prodstack-zone-2.clouds.archive.ubuntu.com/ubuntu xenial InRelease
Get:3 http://prodstack-zone-2.clouds.archive.ubuntu.com/ubuntu xenial-updates InRelease [102 kB]
Hit:4 http://prodstack-zone-2.clouds.archive.ubuntu.com/ubuntu xenial-backports InRelease
Fetched 204 kB in 0s (459 kB/s)
Reading package lists...
sudo DEBIAN_FRONTEND=noninteractive apt-get -y \
    --no-install-recommends install apache2 archdetect-deb authbind avahi-utils bash bind9 bind9utils build-essential bzr bzr-builddeb chromium-browser chromium-chromedriver curl daemontools debhelper dh-apport dh-systemd distro-info dnsutils firefox freeipmi-tools git gjs ipython isc-dhcp-common isc-dhcp-server libjs-angularjs libjs-jquery libjs-jquery-hotkeys libjs-yui3-full libjs-yui3-min libnss-wrapper libpq-dev make nodejs-legacy npm postgresql pxelinux python3-all python3-apt python3-attr python3-bson python3-convoy python3-crochet python3-cssselect python3-curtin python3-dev python3-distro-info python3-django python3-django-nose python3-django-piston3 python3-dnspython python3-docutils python3-formencode python3-hivex python3-httplib2 python3-jinja2 python3-jsonschema python3-lxml python3-netaddr python3-netifaces python3-novaclient python3-oauth python3-oauthlib python3-openssl python3-paramiko python3-petname python3-pexpect python3-psycopg2 python3-pyinotify python3-pyparsing python3-pyvmomi python3-requests python3-seamicroclient python3-setuptools python3-simplestreams python3-sphinx python3-tempita python3-twisted python3-txtftp python3-tz python3-yaml python3-zope.interface python-bson python-crochet python-django python-django-piston python-djorm-ext-pgarray python-formencode python-lxml python-netaddr python-netifaces python-pocket-lint python-psycopg2 python-simplejson python-tempita python-twisted python-yaml socat syslinux-common tgt ubuntu-cloudimage-keyring wget xvfb
Reading package lists...
Building dependency tree...
Reading state information...
authbind is already the newest version (2.1.1+nmu1).
avahi-utils is already the newest version (0.6.32~rc+dfsg-1ubuntu2).
build-essential is already the newest version (12.1ubuntu2).
debhelper is already the newest version (9.20160115ubuntu3).
distro-info is already the newest version (0.14build1).
git is already the newest version (1:2.7.4-0ubuntu1).
libjs-angularjs is already the newest version (1.2.28-1ubuntu2).
libjs-jquery is already the newest version (1.11.3+dfsg-4).
libjs-yui3-full is already the newest version (3.5.1-1ubuntu3).
libjs-yui3-min is already the newest version (3.5.1-1ubuntu3).
make is already the newest version (4.1-6).
postgresql is already the newest version (9.5+173).
pxelinux is already the newest version (3:6.03+dfsg-11ubuntu1).
python-formencode is already the newest version (1.3.0-0ubuntu5).
python-lxml is already the newest version (3.5.0-1build1).
python-netaddr is already the newest version (0.7.18-1).
python-netifaces is already the newest version (0.10.4-0.1build2).
python-psycopg2 ...

=== modified file 'src/maasserver/triggers/tests/test_init.py'
--- src/maasserver/triggers/tests/test_init.py	2017-01-10 13:34:54 +0000
+++ src/maasserver/triggers/tests/test_init.py	2017-01-20 15:33:18 +0000
@@ -183,6 +183,10 @@
         "node_region_controller_update_notify",
         "node_tags_machine_device_tag_link_notify",
         "node_tags_machine_device_tag_unlink_notify",
+        "notification_notification_create_notify",
+        "notification_notification_delete_notify",
+        "notification_notification_update_notify",
+        "notificationdismissal_notificationdismissal_create_notify",
         "packagerepository_packagerepository_create_notify",
         "packagerepository_packagerepository_delete_notify",
         "packagerepository_packagerepository_update_notify",
 
=== modified file 'src/maasserver/triggers/tests/test_websocket_listener.py'
--- src/maasserver/triggers/tests/test_websocket_listener.py	2016-12-07 14:53:00 +0000
+++ src/maasserver/triggers/tests/test_websocket_listener.py	2017-01-20 15:33:18 +0000
@@ -3246,3 +3246,89 @@
         finally:
             yield listener1.stopService()
             yield listener2.stopService()
+
+
+class TestNotificationListener(
+        MAASTransactionServerTestCase, TransactionalHelpersMixin):
+    """Tests for notifications relating to the `Notification` model."""
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_create_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        listener = self.make_listener_without_delay()
+        dv = DeferredValue()
+        listener.register("notification", lambda *args: dv.set(args))
+        yield listener.startService()
+        try:
+            notification = yield deferToDatabase(factory.make_Notification)
+            yield dv.get(timeout=2)
+            self.assertEqual(('create', '%s' % notification.id), dv.value)
+        finally:
+            yield listener.stopService()
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_update_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        listener = self.make_listener_without_delay()
+        dv = DeferredValue()
+        listener.register("notification", lambda *args: dv.set(args))
+        notification = yield deferToDatabase(factory.make_Notification)
+
+        def update_notification(notification):
+            notification.users = not notification.users
+            notification.admins = not notification.admins
+            notification.save()
+
+        yield listener.startService()
+        try:
+            yield deferToDatabase(update_notification, notification)
+            yield dv.get(timeout=2)
+            self.assertEqual(('update', '%s' % notification.id), dv.value)
+        finally:
+            yield listener.stopService()
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_delete_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        listener = self.make_listener_without_delay()
+        dv = DeferredValue()
+        listener.register("notification", lambda *args: dv.set(args))
+        notification = yield deferToDatabase(factory.make_Notification)
+        notification_id = notification.id  # Capture before delete.
+        yield listener.startService()
+        try:
+            yield deferToDatabase(notification.delete)
+            yield dv.get(timeout=2)
+            self.assertEqual(('delete', '%s' % notification_id), dv.value)
+        finally:
+            yield listener.stopService()
+
+
+class TestNotificationDismissalListener(
+        MAASTransactionServerTestCase, TransactionalHelpersMixin):
+    """Tests relating to the `NotificationDismissal` model.
+
+    At present `NotificationDismissal` rows are only ever created.
+    """
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_create_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        listener = self.make_listener_without_delay()
+        dv = DeferredValue()
+        listener.register("notificationdismissal", lambda *args: dv.set(args))
+        yield listener.startService()
+        try:
+            user = yield deferToDatabase(factory.make_User)
+            notification = yield deferToDatabase(factory.make_Notification)
+            yield deferToDatabase(notification.dismiss, user)
+            yield dv.get(timeout=2)
+            self.assertEqual(
+                ('create', '%d:%d' % (notification.id, user.id)),
+                dv.value)
+        finally:
+            yield listener.stopService()
 
=== modified file 'src/maasserver/triggers/websocket.py'
--- src/maasserver/triggers/websocket.py	2017-01-10 13:11:08 +0000
+++ src/maasserver/triggers/websocket.py	2017-01-20 15:33:18 +0000
@@ -960,6 +960,30 @@
         region_and_rack_controller=NODE_TYPE.REGION_AND_RACK_CONTROLLER))
 
 
+def render_notification_dismissal_notification_procedure(
+        proc_name, event_name):
+    """Send the notification_id and user_id when a notification is dismissed.
+
+    Why not send the surrogate primary key as we do for most/all other models?
+    The surrogate primary key exists only because Django won't let us do
+    without. It's just not interesting. We only want the notification's ID and
+    the user's ID, and we may as well put those in the notification because
+    they're really short and it saves an extra trip to the database to load
+    the row.
+    """
+    return dedent("""\
+        CREATE OR REPLACE FUNCTION %s() RETURNS trigger AS $$
+        DECLARE
+        BEGIN
+          PERFORM pg_notify(
+              '%s', CAST(NEW.notification_id AS text) || ':' ||
+              CAST(NEW.user_id AS text));
+          RETURN NEW;
+        END;
+        $$ LANGUAGE plpgsql;
+        """ % (proc_name, event_name))
+
+
 @transactional
 def register_websocket_triggers():
     """Register all websocket triggers into the database."""
@@ -1736,6 +1760,33 @@
         "maasserver_packagerepository", "packagerepository_delete_notify",
         "delete")
 
+    # Node type change.
     register_procedure(node_type_change())
     register_trigger(
         "maasserver_node", "node_type_change_notify", "update")
+
+    # Notification table.
+    register_procedure(
+        render_notification_procedure(
+            'notification_create_notify', 'notification_create', 'NEW.id'))
+    register_procedure(
+        render_notification_procedure(
+            'notification_update_notify', 'notification_update', 'NEW.id'))
+    register_procedure(
+        render_notification_procedure(
+            'notification_delete_notify', 'notification_delete', 'OLD.id'))
+    register_trigger(
+        "maasserver_notification", "notification_create_notify", "insert")
+    register_trigger(
+        "maasserver_notification", "notification_update_notify", "update")
+    register_trigger(
+        "maasserver_notification", "notification_delete_notify", "delete")
+
+    # NotificationDismissal table.
+    register_procedure(
+        render_notification_dismissal_notification_procedure(
+            'notificationdismissal_create_notify',
+            'notificationdismissal_create'))
+    register_trigger(
+        "maasserver_notificationdismissal",
+        "notificationdismissal_create_notify", "insert")