Change the format of the relese_info file

Author: viveksinghggits

scripts/release/build/image_build_process.py

@@ -1,6 +1,6 @@
 import base64
 import subprocess
-from typing import Dict
+from typing import Dict, Optional
 
 import boto3
 import docker
@@ -22,6 +22,14 @@ def build_image(self, tags: list[str],
                     args: Dict[str, str],
                     platforms: list[str]):  pass
 
+    # check_if_image_exists could easily be used to get the digest of manfiest list but
+    # the python package that we use somehow doesn't return the digest of manifest list
+    # even though the respective docker CLI returns the digest. That's why we had to introduce
+    #  this function.
+    def get_manfiest_list_digest(self, image: str) -> Optional[str]: pass
+
+    def pull_image(self, image: str): pass
+
 
 DEFAULT_BUILDER_NAME = "multiarch"  # Default buildx builder name
 
@@ -109,6 +117,25 @@ def check_if_image_exists(self, image_tag: str) -> bool:
         else:
             return True
 
+    def pull_image(self, image):
+        docker_cmd = python_on_whales.docker
+        try:
+            docker_cmd.image.pull(image, quiet=True)
+        except Exception as e:
+            logger.error(f"Failed pulling image. {e}")
+            raise e
+
+    def get_manfiest_list_digest(self, image) -> Optional[str]:
+        self.pull_image(image)
+
+        docker_cmd = python_on_whales.docker
+        try:
+            manifest = docker_cmd.image.inspect(image)
+            return manifest.id
+        except Exception as e:
+            logger.error(f"Failed inspecting the image to get manifest list digest. {e}")
+            raise e
+
     def build_image(self, tags: list[str],
                     dockerfile: str,
                     path: str,
@@ -167,6 +194,13 @@ def check_if_image_exists(self, image_tag: str) -> bool:
             f"PodmanImageBuilder does not support checking if image exists remotely. Skipping check for {image_tag}.")
         return False
 
+    def get_manfiest_list_digest(self, image) -> Optional[str]:
+        logger.warning(f"PodmanImageBuilder does not support getting digest for manifest list, returning empty digest.")
+        return ""
+
+    def pull_image(self, image: str):
+        logger.warning("PodmanImageBuilder does not support pulling image right now.")
+
     def build_image(self, tags: list[str],
                     dockerfile: str,
                     path: str,

scripts/release/release_info.py

@@ -2,6 +2,7 @@
 import json
 import os
 
+from lib.base_logger import logger
 from scripts.release.build.build_info import (
     AGENT_IMAGE,
     DATABASE_IMAGE,
@@ -16,12 +17,16 @@
     load_build_info,
 )
 from scripts.release.build.build_scenario import BuildScenario
+from scripts.release.build.image_build_process import (
+    DockerImageBuilder,
+)
 from scripts.release.kubectl_mongodb.utils import (
     upload_assets_to_github_release,
 )
 
 SEARCH_IMAGE = "search"
 SEARCH_IMAGE_REPOSITORY = "quay.io/mongodb/mongodb-search"
+AGENT_IMAGE_REPOSITORY = "quay.io/mongodb/mongodb-agent"
 
 RELEASE_INFO_IMAGES_ORDERED = [
     OPERATOR_IMAGE,  # mongodb-kubernetes
@@ -52,14 +57,14 @@ def convert_to_release_info_json(build_info: BuildInfo, operator_version: str) -
     images = {name: build_info.images[name] for name in RELEASE_INFO_IMAGES_ORDERED}
 
     for name, image in images.items():
-        add_image_info(release_info_output, name, image.repositories, image.platforms, operator_version)
+        add_image_info(release_info_output, name, image.repositories[0], image.platforms, operator_version)
 
     # add OPS manager image info
     om_build_info = build_info.images[OPS_MANAGER_IMAGE]
     add_image_info(
         release_info_output,
         OPS_MANAGER_IMAGE,
-        om_build_info.repositories,
+        om_build_info.repositories[0],
         om_build_info.platforms,
         latest_om_version(release_data),
     )
@@ -69,7 +74,7 @@ def convert_to_release_info_json(build_info: BuildInfo, operator_version: str) -
     add_image_info(
         release_info_output,
         AGENT_IMAGE,
-        agent_build_info.repositories,
+        AGENT_IMAGE_REPOSITORY,
         agent_build_info.platforms,
         latest_agent_version(release_data),
     )
@@ -79,7 +84,7 @@ def convert_to_release_info_json(build_info: BuildInfo, operator_version: str) -
     add_image_info(
         release_info_output,
         UPGRADE_HOOK_IMAGE,
-        upgradehook_build_info.repositories,
+        upgradehook_build_info.repositories[0],
         upgradehook_build_info.platforms,
         latest_upgrade_hook_version(release_data),
     )
@@ -89,7 +94,7 @@ def convert_to_release_info_json(build_info: BuildInfo, operator_version: str) -
     add_image_info(
         release_info_output,
         READINESS_PROBE_IMAGE,
-        readiness_build_info.repositories,
+        readiness_build_info.repositories[0],
         readiness_build_info.platforms,
         latest_readiness_version(release_data),
     )
@@ -108,8 +113,14 @@ def convert_to_release_info_json(build_info: BuildInfo, operator_version: str) -
     return release_info_output
 
 
-def add_image_info(release_info_output, name, repositories, platforms, version):
-    release_info_output["images"][name] = {"repositories": repositories, "platforms": platforms, "version": version}
+def add_image_info(release_info_output, name, repository: str, platforms, version):
+    digest = manifest_list_digest_for_image(f"{repository}:{version}")
+    release_info_output["images"][name] = {
+        "repoURL": repository,
+        "platforms": platforms,
+        "tag": version,
+        "digest": digest,
+    }
 
 
 def add_om_agent_mappings(release_data, output):
@@ -143,6 +154,19 @@ def latest_search_version(release_data):
     return release_data["search"]["version"]
 
 
+# manifest_list_digest_for_image returns manifest list digest for the passed image. Returns
+# empty string if there was an error figuring that out.
+def manifest_list_digest_for_image(image: str) -> str:
+    builder = DockerImageBuilder()
+    try:
+        digest = builder.get_manfiest_list_digest(image)
+    except Exception as e:
+        logger.error(f"There was an error, figuring out manifest list digest for image {image}. Error: {e}")
+        return ""
+
+    return digest
+
+
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
         description="Create relevant release artifacts information in JSON format.",