Adapt unit tests for GardenLinux feature changes

Signed-off-by: Tobias Wolf <[email protected]>
On-behalf-of: SAP <[email protected]>

Author: NotTheEvilOne

src/gardenlinux/features/__main__.py

@@ -9,7 +9,6 @@
 import logging
 import os
 import re
-from functools import reduce
 from os import path
 from typing import Any, List, Set
 
@@ -167,21 +166,6 @@ def main() -> None:
         print(f"{version}-{commit_id_or_hash[:8]}")
 
 
-def get_flavor(sorted_features: List[str]):
-    """
-    Get the base cname for the feature set given.
-
-    :param sorted_features: Sorted feature set
-
-    :return: (str) Base cname
-    :since: 0.7.0
-    """
-
-    return reduce(
-        lambda a, b: a + ("-" if not b.startswith("_") else "") + b, sorted_features
-    )
-
-
 def get_version_and_commit_id_from_files(gardenlinux_root: str) -> tuple[str, str]:
     """
     Returns the version and commit ID based on files in the GardenLinux root directory.
@@ -287,9 +271,9 @@ def print_output_from_features_parser(
         sorted_features = Parser.sort_graph_nodes(graph)
         minimal_feature_set = get_minimal_feature_set(graph)
 
-        sorted_minimal_features = sort_subset(minimal_feature_set, sorted_features)
+        sorted_minimal_features = Parser.subset(minimal_feature_set, sorted_features)
 
-        cname_base = get_flavor(sorted_minimal_features)
+        cname_base = Parser.get_flavor_from_feature_set(sorted_minimal_features)
 
         if output_type == "cname_base":
             print(cname_base)
@@ -325,10 +309,21 @@ def print_output_from_cname(output_type: str, cname_instance: CName) -> None:
     :since: 0.11.0
     """
 
-    if output_type == "cname_base":
-        print(cname_instance.flavor)
-    elif output_type == "cname":
-        print(cname_instance.cname)
+    if output_type in ("cname_base", "cname", "flavor"):
+        sorted_features = Parser.get_flavor_as_feature_set(cname_instance.flavor)
+        flavor = Parser.get_flavor_from_feature_set(sorted_features)
+
+        if output_type in ("cname_base", "flavor"):
+            print(flavor)
+        else:
+            if cname_instance.version_and_commit_id is None:
+                raise RuntimeError(
+                    "Version and commit ID can't be provided without appropriate input."
+                )
+
+            print(
+                f"{flavor}-{cname_instance.arch}-{cname_instance.version_and_commit_id}"
+            )
     elif output_type == "container_name":
         print(RE_CAMEL_CASE_SPLITTER.sub("\\1-\\2", cname_instance.flavor).lower())
     elif output_type == "platform":
@@ -341,19 +336,5 @@ def print_output_from_cname(output_type: str, cname_instance: CName) -> None:
         print(cname_instance.feature_set_flag)
 
 
-def sort_subset(input_set: Set[str], order_list: List[str]) -> List[str]:
-    """
-    Returns items from `order_list` if given in `input_set`.
-
-    :param input_set:  Set of values
-    :param order_list: networkx.Digraph
-
-    :return: (str) mermaid.js representation
-    :since:  0.7.0
-    """
-
-    return [item for item in order_list if item in input_set]
-
-
 if __name__ == "__main__":
     main()

src/gardenlinux/features/cname.py

@@ -53,7 +53,11 @@ 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._flag_multiple_platforms = bool(environ.get("GL_ALLOW_FRANKENSTEIN", False))
+
+        self._flag_multiple_platforms = bool(
+            environ.get("GL_ALLOW_FRANKENSTEIN", False)
+        )
+
         self._flavor = None
         self._version = None
 
@@ -242,7 +246,8 @@ def feature_set_platform(self) -> str:
         if self._flag_multiple_platforms:
             return ",".join(platforms)
 
-        assert len(platforms) < 2; "Only one platform is supported"
+        assert len(platforms) < 2
+        "Only one platform is supported"
         return platforms[0]
 
     @property
@@ -257,7 +262,8 @@ def release_metadata_string(self) -> str:
         features = Parser().filter_as_dict(self.flavor)
 
         if not self._flag_multiple_platforms:
-            assert len(features["platform"]) < 2; "Only one platform is supported"
+            assert len(features["platform"]) < 2
+            "Only one platform is supported"
 
         elements = ",".join(features["element"])
         flags = ",".join(features["flag"])

src/gardenlinux/features/cname_main.py

@@ -11,10 +11,8 @@
 from os.path import basename, dirname
 
 from .__main__ import (
-    get_flavor,
     get_minimal_feature_set,
     get_version_and_commit_id_from_files,
-    sort_subset,
 )
 from .cname import CName
 from .parser import Parser
@@ -78,9 +76,9 @@ def main():
     sorted_features = Parser.sort_graph_nodes(graph)
     minimal_feature_set = get_minimal_feature_set(graph)
 
-    sorted_minimal_features = sort_subset(minimal_feature_set, sorted_features)
+    sorted_minimal_features = Parser.subset(minimal_feature_set, sorted_features)
 
-    generated_cname = get_flavor(sorted_minimal_features)
+    generated_cname = Parser.get_flavor_from_feature_set(sorted_minimal_features)
 
     generated_cname += f"-{cname.arch}"
 

src/gardenlinux/features/parser.py

@@ -6,9 +6,10 @@
 
 import logging
 import os
+from functools import reduce
 from glob import glob
 from pathlib import Path
-from typing import Callable, Optional, cast
+from typing import Callable, List, Optional, Set
 
 import networkx
 import yaml
@@ -131,7 +132,7 @@ def filter(
         :since:  0.7.0
         """
 
-        feature_set = Parser.get_cname_as_feature_set(cname)
+        feature_set = Parser.get_flavor_as_feature_set(cname)
 
         return self.filter_based_on_feature_set(
             feature_set, ignore_excludes, additional_filter_func
@@ -282,11 +283,11 @@ def filter_based_on_feature_set(
                 self.graph.add_node("libc", content=BARE_FLAVOR_LIBC_FEATURE_CONTENT)
 
         for feature in feature_set:
-            filter_set.update(
-                networkx.descendants(
-                    Parser._get_graph_view_for_attr(self.graph, "include"), feature
-                )
-            )
+            for node in networkx.descendants(
+                Parser._get_graph_view_for_attr(self.graph, "include"), feature
+            ):
+                if node not in filter_set:
+                    filter_set.append(node)
 
         graph = networkx.subgraph_view(
             self.graph,
@@ -310,9 +311,7 @@ def _exclude_from_filter_set(graph, feature_set, filter_set):
         :since: 0.7.0
         """
 
-        exclude_graph_view = cast(
-            networkx.DiGraph, Parser._get_graph_view_for_attr(graph, "exclude")
-        )
+        exclude_graph_view = Parser._get_graph_view_for_attr(graph, "exclude")
         exclude_list = []
 
         for node in networkx.lexicographical_topological_sort(graph):
@@ -362,18 +361,48 @@ def _read_feature_yaml(self, feature_yaml_file: str):
         return {"name": name, "content": content}
 
     @staticmethod
-    def get_cname_as_feature_set(cname):
+    def get_flavor_from_feature_set(sorted_features: List[str]):
+        """
+        Get the base cname for the feature set given.
+
+        :param sorted_features: Sorted feature set
+
+        :return: (str) Base cname
+        :since: 0.7.0
+        """
+
+        return reduce(
+            lambda a, b: a + ("-" if not b.startswith("_") else "") + b, sorted_features
+        )
+
+    @staticmethod
+    def get_flavor_as_feature_set(cname):
         """
         Returns the features of a given canonical name.
 
         :param cname: Canonical name
 
-        :return: (set) Features of the cname
-        :since:  0.7.0
+        :return: (list) Features of the cname
+        :since:  0.11.0
         """
 
         cname = cname.replace("_", "-_")
-        return set(cname.split("-"))
+
+        platform = None
+        features = []
+        flags = []
+
+        for feature in cname.split("-"):
+            if platform is None:
+                platform = feature
+                continue
+
+            if feature[:1] == "_":
+                flags.append(feature)
+            else:
+                features.append(feature)
+
+        return [platform] + sorted(features) + sorted(flags)
 
     @staticmethod
     def _get_filter_set_callable(filter_set, additional_filter_func):
@@ -473,6 +502,20 @@ def key_function(node):
 
         return list(networkx.lexicographical_topological_sort(graph, key=key_function))
 
+    @staticmethod
+    def subset(input_set: Set[str], order_list: List[str]) -> List[str]:
+        """
+        Returns items from `order_list` if given in `input_set`.
+
+        :param input_set:  Set of values for filtering
+        :param order_list: Set of values to be filtered
+
+        :return: (list) Subset
+        :since:  0.11.0
+        """
+
+        return [item for item in order_list if item in input_set]
+
     @staticmethod
     def sort_reversed_graph_nodes(graph):
         """

test-data/gardenlinux

@@ -5,6 +5,7 @@
 import pytest
 
 import gardenlinux.features.cname_main as cname_main
+from gardenlinux.features import Parser
 
 
 def test_main_happy(monkeypatch, capsys):
@@ -19,7 +20,7 @@ class FakeGraph:
         in_degree = lambda self: [("f1", 0)]
         edges = [("f1", "f2")]
 
-    class FakeParser:
+    class FakeParser(Parser):
         def __init__(self, *a, **k):
             pass
 
@@ -55,7 +56,7 @@ def test_main_version_from_file(monkeypatch, capsys):
         lambda root: ("2.0", "abcdef12"),
     )
 
-    class FakeParser:
+    class FakeParser(Parser):
         def __init__(self, *a, **k):
             pass
 
@@ -96,7 +97,7 @@ def raise_runtime(_):
     )
 
     # Patch Parser for minimal valid graph
-    class FakeParser:
+    class FakeParser(Parser):
         def __init__(self, *a, **k):
             pass