Add support to provide the full commit hash in gardenlinux.features.CName

Signed-off-by: Tobias Wolf <[email protected]>

Author: NotTheEvilOne

src/gardenlinux/features/__main__.py

@@ -70,7 +70,7 @@ def main() -> None:
 
     arch = args.arch
     flavor = None
-    commit_id = args.commit
+    commit_id_or_hash = args.commit
     gardenlinux_root = path.dirname(args.feature_dir)
     version = args.version
 
@@ -82,7 +82,9 @@ def main() -> None:
 
     if version is None or version == "":
         try:
-            version, commit_id = get_version_and_commit_id_from_files(gardenlinux_root)
+            version, commit_id_or_hash = get_version_and_commit_id_from_files(
+                gardenlinux_root
+            )
         except RuntimeError as exc:
             logging.debug(
                 "Failed to parse version information for GL root '{0}': {1}".format(
@@ -93,11 +95,13 @@ def main() -> None:
             version = args.default_version
 
     if args.cname:
-        cname = CName(args.cname, arch=arch, commit_id=commit_id, version=version)
+        cname = CName(
+            args.cname, arch=arch, commit_hash=commit_id_or_hash, version=version
+        )
 
         arch = cname.arch
         flavor = cname.flavor
-        commit_id = cname.commit_id
+        commit_id_or_hash = cname.commit_id
         version = cname.version
 
         input_features = Parser.get_cname_as_feature_set(flavor)
@@ -142,8 +146,8 @@ def main() -> None:
             if arch is not None:
                 cname += f"-{arch}"
 
-            if commit_id is not None:
-                cname += f"-{version}-{commit_id}"
+            if commit_id_or_hash is not None:
+                cname += f"-{version}-{commit_id_or_hash[:8]}"
 
             print(cname)
         elif args.type == "graph":
@@ -166,11 +170,11 @@ def main() -> None:
         elif args.type == "flags":
             print(",".join(features_by_type["flag"]))
     elif args.type == "commit_id":
-        print(commit_id)
+        print(commit_id_or_hash[:8])
     elif args.type == "version":
         print(version)
     elif args.type == "version_and_commit_id":
-        print(f"{version}-{commit_id}")
+        print(f"{version}-{commit_id_or_hash[:8]}")
 
 
 def get_cname_base(sorted_features: Set[str]):
@@ -198,21 +202,21 @@ def get_version_and_commit_id_from_files(gardenlinux_root: str) -> tuple[str, st
     :since:  0.7.0
     """
 
-    commit_id = None
+    commit_hash = None
     version = None
 
     if os.access(path.join(gardenlinux_root, "COMMIT"), os.R_OK):
         with open(path.join(gardenlinux_root, "COMMIT"), "r") as fp:
-            commit_id = fp.read().strip()[:8]
+            commit_hash = fp.read().strip()[:8]
 
     if os.access(path.join(gardenlinux_root, "VERSION"), os.R_OK):
         with open(path.join(gardenlinux_root, "VERSION"), "r") as fp:
             version = fp.read().strip()
 
-    if commit_id is None or version is None:
+    if commit_hash is None or version is None:
         raise RuntimeError("Failed to read version or commit ID from files")
 
-    return (version, commit_id)
+    return (version, commit_hash)
 
 
 def get_minimal_feature_set(graph: Any) -> Set[str]:

src/gardenlinux/features/cname.py

@@ -27,25 +27,28 @@ class CName(object):
                  Apache License, Version 2.0
     """
 
-    def __init__(self, cname, arch=None, commit_id=None, version=None):
+    def __init__(self, cname, arch=None, commit_hash=None, version=None):
         """
         Constructor __init__(CName)
 
         :param cname:     Canonical name to represent
         :param arch:      Architecture if not part of cname
-        :param commit_id: Commit ID if not part of cname
+        :param commit_hash: Commit ID or hash if not part of cname
         :param version:   Version if not part of cname
 
         :since: 0.7.0
         """
 
         self._arch = None
+        self._commit_hash = None
         self._commit_id = None
         self._feature_set_cached = None
         self._flavor = None
         self._version = None
         self._platforms_cached = None
 
+        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,
@@ -56,7 +59,7 @@ def __init__(self, cname, arch=None, commit_id=None, version=None):
         if re_match.lastindex == 1:
             self._flavor = re_match[1]
         else:
-            self._commit_id = re_match[7]
+            commit_id_or_hash = re_match[7]
             self._flavor = re_match[1]
             self._version = re_match[6]
 
@@ -69,17 +72,23 @@ def __init__(self, cname, arch=None, commit_id=None, version=None):
             self._arch = arch
 
         if self._version is None and version is not None:
-            # Support version values formatted as <version>-<commit_id>
-            if commit_id is 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}"
 
-                self._commit_id = re_match[3]
+                commit_id_or_hash = re_match[3]
                 self._version = re_match[1]
             else:
-                self._commit_id = commit_id
+                commit_id_or_hash = commit_hash
                 self._version = version
 
+        if commit_id_or_hash is not None:
+            self._commit_id = commit_id_or_hash[:8]
+
+            if len(commit_id_or_hash) == 40: # sha1 hex
+                self._commit_hash = commit_id_or_hash
+
     @property
     def arch(self) -> Optional[str]:
         """
@@ -110,6 +119,36 @@ def cname(self) -> str:
 
         return cname
 
+    @property
+    def commit_hash(self) -> str:
+        """
+        Returns the commit hash if part of the cname parsed.
+
+        :return: (str) Commit hash
+        :since:  0.11.0
+        """
+
+        if self._commit_hash is None:
+            raise RuntimeError("GardenLinux canonical name given does not contain the commit hash")
+
+        return self._commit_hash
+
+    @commit_hash.setter
+    def commit_hash(self, commit_hash) -> None:
+        """
+        Sets the commit hash
+
+        :param commit_hash: Commit hash
+
+        :since: 0.11.0
+        """
+
+        if self._commit_id is not None and not commit_hash.startswith(self._commit_id):
+            raise RuntimeError("Commit hash given differs from commit ID already set")
+
+        self._commit_id = commit_hash[:8]
+        self._commit_hash = commit_hash
+
     @property
     def commit_id(self) -> Optional[str]:
         """
@@ -166,7 +205,7 @@ def platforms(self) -> List[str]:
         Returns the platforms for the cname parsed.
 
         :return: (str) Flavor
-        :since:  0.9.2
+        :since:  0.11.0
         """
 
         if self._platforms_cached is not None:
@@ -205,7 +244,7 @@ def load_from_metadata_file(self, metadata_file: PathLike | str) -> None:
 
         :param metadata_file: Metadata file containing information about the CName instance.
 
-        :since: 0.9.2
+        :since: 0.11.0
         """
 
         if not isinstance(metadata_file, PathLike):
@@ -233,6 +272,7 @@ def load_from_metadata_file(self, metadata_file: PathLike | str) -> None:
         )
 
         commit_id = metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID")
+        commit_hash = metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_COMMIT_ID_LONG")
         version = metadata_config.get(UNNAMED_SECTION, "GARDENLINUX_VERSION")
 
         if (
@@ -248,6 +288,7 @@ def load_from_metadata_file(self, metadata_file: PathLike | str) -> None:
 
         self._arch = loaded_cname_instance.arch
         self._flavor = loaded_cname_instance.flavor
+        self._commit_hash = commit_hash
         self._commit_id = commit_id
         self._version = version
 
@@ -267,7 +308,7 @@ def save_to_metadata_file(
 
         :param metadata_file: Metadata file containing information about the CName instance.
 
-        :since: 0.9.2
+        :since: 0.11.0
         """
 
         if not isinstance(metadata_file, PathLike):
@@ -300,7 +341,7 @@ def save_to_metadata_file(
 GARDENLINUX_FEATURES_FLAGS="{flags}"
 GARDENLINUX_VERSION="{self.version}"
 GARDENLINUX_COMMIT_ID="{self.commit_id}"
-GARDENLINUX_COMMIT_ID_LONG=$BUILDER_COMMIT
+GARDENLINUX_COMMIT_ID_LONG="{self.commit_hash}"
         """.strip()
 
         with metadata_file.open("w") as fp:

src/gardenlinux/features/cname_main.py

@@ -46,7 +46,7 @@ def main():
     assert re_match, f"Not a valid GardenLinux canonical name {args.cname}"
 
     arch = args.arch
-    commit_id = args.commit
+    commit_id_or_hash = args.commit
     gardenlinux_root = dirname(args.feature_dir)
     version = args.version
 
@@ -55,15 +55,17 @@ def main():
 
     if not version:
         try:
-            version, commit_id = get_version_and_commit_id_from_files(gardenlinux_root)
+            version, commit_id_or_hash = get_version_and_commit_id_from_files(
+                gardenlinux_root
+            )
         except RuntimeError as exc:
             logging.warning(
                 "Failed to parse version information for GL root '{0}': {1}".format(
                     gardenlinux_root, exc
                 )
             )
 
-    cname = CName(args.cname, arch=arch, commit_id=commit_id, version=version)
+    cname = CName(args.cname, arch=arch, commit_hash=commit_id_or_hash, version=version)
 
     assert cname.arch, "Architecture could not be determined"