Address review comments, refactor

Author: viveksinghggits

.evergreen-functions.yml

@@ -786,9 +786,11 @@ functions:
       type: setup
       params:
         working_dir: src/github.com/mongodb/mongodb-kubernetes
+        include_expansions_in_env:
+          - OPERATOR_VERSION
         env:
           GH_TOKEN: ${GH_TOKEN}
-        binary: scripts/dev/run_python.sh scripts/release/release_info.py --version 1.0.1
+        binary: scripts/dev/run_python.sh scripts/release/release_info.py --version ${OPERATOR_VERSION|*triggered_by_git_tag}
 
   release_kubectl_mongodb_plugin:
     - command: github.generate_token

scripts/release/kubectl_mongodb/promote_kubectl_plugin.py

@@ -6,7 +6,6 @@
 from pathlib import Path
 
 from botocore.exceptions import ClientError
-from github import Github, GithubException
 
 from lib.base_logger import logger
 from scripts.release.build.build_info import (
@@ -19,16 +18,14 @@
 )
 from scripts.release.kubectl_mongodb.utils import (
     CHECKSUMS_PATH,
-    GITHUB_REPO,
     LOCAL_ARTIFACTS_DIR,
     create_s3_client,
     kubectl_plugin_name,
     parse_platform,
     s3_path,
+    upload_assets_to_github_release,
 )
 
-GITHUB_TOKEN = os.environ.get("GH_TOKEN")
-
 
 def main():
     release_version = os.environ.get("OPERATOR_VERSION")
@@ -269,50 +266,5 @@ def create_tarballs():
 
     return created_archives
 
-
-# upload_assets_to_github_release uploads the release artifacts (downloaded notarized/signed staging artifacts) to
-# the GitHub release as assets.
-def upload_assets_to_github_release(asset_paths: list[str], release_version: str):
-    if not GITHUB_TOKEN:
-        logger.info("ERROR: GITHUB_TOKEN environment variable not set.")
-        sys.exit(1)
-
-    try:
-        g = Github(GITHUB_TOKEN)
-        repo = g.get_repo(GITHUB_REPO)
-    except GithubException as e:
-        logger.info(f"ERROR: Could not connect to GitHub or find repository '{GITHUB_REPO}', Error {e}.")
-        sys.exit(1)
-
-    try:
-        gh_release = None
-        # list all the releases (including draft ones), and get the one corresponding to the passed release_version
-        for r in repo.get_releases():
-            if r.tag_name == release_version:
-                gh_release = r
-                break
-
-        if gh_release is None:
-            logger.error(
-                f"Could not find release (published or draft) with tag '{release_version}'. Please ensure the release exists."
-            )
-            sys.exit(2)
-    except GithubException as e:
-        logger.debug(f"Failed to retrieve releases from the repository {GITHUB_REPO}. Error: {e}")
-        sys.exit(2)
-
-    for asset_path in asset_paths:
-        asset_name = os.path.basename(asset_path)
-        logger.info(f"Uploading artifact '{asset_name}' to github release as asset")
-        try:
-            gh_release.upload_asset(path=asset_path, name=asset_name, content_type="application/gzip")
-        except GithubException as e:
-            logger.debug(f"ERROR: Failed to upload asset {asset_name}. Error: {e}")
-            sys.exit(2)
-        except Exception as e:
-            logger.debug(f"An unexpected error occurred during upload of {asset_name}: {e}")
-            sys.exit(2)
-
-
 if __name__ == "__main__":
     main()

scripts/release/kubectl_mongodb/utils.py

@@ -1,11 +1,17 @@
+import os
+import sys
+
 import boto3
 from botocore.exceptions import NoCredentialsError, PartialCredentialsError
+from github import Github, GithubException
 
+from lib.base_logger import logger
 from scripts.release.build.build_info import KUBECTL_PLUGIN_BINARY
 
 AWS_REGION = "eu-north-1"
 
 GITHUB_REPO = "mongodb/mongodb-kubernetes"
+GITHUB_TOKEN = os.environ.get("GH_TOKEN")
 
 LOCAL_ARTIFACTS_DIR = "artifacts"
 CHECKSUMS_PATH = f"{LOCAL_ARTIFACTS_DIR}/checksums.txt"
@@ -34,3 +40,47 @@ def kubectl_plugin_name(os_name: str, arch_name: str) -> str:
 # The `version` string has the correct version (either patch id or commit sha), based on the BuildScenario.
 def s3_path(filename: str, version: str) -> str:
     return f"{KUBECTL_PLUGIN_BINARY}/{version}/{filename}"
+
+
+# upload_assets_to_github_release uploads the release artifacts (downloaded notarized/signed staging artifacts) to
+# the GitHub release as assets.
+def upload_assets_to_github_release(asset_paths: list[str], release_version: str):
+    if not GITHUB_TOKEN:
+        logger.info("ERROR: GITHUB_TOKEN environment variable not set.")
+        sys.exit(1)
+
+    try:
+        g = Github(GITHUB_TOKEN)
+        repo = g.get_repo(GITHUB_REPO)
+    except GithubException as e:
+        logger.info(f"ERROR: Could not connect to GitHub or find repository '{GITHUB_REPO}', Error {e}.")
+        sys.exit(1)
+
+    try:
+        gh_release = None
+        # list all the releases (including draft ones), and get the one corresponding to the passed release_version
+        for r in repo.get_releases():
+            if r.tag_name == release_version:
+                gh_release = r
+                break
+
+        if gh_release is None:
+            logger.error(
+                f"Could not find release (published or draft) with tag '{release_version}'. Please ensure the release exists."
+            )
+            sys.exit(2)
+    except GithubException as e:
+        logger.debug(f"Failed to retrieve releases from the repository {GITHUB_REPO}. Error: {e}")
+        sys.exit(2)
+
+    for asset_path in asset_paths:
+        asset_name = os.path.basename(asset_path)
+        logger.info(f"Uploading artifact '{asset_name}' to github release as asset")
+        try:
+            gh_release.upload_asset(path=asset_path, name=asset_name, content_type="application/gzip")
+        except GithubException as e:
+            logger.debug(f"ERROR: Failed to upload asset {asset_name}. Error: {e}")
+            sys.exit(2)
+        except Exception as e:
+            logger.debug(f"An unexpected error occurred during upload of {asset_name}: {e}")
+            sys.exit(2)

scripts/release/release_info.py

@@ -3,53 +3,45 @@
 import os
 
 from scripts.release.build.build_info import (
+    AGENT_IMAGE,
     DATABASE_IMAGE,
     INIT_APPDB_IMAGE,
     INIT_DATABASE_IMAGE,
     INIT_OPS_MANAGER_IMAGE,
     OPERATOR_IMAGE,
+    OPS_MANAGER_IMAGE,
     READINESS_PROBE_IMAGE,
     UPGRADE_HOOK_IMAGE,
-    OPS_MANAGER_IMAGE,
-    AGENT_IMAGE,
     BuildInfo,
     load_build_info,
 )
-from scripts.release.kubectl_mongodb.promote_kubectl_plugin import upload_assets_to_github_release
 from scripts.release.build.build_scenario import BuildScenario
-from scripts.release.constants import (
-    DEFAULT_CHANGELOG_PATH,
-    DEFAULT_RELEASE_INITIAL_VERSION,
-    DEFAULT_REPOSITORY_PATH,
+from scripts.release.kubectl_mongodb.utils import (
+    upload_assets_to_github_release,
 )
 
 SEARCH_IMAGE = "search"
 SEARCH_IMAGE_REPOSITORY = "quay.io/mongodb/mongodb-search"
 
 RELEASE_INFO_IMAGES_ORDERED = [
-    OPERATOR_IMAGE, # mongodb-kubernetes
-    INIT_DATABASE_IMAGE, # mongodb-kubernetes-init-database
-    INIT_APPDB_IMAGE, # mongodb-kubernetes-init-appdb
-    INIT_OPS_MANAGER_IMAGE, # mongodb-kubernetes-init-ops-manager
-    DATABASE_IMAGE, # mongodb-kubernetes-database
-    READINESS_PROBE_IMAGE, # mongodb-kubernetes-readinessprobe
-    UPGRADE_HOOK_IMAGE, # mongodb-kubernetes-operator-version-upgrade-post-start-hook
+    OPERATOR_IMAGE,  # mongodb-kubernetes
+    INIT_DATABASE_IMAGE,  # mongodb-kubernetes-init-database
+    INIT_APPDB_IMAGE,  # mongodb-kubernetes-init-appdb
+    INIT_OPS_MANAGER_IMAGE,  # mongodb-kubernetes-init-ops-manager
+    DATABASE_IMAGE,  # mongodb-kubernetes-database
+    READINESS_PROBE_IMAGE,  # mongodb-kubernetes-readinessprobe
 ]
 
-EXTERNAL_INFO_IMAGES = [
-    OPS_MANAGER_IMAGE,
-    AGENT_IMAGE
-]
 
-def create_release_info_json(version: str) -> str:
+def create_release_info_json(operator_version: str) -> str:
     build_info = load_build_info(scenario=BuildScenario.RELEASE)
 
-    release_info_json = convert_to_release_info_json(build_info, version)
+    release_info_json = convert_to_release_info_json(build_info, operator_version)
 
     return json.dumps(release_info_json, indent=2)
 
 
-def convert_to_release_info_json(build_info: BuildInfo, version: str) -> dict:
+def convert_to_release_info_json(build_info: BuildInfo, operator_version: str) -> dict:
     release_json_data = os.path.join(os.getcwd(), "release.json")
     with open(release_json_data, "r") as fd:
         release_data = json.load(fd)
@@ -58,52 +50,86 @@ def convert_to_release_info_json(build_info: BuildInfo, version: str) -> dict:
         "images": {},
     }
     # 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 + EXTERNAL_INFO_IMAGES}
+    images = {name: build_info.images[name] for name in RELEASE_INFO_IMAGES_ORDERED}
 
     for name, image in images.items():
-        release_info_output["images"][name] = {
-            "repositories": image.repositories,
-            "platforms": image.platforms,
-        }
-        
-        if name == OPS_MANAGER_IMAGE:
-            release_info_output["images"][name]["version"] = latest_om_version(release_data)
-            continue
-
-        if name == AGENT_IMAGE:
-            release_info_output["images"][name]["version"] = latest_agent_version(release_data)
-            continue
-
-        release_info_output["images"][name]["version"] = version
-
-    # add search image detail
-    release_info_output["images"][SEARCH_IMAGE] = {
-                "repositories": SEARCH_IMAGE_REPOSITORY,
-                "platforms": ["linux/arm64", "linux/amd64"],
-                "version": latest_search_version(release_data)
-            }
+        add_image_info(release_info_output, name, image.repositories, 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.platforms,
+        latest_om_version(release_data),
+    )
+
+    # add agent image info
+    agent_build_info = build_info.images[AGENT_IMAGE]
+    add_image_info(
+        release_info_output,
+        AGENT_IMAGE,
+        agent_build_info.repositories,
+        agent_build_info.platforms,
+        latest_agent_version(release_data),
+    )
+
+    # add upgrade hook image info
+    upgradehook_build_info = build_info.images[UPGRADE_HOOK_IMAGE]
+    add_image_info(
+        release_info_output,
+        UPGRADE_HOOK_IMAGE,
+        upgradehook_build_info.repositories,
+        upgradehook_build_info.platforms,
+        latest_upgrade_hook_version(release_data),
+    )
+
+    # add search image info
+    add_image_info(
+        release_info_output,
+        SEARCH_IMAGE,
+        SEARCH_IMAGE_REPOSITORY,
+        ["linux/arm64", "linux/amd64"],
+        latest_search_version(release_data),
+    )
 
     release_info_output = add_om_agent_mappings(release_data, release_info_output)
 
     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_om_agent_mappings(release_data, output):
     om_agent_mapping = release_data["latestOpsManagerAgentMapping"]
     output["latestOpsManagerAgentMapping"] = om_agent_mapping
 
     return output
 
+
+def latest_upgrade_hook_version(relese_data):
+    return relese_data["versionUpgradeHookVersion"]
+
+
 def latest_om_version(release_data):
     return release_data["supportedImages"]["ops-manager"]["versions"][-1]
 
+
 def latest_agent_version(release_data):
     newest_om_version = release_data["supportedImages"]["ops-manager"]["versions"][-1]
-    newest_om_mapping = release_data["supportedImages"]["mongodb-agent"]["opsManagerMapping"]["ops_manager"][newest_om_version]
+    newest_om_mapping = release_data["supportedImages"]["mongodb-agent"]["opsManagerMapping"]["ops_manager"][
+        newest_om_version
+    ]
     return newest_om_mapping["agent_version"]
 
+
 def latest_search_version(release_data):
     return release_data["search"]["version"]
 
+
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
         description="Create relevant release artifacts information in JSON format.",