Add support for the GardenLinux platform variant if defined

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

Author: NotTheEvilOne

src/gardenlinux/features/cname.py

@@ -8,7 +8,7 @@
 from configparser import UNNAMED_SECTION, ConfigParser
 from os import PathLike, environ
 from pathlib import Path
-from typing import List, Optional
+from typing import Optional
 
 from ..constants import (
     ARCHS,
@@ -53,6 +53,7 @@ def __init__(self, cname, arch=None, commit_hash=None, version=None):
         self._feature_flags_cached = None
         self._feature_platform_cached = None
         self._feature_set_cached = None
+        self._platform_variant_cached = None
 
         self._flag_multiple_platforms = bool(
             environ.get("GL_ALLOW_FRANKENSTEIN", False)
@@ -250,6 +251,44 @@ def feature_set_platform(self) -> str:
         "Only one platform is supported"
         return platforms[0]
 
+    @property
+    def platform(self) -> str:
+        """
+        Returns the feature set of type "platform" for the cname parsed.
+
+        :return: (str) Feature set platforms
+        :since:  0.7.0
+        """
+
+        return self.feature_set_platform
+
+    @property
+    def platform_variant(self) -> Optional[str]:
+        """
+        Returns the platform variant for the cname parsed.
+
+        :return: (str) Platform variant
+        :since:  1.0.0
+        """
+
+        if self._platform_variant_cached is not None:
+            return self._platform_variant_cached
+
+        # @TODO: Platform variant is set by GardenLinux features to the release file. If not read or cached it is currently invisible for this library.
+        return None
+
+    @platform_variant.setter
+    def platform_variant(self, variant: str) -> None:
+        """
+        Sets the the platform variant
+
+        :param variant: Platform variant
+
+        :since: 1.0.0
+        """
+
+        self._platform_variant_cached = variant
+
     @property
     def release_metadata_string(self) -> str:
         """
@@ -268,6 +307,10 @@ def release_metadata_string(self) -> str:
         elements = ",".join(features["element"])
         flags = ",".join(features["flag"])
         platform = ",".join(features["platform"])
+        platform_variant = self.platform_variant
+
+        if platform_variant is None:
+            platform_variant = ""
 
         metadata = f"""
 ID={GL_RELEASE_ID}
@@ -283,24 +326,14 @@ def release_metadata_string(self) -> str:
 GARDENLINUX_FEATURES_PLATFORM="{platform}"
 GARDENLINUX_FEATURES_ELEMENTS="{elements}"
 GARDENLINUX_FEATURES_FLAGS="{flags}"
+GARDENLINUX_PLATFORM_VARIANT="{platform_variant}"
 GARDENLINUX_VERSION="{self.version}"
 GARDENLINUX_COMMIT_ID="{self.commit_id}"
 GARDENLINUX_COMMIT_ID_LONG="{self.commit_hash}"
         """.strip()
 
         return metadata
 
-    @property
-    def platform(self) -> str:
-        """
-        Returns the feature set of type "platform" for the cname parsed.
-
-        :return: (str) Feature set platforms
-        :since:  0.7.0
-        """
-
-        return self.feature_set_platform
-
     @property
     def version(self) -> Optional[str]:
         """
@@ -360,12 +393,18 @@ def load_from_release_file(self, release_file: PathLike | str) -> None:
                 )
 
         loaded_cname_instance = CName(
-            release_config.get(UNNAMED_SECTION, "GARDENLINUX_CNAME")
+            release_config.get(UNNAMED_SECTION, "GARDENLINUX_CNAME").strip("\"'")
         )
 
-        commit_id = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID")
-        commit_hash = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG")
-        version = release_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION")
+        commit_id = release_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID").strip(
+            "\"'"
+        )
+        commit_hash = release_config.get(
+            UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG"
+        ).strip("\"'")
+        version = release_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION").strip(
+            "\"'"
+        )
 
         if (
             loaded_cname_instance.flavor != self.flavor
@@ -386,19 +425,28 @@ def load_from_release_file(self, release_file: PathLike | str) -> None:
 
         self._feature_set_cached = release_config.get(
             UNNAMED_SECTION, "GARDENLINUX_FEATURES"
-        )
+        ).strip("\"'")
 
-        self._feature_elements_cached = release_config.get(
-            UNNAMED_SECTION, "GARDENLINUX_FEATURES_ELEMENTS"
-        ).split(",")
+        self._feature_elements_cached = (
+            release_config.get(UNNAMED_SECTION, "GARDENLINUX_FEATURES_ELEMENTS")
+            .strip("\"'")
+            .split(",")
+        )
 
-        self._feature_flags_cached = release_config.get(
-            UNNAMED_SECTION, "GARDENLINUX_FEATURES_FLAGS"
-        ).split(",")
+        self._feature_flags_cached = (
+            release_config.get(UNNAMED_SECTION, "GARDENLINUX_FEATURES_FLAGS")
+            .strip("\"'")
+            .split(",")
+        )
 
         self._feature_platform_cached = release_config.get(
             UNNAMED_SECTION, "GARDENLINUX_FEATURES_PLATFORM"
-        )
+        ).strip("\"'")
+
+        if release_config.has_option(UNNAMED_SECTION, "GARDENLINUX_PLATFORM_VARIANT"):
+            self._platform_variant_cached = release_config.get(
+                UNNAMED_SECTION, "GARDENLINUX_PLATFORM_VARIANT"
+            ).strip("\"'")
 
     def save_to_release_file(
         self, release_file: PathLike | str, overwrite: Optional[bool] = False

tests/features/constants.py

@@ -0,0 +1,29 @@
+from gardenlinux.constants import (
+    GL_BUG_REPORT_URL,
+    GL_DISTRIBUTION_NAME,
+    GL_HOME_URL,
+    GL_RELEASE_ID,
+    GL_SUPPORT_URL,
+)
+
+
+def generate_container_amd64_release_metadata(version, commit_hash):
+    return f"""
+ID={GL_RELEASE_ID}
+NAME="{GL_DISTRIBUTION_NAME}"
+PRETTY_NAME="{GL_DISTRIBUTION_NAME} {version}"
+IMAGE_VERSION={version}
+VARIANT_ID="container-amd64"
+HOME_URL="{GL_HOME_URL}"
+SUPPORT_URL="{GL_SUPPORT_URL}"
+BUG_REPORT_URL="{GL_BUG_REPORT_URL}"
+GARDENLINUX_CNAME="container-amd64-{version}-{commit_hash}"
+GARDENLINUX_FEATURES="_slim,base,container"
+GARDENLINUX_FEATURES_PLATFORM="container"
+GARDENLINUX_FEATURES_ELEMENTS="base"
+GARDENLINUX_FEATURES_FLAGS="_slim"
+GARDENLINUX_PLATFORM_VARIANT=""
+GARDENLINUX_VERSION="{version}"
+GARDENLINUX_COMMIT_ID="{commit_hash}"
+GARDENLINUX_COMMIT_ID_LONG="{commit_hash}"
+""".strip()

tests/features/test_main.py

@@ -1,12 +1,15 @@
 import sys
 import types
+from pathlib import Path
+from tempfile import TemporaryDirectory
 
 import pytest
 
 import gardenlinux.features.__main__ as fema
-from gardenlinux.features import CName, Parser
+from gardenlinux.features import CName
 
 from ..constants import GL_ROOT_DIR
+from .constants import generate_container_amd64_release_metadata
 
 # -------------------------------
 # Helper function tests
@@ -363,3 +366,32 @@ def test_main_with_exclude_cname_print_features(monkeypatch, capsys):
         "sap,ssh,_fwcfg,_ignite,_legacy,_nopkg,_prod,_slim,base,server,cloud,kvm,multipath,iscsi,nvme,gardener"
         == captured
     )
+
+
+def test_cname_release_file(monkeypatch, capsys):
+    """
+    Test validation between release metadata and arguments given
+    """
+    # Arrange
+    with TemporaryDirectory() as tmpdir:
+        os_release_file = Path(tmpdir, "os_release")
+
+        with os_release_file.open("w") as fp:
+            fp.write(generate_container_amd64_release_metadata("today", "local"))
+
+        argv = [
+            "prog",
+            "--cname",
+            "container-amd64-today-local",
+            "--release-file",
+            str(os_release_file),
+            "cname",
+        ]
+        monkeypatch.setattr(sys, "argv", argv)
+
+        # Act / Assert
+        fema.main()
+
+        # Assert
+        out = capsys.readouterr().out
+        assert "container-amd64-today-local" in out

tests/features/test_metadata_main.py

@@ -5,34 +5,8 @@
 import pytest
 
 import gardenlinux.features.metadata_main as metadata_main
-from gardenlinux.constants import (
-    GL_BUG_REPORT_URL,
-    GL_DISTRIBUTION_NAME,
-    GL_HOME_URL,
-    GL_RELEASE_ID,
-    GL_SUPPORT_URL,
-)
-
-
-def get_container_amd64_release_metadata(version, commit_hash):
-    return f"""
-ID={GL_RELEASE_ID}
-NAME="{GL_DISTRIBUTION_NAME}"
-PRETTY_NAME="{GL_DISTRIBUTION_NAME} today"
-IMAGE_VERSION=today
-VARIANT_ID="container-amd64"
-HOME_URL="{GL_HOME_URL}"
-SUPPORT_URL="{GL_SUPPORT_URL}"
-BUG_REPORT_URL="{GL_BUG_REPORT_URL}"
-GARDENLINUX_CNAME="container-amd64-today-local"
-GARDENLINUX_FEATURES="_slim,base,container"
-GARDENLINUX_FEATURES_PLATFORM="container"
-GARDENLINUX_FEATURES_ELEMENTS="base"
-GARDENLINUX_FEATURES_FLAGS="_slim"
-GARDENLINUX_VERSION="today"
-GARDENLINUX_COMMIT_ID="local"
-GARDENLINUX_COMMIT_ID_LONG="local"
-""".strip()
+
+from .constants import generate_container_amd64_release_metadata
 
 
 def test_main_output(monkeypatch, capsys):
@@ -56,7 +30,7 @@ def test_main_output(monkeypatch, capsys):
     metadata_main.main()
 
     # Assert
-    expected = get_container_amd64_release_metadata("today", "local")
+    expected = generate_container_amd64_release_metadata("today", "local")
     assert expected == capsys.readouterr().out.strip()
 
 
@@ -85,7 +59,7 @@ def test_main_write(monkeypatch, capsys):
         metadata_main.main()
 
         # Assert
-        expected = get_container_amd64_release_metadata("today", "local")
+        expected = generate_container_amd64_release_metadata("today", "local")
         assert expected == os_release_file.open("r").read()
 
 
@@ -98,7 +72,7 @@ def test_main_validation(monkeypatch):
         os_release_file = Path(tmpdir, "os_release")
 
         with os_release_file.open("w") as fp:
-            fp.write(get_container_amd64_release_metadata("today", "local"))
+            fp.write(generate_container_amd64_release_metadata("today", "local"))
 
         argv = [
             "prog",
@@ -115,5 +89,5 @@ def test_main_validation(monkeypatch):
         monkeypatch.setattr(sys, "argv", argv)
 
         # Act / Assert
-        with pytest.raises(AssertionError):
+        with pytest.raises(RuntimeError):
             metadata_main.main()