Merge lp:~allenap/maas/subnet-attribute-error--bug-1671048 into lp:~maas-committers/maas/trunk

[Gavin Panella]

Node.get_default_gateways now always returns a DefaultGateways instance which contains two GatewayDefinition instances.

Previously plain tuples were sometimes returned instead of GatewayDefinition named tuples.

[Blake Rouse (blake-rouse)]

Looks good. Thanks for the quick fix.

review: Approve

[Blake Rouse (blake-rouse)]

Don't forget the backport.

=== modified file 'src/maasserver/models/node.py'
--- src/maasserver/models/node.py	2017-03-10 18:38:46 +0000
+++ src/maasserver/models/node.py	2017-03-21 15:48:45 +0000
@@ -3129,7 +3129,7 @@
                 interface.id
             """, (self.id,))
         return [
-            GatewayDefinition._make((found[0], found[1], found[2]))
+            GatewayDefinition(found[0], found[1], found[2])
             for found in cursor.fetchall()
         ]
 
@@ -3141,7 +3141,7 @@
     def _get_gateway_tuple(self, gateway_link):
         """Return a tuple for the interface id, subnet id, and gateway IP for
         the `gateway_link`."""
-        return (
+        return GatewayDefinition(
             self._get_best_interface_from_gateway_link(
                 gateway_link),
             gateway_link.subnet.id,
@@ -3181,7 +3181,7 @@
 
         # Early out if we already have both gateways.
         if gateway_ipv4 and gateway_ipv6:
-            return DefaultGateways._make((gateway_ipv4, gateway_ipv6))
+            return DefaultGateways(gateway_ipv4, gateway_ipv6)
 
         # Get the best guesses for the missing IP families.
         found_gateways = self.get_best_guess_for_default_gateways()
@@ -3191,7 +3191,7 @@
         if not gateway_ipv6:
             gateway_ipv6 = self._get_gateway_tuple_by_family(
                 found_gateways, IPADDRESS_FAMILY.IPv6)
-        return DefaultGateways._make((gateway_ipv4, gateway_ipv6))
+        return DefaultGateways(gateway_ipv4, gateway_ipv6)
 
     def get_default_dns_servers(self, ipv4=True, ipv6=True):
         """Return the default DNS servers for this node."""

=== modified file 'src/maasserver/models/tests/test_node.py'
--- src/maasserver/models/tests/test_node.py	2017-03-10 18:38:46 +0000
+++ src/maasserver/models/tests/test_node.py	2017-03-21 15:48:45 +0000
@@ -197,6 +197,7 @@
     HasLength,
     Is,
     IsInstance,
+    MatchesAll,
     MatchesSetwise,
     MatchesStructure,
     Not,
@@ -5209,6 +5210,24 @@
             node.get_best_guess_for_default_gateways())
 
 
+def MatchesDefaultGateways(ipv4, ipv6):
+    # Matches a `DefaultGateways` instance, which must contain
+    # `GatewayDefinition` instances, not just plain tuples.
+    return MatchesAll(
+        IsInstance(DefaultGateways),
+        MatchesStructure(
+            ipv4=MatchesAll(
+                IsInstance(GatewayDefinition),
+                Equals(ipv4),
+            ),
+            ipv6=MatchesAll(
+                IsInstance(GatewayDefinition),
+                Equals(ipv6),
+            ),
+        ),
+    )
+
+
 class TestGetDefaultGateways(MAASServerTestCase):
     """Tests for `Node.get_default_gateways`."""
 
@@ -5244,10 +5263,11 @@
         node.gateway_link_ipv4 = link_v4
         node.gateway_link_ipv6 = link_v6
         node.save()
-        self.assertEqual((
-            (interface.id, subnet_v4_2.id, subnet_v4_2.gateway_ip),
-            (interface.id, subnet_v6_2.id, subnet_v6_2.gateway_ip),
-            ), node.get_default_gateways())
+        self.assertThat(
+            node.get_default_gateways(), MatchesDefaultGateways(
+                (interface.id, subnet_v4_2.id, subnet_v4_2.gateway_ip),
+                (interface.id, subnet_v6_2.id, subnet_v6_2.gateway_ip),
+            ))
 
     def test__return_set_ipv4_and_guess_ipv6(self):
         node = factory.make_Node(status=NODE_STATUS.READY)
@@ -5273,10 +5293,11 @@
             subnet=subnet_v6, interface=interface)
         node.gateway_link_ipv4 = link_v4
         node.save()
-        self.assertEqual((
-            (interface.id, subnet_v4_2.id, subnet_v4_2.gateway_ip),
-            (interface.id, subnet_v6.id, subnet_v6.gateway_ip),
-            ), node.get_default_gateways())
+        self.assertThat(
+            node.get_default_gateways(), MatchesDefaultGateways(
+                (interface.id, subnet_v4_2.id, subnet_v4_2.gateway_ip),
+                (interface.id, subnet_v6.id, subnet_v6.gateway_ip),
+            ))
 
     def test__return_set_ipv6_and_guess_ipv4(self):
         node = factory.make_Node(status=NODE_STATUS.READY)
@@ -5302,10 +5323,11 @@
             subnet=subnet_v6_2, interface=interface)
         node.gateway_link_ipv6 = link_v6
         node.save()
-        self.assertEqual((
-            (interface.id, subnet_v4.id, subnet_v4.gateway_ip),
-            (interface.id, subnet_v6_2.id, subnet_v6_2.gateway_ip),
-            ), node.get_default_gateways())
+        self.assertThat(
+            node.get_default_gateways(), MatchesDefaultGateways(
+                (interface.id, subnet_v4.id, subnet_v4.gateway_ip),
+                (interface.id, subnet_v6_2.id, subnet_v6_2.gateway_ip),
+            ))
 
     def test__return_guess_ipv4_and_ipv6(self):
         node = factory.make_Node(status=NODE_STATUS.READY)
@@ -5322,10 +5344,11 @@
             alloc_type=IPADDRESS_TYPE.STICKY,
             ip=factory.pick_ip_in_network(network_v6),
             subnet=subnet_v6, interface=interface)
-        self.assertEqual((
-            (interface.id, subnet_v4.id, subnet_v4.gateway_ip),
-            (interface.id, subnet_v6.id, subnet_v6.gateway_ip),
-            ), node.get_default_gateways())
+        self.assertThat(
+            node.get_default_gateways(), MatchesDefaultGateways(
+                (interface.id, subnet_v4.id, subnet_v4.gateway_ip),
+                (interface.id, subnet_v6.id, subnet_v6.gateway_ip),
+            ))
 
 
 class TestGetDefaultDNSServers(MAASServerTestCase):