From f4d6edc50108f6f2e46e90181d49051df56fb159 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 20 Aug 2025 20:13:35 +0200 Subject: [PATCH] api/modules: unify frontmatter with module manifest --- pkgs/clan-cli/clan_cli/tests/test_modules.py | 17 --- pkgs/clan-cli/clan_lib/services/modules.py | 111 ++++--------------- pkgs/clan-cli/clan_lib/templates/disk.py | 11 +- pkgs/clan-cli/clan_lib/tests/test_create.py | 3 +- 4 files changed, 33 insertions(+), 109 deletions(-) delete mode 100644 pkgs/clan-cli/clan_cli/tests/test_modules.py diff --git a/pkgs/clan-cli/clan_cli/tests/test_modules.py b/pkgs/clan-cli/clan_cli/tests/test_modules.py deleted file mode 100644 index 2ba3f3bcd..000000000 --- a/pkgs/clan-cli/clan_cli/tests/test_modules.py +++ /dev/null @@ -1,17 +0,0 @@ -from typing import TYPE_CHECKING - -import pytest -from clan_cli.tests.fixtures_flakes import FlakeForTest -from clan_lib.flake import Flake -from clan_lib.services.modules import list_service_modules - -if TYPE_CHECKING: - pass - - -@pytest.mark.with_core -def test_list_modules(test_flake_with_core: FlakeForTest) -> None: - base_path = test_flake_with_core.path - modules_info = list_service_modules(Flake(str(base_path))) - - assert "modules" in modules_info diff --git a/pkgs/clan-cli/clan_lib/services/modules.py b/pkgs/clan-cli/clan_lib/services/modules.py index c2e3587a5..2627c128f 100644 --- a/pkgs/clan-cli/clan_lib/services/modules.py +++ b/pkgs/clan-cli/clan_lib/services/modules.py @@ -1,7 +1,6 @@ import re import tomllib -from dataclasses import dataclass, field -from pathlib import Path +from dataclasses import dataclass, field, fields from typing import Any, TypedDict, TypeVar from clan_lib.api import API @@ -22,11 +21,11 @@ class CategoryInfo(TypedDict): @dataclass -class ModuleFrontmatter: +class ModuleManifest: + name: str description: str categories: list[str] = field(default_factory=lambda: ["Uncategorized"]) features: list[str] = field(default_factory=list) - constraints: dict[str, Any] = field(default_factory=dict) @property def categories_info(self) -> dict[str, CategoryInfo]: @@ -59,6 +58,15 @@ class ModuleFrontmatter: msg = f"Invalid category: {category}" raise ValueError(msg) + @classmethod + def from_dict(cls, data: dict) -> "ModuleManifest": + """ + Create an instance of ModuleFrontmatter from a dictionary. + Drops any keys that are not defined in the dataclass. + """ + valid = {f.name for f in fields(cls)} + return cls(**{k: v for k, v in data.items() if k in valid}) + def parse_frontmatter(readme_content: str) -> tuple[dict[str, Any] | None, str]: """ @@ -127,40 +135,6 @@ def extract_frontmatter[T]( ) -def has_inventory_feature(module_path: Path) -> bool: - readme_file = module_path / "README.md" - if not readme_file.exists(): - return False - with readme_file.open() as f: - readme = f.read() - frontmatter, _ = extract_frontmatter( - readme, f"{module_path}", fm_class=ModuleFrontmatter - ) - return "inventory" in frontmatter.features - - -def get_roles(module_path: Path) -> None | list[str]: - if not has_inventory_feature(module_path): - return None - - roles_dir = module_path / "roles" - if not roles_dir.exists() or not roles_dir.is_dir(): - return [] - - return [ - role.stem # filename without .nix extension - for role in roles_dir.iterdir() - if role.is_file() and role.suffix == ".nix" - ] - - -class ModuleManifest(TypedDict): - name: str - description: str - categories: list[str] - features: dict[str, bool] - - @dataclass class ModuleInfo(TypedDict): manifest: ModuleManifest @@ -178,7 +152,18 @@ def list_service_modules(flake: Flake) -> ModuleList: """ modules = flake.select("clanInternals.inventoryClass.modulesPerSource") - return ModuleList({"modules": modules}) + res: dict[str, dict[str, ModuleInfo]] = {} + for input_name, module_set in modules.items(): + res[input_name] = {} + + for module_name, module_info in module_set.items(): + # breakpoint() + res[input_name][module_name] = ModuleInfo( + manifest=ModuleManifest.from_dict(module_info.get("manifest")), + roles=module_info.get("roles", {}), + ) + + return ModuleList(modules=res) @API.register @@ -308,51 +293,3 @@ def create_service_instance( ) return - - -@dataclass -class LegacyModuleInfo: - description: str - categories: list[str] - roles: None | list[str] - readme: str - features: list[str] - constraints: dict[str, Any] - - -def get_module_info( - module_name: str, - module_path: Path, -) -> LegacyModuleInfo: - """ - Retrieves information about a module - """ - if not module_path.exists(): - msg = "Module not found" - raise ClanError( - msg, - location=f"show_module_info {module_name}", - description="Module does not exist", - ) - module_readme = module_path / "README.md" - if not module_readme.exists(): - msg = "Module not found" - raise ClanError( - msg, - location=f"show_module_info {module_name}", - description="Module does not exist or doesn't have any README.md file", - ) - with module_readme.open() as f: - readme = f.read() - frontmatter, readme_content = extract_frontmatter( - readme, f"{module_path}/README.md", fm_class=ModuleFrontmatter - ) - - return LegacyModuleInfo( - description=frontmatter.description, - categories=frontmatter.categories, - roles=get_roles(module_path), - readme=readme_content, - features=["inventory"] if has_inventory_feature(module_path) else [], - constraints=frontmatter.constraints, - ) diff --git a/pkgs/clan-cli/clan_lib/templates/disk.py b/pkgs/clan-cli/clan_lib/templates/disk.py index 95346c004..84b538eec 100644 --- a/pkgs/clan-cli/clan_lib/templates/disk.py +++ b/pkgs/clan-cli/clan_lib/templates/disk.py @@ -11,11 +11,16 @@ from clan_lib.errors import ClanError from clan_lib.git import commit_file from clan_lib.machines.hardware import HardwareConfig, get_machine_hardware_config from clan_lib.machines.machines import Machine -from clan_lib.services.modules import ModuleFrontmatter, extract_frontmatter +from clan_lib.services.modules import extract_frontmatter log = logging.getLogger(__name__) +@dataclass +class DiskManifest: + description: str + + def disk_in_facter_report(hw_report: dict) -> bool: return "hardware" in hw_report and "disk" in hw_report["hardware"] @@ -57,7 +62,7 @@ class Placeholder: class DiskSchema: name: str readme: str - frontmatter: ModuleFrontmatter + frontmatter: DiskManifest placeholders: dict[str, Placeholder] @@ -128,7 +133,7 @@ def get_machine_disk_schemas( raw_readme = (disk_template / "README.md").read_text() frontmatter, readme = extract_frontmatter( - raw_readme, f"{disk_template}/README.md", fm_class=ModuleFrontmatter + raw_readme, f"{disk_template}/README.md", fm_class=DiskManifest ) disk_schemas[schema_name] = DiskSchema( diff --git a/pkgs/clan-cli/clan_lib/tests/test_create.py b/pkgs/clan-cli/clan_lib/tests/test_create.py index dcef373f4..13e8af74b 100644 --- a/pkgs/clan-cli/clan_lib/tests/test_create.py +++ b/pkgs/clan-cli/clan_lib/tests/test_create.py @@ -204,8 +204,7 @@ def test_clan_create_api( modules = list_service_modules(clan_dir_flake) assert ( - modules["modules"]["clan-core"]["admin"]["manifest"]["name"] - == "clan-core/admin" + modules["modules"]["clan-core"]["admin"]["manifest"].name == "clan-core/admin" ) set_value_by_path(inventory, "instances", inventory_conf.instances)