Prep sonar migration release 0.4 (#1401)

* Update what new with 0.4 release scope

* Bump sonar-migration version to 0.4

* Fixes #1402

* Add test to verify portfolio key is are present

* Add check for portfolios by reference

* Add export of portfolios by reference

* Fix test

* Fixes #1386

Author: okorach

migration/README.md

@@ -108,6 +108,13 @@ When sonar-migration complete successfully they return exit code 0. En case of f
 
 # What's New - Release notes
 
+## Version 0.4
+
+- Robustness: Handle all types of HTTP errors including SSL errors, which were causing freezes
+- Added export of flat list of projects in each portfolio
+- Fix regression: Export of `platform` section is back
+- Added export of portfolios by reference
+
 ## Version 0.3
 
 - Robustness: Handle `connectionError` errors in project extract threads

migration/deploy.sh

@@ -64,5 +64,5 @@ if [ "$release" = "1" ]; then
 fi
 
 if [ "$release_docker" = "1" ]; then
-    docker buildx build --push --platform linux/amd64,linux/arm64 -t olivierkorach/sonar-migration:0.3  -t olivierkorach/sonar-migration:latest -f migration/release.Dockerfile $ROOTDIR
+    docker buildx build --push --platform linux/amd64,linux/arm64 -t olivierkorach/sonar-migration:0.4  -t olivierkorach/sonar-migration:latest -f migration/release.Dockerfile $ROOTDIR
 fi

migration/release.Dockerfile

@@ -31,7 +31,7 @@ COPY ./LICENSE .
 COPY ./sonar/audit sonar/audit
 
 RUN pip install --upgrade pip \
-&& pip install sonar-migration==0.3 --force-reinstall
+&& pip install sonar-migration==0.4 --force-reinstall
 
 USER ${USERNAME}
 WORKDIR /home/${USERNAME}

migration/what-is-new.md

@@ -1,3 +1,11 @@
+
+# Version 0.4
+
+- Robustness: Handle all types of HTTP errors including SSL errors, which were causing freezes
+- Added export of flat list of projects in each portfolio
+- Fix regression: Export of `platform` section is back
+- Added export of portfolios by reference
+
 # Version 0.3
 
 - Robustness: Handle `connectionError` errors in project extract threads

sonar/platform.py

@@ -658,7 +658,7 @@ def _audit_lta_latest(self) -> list[Problem]:
         if not v:
             return []
         # pylint: disable-next=E0606
-        return [Problem(rule, self.url, ".".join(sq_vers), ".".join(v))]
+        return [Problem(rule, self.url, ".".join([str(n) for n in sq_vers]), ".".join([str(n) for n in v]))]
 
 
 # --------------------- Static methods -----------------

sonar/portfolios.py

@@ -103,7 +103,6 @@ def __init__(self, endpoint: pf.Platform, name: str, key: str = None) -> None:
         self._tags = []  #: Portfolio tags when selection mode is TAGS
         self._description = None  #: Portfolio description
         self._visibility = None  #: Portfolio visibility
-        self._ref_portfolios = {}  #: Subportfolios
         self._sub_portfolios = {}  #: Subportfolios
         self._applications = {}  #: applications
         self._permissions = None  #: Permissions
@@ -171,8 +170,7 @@ def reload_sub_portfolios(self) -> None:
             return
         self._sub_portfolios = {}
         for data in self._json["subViews"]:
-            if data["qualifier"] == "SVW":
-                self.load_sub_portfolio(data.copy())
+            self.load_sub_portfolio(data.copy())
 
     def load_selection_mode(self) -> None:
         """Loads the portfolio selection mode"""
@@ -360,11 +358,13 @@ def to_json(self, export_settings: types.ConfigSettings) -> types.ObjectJsonRepr
                 subp_key = subp_json.pop("key")
                 json_data["portfolios"][subp_key] = subp_json
         mode = self.selection_mode().copy()
-        if mode and "none" not in mode:
-            json_data["projects"] = mode
+        if mode:
+            if "none" not in mode or export_settings.get("MODE", "") == "MIGRATION":
+                json_data["projects"] = mode
+            if export_settings.get("MODE", "") == "MIGRATION":
+                json_data["projects"]["keys"] = self.get_project_list()
         json_data["applications"] = self._applications
-        if export_settings.get("MODE", "") == "MIGRATION":
-            json_data["projectsList"] = self.get_project_list()
+
         return json_data
 
     def export(self, export_settings: types.ConfigSettings) -> types.ObjectJsonRepr:
@@ -554,7 +554,6 @@ def is_toplevel(self) -> bool:
 
     def is_parent_of(self, key: str) -> bool:
         """Returns whether a portfolio is parent of another subportfolio (given by key)"""
-        log.debug("SUBP = %s", str(list(self._sub_portfolios.keys())))
         return key in self._sub_portfolios
 
     def is_subporfolio_of(self, key: str) -> bool:

sonar/version.py

@@ -25,4 +25,4 @@
 """
 
 PACKAGE_VERSION = "3.5"
-MIGRATION_TOOL_VERSION = "0.3"
+MIGRATION_TOOL_VERSION = "0.4"

test/test_config.py

@@ -120,6 +120,7 @@ def test_config_inline_commas() -> None:
         # This is a list because there is a comma in one of the branches
         if util.SQ.version() >= (10, 0, 0):
             assert isinstance(json_config["portfolios"]["PORTFOLIO_MULTI_BRANCHES"]["projects"]["manual"]["BANKING-PORTAL"], list)
+        assert json_config["portfolios"]["All"]["portfolios"]["Banking"]["byReference"]
     util.clean(util.JSON_FILE)
 
 

test/test_migration.py

@@ -133,6 +133,10 @@ def test_migration() -> None:
         assert json_config["projects"]["demo:gitlab-ci-maven"]["detectedCi"] == "Gitlab CI"
         assert json_config["projects"]["demo:github-actions-cli"]["detectedCi"] == "Github Actions"
 
+    for p in json_config["portfolios"].values():
+        assert "projects" in p
+        assert "keys" in p["projects"]
+
     util.clean(util.JSON_FILE)