Enforce one platform policy for GardenLinux canonical names

Signed-off-by: Tobias Wolf <[email protected]>
On-behalf-of: SAP <[email protected]>

Author: NotTheEvilOne

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)
@@ -259,7 +259,7 @@ def print_output_from_features_parser(
     :param flavor: Flavor
     :param ignores_list: Features to ignore
 
-    :since: 0.11.0
+    :since: 1.0.0
     """
 
     additional_filter_func = lambda node: node not in ignores_list
@@ -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":
@@ -322,7 +322,7 @@ def print_output_from_cname(output_type: str, cname_instance: CName) -> None:
     :param output_type: Output type
     :param cname_instance: CName instance
 
-    :since: 0.11.0
+    :since: 1.0.0
     """
 
     if output_type == "cname_base":
@@ -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)

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:
@@ -134,7 +135,7 @@ def commit_hash(self) -> str:
         Returns the commit hash if part of the cname parsed.
 
         :return: (str) Commit hash
-        :since:  0.11.0
+        :since:  1.0.0
         """
 
         if self._commit_hash is None:
@@ -151,7 +152,7 @@ def commit_hash(self, commit_hash) -> None:
 
         :param commit_hash: Commit hash
 
-        :since: 0.11.0
+        :since: 1.0.0
         """
 
         if self._commit_id is not None and not commit_hash.startswith(self._commit_id):
@@ -202,7 +203,7 @@ def feature_set_element(self) -> str:
         Returns the feature set of type "element" for the cname parsed.
 
         :return: (str) Feature set elements
-        :since:  0.11.0
+        :since:  1.0.0
         """
 
         if self._feature_elements_cached is not None:
@@ -216,7 +217,7 @@ def feature_set_flag(self) -> str:
         Returns the feature set of type "flag" for the cname parsed.
 
         :return: (str) Feature set flags
-        :since:  0.11.0
+        :since:  1.0.0
         """
 
         if self._feature_flags_cached is not None:
@@ -229,29 +230,38 @@ def feature_set_platform(self) -> str:
         """
         Returns the feature set of type "platform" for the cname parsed.
 
-        :return: (str) Feature set platforms
-        :since:  0.11.0
+        :return: (str) Feature set platform
+        :since:  1.0.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:
         """
         Returns the release metadata describing the given CName instance.
 
         :return: (str) Release metadata describing the given CName instance
-        :since:  0.11.0
+        :since:  1.0.0
         """
 
         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]:
         """
@@ -331,7 +326,7 @@ def load_from_release_file(self, release_file: PathLike | str) -> None:
 
         :param release_file: Release metadata file
 
-        :since: 0.11.0
+        :since: 1.0.0
         """
 
         if not isinstance(release_file, PathLike):
@@ -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
@@ -407,7 +402,7 @@ def save_to_release_file(
 
         :param release_file: Release metadata file
 
-        :since: 0.11.0
+        :since: 1.0.0
         """
 
         if not isinstance(release_file, PathLike):

src/gardenlinux/features/parser.py

@@ -368,8 +368,8 @@ def get_cname_as_feature_set(cname):
 
         :param cname: Canonical name
 
-        :return: (set) Features of the cname
-        :since:  0.7.0
+        :return: (list) Features of the cname
+        :since:  1.0.0
         """
 
         cname = cname.replace("_", "-_")
@@ -473,6 +473,20 @@ def key_function(node):
 
         return list(networkx.lexicographical_topological_sort(graph, key=key_function))
 
+    @staticmethod
+    def subset(input_set: Set[str], order_list: List[str]) -> List[str]:
+        """
+        Returns items from `order_list` if given in `input_set`.
+
+        :param input_set:  Set of values for filtering
+        :param order_list: Set of values to be filtered
+
+        :return: (list) Subset
+        :since:  1.0.0
+        """
+
+        return [item for item in order_list if item in input_set]
+
     @staticmethod
     def sort_reversed_graph_nodes(graph):
         """

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
+        )