Merge pull request #13 from heliocastro/add_license

Create and Update licenses

Author: tngraf

sw360/license.py

@@ -9,12 +9,81 @@
 # SPDX-License-Identifier: MIT
 # -------------------------------------------------------------------------------
 
+from typing import Any
+
 import requests
 
+from .sw360error import SW360Error
+
 
 class LicenseMixin:
-    def download_license_info(self, project_id, filename, generator="XhtmlGenerator",
-                              variant="DISCLOSURE"):
+    def create_new_license(
+        self,
+        shortName: str,
+        fullName: str,
+        text: str,
+        checked: False,
+        license_details={},
+    ) -> Any:
+        """Create a new component
+
+        API endpoint: POST /licenses
+
+        :param shortName: short license name. i.e "MIT"
+        :param fullName: descriptive license name
+        :param text: license text
+        :param checked: if license is checked
+        :type shortname: string
+        :type fullname: string
+        :type text: string
+        :type checked: bool
+        :return: SW360 result
+        :rtype: JSON SW360 result object
+        :raises SW360Error: if there is a negative HTTP response
+        """
+
+        url = self.url + "resource/api/licenses"
+
+        license_details["shortName"] = shortName
+        license_details["fullName"] = fullName
+        license_details["text"] = text
+        license_details["checked"] = checked
+
+        response = requests.post(url, json=license_details, headers=self.api_headers)
+        if response.ok:
+            return response.json()
+
+        raise SW360Error(response, url)
+
+    def delete_license(self, license_shortname):
+        """Delete an existing license
+
+        API endpoint: PATCH /licenses
+
+        :param license_shortname: license shortname as the id
+        :type license_shortname: string
+        :return: SW360 result
+        :rtype: JSON SW360 result object
+        :raises SW360Error: if there is a negative HTTP response
+        """
+
+        if not license_shortname:
+            raise SW360Error(message="No license shortname provided!")
+
+        url = self.url + "resource/api/licenses/" + license_shortname
+        print(url)
+        response = requests.delete(
+            url, headers=self.api_headers,
+        )
+
+        if response.ok:
+            return True
+
+        raise SW360Error(response, url)
+
+    def download_license_info(
+        self, project_id, filename, generator="XhtmlGenerator", variant="DISCLOSURE"
+    ):
         """Gets the license information, aka Readme_OSS for the project
         with the given id
 
@@ -27,8 +96,15 @@ def download_license_info(self, project_id, filename, generator="XhtmlGenerator"
         """
         hdr = self.api_headers.copy()
         hdr["Accept"] = "application/*"
-        url = self.url + "resource/api/projects/" + project_id + \
-            "/licenseinfo?generatorClassName=" + generator + "&variant=" + variant
+        url = (
+            self.url
+            + "resource/api/projects/"
+            + project_id
+            + "/licenseinfo?generatorClassName="
+            + generator
+            + "&variant="
+            + variant
+        )
         req = requests.get(url, allow_redirects=True, headers=hdr)
         open(filename, "wb").write(req.content)
 

tests/test_sw360_licenses.py

@@ -13,9 +13,9 @@
 
 import responses
 
-sys.path.insert(1, "..")
+from sw360 import SW360, SW360Error
 
-from sw360 import SW360  # noqa: E402
+sys.path.insert(1, "..")
 
 
 class Sw360TestLicenses(unittest.TestCase):
@@ -123,6 +123,93 @@ def test_get_license(self):
         self.assertEqual("Apache-2.0", license["shortName"])
         self.assertEqual("Apache License 2.0", license["fullName"])
 
+    @responses.activate
+    def test_create_new_license(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            responses.POST,
+            url=f"{self.MYURL}resource/api/licenses",
+            status=201,
+            json={
+                # server returns full license, here we only mock a part of it
+                'shortName': 'LGPL-2.0-only',
+                'fullName': 'GNU Library General Public License v2 only',
+                'checked': True,
+                '_links': {
+                    'self': {
+                        'href': f"{self.MYURL}resource/api/licenses/LGPL-2.0-only"
+                    }
+                }
+            },
+            match=[responses.json_params_matcher({
+                "shortName": "LGPL-2.0-only",
+                "fullName": "GNU Library General Public License v2 only",
+                "checked": True,
+                "text": ""})]
+        )
+        lib.create_new_license(
+            shortName="LGPL-2.0-only",
+            fullName="GNU Library General Public License v2 only",
+            text="",
+            checked=True,
+        )
+
+    @responses.activate
+    def test_create_new_license_fail(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            responses.POST,
+            url=f"{self.MYURL}resource/api/licenses",
+            status=403,
+            json={
+                # server returns full license, here we only mock a part of it
+                'shortName': 'LGPL-2.0-only',
+                'fullName': 'GNU Library General Public License v2 only',
+                'checked': True,
+                '_links': {
+                    'self': {
+                        'href': f"{self.MYURL}resource/api/licenses/LGPL-2.0-only"
+                    }
+                }
+            },
+            match=[responses.json_params_matcher({
+                "shortName": "LGPL-2.0-only",
+                "fullName": "GNU Library General Public License v2 only",
+                "checked": True,
+                "text": ""})]
+        )
+
+        with self.assertRaises(SW360Error) as context:
+            lib.create_new_license(
+                shortName="LGPL-2.0-only",
+                fullName="GNU Library General Public License v2 only",
+                text="",
+                checked=True,
+            )
+        self.assertEqual(403, context.exception.response.status_code)
+
+    @responses.activate
+    def test_delete_license(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            responses.DELETE,
+            url=self.MYURL + "resource/api/licenses/LGPL-2.0-only",
+            status=201)
+
+        lib.delete_license("LGPL-2.0-only")
+
 
 if __name__ == "__main__":
     unittest.main()