REST: Add filtering by labels to API

Patches in the API can be filtered by labels using the 'labels'
query parameter.

Author: fstachura

docs/api/schemas/latest/patchwork.yaml

@@ -578,6 +578,15 @@ paths:
           schema:
             title: ''
             type: string
+        - in: query
+          name: labels
+          description: |
+            List of labels assigned to queried patches, separated by ','.
+            If a label name begins with a '-', patches with that label won't
+            be included.
+          schema:
+            title: ''
+            type: string
       responses:
         '200':
           description: 'List of patches'

docs/api/schemas/patchwork.j2

@@ -596,6 +596,17 @@ paths:
           schema:
             title: ''
             type: string
+{% endif %}
+{% if version >= (1, 4) %}
+        - in: query
+          name: labels
+          description: |
+            List of labels assigned to queried patches, separated by ','.
+            If a label name begins with a '-', patches with that label won't
+            be included.
+          schema:
+            title: ''
+            type: string
 {% endif %}
       responses:
         '200':

docs/api/schemas/v1.4/patchwork.yaml

@@ -578,6 +578,15 @@ paths:
           schema:
             title: ''
             type: string
+        - in: query
+          name: labels
+          description: |
+            List of labels assigned to queried patches, separated by ','.
+            If a label name begins with a '-', patches with that label won't
+            be included.
+          schema:
+            title: ''
+            type: string
       responses:
         '200':
           description: 'List of patches'

patchwork/api/filters.py

@@ -175,6 +175,21 @@ def msgid_filter(queryset, name, value):
     return queryset.filter(**{name: '<' + value + '>'})
 
 
+def labels_filter(queryset, _, value):
+    label_names = value.split(',')
+
+    labels_pos, labels_neg = [], []
+    for label in label_names:
+        if not label.startswith('-'):
+            labels_pos.append(label)
+        else:
+            labels_neg.append(label[1:])
+
+    queryset = queryset.exclude_labels(labels_neg)
+    queryset = queryset.include_labels(labels_pos)
+    return queryset
+
+
 class CoverFilterSet(TimestampMixin, BaseFilterSet):
     project = ProjectFilter(queryset=Project.objects.all(), distinct=False)
     # NOTE(stephenfin): We disable the select-based HTML widgets for these
@@ -206,6 +221,7 @@ class PatchFilterSet(TimestampMixin, BaseFilterSet):
     state = StateFilter(queryset=State.objects.all(), distinct=False)
     hash = CharFilter(lookup_expr='iexact')
     msgid = CharFilter(method=msgid_filter)
+    labels = CharFilter(method=labels_filter)
 
     class Meta:
         model = Patch
@@ -225,6 +241,7 @@ class Meta:
         )
         versioned_fields = {
             '1.2': ('hash', 'msgid'),
+            '1.4': ('labels'),
         }
 
 

patchwork/tests/unit/api/test_patch.py

@@ -253,6 +253,94 @@ def test_list_filter_msgid(self):
         resp = self.client.get(self.api_url(), {'msgid': 'fishfish@fish.fish'})
         self.assertEqual(0, len(resp.data))
 
+    def test_list_filter_labels(self):
+        """Filter patches by labels."""
+        label1 = create_label()
+        label2 = create_label()
+        label3 = create_label()
+
+        person_obj = create_person(email='test@example.com')
+        project_obj = create_project(linkname='myproject')
+        state_obj = create_state(name='Under Review')
+        patch_kwargs = {
+            'state': state_obj,
+            'project': project_obj,
+            'submitter': person_obj,
+        }
+        patch_no_labels = create_patch(**patch_kwargs)
+        patch1 = create_patch(**patch_kwargs, labels=[label1])
+        patch2 = create_patch(**patch_kwargs, labels=[label1, label2])
+
+        resp = self.client.get(self.api_url(), {'labels': label1.name})
+        self.assertEqual([patch1.id, patch2.id], [x['id'] for x in resp.data])
+
+        resp = self.client.get(self.api_url(), {'labels': label3.name})
+        self.assertEqual(0, len(resp.data))
+
+        resp = self.client.get(self.api_url(), {'labels': '-' + label2.name})
+        self.assertEqual(
+            [patch_no_labels.id, patch1.id], [x['id'] for x in resp.data]
+        )
+
+        resp = self.client.get(
+            self.api_url(), {'labels': label1.name + ',' + label2.name}
+        )
+        self.assertEqual([patch2.id], [x['id'] for x in resp.data])
+
+    def test_list_filter_labels_local_global(self):
+        """Test filtering for patches with different labels, one local and
+        one global (without a project) that have the same name.
+        """
+        project_obj = create_project(linkname='myproject')
+        project_obj2 = create_project(linkname='myproject2')
+
+        label_local = create_label(name='label', project=project_obj)
+        label_local2 = create_label(name='label', project=project_obj2)
+        label_global = create_label(name='label', project=None)
+
+        person_obj = create_person(email='test@example.com')
+        state_obj = create_state(name='Under Review')
+        patch_kwargs = {
+            'state': state_obj,
+            'project': project_obj,
+            'submitter': person_obj,
+        }
+        patch_no_labels = create_patch(**patch_kwargs)
+        patch1 = create_patch(**patch_kwargs, labels=[label_local])
+        patch2 = create_patch(**patch_kwargs, labels=[label_global])
+        patch3 = create_patch(
+            **{'project': project_obj2, **patch_kwargs}, labels=[label_local2]
+        )
+
+        resp = self.client.get(self.api_url(), {'labels': 'label'})
+        self.assertEqual(
+            [patch1.id, patch2.id, patch3.id], [x['id'] for x in resp.data]
+        )
+
+        resp = self.client.get(self.api_url(), {'labels': '-label'})
+        self.assertEqual([patch_no_labels.id], [x['id'] for x in resp.data])
+
+    def test_list_filter_labels_case_insensitive(self):
+        """Test if filtering by label is case-insensitive."""
+        label = create_label(name='RFC')
+
+        person_obj = create_person(email='test@example.com')
+        project_obj = create_project(linkname='myproject')
+        state_obj = create_state(name='Under Review')
+        patch_kwargs = {
+            'state': state_obj,
+            'project': project_obj,
+            'submitter': person_obj,
+        }
+        create_patch(**patch_kwargs)
+        patch1 = create_patch(**patch_kwargs, labels=[label])
+
+        resp = self.client.get(self.api_url(), {'labels': 'RFC'})
+        self.assertEqual([patch1.id], [x['id'] for x in resp.data])
+
+        resp = self.client.get(self.api_url(), {'labels': 'rfc'})
+        self.assertEqual([patch1.id], [x['id'] for x in resp.data])
+
     @utils.store_samples('patch-list-1-0')
     def test_list_version_1_0(self):
         """List patches using API v1.0."""