Add support to parse and return the GardenLinux "cname"

Relates: gardenlinux/gardenlinux#2830
Signed-off-by: Tobias Wolf <[email protected]>

Author: NotTheEvilOne

pyproject.toml

@@ -26,6 +26,7 @@ boto3 = "*"
 black = "^24.8.0"
 
 [tool.poetry.scripts]
+gl-cname = "src.python_gardenlinux_lib.cname:main"
 flavors-parse = "src.python_gardenlinux_lib.flavors.parse_flavors:main"
 
 [tool.pytest.ini_options]

src/python_gardenlinux_lib/cname.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+
+from .features import parse_features
+
+from functools import reduce
+from os.path import basename, dirname
+
+import argparse
+import re
+
+def main():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--feature-dir", default="features")
+    parser.add_argument("--arch", dest="arch")
+    parser.add_argument("--version", dest="version")
+    parser.add_argument("cname")
+
+    args = parser.parse_args()
+
+    re_match = re.match("([a-zA-Z0-9]+(-[a-zA-Z0-9\\_\\-]*?)?)(-([a-z0-9]+)(-([a-z0-9.]+)-([a-z0-9]+))*)?$", args.cname)
+    assert re_match, f"not a valid cname {args.cname}"
+
+    if re_match.lastindex == 1:
+        cname_base, arch = re_match[1].split("-", 1)
+        commit_id = None
+        version = None
+    else:
+        arch = re_match[4]
+        cname_base = re_match[1]
+        commit_id = re_match[7]
+        version = re_match[6]
+
+    if args.arch is not None:
+        arch = args.arch
+
+    if args.version is not None:
+        re_match = re.match("([a-z0-9.]+)(-([a-z0-9]+))?$", args.cname)
+        assert re_match, f"not a valid version {args.version}"
+
+        commit_id = re_match[3]
+        version = re_match[1]
+
+    gardenlinux_root = dirname(args.feature_dir)
+    feature_dir_name = basename(args.feature_dir)
+
+    if gardenlinux_root == "":
+        gardenlinux_root = "."
+
+    args = parser.parse_args()
+    graph = parse_features.get_features_graph(cname_base, gardenlinux_root, feature_dir_name)
+    sorted_features = parse_features.sort_nodes(graph)
+
+    minimal_feature_set = get_minimal_feature_set(graph)
+    sorted_minimal_features = parse_features.sort_set(minimal_feature_set, sorted_features)
+    cname_base = get_cname_base(sorted_minimal_features)
+
+    cname = f"{cname_base}-{arch}"
+    if commit_id is not None: cname += f"-{version}-{commit_id}"
+
+    print(cname)
+
+def get_cname_base(sorted_features):
+    return reduce(lambda a, b : a + ("-" if not b.startswith("_") else "") + b, sorted_features)
+
+def get_minimal_feature_set(graph):
+    return set([node for (node, degree) in graph.in_degree() if degree == 0])
+
+if __name__ == "__main__":
+    main()

src/python_gardenlinux_lib/constants.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+
+# It is important that this list is sorted in descending length of the entries
+GL_MEDIA_TYPES = [
+    "gcpimage.tar.gz.log",
+    "firecracker.tar.gz",
+    "platform.test.log",
+    "platform.test.xml",
+    "gcpimage.tar.gz",
+    "chroot.test.log",
+    "chroot.test.xml",
+    "pxe.tar.gz.log",
+    "root.squashfs",
+    "manifest.log",
+    "release.log",
+    "pxe.tar.gz",
+    "qcow2.log",
+    "test-log",
+    "boot.efi",
+    "manifest",
+    "vmdk.log",
+    "tar.log",
+    "uki.log",
+    "vmlinuz",
+    "release",
+    "vhd.log",
+    "ova.log",
+    "raw.log",
+    "oci.log",
+    "initrd",
+    "tar.gz",
+    "qcow2",
+    "tar",
+    "iso",
+    "oci",
+    "vhd",
+    "vmdk",
+    "ova",
+    "uki",
+    "raw",
+]
+
+GL_MEDIA_TYPE_LOOKUP = {
+    "tar": "application/io.gardenlinux.image.archive.format.tar",
+    "tar.gz": "application/io.gardenlinux.image.archive.format.tar.gz",
+    "pxe.tar.gz": "application/io.gardenlinux.image.archive.format.pxe.tar.gz",
+    "iso": "application/io.gardenlinux.image.archive.format.iso",
+    "oci": "application/io.gardenlinux.image.archive.format.oci",
+    "firecracker.tar.gz": "application/io.gardenlinux.image.archive.format.firecracker.tar.gz",
+    "qcow2": "application/io.gardenlinux.image.format.qcow2",
+    "vhd": "application/io.gardenlinux.image.format.vhd",
+    "gcpimage.tar.gz": "application/io.gardenlinux.image.format.gcpimage.tar.gz",
+    "vmdk": "application/io.gardenlinux.image.format.vmdk",
+    "ova": "application/io.gardenlinux.image.format.ova",
+    "uki": "application/io.gardenlinux.uki",
+    "uki.log": "application/io.gardenlinux.log",
+    "raw": "application/io.gardenlinux.image.archive.format.raw",
+    "manifest.log": "application/io.gardenlinux.log",
+    "release.log": "application/io.gardenlinux.log",
+    "test-log": "application/io.gardenlinux.test-log",
+    "manifest": "application/io.gardenlinux.manifest",
+    "tar.log": "application/io.gardenlinux.log",
+    "release": "application/io.gardenlinux.release",
+    "raw.log": "application/io.gardenlinux.log",
+    "qcow2.log": "application/io.gardenlinux.log",
+    "pxe.tar.gz.log": "application/io.gardenlinux.log",
+    "gcpimage.tar.gz.log": "application/io.gardenlinux.log",
+    "vmdk.log": "application/io.gardenlinux.log",
+    "vhd.log": "application/io.gardenlinux.log",
+    "ova.log": "application/io.gardenlinux.log",
+    "vmlinuz": "application/io.gardenlinux.kernel",
+    "initrd": "application/io.gardenlinux.initrd",
+    "root.squashfs": "application/io.gardenlinux.squashfs",
+    "boot.efi": "application/io.gardenlinux.efi",
+    "platform.test.log": "application/io.gardenlinux.io.platform.test.log",
+    "platform.test.xml": "application/io.gardenlinux.io.platform.test.xml",
+    "chroot.test.log": "application/io.gardenlinux.io.chroot.test.log",
+    "chroot.test.xml": "application/io.gardenlinux.io.chroot.test.xml",
+    "oci.log": "application/io.gardenlinux.log",
+}

src/python_gardenlinux_lib/features/parse_features.py

@@ -1,5 +1,6 @@
+from ..constants import GL_MEDIA_TYPE_LOOKUP, GL_MEDIA_TYPES
+
 from glob import glob
-from git.objects import commit
 import yaml
 import networkx
 import os
@@ -9,86 +10,6 @@
 
 from pygments.filter import apply_filters
 
-# It is important that this list is sorted in descending length of the entries
-GL_MEDIA_TYPES = [
-    "gcpimage.tar.gz.log",
-    "firecracker.tar.gz",
-    "platform.test.log",
-    "platform.test.xml",
-    "gcpimage.tar.gz",
-    "chroot.test.log",
-    "chroot.test.xml",
-    "pxe.tar.gz.log",
-    "root.squashfs",
-    "manifest.log",
-    "release.log",
-    "pxe.tar.gz",
-    "qcow2.log",
-    "test-log",
-    "boot.efi",
-    "manifest",
-    "vmdk.log",
-    "tar.log",
-    "uki.log",
-    "vmlinuz",
-    "release",
-    "vhd.log",
-    "ova.log",
-    "raw.log",
-    "oci.log",
-    "initrd",
-    "tar.gz",
-    "qcow2",
-    "tar",
-    "iso",
-    "oci",
-    "vhd",
-    "vmdk",
-    "ova",
-    "uki",
-    "raw",
-]
-
-
-GL_MEDIA_TYPE_LOOKUP = {
-    "tar": "application/io.gardenlinux.image.archive.format.tar",
-    "tar.gz": "application/io.gardenlinux.image.archive.format.tar.gz",
-    "pxe.tar.gz": "application/io.gardenlinux.image.archive.format.pxe.tar.gz",
-    "iso": "application/io.gardenlinux.image.archive.format.iso",
-    "oci": "application/io.gardenlinux.image.archive.format.oci",
-    "firecracker.tar.gz": "application/io.gardenlinux.image.archive.format.firecracker.tar.gz",
-    "qcow2": "application/io.gardenlinux.image.format.qcow2",
-    "vhd": "application/io.gardenlinux.image.format.vhd",
-    "gcpimage.tar.gz": "application/io.gardenlinux.image.format.gcpimage.tar.gz",
-    "vmdk": "application/io.gardenlinux.image.format.vmdk",
-    "ova": "application/io.gardenlinux.image.format.ova",
-    "uki": "application/io.gardenlinux.uki",
-    "uki.log": "application/io.gardenlinux.log",
-    "raw": "application/io.gardenlinux.image.archive.format.raw",
-    "manifest.log": "application/io.gardenlinux.log",
-    "release.log": "application/io.gardenlinux.log",
-    "test-log": "application/io.gardenlinux.test-log",
-    "manifest": "application/io.gardenlinux.manifest",
-    "tar.log": "application/io.gardenlinux.log",
-    "release": "application/io.gardenlinux.release",
-    "raw.log": "application/io.gardenlinux.log",
-    "qcow2.log": "application/io.gardenlinux.log",
-    "pxe.tar.gz.log": "application/io.gardenlinux.log",
-    "gcpimage.tar.gz.log": "application/io.gardenlinux.log",
-    "vmdk.log": "application/io.gardenlinux.log",
-    "vhd.log": "application/io.gardenlinux.log",
-    "ova.log": "application/io.gardenlinux.log",
-    "vmlinuz": "application/io.gardenlinux.kernel",
-    "initrd": "application/io.gardenlinux.initrd",
-    "root.squashfs": "application/io.gardenlinux.squashfs",
-    "boot.efi": "application/io.gardenlinux.efi",
-    "platform.test.log": "application/io.gardenlinux.io.platform.test.log",
-    "platform.test.xml": "application/io.gardenlinux.io.platform.test.xml",
-    "chroot.test.log": "application/io.gardenlinux.io.chroot.test.log",
-    "chroot.test.xml": "application/io.gardenlinux.io.chroot.test.xml",
-    "oci.log": "application/io.gardenlinux.log",
-}
-
 
 def get_gardenlinux_commit(gardenlinux_root: str, limit: Optional[int] = None) -> str:
     """
@@ -118,54 +39,75 @@ def get_gardenlinux_commit(gardenlinux_root: str, limit: Optional[int] = None) -
         return commit_str
 
 
-def get_features_dict(cname: str, gardenlinux_root: str) -> dict:
+def get_features_dict(
+    cname: str, gardenlinux_root: str, feature_dir_name: str = "features"
+) -> dict:
     """
     :param str cname: the target cname to get the feature dict for
     :param str gardenlinux_root: path of garden linux src root
     :return: dict with list of features for a given cname, split into platform, element and flag
 
     """
-    feature_base_dir = f"{gardenlinux_root}/features"
-    input_features = __reverse_cname_base(cname)
-    feature_graph = read_feature_files(feature_base_dir)
-    graph = filter_graph(feature_graph, input_features)
+
+    graph = get_features_graph(cname, gardenlinux_root, feature_dir_name)
     features = __reverse_sort_nodes(graph)
     features_by_type = dict()
+
     for type in ["platform", "element", "flag"]:
         features_by_type[type] = [
             feature
             for feature in features
             if __get_node_type(graph.nodes[feature]) == type
         ]
-    return features_by_type
 
+    return features_by_type
 
-def get_features_list(cname: str, gardenlinux_root: str) -> list:
+def get_features_graph(
+    cname: str, gardenlinux_root: str, feature_dir_name: str = "features"
+) -> networkx.graph:
     """
     :param str cname: the target cname to get the feature dict for
     :param str gardenlinux_root: path of garden linux src root
     :return: list of features for a given cname
 
     """
-    feature_base_dir = f"{gardenlinux_root}/features"
+
+    feature_base_dir = f"{gardenlinux_root}/{feature_dir_name}"
     input_features = __reverse_cname_base(cname)
     feature_graph = read_feature_files(feature_base_dir)
     graph = filter_graph(feature_graph, input_features)
+
+    return graph
+
+
+def get_features_list(
+    cname: str, gardenlinux_root: str, feature_dir_name: str = "features"
+) -> list:
+    """
+    :param str cname: the target cname to get the feature dict for
+    :param str gardenlinux_root: path of garden linux src root
+    :return: list of features for a given cname
+
+    """
+
+    graph = get_features_graph(cname, gardenlinux_root, feature_dir_name)
     features = __reverse_sort_nodes(graph)
+
     return features
 
 
-def get_features(cname: str, gardenlinux_root: str) -> str:
+def get_features(
+    cname: str, gardenlinux_root: str, feature_dir_name: str = "features"
+) -> str:
     """
     :param str cname: the target cname to get the feature set for
     :param str gardenlinux_root: path of garden linux src root
     :return: a comma separated string with the expanded feature set for the cname
     """
-    feature_base_dir = f"{gardenlinux_root}/features"
-    input_features = __reverse_cname_base(cname)
-    feature_graph = read_feature_files(feature_base_dir)
-    graph = filter_graph(feature_graph, input_features)
+
+    graph = get_features_graph(cname, gardenlinux_root, feature_dir_name)
     features = __reverse_sort_nodes(graph)
+
     return ",".join(features)
 
 
@@ -458,7 +400,7 @@ def __sort_key(graph, node):
     return f"{prefix}-{node}"
 
 
-def __sort_nodes(graph):
+def sort_nodes(graph):
     def key_function(node):
         return __sort_key(graph, node)
 
@@ -473,7 +415,7 @@ def __reverse_cname_base(cname):
 def __reverse_sort_nodes(graph):
     reverse_graph = graph.reverse()
     assert networkx.is_directed_acyclic_graph(reverse_graph)
-    return __sort_nodes(reverse_graph)
+    return sort_nodes(reverse_graph)
 
 
 def __get_node_type(node):