feat: new method dulicate_project to create a copy of an exisiting project

Author: t-graf

ChangeLog.md

@@ -1,5 +1,8 @@
 # SW360 Base Library for Python
 
+## 1.1.0
+* New method `dulicate_project` to create a copy of an exisiting project.
+
 ## 1.0.0
 * **New Features**:
   * `get_projects_by_tag` added.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sw360"
-version = "1.0.0"
+version = "1.1.0"
 description = "Python interface to the SW360 software component catalogue"
 authors = ["Thomas Graf <thomas.graf@siemens.com>",
 "Gernot Hillier <gernot.hillier@siemens.com>"]

sw360/__init__.py

@@ -7,6 +7,6 @@
 # SPDX-License-Identifier: MIT
 # -------------------------------------------------------------------------------
 
-__version__ = (1, 0, 0)
+__version__ = (1, 1, 0)
 
 from .sw360_api import SW360, SW360Error  # noqa: F401

sw360/sw360_api.py

@@ -576,6 +576,38 @@ def get_users_of_project(self, project_id):
         resp = self.api_get(self.url + "resource/api/projects/usedBy/" + project_id)
         return resp
 
+    def duplicate_project(self, project_id: str, new_version: str):
+        """Create a copy of an exisiting project.
+
+        API endpoint: GET /projects/duplicate/{id}
+
+        :param project_id: the id of the exisiting project
+        :type project_id: string
+        :param new_version: the version of the new project
+        :type new_version: string
+        :return: the newly created project
+        :rtype: JSON object
+        :raises SW360Error: if there is a negative HTTP response
+        """
+
+        if not project_id:
+            raise SW360Error(message="No project id provided!")
+
+        project_details = {}
+        project_details["version"] = new_version
+        # force clearing state to OPEN
+        project_details["clearingState"] = "OPEN"
+
+        url = self.url + "resource/api/projects/duplicate/" + project_id
+        response = requests.post(
+            url, json=project_details, headers=self.api_headers
+        )
+
+        if response.ok:
+            return response.json()
+
+        raise SW360Error(response, url)
+
     # ----- Releases ---------------------------------------------------------
 
     def get_release(self, release_id):

tests/test_sw360_projects.py

@@ -768,6 +768,60 @@ def test_get_users_of_project(self):
 
         lib.get_users_of_project("123")
 
+    @responses.activate
+    def test_duplicate_project(self):
+        lib = self.get_logged_in_lib()
+        responses.add(
+            responses.POST,
+            url=self.MYURL + "resource/api/projects/duplicate/007",
+            json={
+                # server returns complete project, here we only mock a part of it
+                'name': 'ExistingProduct',
+                'version': '42',
+                'clearingState': 'OPEN',
+                '_links': {
+                    'self': {
+                        'href': self.MYURL+'resource/api/projects/0206'
+                    }
+                },
+            },
+            match=[
+              responses.json_params_matcher({
+                "version": "42",
+                'clearingState': 'OPEN',
+              })
+            ]
+        )
+        result = lib.duplicate_project("007", "42")
+        self.assertIsNotNone(result)
+        self.assertTrue("clearingState" in result)
+        self.assertEqual("OPEN", result["clearingState"])
+        self.assertTrue("version" in result)
+        self.assertEqual("42", result["version"])
+
+    @responses.activate
+    def test_duplicate_project_no_id(self):
+        lib = self.get_logged_in_lib()
+
+        with self.assertRaises(SW360Error) as context:
+            lib.duplicate_project(None, "42")
+
+        self.assertEqual("No project id provided!", context.exception.message)
+
+    @responses.activate
+    def test_duplicate_project_failed(self):
+        lib = self.get_logged_in_lib()
+
+        responses.add(
+            responses.POST,
+            url=self.MYURL + "resource/api/projects/duplicate/123",
+            body="4",
+            status=404,
+        )
+
+        with self.assertRaises(SW360Error) as context:
+            lib.duplicate_project("123", "42")
+
 
 if __name__ == "__main__":
     unittest.main()