yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'clan-cli: simplify cli helper' (#1726) from DavHau/clan-core:DavHau-dave into main

Browse Source
This commit is contained in:
clan-bot
2024-07-10 11:18:48 +00:00
parent 8498b71f0f e7908c2af5
commit b066c3633a
18 changed files with 29 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
pkgs/clan-app/tests/helpers/cli.py
View File

@@ -8,8 +8,7 @@ from clan_app import main
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
class Cli: def run(args: list[str]) -> None:
def run(self, args: list[str]) -> None:
cmd = shlex.join(["clan", *args]) cmd = shlex.join(["clan", *args])
log.debug(f"$ {cmd} \nCaller: {get_caller()}") log.debug(f"$ {cmd} \nCaller: {get_caller()}")
main(args) main(args)

3
pkgs/clan-app/tests/test_cli.py
View File

@@ -1,8 +1,7 @@
import pytest import pytest
from helpers.cli import Cli from helpers import cli
def test_help(capfd: pytest.CaptureFixture) -> None: def test_help(capfd: pytest.CaptureFixture) -> None:
cli = Cli()
with pytest.raises(SystemExit): with pytest.raises(SystemExit):
cli.run(["clan-app", "--help"]) cli.run(["clan-app", "--help"])

3
pkgs/clan-cli/tests/helpers/cli.py
View File

@@ -8,8 +8,7 @@ from clan_cli.custom_logger import get_caller
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
class Cli: def run(args: list[str]) -> argparse.Namespace:
def run(self, args: list[str]) -> argparse.Namespace:
parser = create_parser(prog="clan") parser = create_parser(prog="clan")
parsed = parser.parse_args(args) parsed = parser.parse_args(args)
cmd = shlex.join(["clan", *args]) cmd = shlex.join(["clan", *args])

4
pkgs/clan-cli/tests/test_backups.py
View File

@@ -1,14 +1,12 @@
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
@pytest.mark.impure @pytest.mark.impure
def test_backups( def test_backups(
test_flake_with_core: FlakeForTest, test_flake_with_core: FlakeForTest,
) -> None: ) -> None:
cli = Cli()
cli.run( cli.run(
[ [
"backups", "backups",

3
pkgs/clan-cli/tests/test_cli.py
View File

@@ -1,9 +1,8 @@
import pytest import pytest
from helpers.cli import Cli from helpers import cli
def test_help(capsys: pytest.CaptureFixture) -> None: def test_help(capsys: pytest.CaptureFixture) -> None:
cli = Cli()
with pytest.raises(SystemExit): with pytest.raises(SystemExit):
cli.run(["--help"]) cli.run(["--help"])
captured = capsys.readouterr() captured = capsys.readouterr()

6
pkgs/clan-cli/tests/test_config.py
View File

@@ -2,7 +2,7 @@ from pathlib import Path
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
from clan_cli import config from clan_cli import config
from clan_cli.config import parsing from clan_cli.config import parsing
@@ -13,12 +13,8 @@ example_options = f"{Path(config.__file__).parent}/jsonschema/options.json"
def test_configure_machine( def test_configure_machine(
test_flake: FlakeForTest, test_flake: FlakeForTest,
temporary_home: Path,
capsys: pytest.CaptureFixture, capsys: pytest.CaptureFixture,
monkeypatch: pytest.MonkeyPatch,
) -> None: ) -> None:
cli = Cli()
# clear the output buffer # clear the output buffer
capsys.readouterr() capsys.readouterr()
# read a option value # read a option value

9
pkgs/clan-cli/tests/test_create_flake.py
View File

@@ -3,12 +3,7 @@ import subprocess
from pathlib import Path from pathlib import Path
import pytest import pytest
from helpers.cli import Cli from helpers import cli
@pytest.fixture
def cli() -> Cli:
return Cli()
@pytest.mark.impure @pytest.mark.impure
@@ -16,7 +11,6 @@ def test_create_flake(
monkeypatch: pytest.MonkeyPatch, monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture, capsys: pytest.CaptureFixture,
temporary_home: Path, temporary_home: Path,
cli: Cli,
clan_core: Path, clan_core: Path,
) -> None: ) -> None:
flake_dir = temporary_home / "test-flake" flake_dir = temporary_home / "test-flake"
@@ -56,7 +50,6 @@ def test_ui_template(
monkeypatch: pytest.MonkeyPatch, monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture, capsys: pytest.CaptureFixture,
temporary_home: Path, temporary_home: Path,
cli: Cli,
clan_core: Path, clan_core: Path,
) -> None: ) -> None:
flake_dir = temporary_home / "test-flake" flake_dir = temporary_home / "test-flake"

3
pkgs/clan-cli/tests/test_flakes_cli.py
View File

@@ -2,7 +2,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
if TYPE_CHECKING: if TYPE_CHECKING:
pass pass
@@ -12,7 +12,6 @@ if TYPE_CHECKING:
def test_flakes_inspect( def test_flakes_inspect(
test_flake_with_core: FlakeForTest, capsys: pytest.CaptureFixture test_flake_with_core: FlakeForTest, capsys: pytest.CaptureFixture
) -> None: ) -> None:
cli = Cli()
cli.run( cli.run(
[ [
"flakes", "flakes",

4
pkgs/clan-cli/tests/test_history_cli.py
View File

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
from pytest import CaptureFixture from pytest import CaptureFixture
from clan_cli.dirs import user_history_file from clan_cli.dirs import user_history_file
@@ -17,7 +17,6 @@ if TYPE_CHECKING:
def test_history_add( def test_history_add(
test_flake_with_core: FlakeForTest, test_flake_with_core: FlakeForTest,
) -> None: ) -> None:
cli = Cli()
cmd = [ cmd = [
"history", "history",
"add", "add",
@@ -36,7 +35,6 @@ def test_history_list(
capsys: CaptureFixture, capsys: CaptureFixture,
test_flake_with_core: FlakeForTest, test_flake_with_core: FlakeForTest,
) -> None: ) -> None:
cli = Cli()
cmd = [ cmd = [
"history", "history",
"list", "list",

4
pkgs/clan-cli/tests/test_import_sops_cli.py
View File

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
if TYPE_CHECKING: if TYPE_CHECKING:
from age_keys import KeyPair from age_keys import KeyPair
@@ -16,8 +16,6 @@ def test_import_sops(
monkeypatch: pytest.MonkeyPatch, monkeypatch: pytest.MonkeyPatch,
age_keys: list["KeyPair"], age_keys: list["KeyPair"],
) -> None: ) -> None:
cli = Cli()
monkeypatch.setenv("SOPS_AGE_KEY", age_keys[1].privkey) monkeypatch.setenv("SOPS_AGE_KEY", age_keys[1].privkey)
cli.run( cli.run(
[ [

3
pkgs/clan-cli/tests/test_machines_cli.py
View File

@@ -1,13 +1,12 @@
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
@pytest.mark.impure @pytest.mark.impure
def test_machine_subcommands( def test_machine_subcommands(
test_flake_with_core: FlakeForTest, capsys: pytest.CaptureFixture test_flake_with_core: FlakeForTest, capsys: pytest.CaptureFixture
) -> None: ) -> None:
cli = Cli()
cli.run( cli.run(
["machines", "create", "--flake", str(test_flake_with_core.path), "machine1"] ["machines", "create", "--flake", str(test_flake_with_core.path), "machine1"]
) )

3
pkgs/clan-cli/tests/test_modules.py
View File

@@ -13,7 +13,7 @@ from clan_cli.nix import nix_eval, run_no_stdout
if TYPE_CHECKING: if TYPE_CHECKING:
from age_keys import KeyPair from age_keys import KeyPair
from helpers.cli import Cli from helpers import cli
from clan_cli.machines.facts import machine_get_fact from clan_cli.machines.facts import machine_get_fact
@@ -39,7 +39,6 @@ def test_add_module_to_inventory(
monkeypatch.chdir(test_flake_with_core.path) monkeypatch.chdir(test_flake_with_core.path)
monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey) monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey)
cli = Cli()
cli.run( cli.run(
[ [
"secrets", "secrets",

5
pkgs/clan-cli/tests/test_secrets_cli.py
View File

@@ -6,7 +6,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
from clan_cli.errors import ClanError from clan_cli.errors import ClanError
@@ -22,7 +22,6 @@ def _test_identities(
capsys: pytest.CaptureFixture, capsys: pytest.CaptureFixture,
age_keys: list["KeyPair"], age_keys: list["KeyPair"],
) -> None: ) -> None:
cli = Cli()
sops_folder = test_flake.path / "sops" sops_folder = test_flake.path / "sops"
cli.run( cli.run(
@@ -111,7 +110,6 @@ def test_machines(
def test_groups( def test_groups(
test_flake: FlakeForTest, capsys: pytest.CaptureFixture, age_keys: list["KeyPair"] test_flake: FlakeForTest, capsys: pytest.CaptureFixture, age_keys: list["KeyPair"]
) -> None: ) -> None:
cli = Cli()
capsys.readouterr() # empty the buffer capsys.readouterr() # empty the buffer
cli.run(["secrets", "groups", "list", "--flake", str(test_flake.path)]) cli.run(["secrets", "groups", "list", "--flake", str(test_flake.path)])
assert capsys.readouterr().out == "" assert capsys.readouterr().out == ""
@@ -249,7 +247,6 @@ def test_secrets(
monkeypatch: pytest.MonkeyPatch, monkeypatch: pytest.MonkeyPatch,
age_keys: list["KeyPair"], age_keys: list["KeyPair"],
) -> None: ) -> None:
cli = Cli()
capsys.readouterr() # empty the buffer capsys.readouterr() # empty the buffer
cli.run(["secrets", "list", "--flake", str(test_flake.path)]) cli.run(["secrets", "list", "--flake", str(test_flake.path)])
assert capsys.readouterr().out == "" assert capsys.readouterr().out == ""

3
pkgs/clan-cli/tests/test_secrets_generate.py
View File

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
from helpers.validator import is_valid_age_key, is_valid_ssh_key from helpers.validator import is_valid_age_key, is_valid_ssh_key
from clan_cli.clan_uri import FlakeId from clan_cli.clan_uri import FlakeId
@@ -24,7 +24,6 @@ def test_generate_secret(
) -> None: ) -> None:
monkeypatch.chdir(test_flake_with_core.path) monkeypatch.chdir(test_flake_with_core.path)
monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey) monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey)
cli = Cli()
cli.run( cli.run(
[ [
"secrets", "secrets",

3
pkgs/clan-cli/tests/test_secrets_password_store.py
View File

@@ -3,7 +3,7 @@ from pathlib import Path
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
from helpers.validator import is_valid_ssh_key from helpers.validator import is_valid_ssh_key
from clan_cli.clan_uri import FlakeId from clan_cli.clan_uri import FlakeId
@@ -37,7 +37,6 @@ def test_upload_secret(
%no-protection %no-protection
""" """
) )
cli = Cli()
subprocess.run( subprocess.run(
nix_shell( nix_shell(
["nixpkgs#gnupg"], ["gpg", "--batch", "--gen-key", str(gpg_key_spec)] ["nixpkgs#gnupg"], ["gpg", "--batch", "--gen-key", str(gpg_key_spec)]

3
pkgs/clan-cli/tests/test_secrets_upload.py
View File

@@ -2,7 +2,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest from fixtures_flakes import FlakeForTest
from helpers.cli import Cli from helpers import cli
from clan_cli.ssh import HostGroup from clan_cli.ssh import HostGroup
@@ -20,7 +20,6 @@ def test_secrets_upload(
monkeypatch.chdir(test_flake_with_core.path) monkeypatch.chdir(test_flake_with_core.path)
monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey) monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey)
cli = Cli()
cli.run( cli.run(
[ [
"secrets", "secrets",

3
pkgs/clan-cli/tests/test_vars.py
View File

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import generate_flake from fixtures_flakes import generate_flake
from helpers.cli import Cli from helpers import cli
from root import CLAN_CORE from root import CLAN_CORE
if TYPE_CHECKING: if TYPE_CHECKING:
@@ -41,7 +41,6 @@ def test_generate_secret(
), ),
) )
monkeypatch.chdir(flake.path) monkeypatch.chdir(flake.path)
cli = Cli()
cmd = ["vars", "generate", "--flake", str(flake.path), "my_machine"] cmd = ["vars", "generate", "--flake", str(flake.path), "my_machine"]
cli.run(cmd) cli.run(cmd)
assert ( assert (

6
pkgs/clan-cli/tests/test_vms_cli.py
View File

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING
import pytest import pytest
from fixtures_flakes import FlakeForTest, generate_flake from fixtures_flakes import FlakeForTest, generate_flake
from helpers.cli import Cli from helpers import cli
from root import CLAN_CORE from root import CLAN_CORE
from clan_cli.dirs import vm_state_dir from clan_cli.dirs import vm_state_dir
@@ -25,7 +25,7 @@ def run_vm_in_thread(machine_name: str) -> None:
# runs machine and prints exceptions # runs machine and prints exceptions
def run() -> None: def run() -> None:
try: try:
Cli().run(["vms", "run", machine_name]) cli.run(["vms", "run", machine_name])
except Exception: except Exception:
# print exception details # print exception details
print(traceback.format_exc(), file=sys.stderr) print(traceback.format_exc(), file=sys.stderr)
@@ -85,7 +85,6 @@ def qga_connect(state_dir: Path) -> QgaSession:
def test_inspect( def test_inspect(
test_flake_with_core: FlakeForTest, capsys: pytest.CaptureFixture test_flake_with_core: FlakeForTest, capsys: pytest.CaptureFixture
) -> None: ) -> None:
cli = Cli()
cli.run(["vms", "inspect", "--flake", str(test_flake_with_core.path), "vm1"]) cli.run(["vms", "inspect", "--flake", str(test_flake_with_core.path), "vm1"])
out = capsys.readouterr() # empty the buffer out = capsys.readouterr() # empty the buffer
assert "Cores" in out.out assert "Cores" in out.out
@@ -100,7 +99,6 @@ def test_run(
) -> None: ) -> None:
monkeypatch.chdir(test_flake_with_core.path) monkeypatch.chdir(test_flake_with_core.path)
monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey) monkeypatch.setenv("SOPS_AGE_KEY", age_keys[0].privkey)
cli = Cli()
cli.run( cli.run(
[ [
"secrets", "secrets",