Merge pull request #38 from Siemens-Healthineers/api/update

Update(api): Update get all release api

Author: tngraf

ChangeLog.md

@@ -5,6 +5,13 @@
 
 # SW360 Base Library for Python
 
+## Upcoming Release
+
+* Update `get_all_releases` to include `isNewClearingWithSourceAvailable` parameter:
+  * This parameter allows filtering releases that are in the **new clearing** state and have
+    the source available.
+  * This feature is yet to be released in the new version of SW360.
+
 ## V1.7.0
 
 * more REST API endpoints implemented:

sw360/releases.py

@@ -64,14 +64,17 @@ def get_releases_by_name(self, name: str) -> List[Any]:
 
     # return type List[Dict[str, Any]] | Optional[Dict[str, Any]] for Python 3.11 is good,
     # Union[List[Dict[str, Any]], Optional[Dict[str, Any]]] for lower Python versions is not good
-    def get_all_releases(self, fields: str = "", all_details: bool = False, page: int = -1,
+    def get_all_releases(self, fields: str = "", all_details: bool = False,
+                         isNewClearingWithSourceAvailable: bool = False, page: int = -1,
                          page_size: int = -1, sort: str = "") -> Any:
         """Get information of about all releases
 
         API endpoint: GET /releases
 
         :param all_details: retrieve all project details (optional))
         :type all_details: bool
+        :param isNewClearingWithSourceAvailable: retrieve releases in new clearning state with source avail
+        :type isNewClearingWithSourceAvailable: bool
         :param page: page to retrieve
         :type page: int
         :param page_size: page size to use
@@ -86,6 +89,9 @@ def get_all_releases(self, fields: str = "", all_details: bool = False, page: in
         if all_details:
             full_url = self._add_param(full_url, "allDetails=true")
 
+        if isNewClearingWithSourceAvailable:
+            full_url = self._add_param(full_url, "isNewClearingWithSourceAvailable=true")
+
         if fields:
             full_url = self._add_param(full_url, "fields=" + fields)
 

tests/test_sw360_releases.py

@@ -149,6 +149,33 @@ def test_get_all_releases(self) -> None:
             self.assertEqual("Tethys.Logging", releases[0]["name"])
             self.assertEqual("1.3.0", releases[0]["version"])
 
+    @responses.activate
+    def test_get_all_releases_isnewclearing_with_source_available(self) -> None:
+        """
+        Test the 'isNewClearingWithSourceAvailable' parameter in the get_all_releases method.
+        """
+        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?isNewClearingWithSourceAvailable=true",
+            body='{"_embedded": {"sw360:releases": [{"name": "Tethys.Logging", "version": "1.3.0"}]}}',
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        releases = lib.get_all_releases(isNewClearingWithSourceAvailable=True)
+
+        self.assertIsNotNone(releases)
+        if releases:
+            self.assertTrue(len(releases) > 0)
+            self.assertEqual("Tethys.Logging", releases[0]["name"])
+            self.assertEqual("1.3.0", releases[0]["version"])
+
     @responses.activate
     def test_get_all_releases_all_details(self) -> None:
         lib = SW360(self.MYURL, self.MYTOKEN, False)