feat(api): add support for topics merge API

nejch · JohnVillalovos · commit 9a6d197f9d2a · 2022-10-14T10:18:29.000-07:00
diff --git a/docs/gl_objects/topics.rst b/docs/gl_objects/topics.rst
@@ -46,3 +46,7 @@ Delete a topic::
 
     # or
     gl.topics.delete(topic_id)
+
+Merge a source topic into a target topic::
+
+    gl.topics.merge(topic_id, target_topic_id)
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -221,6 +221,10 @@ class GitlabTodoError(GitlabOperationError):
     pass
 
 
+class GitlabTopicMergeError(GitlabOperationError):
+    pass
+
+
 class GitlabTimeTrackingError(GitlabOperationError):
     pass
 
diff --git a/gitlab/v4/objects/topics.py b/gitlab/v4/objects/topics.py
@@ -1,5 +1,7 @@
-from typing import Any, cast, Union
+from typing import Any, cast, Dict, TYPE_CHECKING, Union
 
+from gitlab import cli
+from gitlab import exceptions as exc
 from gitlab import types
 from gitlab.base import RESTManager, RESTObject
 from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
@@ -29,3 +31,39 @@ class TopicManager(CRUDMixin, RESTManager):
 
     def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Topic:
         return cast(Topic, super().get(id=id, lazy=lazy, **kwargs))
+
+    @cli.register_custom_action(
+        "TopicManager",
+        mandatory=("source_topic_id", "target_topic_id"),
+    )
+    @exc.on_http_error(exc.GitlabMRClosedError)
+    def merge(
+        self,
+        source_topic_id: Union[int, str],
+        target_topic_id: Union[int, str],
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """Merge two topics, assigning all projects to the target topic.
+
+        Args:
+            source_topic_id: ID of source project topic
+            target_topic_id: ID of target project topic
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabTopicMergeError: If the merge failed
+
+        Returns:
+            The merged topic data (*not* a RESTObject)
+        """
+        path = f"{self.path}/merge"
+        data = {
+            "source_topic_id": source_topic_id,
+            "target_topic_id": target_topic_id,
+        }
+
+        server_data = self.gitlab.http_post(path, post_data=data, **kwargs)
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
+        return server_data
diff --git a/tests/unit/objects/test_topics.py b/tests/unit/objects/test_topics.py
@@ -90,6 +90,19 @@ def resp_delete_topic(no_content):
         yield rsps
 
 
+@pytest.fixture
+def resp_merge_topics():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.POST,
+            url=f"{topics_url}/merge",
+            json=topic_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 def test_list_topics(gl, resp_list_topics):
     topics = gl.topics.list()
     assert isinstance(topics, list)
@@ -120,3 +133,8 @@ def test_update_topic(gl, resp_update_topic):
 def test_delete_topic(gl, resp_delete_topic):
     topic = gl.topics.get(1, lazy=True)
     topic.delete()
+
+
+def test_merge_topic(gl, resp_merge_topics):
+    topic = gl.topics.merge(123, 1)
+    assert topic["id"] == 1
