Add support to accept incomplete release files for S3 artifact upload

Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: SAP <tobias.wolf@sap.com>

Author: NotTheEvilOne

.github/actions/setup/action.yml

@@ -4,7 +4,7 @@ description: Installs the given GardenLinux Python library
 inputs:
   version:
     description: GardenLinux Python library version
-    default: "0.10.13"
+    default: "0.10.14"
   python_version:
     description: Python version to setup
     default: "3.13"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gardenlinux"
-version = "0.10.13"
+version = "0.10.14"
 description = "Contains tools to work with the features directory of gardenlinux, for example deducting dependencies from feature sets or validating cnames"
 authors = ["Garden Linux Maintainers <contact@gardenlinux.io>"]
 license = "Apache-2.0"

src/gardenlinux/constants.py

@@ -148,6 +148,7 @@
 GL_DEB_REPO_BASE_URL = "https://packages.gardenlinux.io/gardenlinux"
 GL_DISTRIBUTION_NAME = "Garden Linux"
 GL_HOME_URL = "https://gardenlinux.io"
+GL_PLATFORM_FRANKENSTEIN = "frankenstein"
 GL_RELEASE_ID = "gardenlinux"
 GL_REPOSITORY_URL = "https://github.com/gardenlinux/gardenlinux"
 GL_SUPPORT_URL = "https://github.com/gardenlinux/gardenlinux"

src/gardenlinux/features/cname.py

@@ -8,13 +8,14 @@
 from configparser import UNNAMED_SECTION, ConfigParser
 from os import PathLike, environ
 from pathlib import Path
-from typing import List, Optional, Self
+from typing import Any, Dict, List, Optional, Self
 
 from ..constants import (
     ARCHS,
     GL_BUG_REPORT_URL,
     GL_DISTRIBUTION_NAME,
     GL_HOME_URL,
+    GL_PLATFORM_FRANKENSTEIN,
     GL_RELEASE_ID,
     GL_SUPPORT_URL,
 )
@@ -59,14 +60,20 @@ def __init__(
         self._feature_flags_cached: Optional[List[str]] = None
         self._feature_platforms_cached: Optional[List[str]] = None
         self._feature_set_cached: Optional[str] = None
+        self._features_cached: Optional[Dict[str, Any]] = None
         self._platform_variant_cached: Optional[str] = None
         self._flavor = ""
         self._version = None
 
+        self._flag_frankenstein = bool(environ.get("GL_ALLOW_FRANKENSTEIN", False))
+
         self._flag_multiple_platforms = bool(
-            environ.get("GL_ALLOW_FRANKENSTEIN", False)
+            environ.get("GL_ALLOW_MULTIPLE_PLATFORMS", False)
         )
 
+        if self._flag_frankenstein:
+            self._flag_multiple_platforms = True
+
         commit_id_or_hash = None
 
         if version is not None:
@@ -213,6 +220,20 @@ def flavor(self) -> str:
 
         return self._flavor
 
+    @property
+    def features(self) -> Dict[str, Any]:
+        """
+        Returns the features for the cname parsed.
+
+        :return: (dict) Features of the cname
+        :since:  0.10.14
+        """
+
+        if self._features_cached is None:
+            self._features_cached = Parser().filter_as_dict(self.flavor)
+
+        return self._features_cached
+
     @property
     def feature_set(self) -> str:
         """
@@ -239,7 +260,7 @@ def feature_set_element(self) -> str:
         if self._feature_elements_cached is not None:
             return ",".join(self._feature_elements_cached)
 
-        return ",".join(Parser().filter_as_dict(self.flavor)["element"])
+        return ",".join(self.features["element"])
 
     @property
     def feature_set_flag(self) -> str:
@@ -253,7 +274,7 @@ def feature_set_flag(self) -> str:
         if self._feature_flags_cached is not None:
             return ",".join(self._feature_flags_cached)
 
-        return ",".join(Parser().filter_as_dict(self.flavor)["flag"])
+        return ",".join(self.features["flag"])
 
     @property
     def feature_set_platform(self) -> str:
@@ -265,7 +286,7 @@ def feature_set_platform(self) -> str:
         """
 
         if self._feature_platforms_cached is None:
-            platforms = Parser().filter_as_dict(self.flavor)["platform"]
+            platforms = self.features["platform"]
         else:
             platforms = self._feature_platforms_cached
 
@@ -274,7 +295,7 @@ def feature_set_platform(self) -> str:
 
         assert len(platforms) < 2
         "Only one platform is supported"
-        return platforms[0]
+        return platforms[0]  # type: ignore[no-any-return]
 
     @property
     def feature_set_list(self) -> List[str]:
@@ -293,21 +314,20 @@ def feature_set_list(self) -> List[str]:
     @property
     def platform(self) -> str:
         """
-        Returns the feature set of type "platform" for the cname parsed.
+        Returns the platform for the cname parsed.
 
-        :return: (str) Feature set platforms
+        :return: (str) Platform
         :since:  0.7.0
         """
 
-        if self._feature_platforms_cached is None:
-            platforms = Parser().filter_as_dict(self.flavor)["platform"]
-        else:
-            platforms = self._feature_platforms_cached
-
-        if not self._flag_multiple_platforms:
-            assert len(platforms) < 2
+        if (
+            self._flag_frankenstein
+            and self._feature_platforms_cached is not None
+            and len(self._feature_platforms_cached) > 1
+        ):
+            return GL_PLATFORM_FRANKENSTEIN
 
-        return platforms[0]
+        return self.feature_set_platform
 
     @property
     def platform_variant(self) -> Optional[str]:
@@ -345,18 +365,8 @@ def release_metadata_string(self) -> str:
         :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"
-
         commit_hash = self.commit_hash
         commit_id = self.commit_id
-        elements = ",".join(features["element"])
-        flags = ",".join(features["flag"])
-        platform = features["platform"][0]
-        platforms = ",".join(features["platform"])
         platform_variant = self.platform_variant
         version = self.version
 
@@ -387,10 +397,10 @@ 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_ELEMENTS="{elements}"
-GARDENLINUX_FEATURES_FLAGS="{flags}"
-GARDENLINUX_PLATFORM="{platform}"
+GARDENLINUX_FEATURES_PLATFORMS="{self.feature_set_platform}"
+GARDENLINUX_FEATURES_ELEMENTS="{self.feature_set_element}"
+GARDENLINUX_FEATURES_FLAGS="{self.feature_set_flag}"
+GARDENLINUX_PLATFORM="{self.platform}"
 GARDENLINUX_PLATFORM_VARIANT="{platform_variant}"
 GARDENLINUX_VERSION="{version}"
 GARDENLINUX_COMMIT_ID="{commit_id}"

src/gardenlinux/s3/s3_artifacts.py

@@ -120,7 +120,24 @@ def upload_from_directory(
 
         release_file = artifacts_dir.joinpath(f"{base_name}.release")
 
-        cname_object = CName.new_from_release_file(release_file)
+        try:
+            cname_object = CName.new_from_release_file(release_file)
+        except RuntimeError:
+            if not release_file.exists():
+                raise RuntimeError(
+                    f"Release metadata file given is invalid: {release_file}"
+                )
+
+            release_config = ConfigParser(allow_unnamed_section=True)
+            release_config.read(release_file)
+
+            cname_object = CName(
+                release_config.get(UNNAMED_SECTION, "GARDENLINUX_CNAME"),
+                commit_hash=release_config.get(
+                    UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG"
+                ),
+                version=release_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION"),
+            )
 
         if cname_object.version_and_commit_id is None:
             raise RuntimeError(

tests/s3/test_s3_artifacts.py

@@ -215,6 +215,30 @@ def test_upload_from_directory_invalid_artifact_name(s3_setup: S3Env) -> None:
     assert len(list(bucket.objects.filter(Prefix=f"meta/singles/{env.cname}"))) == 1
 
 
+def test_upload_from_directory_invalid_release_file_with_valid_cname(
+    s3_setup: S3Env,
+) -> None:
+    """
+    Raise RuntimeError if artifact release file is invalid but contains a valid cname.
+    """
+    # Arrange
+    env = s3_setup
+    release_path = env.tmp_path / f"{env.cname}.release"
+    bad_data = RELEASE_DATA.replace(
+        "GARDENLINUX_FEATURES_PLATFORMS=", "GARDENLINUX_FEATURES_PLATFORMS_UNDEFINED="
+    )
+    release_path.write_text(bad_data)
+
+    artifacts = S3Artifacts(env.bucket_name)
+
+    # Act
+    artifacts.upload_from_directory(env.cname, env.tmp_path)
+
+    # Assert
+    bucket = env.s3.Bucket(env.bucket_name)
+    assert len(list(bucket.objects.filter(Prefix=f"meta/singles/{env.cname}"))) == 1
+
+
 def test_upload_from_directory_commit_mismatch(s3_setup: S3Env) -> None:
     """
     Validate that the release file may contain a different commit hash not matching the artifact name.