REST: Add modifying patch labels to API

Author: fstachura

docs/api/schemas/latest/patchwork.yaml

@@ -2404,6 +2404,11 @@ components:
           type: array
           items:
             type: integer
+        labels:
+          title: Labels
+          type: array
+          items:
+            type: string
     Person:
       type: object
       title: Person

docs/api/schemas/patchwork.j2

@@ -2495,6 +2495,13 @@ components:
           type: array
           items:
             type: integer
+{% endif %}
+{% if version >= (1, 4) %}
+        labels:
+          title: Labels
+          type: array
+          items:
+            type: string
 {% endif %}
     Person:
       type: object

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

@@ -2404,6 +2404,11 @@ components:
           type: array
           items:
             type: integer
+        labels:
+          title: Labels
+          type: array
+          items:
+            type: string
     Person:
       type: object
       title: Person

patchwork/api/patch.py

@@ -18,7 +18,7 @@
 from rest_framework.reverse import reverse
 from rest_framework.serializers import SerializerMethodField
 from rest_framework import status
-from rest_framework.serializers import StringRelatedField
+from rest_framework.serializers import SlugRelatedField
 
 from patchwork.api.base import BaseHyperlinkedModelSerializer
 from patchwork.api.base import LinkHeaderPagination
@@ -31,6 +31,7 @@
 from patchwork.api.filters import PatchFilterSet
 from patchwork.models import Patch
 from patchwork.models import PatchRelation
+from patchwork.models import Label
 from patchwork.models import State
 from patchwork.parser import clean_subject
 
@@ -78,6 +79,12 @@ class PatchConflict(APIException):
     )
 
 
+class LabelsField(SlugRelatedField):
+    def get_queryset(self):
+        project = self.parent.parent.instance.project
+        return Label.get_project_labels(project)
+
+
 class PatchListSerializer(BaseHyperlinkedModelSerializer):
     web_url = SerializerMethodField()
     project = ProjectSerializer(read_only=True)
@@ -96,7 +103,7 @@ class PatchListSerializer(BaseHyperlinkedModelSerializer):
         default=[],
         style={'base_template': 'input.html'},
     )
-    labels = StringRelatedField(many=True)
+    labels = LabelsField(many=True, slug_field='name')
 
     def get_web_url(self, instance):
         request = self.context.get('request')
@@ -198,7 +205,6 @@ class Meta:
             'check',
             'checks',
             'tags',
-            'labels',
         )
         versioned_fields = {
             '1.1': ('comments', 'web_url'),

patchwork/tests/unit/api/test_patch.py

@@ -529,6 +529,49 @@ def test_update_maintainer_version_1_0(self):
         self.assertEqual(Patch.objects.get(id=patch.id).state, state)
         self.assertEqual(Patch.objects.get(id=patch.id).delegate, user)
 
+    def test_update_labels(self):
+        """Update labels as maintainer."""
+        project = create_project()
+        project2 = create_project()
+        label1 = create_label(name='label', project=project)
+        label2 = create_label(name='label2')
+        label_p2 = create_label(name='label_p2', project=project2)
+        label1_global = create_label(name='label', project=None)
+        patch = create_patch(project=project, labels=[label1_global])
+        user = create_maintainer(project)
+
+        # Test adding labels labels, make sure local labels are prioritized
+
+        self.client.authenticate(user=user)
+        resp = self.client.patch(
+            self.api_url(patch.id), {'labels': [label1.name, label2.name]}
+        )
+        self.assertEqual(status.HTTP_200_OK, resp.status_code, resp)
+        self.assertEqual(
+            sorted(
+                Patch.objects.get(id=patch.id).labels.values_list(
+                    'id', flat=True
+                )
+            ),
+            sorted([label1.id, label2.id]),
+        )
+
+        # Test removing labels
+
+        self.client.authenticate(user=user)
+        resp = self.client.patch(self.api_url(patch.id), {'labels': []})
+        self.assertEqual(status.HTTP_200_OK, resp.status_code, resp)
+        self.assertEqual(Patch.objects.get(id=patch.id).labels.count(), 0)
+
+        # Make sure labels from other projects cannot be added
+
+        self.client.authenticate(user=user)
+        resp = self.client.patch(
+            self.api_url(patch.id), {'labels': [label1.name, label_p2.name]}
+        )
+        self.assertEqual(status.HTTP_400_BAD_REQUEST, resp.status_code, resp)
+        self.assertEqual(Patch.objects.get(id=patch.id).labels.count(), 0)
+
     @utils.store_samples('patch-update-error-bad-request')
     def test_update_invalid_state(self):
         """Update patch with invalid fields.