Merge lp:~tribaal/maas/api-list-nodes-filter-by-hostname into lp:~maas-committers/maas/trunk

[Chris Glass]

Add a 'hostname' parameter to the list nodes API call. The parameter should
be a list of hostnames to filter nodes by, similar to the already existing
'mac_address' parameter.

This branch adds a "hostname" parameter (a list) to the list nodes API call.

It behaves in a similar fashion to the "mac_address" parameter in that it acts as a filter for the list of nodes returned. We need it because in our current situation it is much more convenient for us to filter by hostnames instead of Mac addresses (which we would like to remain "random").

The linked bug was edited to cover the more general case of treating an invalid filter as an error instead of an absence of filters, but we are less interested in that functionality right now.

As I am not 100% familiar with your development process, please do not hesitate to tell me what other steps I should take to make this land :)

[Gavin Panella (allenap)]

Looks good to me, thanks for this.

review: Approve

=== modified file 'src/maasserver/api.py'
--- src/maasserver/api.py	2013-10-24 23:24:16 +0000
+++ src/maasserver/api.py	2013-11-12 10:36:35 +0000
@@ -734,6 +734,9 @@
     def list(self, request):
         """List Nodes visible to the user, optionally filtered by criteria.
 
+        :param hostname: An optional list of hostnames.  Only nodes with
+            matching hostnames will be returned.
+        :type hostname: iterable
         :param mac_address: An optional list of MAC addresses.  Only
             nodes with matching MAC addresses will be returned.
         :type mac_address: iterable
@@ -758,6 +761,9 @@
             request.user, NODE_PERMISSION.VIEW, ids=match_ids)
         if match_macs is not None:
             nodes = nodes.filter(macaddress__mac_address__in=match_macs)
+        match_hostnames = get_optional_list(request.GET, 'hostname')
+        if match_hostnames is not None:
+            nodes = nodes.filter(hostname__in=match_hostnames)
         match_agent_name = request.GET.get('agent_name', None)
         if match_agent_name is not None:
             nodes = nodes.filter(agent_name=match_agent_name)

=== modified file 'src/maasserver/tests/test_api_nodes.py'
--- src/maasserver/tests/test_api_nodes.py	2013-10-18 16:57:37 +0000
+++ src/maasserver/tests/test_api_nodes.py	2013-11-12 10:36:35 +0000
@@ -275,8 +275,22 @@
         self.assertItemsEqual(
             [existing_id], extract_system_ids(parsed_result))
 
+    def test_GET_list_with_hostname_returns_matching_nodes(self):
+        # The list operation takes optional "hostname" parameters. Only nodes
+        # with matching hostnames will be returned.
+        nodes = [factory.make_node() for counter in range(3)]
+        matching_hostname = nodes[0].hostname
+        matching_system_id = nodes[0].system_id
+        response = self.client.get(self.get_uri('nodes/'), {
+            'op': 'list',
+            'hostname': [matching_hostname],
+        })
+        parsed_result = json.loads(response.content)
+        self.assertItemsEqual(
+            [matching_system_id], extract_system_ids(parsed_result))
+
     def test_GET_list_with_macs_returns_matching_nodes(self):
-        # The "list" operation takes optional "mac_address" parameters.  Only
+        # The "list" operation takes optional "mac_address" parameters. Only
         # nodes with matching MAC addresses will be returned.
         macs = [factory.make_mac_address() for counter in range(3)]
         matching_mac = macs[0].mac_address