Merge pull request 'use experimental flags everywhere' (#298) from Mic92-vm-api into main

.gitea/workflows/checks.yaml

@@ -8,4 +8,4 @@ jobs:
     runs-on: nix
     steps:
       - uses: actions/checkout@v3
-      - run: nix run --refresh github:Mic92/nix-ci-build
+      - run: nix run --refresh github:Mic92/nix-fast-build/ae50c356c2f9e790f3d9d8e00bfa9f4b54f49bdd

pkgs/clan-cli/clan_cli/__init__.py

@@ -4,7 +4,7 @@ import sys
 from types import ModuleType
 from typing import Optional
 
-from . import admin, config, machines, secrets, webui, zerotier
+from . import config, create, machines, secrets, webui, zerotier
 from .errors import ClanError
 from .ssh import cli as ssh_cli
 
@@ -19,8 +19,8 @@ def create_parser(prog: Optional[str] = None) -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(prog=prog, description="cLAN tool")
     subparsers = parser.add_subparsers()
 
-    parser_admin = subparsers.add_parser("admin", help="administrate a clan")
-    admin.register_parser(parser_admin)
+    parser_create = subparsers.add_parser("create", help="create a clan flake")
+    create.register_parser(parser_create)
 
     # DISABLED: this currently crashes if a flake does not define .#clanOptions
     if os.environ.get("CLAN_OPTIONS_FILE") is not None:

pkgs/clan-cli/clan_cli/admin.py

@@ -1,37 +0,0 @@
-# !/usr/bin/env python3
-import argparse
-import os
-import subprocess
-
-
-def create(args: argparse.Namespace) -> None:
-    os.makedirs(args.folder, exist_ok=True)
-    # TODO create clan template in flake
-    subprocess.run(
-        [
-            "nix",
-            "flake",
-            "init",
-            "-t",
-            "git+https://git.clan.lol/clan/clan-core#new-clan",
-        ]
-    )
-
-
-# takes a (sub)parser and configures it
-def register_parser(parser: argparse.ArgumentParser) -> None:
-    parser.add_argument(
-        "-f",
-        "--folder",
-        help="the folder where the clan is defined, default to the current folder",
-        default=os.environ["PWD"],
-    )
-    subparser = parser.add_subparsers(
-        title="command",
-        description="the command to run",
-        help="the command to run",
-        required=True,
-    )
-
-    parser_create = subparser.add_parser("create", help="create a new clan")
-    parser_create.set_defaults(func=create)

pkgs/clan-cli/clan_cli/config/parsing.py

@@ -3,7 +3,8 @@ import subprocess
 from pathlib import Path
 from typing import Any, Optional, Type, Union
 
-from clan_cli.errors import ClanError
+from ..errors import ClanError
+from ..nix import nix_eval
 
 script_dir = Path(__file__).parent
 
@@ -30,11 +31,9 @@ def schema_from_module_file(
             slib.parseModule {absolute_path}
     """
     # run the nix expression and parse the output as json
-    return json.loads(
-        subprocess.check_output(
-            ["nix", "eval", "--impure", "--json", "--expr", nix_expr]
-        )
-    )
+    cmd = nix_eval(["--expr", nix_expr])
+    proc = subprocess.run(cmd, stdout=subprocess.PIPE, check=True)
+    return json.loads(proc.stdout)
 
 
 def subtype_from_schema(schema: dict[str, Any]) -> Type:

pkgs/clan-cli/clan_cli/create.py

@@ -0,0 +1,25 @@
+# !/usr/bin/env python3
+import argparse
+import subprocess
+
+from .nix import nix_command
+
+
+def create(args: argparse.Namespace) -> None:
+    # TODO create clan template in flake
+    subprocess.run(
+        nix_command(
+            [
+                "flake",
+                "init",
+                "-t",
+                "git+https://git.clan.lol/clan/clan-core#new-clan",
+            ]
+        ),
+        check=True,
+    )
+
+
+# takes a (sub)parser and configures it
+def register_parser(parser: argparse.ArgumentParser) -> None:
+    parser.set_defaults(func=create)

pkgs/clan-cli/clan_cli/machines/update.py

@@ -5,7 +5,7 @@ import subprocess
 from typing import Optional
 
 from ..dirs import get_clan_flake_toplevel
-from ..nix import nix_eval
+from ..nix import nix_command, nix_eval
 from ..secrets.generate import generate_secrets
 from ..secrets.upload import upload_secrets
 from ..ssh import Host, HostGroup, HostKeyCheck
@@ -22,7 +22,7 @@ def deploy_nixos(hosts: HostGroup) -> None:
         env = os.environ.copy()
         env["NIX_SSHOPTS"] = ssh_arg
         res = h.run_local(
-            ["nix", "flake", "archive", "--to", f"ssh://{target}", "--json"],
+            nix_command(["flake", "archive", "--to", f"ssh://{target}", "--json"]),
             check=True,
             stdout=subprocess.PIPE,
             extra_env=env,

pkgs/clan-cli/clan_cli/nix.py

@@ -4,28 +4,35 @@ import tempfile
 from .dirs import nixpkgs_flake, nixpkgs_source, unfree_nixpkgs
 
 
+def nix_command(flags: list[str]) -> list[str]:
+    return ["nix", "--experimental-features", "nix-command flakes"] + flags
+
+
 def nix_build(
     flags: list[str],
 ) -> list[str]:
-    return [
-        "nix",
+    return (
+        nix_command(
+            [
                 "build",
                 "--no-link",
                 "--print-out-paths",
                 "--extra-experimental-features",
                 "nix-command flakes",
-    ] + flags
+            ]
+        )
+        + flags
+    )
 
 
 def nix_eval(flags: list[str]) -> list[str]:
-    default_flags = [
-        "nix",
+    default_flags = nix_command(
+        [
             "eval",
             "--show-trace",
             "--json",
-        "--extra-experimental-features",
-        "nix-command flakes",
         ]
+    )
     if os.environ.get("IN_NIX_SANDBOX"):
         with tempfile.TemporaryDirectory() as nix_store:
             return (
@@ -51,14 +58,13 @@ def nix_shell(packages: list[str], cmd: list[str]) -> list[str]:
         return cmd
     wrapped_packages = [f"nixpkgs#{p}" for p in packages]
     return (
+        nix_command(
             [
-            "nix",
                 "shell",
-            "--extra-experimental-features",
-            "nix-command flakes",
                 "--inputs-from",
                 f"{str(nixpkgs_flake())}",
             ]
+        )
         + wrapped_packages
         + ["-c"]
         + cmd
@@ -69,14 +75,13 @@ def unfree_nix_shell(packages: list[str], cmd: list[str]) -> list[str]:
     if os.environ.get("IN_NIX_SANDBOX"):
         return cmd
     return (
+        nix_command(
             [
-            "nix",
                 "shell",
-            "--extra-experimental-features",
-            "nix-command flakes",
                 "-f",
                 str(unfree_nixpkgs()),
             ]
+        )
         + packages
         + ["-c"]
         + cmd

pkgs/clan-cli/pyproject.toml

@@ -18,6 +18,7 @@ clan_cli = [ "config/jsonschema/*", "webui/assets/**/*"]
 faulthandler_timeout = 30
 addopts = "--cov . --cov-report term --cov-report html:.reports/html --no-cov-on-fail --workers auto --durations 5"
 norecursedirs = "tests/helpers"
+markers = [ "impure" ]
 
 [tool.mypy]
 python_version = "3.10"

pkgs/clan-cli/tests/root.py

@@ -4,12 +4,13 @@ import pytest
 
 TEST_ROOT = Path(__file__).parent.resolve()
 PROJECT_ROOT = TEST_ROOT.parent
+CLAN_CORE = PROJECT_ROOT.parent.parent
 
 
 @pytest.fixture(scope="session")
 def project_root() -> Path:
     """
-    Root directory of the tests
+    Root directory the clan-cli
     """
     return PROJECT_ROOT
 
@@ -20,3 +21,11 @@ def test_root() -> Path:
     Root directory of the tests
     """
     return TEST_ROOT
+
+
+@pytest.fixture(scope="session")
+def clan_core() -> Path:
+    """
+    Directory of the clan-core flake
+    """
+    return CLAN_CORE

pkgs/clan-cli/tests/test_admin_cli.py

@@ -1,14 +0,0 @@
-from typing import Union
-
-import pytest_subprocess.fake_process
-from cli import Cli
-from pytest_subprocess import utils
-
-
-# using fp fixture from pytest-subprocess
-def test_create(fp: pytest_subprocess.fake_process.FakeProcess) -> None:
-    cmd: list[Union[str, utils.Any]] = ["nix", "flake", "init", "-t", fp.any()]
-    fp.register(cmd)
-    cli = Cli()
-    cli.run(["admin", "--folder", "./my-clan", "create"])
-    assert fp.call_count(cmd) == 1

pkgs/clan-cli/tests/test_clan_template.py

@@ -0,0 +1,12 @@
+from pathlib import Path
+
+import pytest
+from cli import Cli
+
+
+@pytest.mark.impure
+def test_template(monkeypatch: pytest.MonkeyPatch, temporary_dir: Path) -> None:
+    monkeypatch.chdir(temporary_dir)
+    cli = Cli()
+    cli.run(["create"])
+    assert (temporary_dir / ".clan-flake").exists()

pkgs/clan-cli/tests/test_flake.py

@@ -5,7 +5,7 @@ from pathlib import Path
 from typing import Iterator
 
 import pytest
-from root import PROJECT_ROOT
+from root import CLAN_CORE
 
 from clan_cli.dirs import nixpkgs_source
 
@@ -46,9 +46,8 @@ def test_flake(monkeymodule: pytest.MonkeyPatch) -> Iterator[Path]:
 
 @pytest.fixture(scope="module")
 def test_flake_with_core(monkeymodule: pytest.MonkeyPatch) -> Iterator[Path]:
-    clan_core_flake = PROJECT_ROOT.parent.parent
-    if not (clan_core_flake / "flake.nix").exists():
+    if not (CLAN_CORE / "flake.nix").exists():
         raise Exception(
             "clan-core flake not found. This test requires the clan-core flake to be present"
         )
-    yield from create_flake(monkeymodule, "test_flake_with_core", clan_core_flake)
+    yield from create_flake(monkeymodule, "test_flake_with_core", CLAN_CORE)

pkgs/clan-cli/tests/test_ssh_cli.py

@@ -30,9 +30,8 @@ def test_ssh_no_pass(
         monkeypatch.delenv("IN_NIX_SANDBOX")
     cmd: list[Union[str, utils.Any]] = [
         "nix",
+        fp.any(),
         "shell",
-        "--extra-experimental-features",
-        "nix-command flakes",
         fp.any(),
         "-c",
         "torify",
@@ -61,9 +60,8 @@ def test_ssh_with_pass(
         monkeypatch.delenv("IN_NIX_SANDBOX")
     cmd: list[Union[str, utils.Any]] = [
         "nix",
+        fp.any(),
         "shell",
-        "--extra-experimental-features",
-        "nix-command flakes",
         fp.any(),
         "-c",
         "torify",