Enhance handling of flavors.yaml checked out from GitHub

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

Author: NotTheEvilOne

src/gardenlinux/constants.py

@@ -140,6 +140,8 @@
     "secureboot.aws-efivars": "application/io.gardenlinux.cert.secureboot.aws-efivars",
 }
 
+GL_REPOSITORY_URL = "https://github.com/gardenlinux/gardenlinux"
+
 OCI_ANNOTATION_SIGNATURE_KEY = "io.gardenlinux.oci.signature"
 OCI_ANNOTATION_SIGNED_STRING_KEY = "io.gardenlinux.oci.signed-string"
 OCI_IMAGE_INDEX_MEDIA_TYPE = "application/vnd.oci.image.index.v1+json"

src/gardenlinux/flavors/__main__.py

@@ -6,14 +6,27 @@
 """
 
 from argparse import ArgumentParser
+from pathlib import Path
+from tempfile import TemporaryDirectory
 import json
 import os
 import sys
 
-from ..git import Git
-from ..github import GitHub
+from git import Repo
+from git.exc import GitError
 
 from .parser import Parser
+from ..constants import GL_REPOSITORY_URL
+from ..git import Git
+
+
+def _get_flavors_file_data(flavors_file):
+    if not flavors_file.exists():
+        raise RuntimeError(f"Error: {flavors_file} does not exist.")
+
+    # Load and validate the flavors.yaml
+    with flavors_file.open("r") as fp:
+        return fp.read()
 
 
 def generate_markdown_table(combinations, no_arch):
@@ -52,7 +65,7 @@ def parse_args():
     parser.add_argument(
         "--commit",
         default=None,
-        help="Commit hash to fetch flavors.yaml from GitHub (if not specified, uses local file).",
+        help="Commit hash to fetch flavors.yaml from GitHub. An existing 'flavors.yaml' file will be preferred.",
     )
     parser.add_argument(
         "--no-arch",
@@ -126,44 +139,33 @@ def main():
 
     args = parse_args()
 
-    if args.commit:
-        # Use GitHub API to fetch flavors.yaml
-        github = GitHub()
-        flavors_content = github.get_flavors_yaml(commit=args.commit)
-
-        parser = Parser(data=flavors_content)
-
-        combinations = parser.filter(
-            include_only_patterns=args.include_only,
-            wildcard_excludes=args.exclude,
-            only_build=args.build,
-            only_test=args.test,
-            only_test_platform=args.test_platform,
-            only_publish=args.publish,
-            filter_categories=args.category,
-            exclude_categories=args.exclude_category,
-        )
-    else:
-        # Use local file
-        flavors_file = os.path.join(Git().root, "flavors.yaml")
-
-        if not os.path.isfile(flavors_file):
-            sys.exit(f"Error: {flavors_file} does not exist.")
-
-        # Load and validate the flavors.yaml
-        with open(flavors_file, "r") as file:
-            flavors_data = file.read()
-
-        combinations = Parser(flavors_data).filter(
-            include_only_patterns=args.include_only,
-            wildcard_excludes=args.exclude,
-            only_build=args.build,
-            only_test=args.test,
-            only_test_platform=args.test_platform,
-            only_publish=args.publish,
-            filter_categories=args.category,
-            exclude_categories=args.exclude_category,
-        )
+    try:
+        flavors_data = _get_flavors_file_data(Path(Git().root, "flavors.yaml"))
+    except (GitError, RuntimeError):
+        with TemporaryDirectory() as git_directory:
+            repo = Repo.clone_from(
+                GL_REPOSITORY_URL, git_directory, no_origin=True, sparse=True
+            )
+
+            ref = repo.heads.main
+
+            if args.commit is not None:
+                ref = ref.set_commit(args.commit)
+
+            flavors_data = _get_flavors_file_data(
+                Path(repo.working_dir, "flavors.yaml")
+            )
+
+    combinations = Parser(flavors_data).filter(
+        include_only_patterns=args.include_only,
+        wildcard_excludes=args.exclude,
+        only_build=args.build,
+        only_test=args.test,
+        only_test_platform=args.test_platform,
+        only_publish=args.publish,
+        filter_categories=args.category,
+        exclude_categories=args.exclude_category,
+    )
 
     if args.json_by_arch:
         grouped_combinations = Parser.group_by_arch(combinations)

src/gardenlinux/flavors/parser.py

@@ -10,7 +10,6 @@
 
 from ..constants import GL_FLAVORS_SCHEMA
 from ..logger import LoggerSetup
-from ..github import GitHub
 
 
 class Parser(object):

src/gardenlinux/git/git.py

@@ -1,10 +1,11 @@
 # -*- coding: utf-8 -*-
 
+from os import PathLike
+from pathlib import Path
 import sys
+
 from git import Repo
 from git import Git as _Git
-from os import PathLike
-from pathlib import Path
 
 from ..logger import LoggerSetup
 

tests/flavors/test_main.py

@@ -2,7 +2,8 @@
 import sys
 import pytest
 
-import gardenlinux.flavors.__main__ as fm
+from gardenlinux.flavors import __main__ as fm
+from gardenlinux.git import Git
 
 
 def test_generate_markdown_table():
@@ -98,22 +99,17 @@ def remove_arch(combinations):
     return DummyParser
 
 
-def test_main_exits_when_flavors_missing(tmp_path, monkeypatch):
-    # Arrange
-    # make Git().root point to a tmp dir that does NOT contain flavors.yaml
+def _make_git_class(tmp_path):
+    """
+    Factory to create a fake Parser class
+    Instances ignore the favors_data passed to __init__.
+    """
+
     class DummyGit:
         def __init__(self):
-            self.root = str(tmp_path)
+            self.root = tmp_path
 
-    monkeypatch.setattr(fm, "Git", DummyGit)
-
-    # ensure no flavors.yaml
-    monkeypatch.setattr(sys, "argv", ["prog"])
-
-    # Act / Assert
-    with pytest.raises(SystemExit) as excinfo:
-        fm.main()
-    assert "does not exist" in str(excinfo.value)
+    return DummyGit
 
 
 def test_main_json_by_arch_prints_json(tmp_path, monkeypatch, capsys):
@@ -122,14 +118,11 @@ def test_main_json_by_arch_prints_json(tmp_path, monkeypatch, capsys):
     flavors_file = tmp_path / "flavors.yaml"
     flavors_file.write_text("dummy: content")
 
-    class DummyGit:
-        def __init__(self):
-            self.root = str(tmp_path)
-
     # define combinations and expected grouped mapping
     combinations = [("x86", "linux-x86"), ("arm", "android-arm")]
     grouped = {"x86": ["linux-x86"], "arm": ["android-arm"]}
 
+    DummyGit = _make_git_class(str(tmp_path))
     DummyParser = _make_parser_class(filter_result=combinations, group_result=grouped)
     monkeypatch.setattr(fm, "Git", DummyGit)
     monkeypatch.setattr(fm, "Parser", DummyParser)
@@ -151,13 +144,11 @@ def test_main_json_by_arch_with_no_arch_strips_arch_suffix(
     flavors_file = tmp_path / "flavors.yaml"
     flavors_file.write_text("dummy: content")
 
-    class DummyGit:
-        def __init__(self):
-            self.root = str(tmp_path)
-
     combinations = [("x86", "linux-x86"), ("arm", "android-arm")]
     # group_by_arch returns items that include architecture suffixes
     grouped = {"x86": ["linux-x86"], "arm": ["android-arm"]}
+
+    DummyGit = _make_git_class(str(tmp_path))
     DummyParser = _make_parser_class(filter_result=combinations, group_result=grouped)
 
     monkeypatch.setattr(fm, "Git", DummyGit)
@@ -179,11 +170,9 @@ def test_main_markdown_table_branch(tmp_path, monkeypatch, capsys):
     flavors_file = tmp_path / "flavors.yaml"
     flavors_file.write_text("dummy: content")
 
-    class DummyGit:
-        def __init__(self):
-            self.root = str(tmp_path)
-
     combinations = [("x86_64", "linux-x86_64"), ("armv7", "android-armv7")]
+
+    DummyGit = _make_git_class(str(tmp_path))
     DummyParser = _make_parser_class(filter_result=combinations)
 
     monkeypatch.setattr(fm, "Git", DummyGit)
@@ -205,12 +194,10 @@ def test_main_default_prints_flavors_list(tmp_path, monkeypatch, capsys):
     flavors_file = tmp_path / "flavors.yaml"
     flavors_file.write_text("dummy: content")
 
-    class DummyGit:
-        def __init__(self):
-            self.root = str(tmp_path)
-
     # filter returns tuples; main's default branch prints comb[1] values, sorted unique
     combinations = [("x86", "linux-x86"), ("arm", "android-arm")]
+
+    DummyGit = _make_git_class(str(tmp_path))
     DummyParser = _make_parser_class(filter_result=combinations)
 
     monkeypatch.setattr(fm, "Git", DummyGit)
@@ -224,3 +211,25 @@ def __init__(self):
 
     # Assert
     assert sorted(lines) == sorted(["linux-x86", "android-arm"])
+
+
+def test_main_default_prints_git_flavors_list(tmp_path, monkeypatch, capsys):
+    # Arrange
+    flavors_file = tmp_path / "flavors.yaml"
+    flavors_file.write_text("dummy: content")
+
+    # filter returns tuples; main's default branch prints comb[1] values, sorted unique
+    combinations = [("x86", "linux-x86"), ("arm", "android-arm")]
+
+    DummyParser = _make_parser_class(filter_result=combinations)
+
+    monkeypatch.setattr(fm, "Parser", DummyParser)
+    monkeypatch.setattr(sys, "argv", ["prog"])
+
+    # Act
+    fm.main()
+    out = capsys.readouterr().out
+    lines = out.strip().splitlines()
+
+    # Assert
+    assert sorted(lines) == sorted(["linux-x86", "android-arm"])