Merge lp:~newell-jensen/maas/fix-1608555-1631079 into lp:~maas-committers/maas/trunk

[Newell Jensen]

Add triggers for updating a subnet when it's IP range is created/updated/deleted.

[Blake Rouse (blake-rouse)]

Looks good. But you are missing the triggers tests that should be added in triggers/tests/test_websocket_listener.py.

review: Needs Fixing

[Blake Rouse (blake-rouse)]

Looks good. Thanks for the tests.

review: Approve

=== modified file 'src/maasserver/static/js/angular/controllers/subnet_details.js'
--- src/maasserver/static/js/angular/controllers/subnet_details.js	2016-10-05 06:22:13 +0000
+++ src/maasserver/static/js/angular/controllers/subnet_details.js	2016-10-08 02:08:09 +0000
@@ -326,8 +326,6 @@
         $scope.ipRangeConfirmDelete = function() {
             IPRangesManager.deleteItem($scope.deleteIPRange).then(function() {
                 $scope.deleteIPRange = null;
-                // Reload the subnet after deleting the IP range.
-                $scope.subnet = SubnetsManager.getItem($scope.subnet.id);
             });
         };
 
 
=== modified file 'src/maasserver/static/js/angular/controllers/tests/test_subnet_details.js'
--- src/maasserver/static/js/angular/controllers/tests/test_subnet_details.js	2016-10-05 18:39:44 +0000
+++ src/maasserver/static/js/angular/controllers/tests/test_subnet_details.js	2016-10-08 02:08:09 +0000
@@ -565,15 +565,12 @@
 
         it("calls deleteItem and clears deleteIPRange on resolve", function() {
             var controller = makeController();
-            var subnet = makeSubnet();
             var range = {};
-            $scope.subnet = subnet;
             $scope.deleteIPRange = range;
 
             var defer = $q.defer();
             spyOn(IPRangesManager, "deleteItem").and.returnValue(
                 defer.promise);
-            spyOn(SubnetsManager, "getItem");
             $scope.ipRangeConfirmDelete();
 
             expect(IPRangesManager.deleteItem).toHaveBeenCalledWith(range);
@@ -581,7 +578,6 @@
             $scope.$digest();
 
             expect($scope.deleteIPRange).toBeNull();
-            expect(SubnetsManager.getItem).toHaveBeenCalledWith(subnet.id);
         });
     });
 
 
=== modified file 'src/maasserver/triggers/tests/test_websocket.py'
--- src/maasserver/triggers/tests/test_websocket.py	2016-09-22 02:53:33 +0000
+++ src/maasserver/triggers/tests/test_websocket.py	2016-10-08 02:08:09 +0000
@@ -99,6 +99,9 @@
             "dhcpsnippet_dhcpsnippet_create_notify",
             "dhcpsnippet_dhcpsnippet_update_notify",
             "dhcpsnippet_dhcpsnippet_delete_notify",
+            "iprange_iprange_subnet_insert_notify",
+            "iprange_iprange_subnet_update_notify",
+            "iprange_iprange_subnet_delete_notify",
             ]
         sql, args = psql_array(triggers, sql_type="text")
         with closing(connection.cursor()) as cursor:
 
=== modified file 'src/maasserver/triggers/tests/test_websocket_listener.py'
--- src/maasserver/triggers/tests/test_websocket_listener.py	2016-09-22 02:53:33 +0000
+++ src/maasserver/triggers/tests/test_websocket_listener.py	2016-10-08 02:08:09 +0000
@@ -13,6 +13,7 @@
 from crochet import wait_for
 from maasserver.enum import (
     IPADDRESS_TYPE,
+    IPRANGE_TYPE,
     NODE_TYPE,
 )
 from maasserver.listener import PostgresListenerService
@@ -2980,6 +2981,127 @@
             yield listener.stopService()
 
 
+class TestIPRangeSubnetListener(
+        MAASTransactionServerTestCase, TransactionalHelpersMixin):
+    """End-to-end test of both the listeners code and the triggers on
+    maasserver_iprange tables that notifies affected subnets."""
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_create_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        subnet = yield deferToDatabase(
+            self.create_subnet, {
+                "cidr": '192.168.0.0/24',
+                "gateway_ip": '192.168.0.1',
+                "dns_servers": [],
+                })
+
+        listener = PostgresListenerService()
+        dv = DeferredValue()
+        listener.register("subnet", lambda *args: dv.set(args))
+        yield listener.startService()
+        try:
+            iprange = yield deferToDatabase(
+                self.create_iprange, {
+                    "type": IPRANGE_TYPE.DYNAMIC,
+                    "subnet": subnet,
+                    "start_ip": '192.168.0.100',
+                    "end_ip": '192.168.0.110',
+                    })
+            yield dv.get(timeout=2)
+            self.assertEqual(('update', '%s' % iprange.subnet.id), dv.value)
+        finally:
+            yield listener.stopService()
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_update_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        iprange = yield deferToDatabase(self.create_iprange)
+        new_end_ip = factory.pick_ip_in_IPRange(iprange)
+
+        listener = PostgresListenerService()
+        dv = DeferredValue()
+        listener.register("subnet", lambda *args: dv.set(args))
+        yield listener.startService()
+        try:
+            yield deferToDatabase(
+                self.update_iprange,
+                iprange.id, {"end_ip": new_end_ip})
+            yield dv.get(timeout=2)
+            self.assertEqual(('update', '%s' % iprange.subnet.id), dv.value)
+        finally:
+            yield listener.stopService()
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_update_on_old_and_new_subnet_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        old_subnet = yield deferToDatabase(
+            self.create_subnet, {
+                "cidr": '192.168.0.0/24',
+                "gateway_ip": '192.168.0.1',
+                "dns_servers": [],
+                })
+        new_subnet = yield deferToDatabase(
+            self.create_subnet, {
+                "cidr": '192.168.1.0/24',
+                "gateway_ip": '192.168.1.1',
+                "dns_servers": [],
+                })
+        iprange = yield deferToDatabase(
+            self.create_iprange, {
+                "type": IPRANGE_TYPE.DYNAMIC,
+                "subnet": old_subnet,
+                "start_ip": '192.168.0.100',
+                "end_ip": '192.168.0.110',
+                })
+        dvs = [DeferredValue(), DeferredValue()]
+
+        def set_defer_value(*args):
+            for dv in dvs:
+                if not dv.isSet:
+                    dv.set(args)
+                    break
+
+        listener = PostgresListenerService()
+        listener.register("subnet", set_defer_value)
+        yield listener.startService()
+        try:
+            yield deferToDatabase(self.update_iprange, iprange.id, {
+                "type": IPRANGE_TYPE.DYNAMIC,
+                "subnet": new_subnet,
+                "start_ip": '192.168.1.10',
+                "end_ip": '192.168.1.150',
+                })
+            yield dvs[0].get(timeout=2)
+            yield dvs[1].get(timeout=2)
+            self.assertItemsEqual([
+                ('update', '%s' % old_subnet.id),
+                ('update', '%s' % new_subnet.id),
+                ], [dvs[0].value, dvs[1].value])
+        finally:
+            yield listener.stopService()
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__calls_handler_on_delete_notification(self):
+        yield deferToDatabase(register_websocket_triggers)
+        iprange = yield deferToDatabase(self.create_iprange)
+
+        listener = PostgresListenerService()
+        dv = DeferredValue()
+        listener.register("subnet", lambda *args: dv.set(args))
+        yield listener.startService()
+        try:
+            yield deferToDatabase(self.delete_iprange, iprange.id)
+            yield dv.get(timeout=2)
+            self.assertEqual(('update', '%s' % iprange.subnet.id), dv.value)
+        finally:
+            yield listener.stopService()
+
+
 class TestNodeTypeChange(
         MAASTransactionServerTestCase, TransactionalHelpersMixin):
     """End-to-end test of node type change triggers code."""
 
=== modified file 'src/maasserver/triggers/websocket.py'
--- src/maasserver/triggers/websocket.py	2016-09-22 02:53:33 +0000
+++ src/maasserver/triggers/websocket.py	2016-10-08 02:08:09 +0000
@@ -687,6 +687,50 @@
     $$ LANGUAGE plpgsql;
     """)
 
+# Procedure that is called when an IP range is created to update its related
+# subnet.
+IP_RANGE_SUBNET_INSERT_NOTIFY = dedent("""\
+    CREATE OR REPLACE FUNCTION %s() RETURNS trigger AS $$
+    BEGIN
+      IF NEW.subnet_id IS NOT NULL THEN
+        PERFORM pg_notify('subnet_update',CAST(NEW.subnet_id AS text));
+      END IF;
+      RETURN NEW;
+    END;
+    $$ LANGUAGE plpgsql;
+    """)
+
+# Procedure that is called when an IP range is updated to update its related
+# subnet.
+IP_RANGE_SUBNET_UPDATE_NOTIFY = dedent("""\
+    CREATE OR REPLACE FUNCTION %s() RETURNS trigger AS $$
+    BEGIN
+      IF OLD.subnet_id != NEW.subnet_id THEN
+        IF OLD.subnet_id IS NOT NULL THEN
+          PERFORM pg_notify('subnet_update',CAST(OLD.subnet_id AS text));
+        END IF;
+      END IF;
+      IF NEW.subnet_id IS NOT NULL THEN
+        PERFORM pg_notify('subnet_update',CAST(NEW.subnet_id AS text));
+      END IF;
+      RETURN NEW;
+    END;
+    $$ LANGUAGE plpgsql;
+    """)
+
+# Procedure that is called when an IP range is deleted to update its related
+# subnet.
+IP_RANGE_SUBNET_DELETE_NOTIFY = dedent("""\
+    CREATE OR REPLACE FUNCTION %s() RETURNS trigger AS $$
+    BEGIN
+      IF OLD.subnet_id IS NOT NULL THEN
+        PERFORM pg_notify('subnet_update',CAST(OLD.subnet_id AS text));
+      END IF;
+      RETURN OLD;
+    END;
+    $$ LANGUAGE plpgsql;
+    """)
+
 # Procedure that is called when a DNSData entry is changed.
 DNSDATA_DOMAIN_NOTIFY = dedent("""\
     CREATE OR REPLACE FUNCTION %s() RETURNS trigger AS $$
@@ -1134,6 +1178,23 @@
         "maasserver_staticipaddress",
         "ipaddress_domain_delete_notify", "delete")
 
+    # IP range subnet notifications
+    register_procedure(
+        IP_RANGE_SUBNET_INSERT_NOTIFY % 'iprange_subnet_insert_notify')
+    register_procedure(
+        IP_RANGE_SUBNET_UPDATE_NOTIFY % 'iprange_subnet_update_notify')
+    register_procedure(
+        IP_RANGE_SUBNET_DELETE_NOTIFY % 'iprange_subnet_delete_notify')
+    register_trigger(
+        "maasserver_iprange",
+        "iprange_subnet_insert_notify", "insert")
+    register_trigger(
+        "maasserver_iprange",
+        "iprange_subnet_update_notify", "update")
+    register_trigger(
+        "maasserver_iprange",
+        "iprange_subnet_delete_notify", "delete")
+
     # DNSData table
     register_procedure(
         DNSDATA_DOMAIN_NOTIFY % (