clan-core/pkgs/generate-test-vars/generate_test_vars/cli.py

#! /usr/bin/env python3

import argparse
import json
import os
import subprocess
from pathlib import Path
from tempfile import NamedTemporaryFile
from typing import Any

from clan_cli.dirs import find_git_repo_root
from clan_cli.flake import Flake
from clan_cli.machines.machines import Machine
from clan_cli.nix import nix_build, nix_config, nix_eval
from clan_cli.vars.generate import generate_vars

sops_priv_key = (
    "AGE-SECRET-KEY-1PL0M9CWRCG3PZ9DXRTTLMCVD57U6JDFE8K7DNVQ35F4JENZ6G3MQ0RQLRV"
)
sops_pub_key = "age1qm0p4vf9jvcnn43s6l4prk8zn6cx0ep9gzvevxecv729xz540v8qa742eg"


def machine_names(repo_root: Path, check_attr: str) -> list[str]:
    """
    Get the machine names from the test flake
    """
    cmd = nix_eval(
        [
            f"{repo_root}#checks.{nix_config()['system']}.{check_attr}.nodes",
            "--apply",
            "builtins.attrNames",
        ]
    )
    out = subprocess.run(cmd, check=True, text=True, stdout=subprocess.PIPE)
    return json.loads(out.stdout.strip())


class TestMachine(Machine):
    """
    Machine class which is able to deal with not having an actual flake.
    All nix build and eval calls will be forwarded to:
      clan-core#checks.<system>.<test_name>.nodes.<machine_name>.<attr>
    """

    def __init__(self, name: str, flake: Flake, check_attr: str) -> None:
        super().__init__(name, flake)
        self.check_attr = check_attr

    @property
    def deployment(self) -> dict:
        if getattr(self, "_deployment", None):
            return self._deployment
        cmd = nix_build(
            [
                f"{self.flake.path}#checks.{nix_config()['system']}.{self.check_attr}.nodes.{self.name}.system.clan.deployment.file"
            ]
        )
        out = subprocess.run(cmd, check=True, text=True, stdout=subprocess.PIPE)
        self._deployment = json.loads(Path(out.stdout.strip()).read_text())
        return self._deployment

    def eval_nix(
        self,
        attr: str,
        refresh: bool = False,
        extra_config: None | dict = None,
        nix_options: list[str] | None = None,
    ) -> Any:
        """
        eval a nix attribute of the machine
        @attr: the attribute to get
        """

        if nix_options is None:
            nix_options = []

        # return self.nix("eval", attr, nix_options)
        cmd = nix_eval(
            [
                f"{self.flake.path}#checks.{nix_config()['system']}.{self.check_attr}.nodes.{self.name}.{attr}"
            ]
        )
        out = subprocess.run(cmd, check=True, text=True, stdout=subprocess.PIPE)
        return json.loads(out.stdout.strip())

    def build_nix(
        self,
        attr: str,
        extra_config: None | dict = None,
        nix_options: list[str] | None = None,
    ) -> Path:
        """
        build a nix attribute of the machine
        @attr: the attribute to get
        """

        if nix_options is None:
            nix_options = []

        cmd = nix_build(
            [
                f"{self.flake.path}#checks.{nix_config()['system']}.{self.check_attr}.nodes.{self.name}.{attr}"
            ]
        )
        out = subprocess.run(cmd, check=True, text=True, stdout=subprocess.PIPE)
        return Path(out.stdout.strip())

    def flush_caches(self) -> None:
        """
        Disable flush, because it calls prefetch() which resets the overridden Flake._path
        """
        return


def parse_args() -> argparse.Namespace:
    import argparse

    parser = argparse.ArgumentParser(
        description="""
            Update the vars of a 'makeTestClan' integration test.
            See 'clanLib.test.makeTestClan' for more information on how to create such a test.
        """,
    )
    parser.add_argument(
        "--repo_root",
        type=Path,
        help="""
            Should be an absolute path to the repo root.
            This path is used as root to evaluate and build attributes using the nix commands.
            i.e. 'nix eval <repo_root>#checks ...'
        """,
        required=False,
        default=os.environ.get("PRJ_ROOT", find_git_repo_root()),
    )
    parser.add_argument(
        "test_dir",
        type=Path,
        help="""
            The folder of the test. Usually passed as 'directory' to clan in the test.
            Must be relative to the repo_root.
        """,
    )
    parser.add_argument(
        "check_attr",
        type=str,
        help="The attribute name of the flake#checks to update",
    )
    return parser.parse_args()


def main() -> None:
    os.environ["CLAN_NO_COMMIT"] = "1"
    args = parse_args()
    test_dir = args.repo_root / args.test_dir
    subprocess.run(["rm", "-rf", f"{test_dir}/vars", f"{test_dir}/sops"])
    flake = Flake(str(test_dir))
    flake._path = test_dir  # noqa SLF001
    flake._is_local = True  # noqa SLF001
    machines = [
        TestMachine(name, flake, args.check_attr)
        for name in machine_names(
            args.repo_root,
            args.check_attr,
        )
    ]
    user = "admin"
    admin_key_path = Path(flake.path / "sops" / "users" / user / "key.json")
    admin_key_path.parent.mkdir(parents=True, exist_ok=True)
    admin_key_path.write_text(
        json.dumps(
            {
                "publickey": sops_pub_key,
                "type": "age",
            }
        )
    )
    with NamedTemporaryFile("w") as f:
        f.write("# created: 2023-07-17T10:51:45+02:00\n")
        f.write(f"# public key: {sops_pub_key}\n")
        f.write(sops_priv_key)
        f.seek(0)
        os.environ["SOPS_AGE_KEY_FILE"] = f.name
        generate_vars(list(machines))


if __name__ == "__main__":
    main()