Fix release_info.py structure

Author: MaciejKaras

scripts/release/build/build_info.py

@@ -6,6 +6,18 @@
 from scripts.release.constants import DEFAULT_REPOSITORY_PATH, DEFAULT_CHANGELOG_PATH, RELEASE_INITIAL_VERSION_ENV_VAR, \
     get_initial_version, get_initial_commit_sha
 
+MEKO_TESTS_IMAGE = "meko-tests"
+OPERATOR_IMAGE = "operator"
+MCO_TESTS_IMAGE = "mco-tests"
+READINESS_PROBE_IMAGE = "readiness-probe"
+UPGRADE_HOOK_IMAGE = "upgrade-hook"
+DATABASE_IMAGE = "database"
+AGENT_IMAGE = "agent"
+INIT_APPDB_IMAGE = "init-appdb"
+INIT_DATABASE_IMAGE = "init-database"
+INIT_OPS_MANAGER_IMAGE = "init-ops-manager"
+OPS_MANAGER_IMAGE = "ops-manager"
+
 
 @dataclass
 class ImageInfo:
@@ -14,9 +26,6 @@ class ImageInfo:
     version: str
     sign: bool
 
-    def to_release_info_json(self):
-        return {"repository": self.repository, "platforms": self.platforms, "version": self.version}
-
 
 @dataclass
 class BinaryInfo:
@@ -25,34 +34,20 @@ class BinaryInfo:
     version: str
     sign: bool
 
-    def to_release_info_json(self):
-        return {"platforms": self.platforms, "version": self.version}
-
 
 @dataclass
 class HelmChartInfo:
     repository: str
     version: str
     sign: bool
 
-    def to_release_info_json(self):
-        return {"repository": self.repository, "version": self.version}
-
 
 @dataclass
 class BuildInfo:
     images: Dict[str, ImageInfo]
     binaries: Dict[str, BinaryInfo]
     helm_charts: Dict[str, HelmChartInfo]
 
-    def to_release_info_json(self):
-        return {
-            "images": {name: images.to_release_info_json() for name, images in self.images.items() if
-                       name not in ["agent", "ops-manager"]},
-            "binaries": {name: bin.to_release_info_json() for name, bin in self.binaries.items()},
-            "helm-charts": {name: chart.to_release_info_json() for name, chart in self.helm_charts.items()},
-        }
-
 
 def load_build_info(scenario: BuildScenario,
                     repository_path: str = DEFAULT_REPOSITORY_PATH,

scripts/release/pipeline_main.py

@@ -28,7 +28,20 @@
     build_tests_image,
     build_upgrade_hook_image,
 )
-from scripts.release.build.build_info import load_build_info
+from scripts.release.build.build_info import (
+    AGENT_IMAGE,
+    DATABASE_IMAGE,
+    INIT_APPDB_IMAGE,
+    INIT_DATABASE_IMAGE,
+    INIT_OPS_MANAGER_IMAGE,
+    MCO_TESTS_IMAGE,
+    MEKO_TESTS_IMAGE,
+    OPERATOR_IMAGE,
+    OPS_MANAGER_IMAGE,
+    READINESS_PROBE_IMAGE,
+    UPGRADE_HOOK_IMAGE,
+    load_build_info,
+)
 from scripts.release.build.build_scenario import (
     BuildScenario,
 )
@@ -48,19 +61,19 @@ def get_builder_function_for_image_name() -> Dict[str, Callable]:
     """Returns a dictionary of image names that can be built."""
 
     image_builders = {
-        "meko-tests": build_tests_image,  # working
-        "operator": build_operator_image,  # working
-        "mco-tests": build_mco_tests_image,  # working
-        "readiness-probe": build_readiness_probe_image,  # working
-        "upgrade-hook": build_upgrade_hook_image,  # working
-        "database": build_database_image,  # working
-        "agent": build_agent_default_case,  # working
+        MEKO_TESTS_IMAGE: build_tests_image,  # working
+        OPERATOR_IMAGE: build_operator_image,  # working
+        MCO_TESTS_IMAGE: build_mco_tests_image,  # working
+        READINESS_PROBE_IMAGE: build_readiness_probe_image,  # working
+        UPGRADE_HOOK_IMAGE: build_upgrade_hook_image,  # working
+        DATABASE_IMAGE: build_database_image,  # working
+        AGENT_IMAGE: build_agent_default_case,  # working
         # Init images
-        "init-appdb": build_init_appdb_image,  # working
-        "init-database": build_init_database_image,  # working
-        "init-ops-manager": build_init_om_image,  # working
+        INIT_APPDB_IMAGE: build_init_appdb_image,  # working
+        INIT_DATABASE_IMAGE: build_init_database_image,  # working
+        INIT_OPS_MANAGER_IMAGE: build_init_om_image,  # working
         # Ops Manager image
-        "ops-manager": build_om_image,  # working
+        OPS_MANAGER_IMAGE: build_om_image,  # working
     }
 
     return image_builders

scripts/release/release_info.py

@@ -2,14 +2,34 @@
 import json
 import pathlib
 
-from scripts.release.build.build_info import load_build_info
+from scripts.release.build.build_info import (
+    DATABASE_IMAGE,
+    INIT_APPDB_IMAGE,
+    INIT_DATABASE_IMAGE,
+    INIT_OPS_MANAGER_IMAGE,
+    OPERATOR_IMAGE,
+    READINESS_PROBE_IMAGE,
+    UPGRADE_HOOK_IMAGE,
+    BuildInfo,
+    load_build_info,
+)
 from scripts.release.build.build_scenario import BuildScenario
 from scripts.release.constants import (
     DEFAULT_CHANGELOG_PATH,
     DEFAULT_RELEASE_INITIAL_VERSION,
     DEFAULT_REPOSITORY_PATH,
 )
 
+RELEASE_INFO_IMAGES_ORDERED = [
+    OPERATOR_IMAGE,
+    INIT_DATABASE_IMAGE,
+    INIT_APPDB_IMAGE,
+    INIT_OPS_MANAGER_IMAGE,
+    DATABASE_IMAGE,
+    READINESS_PROBE_IMAGE,
+    UPGRADE_HOOK_IMAGE,
+]
+
 
 def create_release_info_json(
     repository_path: str, changelog_sub_path: str, initial_commit_sha: str = None, initial_version: str = None
@@ -22,7 +42,40 @@ def create_release_info_json(
         initial_version=initial_version,
     )
 
-    return json.dumps(build_info.to_release_info_json(), indent=2)
+    release_info_json = convert_to_release_info_json(build_info)
+
+    return json.dumps(release_info_json, indent=2)
+
+
+def convert_to_release_info_json(build_info: BuildInfo) -> dict:
+    output = {
+        "images": {},
+        "binaries": {},
+        "helm-charts": {},
+    }
+    # Filter (and order) images to include only those relevant for release info
+    images = {name: build_info.images[name] for name in RELEASE_INFO_IMAGES_ORDERED}
+
+    for name, image in images.items():
+        output["images"][name] = {
+            "repository": image.repository,
+            "platforms": image.platforms,
+            "version": image.version,
+        }
+
+    for name, binary in build_info.binaries.items():
+        output["binaries"][name] = {
+            "platforms": binary.platforms,
+            "version": binary.version,
+        }
+
+    for name, chart in build_info.helm_charts.items():
+        output["helm-charts"][name] = {
+            "repository": chart.repository,
+            "version": chart.version,
+        }
+
+    return output
 
 
 if __name__ == "__main__":