Merge lp:~mpontillo/maas/view-current-gateway--bug-1674807--2.1 into lp:maas/2.1

[Mike Pontillo]

Allow viewing the currently-set default gateways for a machine using the API.

 * Merges revision 5895 from trunk to fix bug #1674807.

[Mike Pontillo (mpontillo)]

Self-approve backport.

review: Approve

=== modified file 'docs/changelog.rst'
--- docs/changelog.rst	2017-03-30 17:18:49 +0000
+++ docs/changelog.rst	2017-03-30 23:38:15 +0000
@@ -8,7 +8,9 @@
 Bugs fixed in this release
 --------------------------
 
-LP: ##1677507   Fix potential IP allocation from incorrect range.
+LP: #1677507    Fix potential IP allocation from incorrect range.
+
+LP: #1674807    Fix missing default_gateways entry in machine API output.
 
 
 2.1.5
 
=== modified file 'src/maasserver/api/machines.py'
--- src/maasserver/api/machines.py	2016-12-09 07:07:02 +0000
+++ src/maasserver/api/machines.py	2017-03-30 23:38:15 +0000
@@ -125,6 +125,7 @@
     'node_type',
     'node_type_name',
     'special_filesystems',
+    'default_gateways',
 )
 
 # Limited set of machine fields exposed on the anonymous API.
@@ -185,6 +186,23 @@
         """The network interface which is used to boot over the network."""
         return machine.get_boot_interface()
 
+    @classmethod
+    def default_gateways(handler, machine):
+        """The default gateways that will be used for this machine."""
+        gateways = machine.get_default_gateways()
+        ipv4 = gateways.ipv4.gateway_ip if gateways.ipv4 is not None else None
+        ipv6 = gateways.ipv6.gateway_ip if gateways.ipv6 is not None else None
+        return {
+            "ipv4": {
+                "gateway_ip": ipv4,
+                "link_id": machine.gateway_link_ipv4_id,
+            },
+            "ipv6": {
+                "gateway_ip": ipv6,
+                "link_id": machine.gateway_link_ipv6_id,
+            }
+        }
+
     @admin_method
     def update(self, request, system_id):
         """Update a specific Machine.
 
=== modified file 'src/maasserver/api/tests/test_enlistment.py'
--- src/maasserver/api/tests/test_enlistment.py	2016-10-20 19:41:25 +0000
+++ src/maasserver/api/tests/test_enlistment.py	2017-03-30 23:38:15 +0000
@@ -493,6 +493,7 @@
         self.assertItemsEqual(
             [
                 'hostname',
+                'default_gateways',
                 'domain',
                 'fqdn',
                 'owner',
@@ -652,6 +653,7 @@
         self.assertItemsEqual(
             [
                 'hostname',
+                'default_gateways',
                 'domain',
                 'fqdn',
                 'owner',
 
=== modified file 'src/maasserver/api/tests/test_machine.py'
--- src/maasserver/api/tests/test_machine.py	2016-10-28 08:43:09 +0000
+++ src/maasserver/api/tests/test_machine.py	2017-03-30 23:38:15 +0000
@@ -1830,7 +1830,7 @@
                 "using status %d" % status)
 
 
-class TestClearDefaultGateways(APITestCase.ForUser):
+class TestDefaultGateways(APITestCase.ForUser):
 
     def get_machine_uri(self, machine):
         """Get the API URI for `machine`."""
@@ -1873,6 +1873,105 @@
         self.assertIsNone(machine.gateway_link_ipv4)
         self.assertIsNone(machine.gateway_link_ipv6)
 
+    def test__returns_null_gateway_if_no_explicit_gateway_exists(self):
+        machine = factory.make_Node(
+            owner=self.user, status=NODE_STATUS.ALLOCATED)
+        interface = factory.make_Interface(
+            INTERFACE_TYPE.PHYSICAL, node=machine)
+        network_v4 = factory.make_ipv4_network()
+        subnet_v4 = factory.make_Subnet(
+            cidr=str(network_v4.cidr), vlan=interface.vlan, gateway_ip=None)
+        factory.make_StaticIPAddress(
+            alloc_type=IPADDRESS_TYPE.AUTO, ip="",
+            subnet=subnet_v4, interface=interface)
+        network_v6 = factory.make_ipv6_network()
+        subnet_v6 = factory.make_Subnet(
+            cidr=str(network_v6.cidr), vlan=interface.vlan, gateway_ip=None)
+        factory.make_StaticIPAddress(
+            alloc_type=IPADDRESS_TYPE.AUTO, ip="",
+            subnet=subnet_v6, interface=interface)
+        response = self.client.get(self.get_machine_uri(machine))
+        self.assertEqual(
+            http.client.OK, response.status_code, response.content)
+        response = json_load_bytes(response.content)
+        self.assertThat(response['default_gateways'], Equals({
+            "ipv4": {
+                "link_id": None,
+                "gateway_ip": None,
+            },
+            "ipv6": {
+                "link_id": None,
+                "gateway_ip": None,
+            },
+        }))
+
+    def test__returns_effective_gateway_if_no_explicit_gateway_set(self):
+        machine = factory.make_Node(
+            owner=self.user, status=NODE_STATUS.ALLOCATED)
+        interface = factory.make_Interface(
+            INTERFACE_TYPE.PHYSICAL, node=machine)
+        network_v4 = factory.make_ipv4_network()
+        subnet_v4 = factory.make_Subnet(
+            cidr=str(network_v4.cidr), vlan=interface.vlan)
+        factory.make_StaticIPAddress(
+            alloc_type=IPADDRESS_TYPE.AUTO, ip="",
+            subnet=subnet_v4, interface=interface)
+        network_v6 = factory.make_ipv6_network()
+        subnet_v6 = factory.make_Subnet(
+            cidr=str(network_v6.cidr), vlan=interface.vlan)
+        factory.make_StaticIPAddress(
+            alloc_type=IPADDRESS_TYPE.AUTO, ip="",
+            subnet=subnet_v6, interface=interface)
+        response = self.client.get(self.get_machine_uri(machine))
+        self.assertEqual(
+            http.client.OK, response.status_code, response.content)
+        response = json_load_bytes(response.content)
+        self.assertThat(response['default_gateways'], Equals({
+            "ipv4": {
+                "link_id": None,
+                "gateway_ip": str(subnet_v4.gateway_ip),
+            },
+            "ipv6": {
+                "link_id": None,
+                "gateway_ip": str(subnet_v6.gateway_ip),
+            },
+        }))
+
+    def test__returns_links_if_set(self):
+        machine = factory.make_Node(
+            owner=self.user, status=NODE_STATUS.ALLOCATED)
+        interface = factory.make_Interface(
+            INTERFACE_TYPE.PHYSICAL, node=machine)
+        network_v4 = factory.make_ipv4_network()
+        subnet_v4 = factory.make_Subnet(
+            cidr=str(network_v4.cidr), vlan=interface.vlan)
+        link_v4 = factory.make_StaticIPAddress(
+            alloc_type=IPADDRESS_TYPE.AUTO, ip="",
+            subnet=subnet_v4, interface=interface)
+        machine.gateway_link_ipv4 = link_v4
+        network_v6 = factory.make_ipv6_network()
+        subnet_v6 = factory.make_Subnet(
+            cidr=str(network_v6.cidr), vlan=interface.vlan)
+        link_v6 = factory.make_StaticIPAddress(
+            alloc_type=IPADDRESS_TYPE.AUTO, ip="",
+            subnet=subnet_v6, interface=interface)
+        machine.gateway_link_ipv6 = link_v6
+        machine.save()
+        response = self.client.get(self.get_machine_uri(machine))
+        self.assertEqual(
+            http.client.OK, response.status_code, response.content)
+        response = json_load_bytes(response.content)
+        self.assertThat(response['default_gateways'], Equals({
+            "ipv4": {
+                "link_id": link_v4.id,
+                "gateway_ip": str(subnet_v4.gateway_ip),
+            },
+            "ipv6": {
+                "link_id": link_v6.id,
+                "gateway_ip": str(subnet_v6.gateway_ip),
+            },
+        }))
+
 
 class TestGetCurtinConfig(APITestCase.ForUser):