Merge pull request #7 from sw360/develop

Develop to master

Author: tngraf

ChangeLog.md

@@ -1,14 +1,18 @@
 # SW360 Base Library for Python
 
+## NEXT
+* new method `update_project_release_relationship`.
+* original get_health_status() endpoint URL has been restored by the SW360 team.
+
 ## 1.1.0
-* New method `dulicate_project` to create a copy of an exisiting project.
+* New method `duplicate_project` to create a copy of an existing project.
 
 ## 1.0.0
 * **New Features**:
   * `get_projects_by_tag` added.
   * `get_releases_by_name` added.
   * `get_all_vendors` added.
-* We have covered nearly all of the possibel REST API calls.  
+* We have covered nearly all of the possible REST API calls.  
   The library is successfully being used by multiple projects.  
   Time to release version 1.0.0.
 

CreateCoverageReport.ps1

@@ -0,0 +1,13 @@
+# -----------------------------------------
+# Run tests and create code coverage report
+# -----------------------------------------
+
+# 2021-12-20, T. Graf
+
+poetry run coverage run -m pytest
+poetry run coverage report -m --omit "*/site-packages/*.py"
+poetry run coverage html --omit "*/site-packages/*.py"
+
+
+# -----------------------------------
+# -----------------------------------

sw360/sw360_api.py

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------------
-# (c) 2019-2021 Siemens AG
+# (c) 2019-2022 Siemens AG
 # All Rights Reserved.
 # Authors: thomas.graf@siemens.com, gernot.hillier@siemens.com
 #
@@ -360,7 +360,7 @@ def get_projects_by_tag(self, tag):
         :rtype: list of JSON project objects
         :raises SW360Error: if there is a negative HTTP response
         """
-        full_url = self.url + "resource/api/projects?tag=" + tag
+        full_url = self.url + "resource/api/projects?tag=" + tag + "&luceneSearch=true"
         resp = self.api_get(full_url)
         if not resp:
             return None
@@ -608,6 +608,45 @@ def duplicate_project(self, project_id: str, new_version: str):
 
         raise SW360Error(response, url)
 
+    def update_project_release_relationship(self, project_id: str, release_id: str, new_state: str,
+            new_relation: str, comment: str):
+        """Update the relationship for a specific release of a project
+
+        API endpoint PATCH /projects/{pid}/release{rid}
+
+        :param project_id: the id of the exisiting project
+        :type project_id: string
+        :param release_id: the id of the release to be requested
+        :type release_id: string
+        :param new_state: the new mainline state of the release, one of 
+         (OPEN, MAINLINE, SPECIFIC, PHASEOUT, DENIED)
+        :type new_state: string
+        :param new_relation: the new relation of the release, one of 
+         (CONTAINED, REFERRED, UNKNOWN, DYNAMICALLY_LINKED, STATICALLY_LINKED, SIDE_BY_SIDE, STANDALONE,
+          INTERNAL_USE, OPTIONAL, TO_BE_REPLACED, CODE_SNIPPET)
+        :type new_relation: string
+        :param comment: a comment
+        :type comment: string
+        """
+        if not project_id:
+            raise SW360Error(message="No project id provided!")
+
+        if not release_id:
+            raise SW360Error(message="No release id provided!")
+
+        relation = {}
+        relation["releaseRelation"] = new_relation
+        relation["mainlineState"] = new_state
+        relation["comment"] = comment
+
+        url = self.url + "resource/api/projects/" + project_id + "/release/" + release_id
+        response = requests.patch(url, json=relation, headers=self.api_headers)
+
+        if response.ok:
+            return response.json()
+
+        raise SW360Error(response, url)
+
     # ----- Releases ---------------------------------------------------------
 
     def get_release(self, release_id):

tests/test_sw360_health.py

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------------
-# (c) 2020 Siemens AG
+# (c) 2020-2022 Siemens AG
 # All Rights Reserved.
 # Author: thomas.graf@siemens.com
 #

tests/test_sw360_projects.py

@@ -409,7 +409,7 @@ def test_get_projects_by_tag(self):
 
         responses.add(
             responses.GET,
-            url=self.MYURL + "resource/api/projects?tag=SI BP",
+            url=self.MYURL + "resource/api/projects?tag=SI BP&luceneSearch=true",
             body='{"_embedded": {"sw360:projects": [{"name": "My Testproject", "externalIds": {"com.siemens.code.project.id": "13171"}}]}}',  # noqa
             status=200,
             content_type="application/json",
@@ -427,7 +427,7 @@ def test_get_projects_by_tag_no_result(self):
 
         responses.add(
             responses.GET,
-            url=self.MYURL + "resource/api/projects?tag=SI",
+            url=self.MYURL + "resource/api/projects?tag=SI&luceneSearch=true",
             body='{}',
             status=200,
             content_type="application/json",