Merge lp:~mpontillo/maas/list-connected-macs-2.0 into lp:~maas-committers/maas/trunk

[Mike Pontillo]

Add backward compatability API to list the connected MACs on a subnet (optionally by VLAN).

Note: this branch is pretty much the 1.9 version of list_connected_macs, ported to Python 3 and adjusted for the changes in the API test case.

The only difference is, the new API allows the user to select whether they want to list connected MACs by IP addresses assigned to the subnet (the default) or by checking which IP addresses are assigned to subnet's associated VLAN. (the MAAS 1.8 behavior was a little like both options, and this API is just a convenience for backward compatibility; the new API offers the same data, but it would take several steps to obtain and filter.)

[MAAS Lander (maas-lander)]

Transitioned to Git.

lp:maas has now moved from Bzr to Git.
Please propose your branches with Launchpad using Git.

git clone https://git.launchpad.net/maas

Unmerged revisions

5078. By Mike Pontillo on 2016-06-06

Add backward compatability API to list the connected MACs on a subnet (optionally by VLAN).

=== modified file 'src/maasserver/api/subnets.py'
--- src/maasserver/api/subnets.py	2016-04-27 20:40:24 +0000
+++ src/maasserver/api/subnets.py	2016-06-06 20:00:55 +0000
@@ -13,7 +13,11 @@
 from maasserver.enum import NODE_PERMISSION
 from maasserver.exceptions import MAASAPIValidationError
 from maasserver.forms_subnet import SubnetForm
-from maasserver.models import Subnet
+from maasserver.models import (
+    Interface,
+    Node,
+    Subnet,
+)
 from piston3.utils import rc
 from provisioningserver.utils.network import IPRangeStatistics
 
@@ -224,3 +228,43 @@
             request.GET, 'with_node_summary', True, validator=StringBool)
         return subnet.render_json_for_related_ips(
             with_username=with_username, with_node_summary=with_node_summary)
+
+    @operation(idempotent=True)
+    def list_connected_macs(self, request, subnet_id):
+        """Returns the list of MAC addresses connected to this network.
+
+        Only MAC addresses for nodes visible to the requesting user are
+        returned.
+
+        :param by_vlan: Optional boolean to indicate that the MACs should be
+            found via the VLAN attached to the subnet, not using assigned IP
+            addresses on the subnet. (Finding the MACs using assigned IP
+            addresses is the default.)
+        :type by_vlan: bool
+        """
+        subnet = Subnet.objects.get_object_by_specifiers_or_raise(subnet_id)
+        by_vlan = get_optional_param(
+            request.GET, 'by_vlan', default=False, validator=StringBool)
+        visible_nodes = Node.objects.get_nodes(
+            request.user, NODE_PERMISSION.VIEW,
+            from_nodes=Node.objects.all())
+        if by_vlan:
+            interfaces = Interface.objects.filter(
+                node__in=visible_nodes, vlan__subnet=subnet)
+        else:
+            interfaces = Interface.objects.filter(
+                node__in=visible_nodes, ip_addresses__subnet=subnet)
+        existing_macs = set()
+        unique_interfaces_by_mac = [
+            interface
+            for interface in interfaces
+            if (interface.mac_address not in existing_macs and
+                not existing_macs.add(interface.mac_address))
+        ]
+        unique_interfaces_by_mac = sorted(
+            unique_interfaces_by_mac,
+            key=lambda x: (x.node.hostname.lower(), x.mac_address.get_raw()))
+        return [
+            {"mac_address": str(interface.mac_address)}
+            for interface in unique_interfaces_by_mac
+        ]
 
=== modified file 'src/maasserver/api/tests/test_subnets.py'
--- src/maasserver/api/tests/test_subnets.py	2016-05-24 21:29:53 +0000
+++ src/maasserver/api/tests/test_subnets.py	2016-06-06 20:00:55 +0000
@@ -12,6 +12,7 @@
 from django.conf import settings
 from django.core.urlresolvers import reverse
 from maasserver.enum import (
+    INTERFACE_TYPE,
     IPADDRESS_TYPE,
     IPRANGE_TYPE,
     NODE_STATUS,
@@ -620,3 +621,123 @@
         expected_result = subnet.render_json_for_related_ips(
             with_username=True, with_node_summary=False)
         self.assertThat(result, Equals(expected_result))
+
+
+class TestListConnectedMACs(APITestCase.ForUser):
+
+    def make_interface(
+            self, subnets=None, owner=None, node=None, with_ip=True):
+        """Create a Interface.
+
+        :param subnets: Optional list of `Subnet` objects to connect the
+            interface to.  If omitted, the interface will not be connected to
+            any subnets.
+        :param node: Optional node that will have this interface.
+            If omitted, one will be created.
+        :param owner: Optional owner for the node that will have this MAC
+            address.  If omitted, one will be created.  The node will be in
+            the "allocated" state.  This parameter is ignored if a node is
+            provided.
+        :param with_ip: if True, creates an IP address on the interface. If
+            False, simply associates the Interface with the VLAN.
+        """
+        if subnets is None:
+            subnets = []
+        if owner is None:
+            owner = factory.make_User()
+        if node is None:
+            node = factory.make_Node(status=NODE_STATUS.ALLOCATED, owner=owner)
+        interface = factory.make_Interface(INTERFACE_TYPE.PHYSICAL, node=node)
+        if with_ip:
+            for subnet in subnets:
+                factory.make_StaticIPAddress(
+                    alloc_type=IPADDRESS_TYPE.DHCP, ip="",
+                    subnet=subnet, interface=interface)
+        else:
+            interface.vlan = subnets[0].vlan
+            interface.save()
+        return interface
+
+    def request_connected_macs(self, subnet, by_vlan=False):
+        """Request and return the MAC addresses attached to `subnet`.
+
+        :param by_vlan: If True, finds all MACs associated with the VLAN,
+            not just those with an IP address on the specified subnet.
+        """
+        url = reverse(
+            'subnet_handler', args=[str(subnet.cidr)])
+        response = self.client.get(url, {
+            'op': 'list_connected_macs',
+            'by_vlan': str(by_vlan),
+        })
+        self.assertEqual(http.client.OK, response.status_code)
+        return json.loads(response.content.decode(settings.DEFAULT_CHARSET))
+
+    def extract_macs(self, returned_macs):
+        """Extract the textual MAC addresses from an API response."""
+        return [item['mac_address'] for item in returned_macs]
+
+    def test_returns_connected_macs(self):
+        subnet = factory.make_Subnet()
+        interfaces = [
+            self.make_interface(subnets=[subnet], owner=self.user)
+            for _ in range(3)
+            ]
+        self.assertEqual(
+            {interface.mac_address for interface in interfaces},
+            set(self.extract_macs(self.request_connected_macs(subnet))))
+
+    def test_returns_connected_macs_by_vlan(self):
+        subnet = factory.make_Subnet()
+        interfaces = [
+            self.make_interface(
+                subnets=[subnet], owner=self.user, with_ip=False)
+            for _ in range(3)
+            ]
+        self.assertEqual(
+            {interface.mac_address for interface in interfaces},
+            set(self.extract_macs(self.request_connected_macs(
+                subnet, by_vlan=True))))
+
+    def test_ignores_unconnected_macs(self):
+        self.make_interface(
+            subnets=[factory.make_Subnet()], owner=self.user)
+        self.make_interface(subnets=[], owner=self.user)
+        self.assertEqual(
+            [],
+            self.request_connected_macs(factory.make_Subnet()))
+
+    def test_includes_MACs_for_nodes_visible_to_user(self):
+        subnet = factory.make_Subnet()
+        interface = self.make_interface(
+            subnets=[subnet], owner=self.user)
+        self.assertEqual(
+            [interface.mac_address],
+            self.extract_macs(self.request_connected_macs(subnet)))
+
+    def test_excludes_MACs_for_nodes_not_visible_to_user(self):
+        subnet = factory.make_Subnet()
+        self.make_interface(subnets=[subnet])
+        self.assertEqual([], self.request_connected_macs(subnet))
+
+    def test_returns_sorted_MACs(self):
+        subnet = factory.make_Subnet()
+        interfaces = [
+            self.make_interface(
+                subnets=[subnet], node=factory.make_Node(sortable_name=True),
+                owner=self.user)
+            for _ in range(4)
+            ]
+        # Create MACs connected to the same node.
+        interfaces = interfaces + [
+            self.make_interface(
+                subnets=[subnet], owner=self.user,
+                node=interfaces[0].node)
+            for _ in range(3)
+            ]
+        sorted_interfaces = sorted(
+            interfaces,
+            key=lambda x: (x.node.hostname.lower(), x.mac_address.get_raw()))
+        self.assertEqual(
+            [nic.mac_address.get_raw() for nic in sorted_interfaces],
+            self.extract_macs(self.request_connected_macs(subnet)))