Restructure GL features parsing and module structure

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

Author: NotTheEvilOne

poetry.lock

@@ -1,11 +1,11 @@
 [tool.poetry]
-name = "python_gardenlinux_lib"
+name = "gardenlinux"
 version = "0.6.0"
 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 <[email protected]>"]
 license = "Apache-2.0"
 readme = "README.md"
-packages = [{include = "python_gardenlinux_lib", from="src"}]
+packages = [{include = "gardenlinux", from="src"}, {include = "python_gardenlinux_lib", from="src"}]
 
 [tool.poetry.dependencies]
 python = "^3.10"
@@ -21,18 +21,17 @@ python-dotenv = "^1.0.1"
 cryptography = "^44.0.0"
 boto3 = "*"
 
-
 [tool.poetry.group.dev.dependencies]
 black = "^24.8.0"
 
 [tool.poetry.scripts]
-gl-cname = "src.python_gardenlinux_lib.cname:main"
-flavors-parse = "python_gardenlinux_lib.flavors.__main__:main"
+gl-cname = "gardenlinux.features.cname_main:main"
+gl-features-parse = "gardenlinux.features.__main__:main"
+gl-flavors-parse = "gardenlinux.flavors.__main__:main"
+flavors-parse = "gardenlinux.flavors.__main__:main"
 
 [tool.pytest.ini_options]
-pythonpath = [
-  "src"
-]
+pythonpath = ["src"]
 norecursedirs = "test-data"
 
 [build-system]

pyproject.toml

@@ -0,0 +1 @@
+from .parser import Parser

src/gardenlinux/features/__init__.py

@@ -0,0 +1,172 @@
+#!/usr/bin/env python3
+
+from .parser import Parser
+
+from functools import reduce
+from os.path import basename, dirname
+
+import argparse
+import re
+import sys
+
+
+_ARGS_TYPE_ALLOWED = [
+    "cname",
+    "cname_base",
+    "features",
+    "platforms",
+    "flags",
+    "elements",
+    "arch",
+    "version",
+    "graph"
+]
+
+
+def main():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--arch", dest = "arch")
+    parser.add_argument("--feature-dir", default = "features")
+    parser.add_argument("--features", type = lambda arg: set([f for f in arg.split(",") if f]))
+    parser.add_argument("--ignore", dest = "ignore", type = lambda arg: set([f for f in arg.split(",") if f]), default = set())
+    parser.add_argument("--cname")
+    parser.add_argument("--default-arch")
+    parser.add_argument("--default-version")
+    parser.add_argument("--version", dest="version")
+    parser.add_argument("type", nargs="?", choices = _ARGS_TYPE_ALLOWED, default = "cname")
+
+    args = parser.parse_args()
+
+    assert bool(args.features) or bool(args.cname), "Please provide either `--features` or `--cname` argument"
+
+    arch = None
+    cname_base = None
+    commit_id = None
+    version = None
+
+    if args.cname:
+        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 GardenLinux canonical name {args.cname}"
+
+        if re_match.lastindex == 1:
+            data_splitted = re_match[1].split("-", 1)
+
+            if len(data_splitted) > 1:
+                arch = data_splitted[1]
+
+            cname_base = data_splitted[0]
+        else:
+            arch = re_match[4]
+            cname_base = re_match[1]
+            commit_id = re_match[7]
+            version = re_match[6]
+
+        input_features = Parser.get_cname_as_feature_set(cname_base)
+    else:
+        input_features = args.features
+
+    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.version)
+        assert re_match, f"Not a valid version {args.version}"
+
+        commit_id = re_match[3]
+        version = re_match[1]
+
+    if arch is None or arch == "" and (args.type in ( "cname", "arch" )):
+        assert args.default_arch, "Architecture could not be determined and no default architecture set"
+        arch = args.default_arch
+
+    if not version and (args.type in ("cname", "version" )):
+        assert args.default_version, "version not specified and no default version set"
+        version = args.default_version
+
+    gardenlinux_root = dirname(args.feature_dir)
+    feature_dir_name = basename(args.feature_dir)
+
+    if gardenlinux_root == "":
+        gardenlinux_root = "."
+
+    if gardenlinux_root == "":
+        gardenlinux_root = "."
+
+    additional_filter_func = lambda node: node not in args.ignore
+
+    if args.type == "arch":
+        print(arch)
+    elif args.type in ( "cname_base", "cname", "graph" ):
+        graph = Parser(gardenlinux_root, feature_dir_name).filter(cname_base, additional_filter_func = additional_filter_func)
+
+        sorted_features = Parser.sort_reversed_graph_nodes(graph)
+
+        minimal_feature_set = get_minimal_feature_set(graph)
+
+        sorted_minimal_features = sort_subset(
+            minimal_feature_set, sorted_features
+        )
+
+        cname_base = get_cname_base(sorted_minimal_features)
+
+        if args.type == "cname_base":
+            print(cname_base)
+        elif args.type == "cname":
+            cname = cname_base
+
+            if arch is not None:
+                cname += f"-{arch}"
+
+            if commit_id is not None:
+                cname += f"-{version}-{commit_id}"
+
+            print(cname)
+        elif args.type == "graph":
+            print(graph_as_mermaid_markup(cname_base, graph))
+    elif args.type == "features":
+	    print(Parser(gardenlinux_root, feature_dir_name).filter_as_string(cname_base, additional_filter_func = additional_filter_func))
+    elif args.type in ( "flags", "elements", "platforms" ):
+        features_by_type = Parser(gardenlinux_root, feature_dir_name).filter_as_dict(cname_base, additional_filter_func = additional_filter_func)
+
+        if args.type == "platforms":
+            print(",".join(features_by_type["platform"]))
+        elif args.type == "elements":
+            print(",".join(features_by_type["element"]))
+        elif args.type == "flags":
+            print(",".join(features_by_type["flag"]))
+    elif args.type == "version":
+        print(f"{version}-{commit_id}")
+
+
+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])
+
+def graph_as_mermaid_markup(cname_base, graph):
+	"""
+	Generates a mermaid.js representation of the graph.
+	This is helpful to identify dependencies between features.
+
+	Syntax docs:
+	https://mermaid.js.org/syntax/flowchart.html?id=flowcharts-basic-syntax
+	"""
+	markup = f"---\ntitle: Dependency Graph for Feature {cname_base}\n---\ngraph TD;\n"
+	for u,v in graph.edges:
+		markup += f"    {u}-->{v};\n"
+	return markup
+
+def sort_subset(input_set, order_list):
+    return [item for item in order_list if item in input_set]
+
+
+if __name__ == "__main__":
+    main()

src/gardenlinux/features/__main__.py

@@ -1,13 +1,13 @@
 #!/usr/bin/env python3
 
-from .features import parse_features
-
 from functools import reduce
 from os.path import basename, dirname
-
 import argparse
 import re
 
+from .__main__ import get_cname_base, get_minimal_feature_set, sort_subset
+from .parser import Parser
+
 
 def main():
     parser = argparse.ArgumentParser()
@@ -24,12 +24,19 @@ def main():
         args.cname
     )
 
-    assert re_match, f"not a valid cname {args.cname}"
+    assert re_match, f"Not a valid GardenLinux canonical name {args.cname}"
+
+    arch = None
+    commit_id = None
+    version = None
 
     if re_match.lastindex == 1:
-        cname_base, arch = re_match[1].split("-", 1)
-        commit_id = None
-        version = None
+        data_splitted = re_match[1].split("-", 1)
+
+        if len(data_splitted) > 1:
+            arch = data_splitted[1]
+
+        cname_base = data_splitted[0]
     else:
         arch = re_match[4]
         cname_base = re_match[1]
@@ -39,9 +46,11 @@ def main():
     if args.arch is not None:
         arch = args.arch
 
+    assert arch is None or arch == "", "Architecture could not be determined"
+
     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}"
+        re_match = re.match("([a-z0-9.]+)(-([a-z0-9]+))?$", args.version)
+        assert re_match, f"Not a valid version {args.version}"
 
         commit_id = re_match[3]
         version = re_match[1]
@@ -52,34 +61,26 @@ def main():
     if gardenlinux_root == "":
         gardenlinux_root = "."
 
-    graph = parse_features.get_features_graph(
-        cname_base, gardenlinux_root, feature_dir_name
-    )
+    graph = Parser(gardenlinux_root, feature_dir_name).filter(cname_base)
 
-    sorted_features = parse_features.sort_nodes(graph)
+    sorted_features = Parser.sort_reversed_graph_nodes(graph)
 
     minimal_feature_set = get_minimal_feature_set(graph)
 
-    sorted_minimal_features = parse_features.sort_set(
+    sorted_minimal_features = sort_subset(
         minimal_feature_set, sorted_features
     )
 
-    cname_base = get_cname_base(sorted_minimal_features)
+    cname = get_cname_base(sorted_minimal_features)
+
+    if arch is not None:
+        cname += f"-{arch}"
 
-    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()