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]:
         """
@@ -400,6 +433,11 @@ def load_from_release_file(self, release_file: PathLike | str) -> None:
             UNNAMED_SECTION, "GARDENLINUX_FEATURES_PLATFORM"
         )
 
+        if release_config.has_option(UNNAMED_SECTION, "GARDENLINUX_PLATFORM_VARIANT"):
+            self._platform_variant_cached = release_config.get(
+                UNNAMED_SECTION, "GARDENLINUX_PLATFORM_VARIANT"
+            )
+
     def save_to_release_file(
         self, release_file: PathLike | str, overwrite: Optional[bool] = False
     ) -> None: