Enforce one platform policy for GardenLinux canonical names

NotTheEvilOne · NotTheEvilOne · commit f930e547385c · 2025-11-07T13:40:45.000+01:00
Signed-off-by: Tobias Wolf &lt;wolf@b1-systems.de&gt;
On-behalf-of: SAP &lt;tobias.wolf@sap.com&gt;
diff --git a/src/gardenlinux/features/__main__.py b/src/gardenlinux/features/__main__.py
@@ -23,7 +23,7 @@
     "container_tag",
     "commit_id",
     "features",
-    "platforms",
+    "platform",
     "flags",
     "flavor",
     "elements",
@@ -147,7 +147,7 @@ def main() -> None:
         "flags",
         "flavor",
         "graph",
-        "platforms",
+        "platform",
     ):
         if args.type == "graph" or len(args.ignore) > 0:
             features_parser = Parser(gardenlinux_root, feature_dir_name)
@@ -270,13 +270,13 @@ def print_output_from_features_parser(
                 flavor, additional_filter_func=additional_filter_func
             )
         )
-    elif (output_type in "platforms", "elements", "flags"):
+    elif (output_type in "platform", "elements", "flags"):
         features_by_type = parser.filter_as_dict(
             flavor, additional_filter_func=additional_filter_func
         )
 
-        if output_type == "platforms":
-            print(",".join(features_by_type["platform"]))
+        if output_type == "platform":
+            print(features_by_type["platform"][0])
         elif output_type == "elements":
             print(",".join(features_by_type["element"]))
         elif output_type == "flags":
@@ -305,8 +305,8 @@ def print_output_from_features_parser(
             print(cname)
         elif output_type == "container_name":
             print(RE_CAMEL_CASE_SPLITTER.sub("\\1_\\2", cname_base).lower())
-        elif output_type == "platforms":
-            print(",".join(features_by_type["platform"]))
+        elif output_type == "platform":
+            print(features_by_type["platform"][0])
         elif output_type == "elements":
             print(",".join(features_by_type["element"]))
         elif output_type == "flags":
@@ -331,7 +331,7 @@ def print_output_from_cname(output_type: str, cname_instance: CName) -> None:
         print(cname_instance.cname)
     elif output_type == "container_name":
         print(RE_CAMEL_CASE_SPLITTER.sub("\\1-\\2", cname_instance.flavor).lower())
-    elif output_type == "platforms":
+    elif output_type == "platform":
         print(cname_instance.feature_set_platform)
     elif output_type == "elements":
         print(cname_instance.feature_set_element)
diff --git a/src/gardenlinux/features/cname.py b/src/gardenlinux/features/cname.py
@@ -6,7 +6,7 @@
 
 import re
 from configparser import UNNAMED_SECTION, ConfigParser
-from os import PathLike
+from os import environ, PathLike
 from pathlib import Path
 from typing import List, Optional
 
@@ -51,8 +51,9 @@ def __init__(self, cname, arch=None, commit_hash=None, version=None):
         self._commit_id = None
         self._feature_elements_cached = None
         self._feature_flags_cached = None
-        self._feature_platforms_cached = None
+        self._feature_platform_cached = None
         self._feature_set_cached = None
+        self._flag_multiple_platforms = bool(environ.get("GL_ALLOW_FRANKENSTEIN", False))
         self._flavor = None
         self._version = None
 
@@ -117,7 +118,7 @@ def cname(self) -> str:
         :return: (str) CName
         :since:  0.7.0
         """
-        assert self._flavor is not None, "CName flavor is not set!"
+
         cname = self._flavor
 
         if self._arch is not None:
@@ -229,14 +230,20 @@ def feature_set_platform(self) -> str:
         """
         Returns the feature set of type "platform" for the cname parsed.
 
-        :return: (str) Feature set platforms
+        :return: (str) Feature set platform
         :since:  0.11.0
         """
 
-        if self._feature_platforms_cached is not None:
-            return ",".join(self._feature_platforms_cached)
+        if self._feature_platform_cached is not None:
+            return self._feature_platform_cached
+
+        platforms = Parser().filter_as_dict(self.flavor)["platform"]
+
+        if self._flag_multiple_platforms:
+            return ",".join(platforms)
 
-        return ",".join(Parser().filter_as_dict(self.flavor)["platform"])
+        assert len(platforms) < 2; "Only one platform is supported"
+        return platforms[0]
 
     @property
     def release_metadata_string(self) -> str:
@@ -249,9 +256,12 @@ def release_metadata_string(self) -> str:
 
         features = Parser().filter_as_dict(self.flavor)
 
+        if not self._flag_multiple_platforms:
+            assert len(features["platform"]) < 2; "Only one platform is supported"
+
         elements = ",".join(features["element"])
         flags = ",".join(features["flag"])
-        platforms = ",".join(features["platform"])
+        platform = ",".join(features["platform"])
 
         metadata = f"""
 ID={GL_RELEASE_ID}
@@ -264,7 +274,7 @@ def release_metadata_string(self) -> str:
 BUG_REPORT_URL="{GL_BUG_REPORT_URL}"
 GARDENLINUX_CNAME="{self.cname}"
 GARDENLINUX_FEATURES="{self.feature_set}"
-GARDENLINUX_FEATURES_PLATFORMS="{platforms}"
+GARDENLINUX_FEATURES_PLATFORM="{platform}"
 GARDENLINUX_FEATURES_ELEMENTS="{elements}"
 GARDENLINUX_FEATURES_FLAGS="{flags}"
 GARDENLINUX_VERSION="{self.version}"
@@ -282,24 +292,9 @@ def platform(self) -> str:
         :return: (str) Feature set platforms
         :since:  0.7.0
         """
-        assert self._flavor is not None, "Flavor not set!"
 
         return self.feature_set_platform
 
-    @property
-    def platforms(self) -> List[str]:
-        """
-        Returns the platforms for the cname parsed.
-
-        :return: (str) Platforms
-        :since:  0.11.0
-        """
-
-        if self._feature_platforms_cached is not None:
-            return self._feature_platforms_cached
-
-        return Parser().filter_as_dict(self.flavor)["platform"]
-
     @property
     def version(self) -> Optional[str]:
         """
@@ -350,7 +345,7 @@ def load_from_release_file(self, release_file: PathLike | str) -> None:
             "GARDENLINUX_FEATURES",
             "GARDENLINUX_FEATURES_ELEMENTS",
             "GARDENLINUX_FEATURES_FLAGS",
-            "GARDENLINUX_FEATURES_PLATFORMS",
+            "GARDENLINUX_FEATURES_PLATFORM",
             "GARDENLINUX_VERSION",
         ):
             if not release_config.has_option(UNNAMED_SECTION, release_field):
@@ -395,9 +390,9 @@ def load_from_release_file(self, release_file: PathLike | str) -> None:
             UNNAMED_SECTION, "GARDENLINUX_FEATURES_FLAGS"
         ).split(",")
 
-        self._feature_platforms_cached = release_config.get(
-            UNNAMED_SECTION, "GARDENLINUX_FEATURES_PLATFORMS"
-        ).split(",")
+        self._feature_platform_cached = release_config.get(
+            UNNAMED_SECTION, "GARDENLINUX_FEATURES_PLATFORM"
+        )
 
     def save_to_release_file(
         self, release_file: PathLike | str, overwrite: Optional[bool] = False
diff --git a/src/gardenlinux/s3/__main__.py b/src/gardenlinux/s3/__main__.py
@@ -36,4 +36,6 @@ def main() -> None:
     if args.action == "download-artifacts-from-bucket":
         S3Artifacts(args.bucket).download_to_directory(args.cname, args.path)
     elif args.action == "upload-artifacts-to-bucket":
-        S3Artifacts(args.bucket).upload_from_directory(args.cname, args.path, dry_run=args.dry_run)
+        S3Artifacts(args.bucket).upload_from_directory(
+            args.cname, args.path, dry_run=args.dry_run
+        )
diff --git a/src/gardenlinux/s3/s3_artifacts.py b/src/gardenlinux/s3/s3_artifacts.py
@@ -19,6 +19,7 @@
 import yaml
 
 from .bucket import Bucket
+from ..features import CName
 
 
 class S3Artifacts(object):
@@ -116,36 +117,20 @@ def upload_from_directory(
 
         artifacts_dir = Path(artifacts_dir)
 
+        cname_object = CName(cname)
+
         if not artifacts_dir.is_dir():
             raise RuntimeError(f"Artifacts directory given is invalid: {artifacts_dir}")
 
         release_file = artifacts_dir.joinpath(f"{cname}.release")
         release_timestamp = stat(release_file).st_ctime
 
-        release_config = ConfigParser(allow_unnamed_section=True)
-        release_config.read(release_file)
-
-        # Get architecture from the GARDENLINUX_CNAME (second to last element when split by -)
-        release_cname = release_config.get(UNNAMED_SECTION, "GARDENLINUX_CNAME")
-        cname_parts = release_cname.split("-")
-        if len(cname_parts) < 2:
-            raise RuntimeError(f"Invalid GARDENLINUX_CNAME format in release file: {release_cname}")
-        arch = cname_parts[-2]  # Second to last element is the architecture
+        cname_object.load_from_release_file(release_file)
 
-        commit_id = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID")
-        expected_cname = f"{release_cname}-{commit_id}"
-
-        # Verify the provided cname matches the release file
-        if cname != expected_cname:
-            raise RuntimeError(
-                f"Release file cname does not match provided cname: {expected_cname} != {cname}"
-            )
-
-        commit_hash = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG")
-
-        feature_set = release_config.get(UNNAMED_SECTION, "GARDENLINUX_FEATURES")
-        feature_list = feature_set.split(",")
+        if cname_object.arch is None:
+            raise RuntimeError("Architecture could not be determined from cname")
 
+        feature_list = cname_object.feature_set
         requirements_file = artifacts_dir.joinpath(f"{cname}.requirements")
         require_uefi = None
         secureboot = None
@@ -168,33 +153,25 @@ def upload_from_directory(
         if secureboot is None:
             secureboot = "_trustedboot" in feature_list
 
-        version = release_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION")
-        platform = release_config.get(UNNAMED_SECTION, "GARDENLINUX_PLATFORM")
-
         metadata = {
-            "platform": platform,
-            "architecture": arch,
+            "platform": cname_object.feature_set_platform,
+            "architecture": cname_object.arch,
             "base_image": None,
-            "build_committish": commit_hash,
+            "build_committish": cname_object.commit_hash,
             "build_timestamp": datetime.fromtimestamp(release_timestamp).isoformat(),
-            "gardenlinux_epoch": int(version.split(".", 1)[0]),
+            "gardenlinux_epoch": int(cname_object.version.split(".", 1)[0]),
             "logs": None,
-            "modifiers": feature_list,
+            "modifiers": cname_object.feature_set,
             "require_uefi": require_uefi,
             "secureboot": secureboot,
             "published_image_metadata": None,
             "s3_bucket": self._bucket.name,
             "s3_key": f"meta/singles/{cname}",
             "test_result": None,
-            "version": version,
+            "version": cname_object.version,
             "paths": [],
         }
 
-        if release_config.has_option(UNNAMED_SECTION, "GARDENLINUX_PLATFORM_VARIANT"):
-            metadata["platform_variant"] = release_config.get(
-                UNNAMED_SECTION, "GARDENLINUX_PLATFORM_VARIANT"
-            )
-
         re_object = re.compile("[^a-zA-Z0-9\\s+\\-=.\\_:/@]")
 
         for artifact in artifacts_dir.iterdir():
@@ -224,16 +201,14 @@ def upload_from_directory(
             }
 
             s3_tags = {
-                "architecture": re_object.sub("+", arch),
-                "platform": re_object.sub("+", platform),
-                "version": re_object.sub("+", version),
-                "committish": commit_hash,
+                "architecture": re_object.sub("+", cname_object.arch),
+                "platform": re_object.sub("+", cname_object.platform),
+                "version": re_object.sub("+", cname_object.version),
+                "committish": cname_object.commit_hash,
                 "md5sum": md5sum,
                 "sha256sum": sha256sum,
             }
 
-            metadata["paths"].append(artifact_metadata)
-
             if not dry_run:
                 if delete_before_push:
                     self._bucket.delete_objects(Delete={"Objects": [{"Key": s3_key}]})
@@ -244,6 +219,8 @@ def upload_from_directory(
                     ExtraArgs={"Tagging": urlencode(s3_tags)},
                 )
 
+            metadata["paths"].append(artifact_metadata)
+
         if dry_run:
             print(yaml.dump(metadata, sort_keys=False))
         else:
