feat added get_projects_by_tag, get_releases_by_name, and get_all_vendors

Author: t-graf

sw360/sw360_api.py

@@ -330,7 +330,7 @@ def get_projects_by_external_id(self, ext_id_name, ext_id_value=""):
     def get_projects_by_group(self, group, all_details=False):
         """Get projects by group.
 
-        API endpoint: GET /projects
+        API endpoint: GET /projects?group=
 
         :param group: the group the projects shall belong to
         :type group: string
@@ -349,6 +349,25 @@ def get_projects_by_group(self, group, all_details=False):
         resp = resp["_embedded"]["sw360:projects"]
         return resp
 
+    def get_projects_by_tag(self, tag):
+        """Get projects by tag.
+
+        API endpoint: GET /projects?tag=
+
+        :param group: the group the projects shall belong to
+        :type group: string
+        :return: list of projects
+        :rtype: list of JSON project objects
+        :raises SW360Error: if there is a negative HTTP response
+        """
+        full_url = self.url + "resource/api/projects?tag=" + tag
+        resp = self.api_get(full_url)
+        if not resp:
+            return None
+
+        resp = resp["_embedded"]["sw360:projects"]
+        return resp
+
     def download_license_info(self, project_id, filename, generator="XhtmlGenerator",
                               variant="DISCLOSURE"):
         """Gets the license information, aka Readme_OSS for the project
@@ -587,6 +606,23 @@ def get_release_by_url(self, release_url):
         resp = self.api_get(release_url)
         return resp
 
+    def get_releases_by_name(self, name):
+        """Gets a list of releases that match the given name.
+
+        API endpoint: GET /releases?name=
+
+        :param name: the name
+        :type name: string
+        :return: list of releases
+        :rtype: list of JSON release objects
+        :raises SW360Error: if there is a negative HTTP response
+        """
+        full_url = self.url + "resource/api/releases?name=" + name
+        resp = self.api_get(full_url)
+        if resp and ("_embedded" in resp) and ("sw360:releases" in resp["_embedded"]):
+            resp = resp["_embedded"]["sw360:releases"]
+        return resp
+
     def get_all_releases(self, fields=None, all_details=False):
         """Get information of about all releases
 
@@ -919,9 +955,9 @@ def update_component(self, component, component_id):
 
         API endpoint: PATCH /components
 
-        :param component: the new vedor data
+        :param component: the new component data
         :param component_id: the id of the component to be updated
-        :type component: JSON vendor object
+        :type component: JSON component object
         :type component_id: string
         :return: SW360 result
         :rtype: JSON SW360 result object
@@ -1013,15 +1049,32 @@ def get_users_of_component(self, component_id):
 
     # ----- Vendor ----------------------------------------------------------
 
+    def get_all_vendors(self):
+        """Returns all vendors
+
+        API endpoint: GET /vendors
+
+        :return: a vendor
+        :rtype: JSON vendor object
+        :raises SW360Error: if there is a negative HTTP response
+        """
+
+        resp = self.api_get(self.url + "resource/api/vendors")
+        if not resp:
+            return None
+
+        resp = resp["_embedded"]["sw360:vendors"]
+        return resp
+
     def get_vendor(self, vendor_id):
         """Returns a vendor
 
         API endpoint: GET /vendors/{id}
 
         :param vendor_id: the id of the vendor to be requested
         :type vendor_id: string
-        :return: a vendor
-        :rtype: JSON vendor object
+        :return: list of vendors
+        :rtype: list of JSON vendor objects
         :raises SW360Error: if there is a negative HTTP response
         """
 

tests/test_sw360_clearingrequests.py

@@ -64,6 +64,29 @@ def test_get_clearing_request(self):
         self.assertIsNotNone(vendor)
         self.assertEqual("2021-09-04", vendor["requestedClearingDate"])
 
+    @responses.activate
+    def test_get_clearing_request_for_project(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            method=responses.GET,
+            url=self.MYURL + "resource/api/clearingrequest/project/12345",
+            body='{"id": "12345",\
+              "requestedClearingDate": "2021-09-04",\
+              "projectId": "007",\
+              "clearingState": "NEW"}',  # noqa
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        vendor = lib.get_clearing_request_for_project("12345")
+        self.assertIsNotNone(vendor)
+        self.assertEqual("2021-09-04", vendor["requestedClearingDate"])
+
 
 if __name__ == "__main__":
     unittest.main()

tests/test_sw360_projects.py

@@ -403,6 +403,40 @@ def test_get_projects_by_group_no_result(self):
         projects = lib.get_projects_by_group("SI")
         self.assertIsNone(projects)
 
+    @responses.activate
+    def test_get_projects_by_tag(self):
+        lib = self.get_logged_in_lib()
+
+        responses.add(
+            responses.GET,
+            url=self.MYURL + "resource/api/projects?tag=SI BP",
+            body='{"_embedded": {"sw360:projects": [{"name": "My Testproject", "externalIds": {"com.siemens.code.project.id": "13171"}}]}}',  # noqa
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        projects = lib.get_projects_by_tag("SI BP")
+        self.assertIsNotNone(projects)
+        self.assertTrue(len(projects) > 0)
+        self.assertEqual("My Testproject", projects[0]["name"])
+
+    @responses.activate
+    def test_get_projects_by_tag_no_result(self):
+        lib = self.get_logged_in_lib()
+
+        responses.add(
+            responses.GET,
+            url=self.MYURL + "resource/api/projects?tag=SI",
+            body='{}',
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        projects = lib.get_projects_by_tag("SI")
+        self.assertIsNone(projects)
+
     @responses.activate
     def test_download_license_info(self):
         lib = self.get_logged_in_lib()

tests/test_sw360_releases.py

@@ -226,6 +226,28 @@ def test_get_releases_by_external_id(self):
         self.assertEqual("Tethys.Logging", releases[0]["name"])
         self.assertEqual("1.3.0", releases[0]["version"])
 
+    @responses.activate
+    def test_get_releases_by_name(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            method=responses.GET,
+            url=self.MYURL + "resource/api/releases?name=john",
+            body='{"_embedded": {"sw360:releases": [{"name": "john", "version": "2.2.2", "_links": {"self": {"href": "https://my.server.com/resource/api/releases/08ddfd57636c4c47f4c879515007081f"}}}]}}',  # noqa
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        releases = lib.get_releases_by_name("john")
+        self.assertIsNotNone(releases)
+        self.assertTrue(len(releases) > 0)
+        self.assertEqual("john", releases[0]["name"])
+        self.assertEqual("2.2.2", releases[0]["version"])
+
     @responses.activate
     def test_create_new_release(self):
         lib = SW360(self.MYURL, self.MYTOKEN, False)

tests/test_sw360_vendors.py

@@ -94,7 +94,7 @@ def test_get_vendor(self):
               "shortName": "Triangle, Inc.",\
               "fullName": "Triangle, Inc.",\
               "_links": { "self": {\
-              "href": "https://sw360.siemens.com/resource/api/vendors/12345"}}}',  # noqa
+              "href": "https://my.server.com/resource/api/vendors/12345"}}}',  # noqa
             status=200,
             content_type="application/json",
             adding_headers={"Authorization": "Token " + self.MYTOKEN},
@@ -104,6 +104,50 @@ def test_get_vendor(self):
         self.assertIsNotNone(vendor)
         self.assertEqual("Triangle, Inc.", vendor["shortName"])
 
+    @responses.activate
+    def test_get_all_vendors(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            method=responses.GET,
+            url=self.MYURL + "resource/api/vendors",
+            body='{"_embedded" : {\
+                "sw360:vendors" : [{\
+                    "fullName": "Premium Software",\
+                    "_links": { "self": {\
+                             "href": "https://my.server.com/resource/api/vendors/006"}}}]}}',
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        vendors = lib.get_all_vendors()
+        self.assertIsNotNone(vendors)
+        self.assertEqual(1, len(vendors))
+        self.assertEqual("Premium Software", vendors[0]["fullName"])
+
+    @responses.activate
+    def test_get_all_vendors_no_result(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            method=responses.GET,
+            url=self.MYURL + "resource/api/vendors",
+            body='{}',
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        vendors = lib.get_all_vendors()
+        self.assertIsNone(vendors)
+
     @responses.activate
     def test_create_new_vendor(self):
         lib = SW360(self.MYURL, self.MYTOKEN, False)