Merge pull request #3288 from SEED-platform/3287-add-label-names-to-filter

add label_names filter to properties/labels

Author: anchapin

seed/tests/test_labels_api_views.py

@@ -7,7 +7,6 @@
 Unit tests for seed/views/labels.py
 """
 
-import json
 from collections import defaultdict
 from datetime import datetime
 
@@ -149,35 +148,55 @@ def test_labels_inventory_specific_filter_endpoint_provides_IDs_for_records_wher
 
         # Ensures that at least a single label exists to ensure that we are not
         # relying on auto-creation of labels for this test to pass.
-        new_label = Label.objects.create(
+        new_label_1 = Label.objects.create(
             color="red",
             name="test_label-a",
             super_organization=organization_a,
         )
+        new_label_2 = Label.objects.create(
+            color="blue",
+            name="test_label-b",
+            super_organization=organization_a,
+        )
 
         # Create 2 properties and 2 tax lots. Then, apply that label to one of each
         property_view_factory = FakePropertyViewFactory(organization=organization_a, user=user)
         p_view_1 = property_view_factory.get_property_view()
-        p_view_1.labels.add(new_label)
+        p_view_1.labels.add(new_label_1)
+        p_view_2 = property_view_factory.get_property_view()
+        p_view_2.labels.add(new_label_1)
+        p_view_2.labels.add(new_label_2)
+
+        # create more random properties
+        property_view_factory.get_property_view()
         property_view_factory.get_property_view()
 
         taxlot_view_factory = FakeTaxLotViewFactory(organization=organization_a, user=user)
         tl_view_1 = taxlot_view_factory.get_taxlot_view()
-        tl_view_1.labels.add(new_label)
+        tl_view_1.labels.add(new_label_1)
+        # more random tax lotx
         taxlot_view_factory.get_taxlot_view()
 
         client = APIClient()
         client.login(username=user.username, password='secret')
 
         url = reverse('api:v3:properties-labels')
-        response_a = client.post(url + '?organization_id={}'.format(organization_a.pk))
-        data = json.loads(response_a.content)
-
+        response_a = client.post(url + f'?organization_id={organization_a.pk}')
+        data = response_a.json()
         for label in data:
-            if label.get('name') != 'test_label-a':
-                self.assertCountEqual(label.get('is_applied'), [])
+            if label.get('name') == 'test_label-a':
+                self.assertListEqual(label.get('is_applied'), [p_view_1.id, p_view_2.id])
+            elif label.get('name') == 'test_label-b':
+                self.assertCountEqual(label.get('is_applied'), [p_view_2.id])
             else:
-                self.assertCountEqual(label.get('is_applied'), [p_view_1.id])
+                self.assertCountEqual(label.get('is_applied'), [])
+
+        # check if we can filter to only label_2 and on p_view 2
+        response_b = client.post(url + f'?organization_id={organization_a.pk}', data={'selected': [p_view_2.id], 'label_names': [new_label_1.name]})
+        data = response_b.json()
+        self.assertEqual(len(data), 1)
+        self.assertEqual(data[0].get('name'), new_label_1.name)
+        self.assertListEqual(data[0].get('is_applied'), [p_view_2.id])
 
 
 class TestUpdateInventoryLabelsAPIView(DeleteModelsTestCase):

seed/views/v3/properties.py

@@ -188,8 +188,10 @@ def _move_relationships(self, old_state, new_state):
         request_body=AutoSchemaHelper.schema_factory(
             {
                 'selected': ['integer'],
+                'label_names': ['string'],
             },
-            description='IDs for properties to be checked for which labels are applied.'
+            description='- selected: Property View IDs to be checked for which labels are applied\n'
+                        '- label_names: list of label names to query'
         )
     )
     @has_perm_class('requires_viewer')
@@ -199,12 +201,25 @@ def labels(self, request):
         Returns a list of all labels where the is_applied field
         in the response pertains to the labels applied to property_view
         """
-        labels = Label.objects.filter(
-            super_organization=self.get_parent_org(self.request)
-        ).order_by("name").distinct()
-        super_organization = self.get_organization(request)
+        # labels are attached to the organization, but newly created ones in a suborg are
+        # part of the suborg.  A parent org's label should not be a factor of the current orgs labels,
+        # but that isn't the current state of the system. This needs to be reworked when
+        # we deal with accountability hierarchies.
+        # organization = self.get_organization(request)
+        super_organization = self.get_parent_org(request)
+
+        labels_qs = Label.objects.filter(
+            super_organization=super_organization
+        ).order_by('name').distinct()
+
+        # if labels names is passes, then get only those labels
+        if request.data.get('label_names', None):
+            labels_qs = labels_qs.filter(
+                name__in=request.data.get('label_names')
+            ).order_by('name')
+
         # TODO: refactor to avoid passing request here
-        return get_labels(request, labels, super_organization, 'property_view')
+        return get_labels(request, labels_qs, super_organization, 'property_view')
 
     @swagger_auto_schema(
         manual_parameters=[AutoSchemaHelper.query_org_id_field(required=True)],