feat(api): add project label promotion

StingRayZA · StingRayZA · commit 76715a52ed21 · 2021-09-29T10:25:43.000+01:00
Adds a mixin that allows the /promote endpoint to be called.

Signed-off-by: Raimund Hook &lt;raimund.hook@exfo.com&gt;
diff --git a/docs/gl_objects/labels.rst b/docs/gl_objects/labels.rst
@@ -36,6 +36,10 @@ Update a label for a project::
     label.color = '#112233'
     label.save()
 
+Promote a project label to a group label::
+
+    label.promote()
+
 Delete a label for a project::
 
     project.labels.delete(label_id)
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -111,6 +111,10 @@ class GitlabProjectDeployKeyError(GitlabOperationError):
     pass
 
 
+class GitlabPromoteError(GitlabOperationError):
+    pass
+
+
 class GitlabCancelError(GitlabOperationError):
     pass
 
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -926,3 +926,50 @@ def render(self, link_url: str, image_url: str, **kwargs: Any) -> Dict[str, Any]
         if TYPE_CHECKING:
             assert not isinstance(result, requests.Response)
         return result
+
+
+class PromoteMixin(_RestObjectBase):
+    _id_attr: Optional[str]
+    _attrs: Dict[str, Any]
+    _module: ModuleType
+    _parent_attrs: Dict[str, Any]
+    _updated_attrs: Dict[str, Any]
+    _update_uses_post: bool = False
+    manager: base.RESTManager
+
+    def _get_update_method(
+        self,
+    ) -> Callable[..., Union[Dict[str, Any], requests.Response]]:
+        """Return the HTTP method to use.
+
+        Returns:
+            object: http_put (default) or http_post
+        """
+        if self._update_uses_post:
+            http_method = self.manager.gitlab.http_post
+        else:
+            http_method = self.manager.gitlab.http_put
+        return http_method
+
+    @exc.on_http_error(exc.GitlabPromoteError)
+    def promote(self, **kwargs: Any) -> Dict[str, Any]:
+        """Promote the item.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabHttpError: When the return code is not 2xx
+            GitlabParsingError: If the json data could not be parsed
+
+        Returns:
+            dict: The updated object data (*not* a RESTObject)
+        """
+
+        path = "%s/%s/promote" % (self.manager.path, self.id)
+        http_method = self._get_update_method()
+        result = http_method(path, **kwargs)
+        if TYPE_CHECKING:
+            assert not isinstance(result, requests.Response)
+        return result
diff --git a/gitlab/v4/objects/labels.py b/gitlab/v4/objects/labels.py
@@ -5,6 +5,7 @@
     DeleteMixin,
     ListMixin,
     ObjectDeleteMixin,
+    PromoteMixin,
     RetrieveMixin,
     SaveMixin,
     SubscribableMixin,
@@ -83,7 +84,9 @@ def delete(self, name, **kwargs):
         self.gitlab.http_delete(self.path, query_data={"name": name}, **kwargs)
 
 
-class ProjectLabel(SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
+class ProjectLabel(
+    PromoteMixin, SubscribableMixin, SaveMixin, ObjectDeleteMixin, RESTObject
+):
     _id_attr = "name"
 
     # Update without ID, but we need an ID to get from list.
diff --git a/tests/functional/api/test_projects.py b/tests/functional/api/test_projects.py
@@ -159,6 +159,25 @@ def test_project_labels(project):
     assert len(project.labels.list()) == 0
 
 
+def test_project_label_promotion(gl, groupproject):
+    """
+    Label promotion requires the project to be a child of a group (not in a user namespace)
+
+    """
+    promotedlabel = groupproject.labels.create(
+        {"name": "promoteme", "color": "#112233"}
+    )
+    promotedlabel.promote()
+
+    group = gl.groups.get(groupproject.namespace["id"])
+
+    grouplabels = group.labels.list()
+    assert len(grouplabels) == 1
+
+    group.labels.delete("promoteme")
+    assert len(group.labels.list()) == 0
+
+
 def test_project_milestones(project):
     milestone = project.milestones.create({"title": "milestone1"})
     assert len(project.milestones.list()) == 1
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
@@ -228,6 +228,28 @@ def project(gl):
         print(f"Project already deleted: {e}")
 
 
+@pytest.fixture(scope="module")
+def groupproject(gl):
+    """Project fixture for project API resource tests that need a group/project hierarchy."""
+    _id = uuid.uuid4().hex
+    data = {
+        "name": f"test-group-{_id}",
+        "path": f"group-{_id}",
+    }
+    group = gl.groups.create(data)
+
+    projectname = f"test-project-{_id}"
+
+    project = gl.projects.create(name=projectname, namespace_id=group.id)
+
+    yield project
+
+    try:
+        group.delete()
+    except gitlab.exceptions.GitlabDeleteError as e:
+        print(f"Group already deleted: {e}")
+
+
 @pytest.fixture(scope="function")
 def merge_request(project, wait_for_sidekiq):
     """Fixture used to create a merge_request.
