images info for release notes (#217)

* images info for release notes

* working deployment platform classes

* removing unused code

* gitignore update

* cleanup; tests for github cli

* gitignore update

* no glob for test artifacts metadata files

Author: vivus-ignis

.gitignore

@@ -169,3 +169,6 @@ bandit-report.json
 
 # zot
 test-data/zot
+
+s3_downloads/
+.github_release_id

src/gardenlinux/github/__main__.py

@@ -1,5 +1,6 @@
 import argparse
 
+from gardenlinux.constants import GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
 from gardenlinux.logger import LoggerSetup
 
 from .release import create_github_release, upload_to_github_release_page, write_to_release_id_file
@@ -30,7 +31,7 @@ def main():
     args = parser.parse_args()
 
     if args.command == "create":
-        body = create_github_release_notes(args.tag, args.commit)
+        body = create_github_release_notes(args.tag, args.commit, GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME)
         if args.dry_run:
             print("Dry Run ...")
             print("This release would be created:")

src/gardenlinux/github/release_notes/__init__.py

@@ -1,12 +1,13 @@
-from .helpers import get_package_list
+from .helpers import download_all_metadata_files, get_package_list
 from .sections import (
     release_notes_changes_section,
     release_notes_compare_package_versions_section,
+    release_notes_image_ids_section,
     release_notes_software_components_section,
 )
 
 
-def create_github_release_notes(gardenlinux_version, commitish):
+def create_github_release_notes(gardenlinux_version, commitish, releases_s3_bucket_name):
     package_list = get_package_list(gardenlinux_version)
 
     output = ""
@@ -19,7 +20,9 @@ def create_github_release_notes(gardenlinux_version, commitish):
         gardenlinux_version, package_list
     )
 
-    # TODO: image ids
+    metadata_files = download_all_metadata_files(gardenlinux_version, commitish, releases_s3_bucket_name)
+
+    output += release_notes_image_ids_section(metadata_files)
 
     output += "\n"
     output += "## Kernel Module Build Container (kmodbuild)"

src/gardenlinux/github/release_notes/deployment_platform/__init__.py

@@ -0,0 +1,104 @@
+from gardenlinux.constants import GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
+
+
+class DeploymentPlatform():
+    artifacts_bucket_name = GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
+
+    def short_name(self):
+        return "generic"
+
+    def full_name(self):
+        return "Generic Deployment Platform"
+
+    def published_images_by_regions(self, image_metadata):
+        published_image_metadata = image_metadata["published_image_metadata"]
+        flavor_name = image_metadata["s3_key"].split("/")[-1]
+
+        regions = []
+        for pset in published_image_metadata:
+            for p in published_image_metadata[pset]:
+                regions.append({"region": p["region_id"], "image_id": p["image_id"]})
+
+        return {"flavor": flavor_name, "regions": regions}
+
+    def image_extension(self):
+        return "raw"
+
+    def artifact_for_flavor(self, flavor, markdown_format=True):
+        base_url = f"https://{self.__class__.artifacts_bucket_name}.s3.amazonaws.com/objects"
+        filename = f"{flavor}.{self.image_extension()}"
+        download_url = f"{base_url}/{flavor}/{filename}"
+        if markdown_format:
+            return f"[{filename}]({download_url})"
+        else:
+            return download_url
+
+    def region_details(self, image_metadata):
+        """
+        Generate the detailed region information for the collapsible section
+        """
+        details = ""
+
+        match self.published_images_by_regions(image_metadata):
+            case {"regions": regions}:
+                for region in regions:
+                    match region:
+                        case {
+                            "region": region_name,
+                            "image_id": image_id,
+                            "image_name": image_name,
+                        }:
+                            details += f"**{region_name}:** {image_id} ({image_name})<br>"
+                        case {"region": region_name, "image_id": image_id}:
+                            details += f"**{region_name}:** {image_id}<br>"
+            case {"details": details_dict}:
+                for key, value in details_dict.items():
+                    details += f"**{key.replace('_', ' ').title()}:** {value}<br>"
+            case {
+                "gallery_images": gallery_images,
+                "marketplace_images": marketplace_images,
+            }:
+                if gallery_images:
+                    details += "**Gallery Images:**<br>"
+                    for img in gallery_images:
+                        details += f"• {img['hyper_v_generation']} ({img['azure_cloud']}): {img['image_id']}<br>"
+                if marketplace_images:
+                    details += "**Marketplace Images:**<br>"
+                    for img in marketplace_images:
+                        details += f"• {img['hyper_v_generation']}: {img['urn']}<br>"
+            case {"gallery_images": gallery_images}:
+                details += "**Gallery Images:**<br>"
+                for img in gallery_images:
+                    details += f"• {img['hyper_v_generation']} ({img['azure_cloud']}): {img['image_id']}<br>"
+            case {"marketplace_images": marketplace_images}:
+                details += "**Marketplace Images:**<br>"
+                for img in marketplace_images:
+                    details += f"• {img['hyper_v_generation']}: {img['urn']}<br>"
+
+        return details
+
+    def summary_text(self, image_metadata):
+        """
+        Generate the summary text for the collapsible section
+        """
+        match self.published_images_by_regions(image_metadata):
+            case {"regions": regions}:
+                count = len(regions)
+                return f"{count} regions"
+            case {"details": _}:
+                return "Global availability"
+            case {
+                "gallery_images": gallery_images,
+                "marketplace_images": marketplace_images,
+            }:
+                gallery_count = len(gallery_images)
+                marketplace_count = len(marketplace_images)
+                return f"{gallery_count} gallery + {marketplace_count} marketplace images"
+            case {"gallery_images": gallery_images}:
+                gallery_count = len(gallery_images)
+                return f"{gallery_count} gallery images"
+            case {"marketplace_images": marketplace_images}:
+                marketplace_count = len(marketplace_images)
+                return f"{marketplace_count} marketplace images"
+            case _:
+                return "Details available"

src/gardenlinux/github/release_notes/deployment_platform/ali_cloud.py

@@ -0,0 +1,12 @@
+from . import DeploymentPlatform
+
+
+class AliCloud(DeploymentPlatform):
+    def short_name(self):
+        return "ali"
+
+    def full_name(self):
+        return "Alibaba Cloud"
+
+    def image_extension(self):
+        return "qcow2"

src/gardenlinux/github/release_notes/deployment_platform/amazon_web_services.py

@@ -0,0 +1,20 @@
+from . import DeploymentPlatform
+
+
+class AmazonWebServices(DeploymentPlatform):
+    def short_name(self):
+        return "aws"
+
+    def full_name(self):
+        return "Amazon Web Services"
+
+    def published_images_by_regions(self, image_metadata):
+        published_image_metadata = image_metadata["published_image_metadata"]
+        flavor_name = image_metadata["s3_key"].split("/")[-1]
+
+        regions = []
+        for pset in published_image_metadata:
+            for p in published_image_metadata[pset]:
+                regions.append({"region": p["aws_region_id"], "image_id": p["ami_id"]})
+
+        return {"flavor": flavor_name, "regions": regions}

src/gardenlinux/github/release_notes/deployment_platform/azure.py

@@ -0,0 +1,45 @@
+from . import DeploymentPlatform
+
+
+class Azure(DeploymentPlatform):
+    def short_name(self):
+        return "azure"
+
+    def full_name(self):
+        return "Microsoft Azure"
+
+    def image_extension(self):
+        return "vhd"
+
+    def published_images_by_regions(self, image_metadata):
+        published_image_metadata = image_metadata["published_image_metadata"]
+        flavor_name = image_metadata["s3_key"].split("/")[-1]
+
+        gallery_images = []
+        marketplace_images = []
+
+        for pset in published_image_metadata:
+            if pset == "published_gallery_images":
+                for gallery_image in published_image_metadata[pset]:
+                    gallery_images.append(
+                        {
+                            "hyper_v_generation": gallery_image["hyper_v_generation"],
+                            "azure_cloud": gallery_image["azure_cloud"],
+                            "image_id": gallery_image["community_gallery_image_id"],
+                        }
+                    )
+
+            if pset == "published_marketplace_images":
+                for market_image in published_image_metadata[pset]:
+                    marketplace_images.append(
+                        {
+                            "hyper_v_generation": market_image["hyper_v_generation"],
+                            "urn": market_image["urn"],
+                        }
+                    )
+
+        return {
+            "flavor": flavor_name,
+            "gallery_images": gallery_images,
+            "marketplace_images": marketplace_images,
+        }

src/gardenlinux/github/release_notes/deployment_platform/google_cloud.py

@@ -0,0 +1,25 @@
+from . import DeploymentPlatform
+
+
+class GoogleCloud(DeploymentPlatform):
+    def short_name(self):
+        return "gcp"
+
+    def full_name(self):
+        return "Google Cloud Platform"
+
+    def image_extension(self):
+        return "gcpimage.tar.gz"
+
+    def published_images_by_regions(self, image_metadata):
+        published_image_metadata = image_metadata["published_image_metadata"]
+        flavor_name = image_metadata["s3_key"].split("/")[-1]
+
+        details = {}
+        if "gcp_image_name" in published_image_metadata:
+            details["image_name"] = published_image_metadata["gcp_image_name"]
+        if "gcp_project_name" in published_image_metadata:
+            details["project"] = published_image_metadata["gcp_project_name"]
+        details["availability"] = "Global (all regions)"
+
+        return {"flavor": flavor_name, "details": details}

src/gardenlinux/github/release_notes/deployment_platform/openstack.py

@@ -0,0 +1,26 @@
+from . import DeploymentPlatform
+
+
+class OpenStack(DeploymentPlatform):
+    def short_name(self):
+        return "openstack"
+
+    def full_name(self):
+        return "OpenStack"
+
+    def published_images_by_regions(self, image_metadata):
+        published_image_metadata = image_metadata["published_image_metadata"]
+        flavor_name = image_metadata["s3_key"].split("/")[-1]
+
+        regions = []
+        if "published_openstack_images" in published_image_metadata:
+            for image in published_image_metadata["published_openstack_images"]:
+                regions.append(
+                    {
+                        "region": image["region_name"],
+                        "image_id": image["image_id"],
+                        "image_name": image["image_name"],
+                    }
+                )
+
+        return {"flavor": flavor_name, "regions": regions}

src/gardenlinux/github/release_notes/deployment_platform/openstack_baremetal.py

@@ -0,0 +1,9 @@
+from .openstack import OpenStack
+
+
+class OpenStackBareMetal(OpenStack):
+    def short_name(self):
+        return "openstackbaremetal"
+
+    def full_name(self):
+        return "OpenStack Baremetal"