Add workaround to accept GL canonical names without a commit ID

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

Author: NotTheEvilOne

.github/actions/features_parse/action.yml

@@ -11,7 +11,7 @@ outputs:
 runs:
   using: composite
   steps:
-    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.10
+    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.11
     - id: result
       shell: bash
       run: |

.github/actions/flavors_parse/action.yml

@@ -13,7 +13,7 @@ outputs:
 runs:
   using: composite
   steps:
-    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.10
+    - uses: gardenlinux/python-gardenlinux-lib/.github/actions/setup@0.10.11
     - id: matrix
       shell: bash
       run: |

.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.10"
+    default: "0.10.11"
   python_version:
     description: Python version to setup
     default: "3.13"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gardenlinux"
-version = "0.10.10"
+version = "0.10.11"
 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/features/cname.py

@@ -69,17 +69,46 @@ def __init__(
 
         commit_id_or_hash = None
 
-        re_match = re.match(
-            "([a-zA-Z0-9]+([\\_\\-][a-zA-Z0-9]+)*?)(-([a-z0-9]+)(-([a-z0-9.]+)-([a-z0-9]+))*)?$",
-            cname,
+        if version is not None:
+            # Support version values formatted as <version>-<commit_hash>
+            if commit_hash is None:
+                re_match = re.match("([a-z0-9.]+)(-([a-z0-9]+))?$", version)
+                assert re_match, f"Not a valid version {version}"
+
+                commit_id_or_hash = re_match[3]
+                version = re_match[1]
+            else:
+                commit_id_or_hash = commit_hash
+
+        re_object = re.compile(
+            "([a-zA-Z0-9]+([\\_\\-][a-zA-Z0-9]+)*?)(-([a-z0-9]+)(-([a-z0-9.]+)-([a-z0-9]+))*)?$"
         )
 
+        re_match = re_object.match(cname)
+
+        # Workaround Garden Linux canonical names without mandatory final commit hash
+        if (
+            not re_match
+            and commit_id_or_hash
+            and re.match(
+                "([a-zA-Z0-9]+([\\_\\-][a-zA-Z0-9]+)*?)(-([a-z0-9]+)(-([a-z0-9.]+))*)?$",
+                cname,
+            )
+        ):
+            re_match = re_object.match(f"{cname}-{commit_id_or_hash}")
+
         assert re_match, f"Not a valid Garden Linux canonical name {cname}"
 
         if re_match.lastindex == 1:
             self._flavor = re_match[1]
         else:
-            commit_id_or_hash = re_match[7]
+            if commit_id_or_hash is None:
+                commit_id_or_hash = re_match[7]
+            elif re_match.group(7) is not None:
+                assert commit_id_or_hash.startswith(re_match[7]), (
+                    f"Mismatch between Garden Linux canonical name {cname} and given commit ID {commit_id_or_hash} detected"
+                )
+
             self._flavor = re_match[1]
             self._version = re_match[6]
 
@@ -92,16 +121,7 @@ def __init__(
             self._arch = arch
 
         if self._version is None and version is not None:
-            # Support version values formatted as <version>-<commit_hash>
-            if commit_hash is None:
-                re_match = re.match("([a-z0-9.]+)(-([a-z0-9]+))?$", version)
-                assert re_match, f"Not a valid version {version}"
-
-                commit_id_or_hash = re_match[3]
-                self._version = re_match[1]
-            else:
-                commit_id_or_hash = commit_hash
-                self._version = version
+            self._version = version
 
         if commit_id_or_hash is not None:
             self._commit_id = commit_id_or_hash[:8]
@@ -312,21 +332,36 @@ def release_metadata_string(self) -> str:
             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
+
+        if commit_id is None:
+            commit_id = ""
+
+        if commit_hash is None:
+            commit_hash = commit_id
 
         if platform_variant is None:
             platform_variant = ""
 
+        if version is None:
+            pretty_name = f"{GL_DISTRIBUTION_NAME} unsupported version"
+            version = ""
+        else:
+            pretty_name=f"{GL_DISTRIBUTION_NAME} {version}"
+
         metadata = f"""
 ID={GL_RELEASE_ID}
 ID_LIKE=debian
 NAME="{GL_DISTRIBUTION_NAME}"
-PRETTY_NAME="{GL_DISTRIBUTION_NAME} {self.version}"
-IMAGE_VERSION={self.version}
+PRETTY_NAME="{pretty_name}"
+IMAGE_VERSION={version}
 VARIANT_ID="{self.flavor}-{self.arch}"
 HOME_URL="{GL_HOME_URL}"
 SUPPORT_URL="{GL_SUPPORT_URL}"
@@ -338,9 +373,9 @@ def release_metadata_string(self) -> str:
 GARDENLINUX_FEATURES_FLAGS="{flags}"
 GARDENLINUX_PLATFORM="{platform}"
 GARDENLINUX_PLATFORM_VARIANT="{platform_variant}"
-GARDENLINUX_VERSION="{self.version}"
-GARDENLINUX_COMMIT_ID="{self.commit_id}"
-GARDENLINUX_COMMIT_ID_LONG="{self.commit_hash}"
+GARDENLINUX_VERSION="{version}"
+GARDENLINUX_COMMIT_ID="{commit_id}"
+GARDENLINUX_COMMIT_ID_LONG="{commit_hash}"
         """.strip()
 
         return metadata
@@ -365,7 +400,7 @@ def version_and_commit_id(self) -> Optional[str]:
         :since:  0.7.0
         """
 
-        if self._commit_id is None:
+        if self._version is None or self._commit_id is None:
             return None
 
         return f"{self._version}-{self._commit_id}"

src/gardenlinux/s3/s3_artifacts.py

@@ -158,10 +158,10 @@ def upload_from_directory(
         if secureboot is None:
             secureboot = "_trustedboot" in feature_list
 
-        commit_hash = cname_object.commit_hash
+        commit_id_or_hash = cname_object.commit_hash
 
-        if commit_hash is None:
-            commit_hash = ""
+        if commit_id_or_hash is None:
+            commit_id_or_hash = cname_object.commit_id
 
         version_epoch = str(cname_object.version_epoch)
 
@@ -172,7 +172,7 @@ def upload_from_directory(
             "platform": cname_object.feature_set_platform,
             "architecture": cname_object.arch,
             "base_image": None,
-            "build_committish": commit_hash,
+            "build_committish": commit_id_or_hash,
             "build_timestamp": datetime.fromtimestamp(release_timestamp).isoformat(),
             "gardenlinux_epoch": {version_epoch},
             "logs": None,
@@ -224,7 +224,7 @@ def upload_from_directory(
                 "architecture": re_object.sub("+", cname_object.arch),
                 "platform": re_object.sub("+", cname_object.platform),
                 "version": re_object.sub("+", cname_object.version),  # type: ignore[arg-type]
-                "committish": commit_hash,
+                "committish": commit_id_or_hash,
                 "md5sum": md5sum,
                 "sha256sum": sha256sum,
             }

tests/s3/conftest.py

@@ -27,7 +27,7 @@ def make_cname(
     flavor: str = "container",
     arch: str = "amd64",
     version: str = "1234.1",
-    commit: str = "abc123",
+    commit: str = "abc123long",
 ) -> str:
     """
     Helper function to build cname. Can be used to customized the cname.

tests/s3/test_s3_artifacts.py

@@ -11,7 +11,7 @@
 from .conftest import S3Env
 
 RELEASE_DATA = """
-GARDENLINUX_CNAME="container-amd64-1234.1-abc123"
+GARDENLINUX_CNAME="container-amd64-1234.1"
 GARDENLINUX_VERSION=1234.1
 GARDENLINUX_COMMIT_ID="abc123"
 GARDENLINUX_COMMIT_ID_LONG="abc123long"