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

vars/api: rename, unregister some unused vars functions

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-07-06 20:10:58 +02:00
parent 7370212ec2
commit ad48771c98
4 changed files with 25 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
pkgs/clan-cli/clan_cli/tests/test_vars.py
View File

@@ -14,7 +14,7 @@ from clan_cli.vars.generate import (
create_machine_vars_interactive, create_machine_vars_interactive,
get_generators_closure, get_generators_closure,
) )
from clan_cli.vars.get import get_var from clan_cli.vars.get import get_machine_var
from clan_cli.vars.graph import all_missing_closure, requested_closure from clan_cli.vars.graph import all_missing_closure, requested_closure
from clan_cli.vars.list import stringify_all_vars from clan_cli.vars.list import stringify_all_vars
from clan_cli.vars.public_modules import in_repo from clan_cli.vars.public_modules import in_repo
@@ -172,13 +172,13 @@ def test_generate_public_and_secret_vars(
in commit_message in commit_message
) )
assert ( assert (
get_var( get_machine_var(
str(machine.flake.path), machine.name, "my_generator/my_value" str(machine.flake.path), machine.name, "my_generator/my_value"
).printable_value ).printable_value
== "public" == "public"
) )
assert ( assert (
get_var( get_machine_var(
str(machine.flake.path), machine.name, "my_shared_generator/my_shared_value" str(machine.flake.path), machine.name, "my_shared_generator/my_shared_value"
).printable_value ).printable_value
== "shared" == "shared"
@@ -343,9 +343,9 @@ def test_generated_shared_secret_sops(
shared_generator["script"] = 'echo hello > "$out"/my_shared_secret' shared_generator["script"] = 'echo hello > "$out"/my_shared_secret'
m2_config = flake.machines["machine2"] m2_config = flake.machines["machine2"]
m2_config["nixpkgs"]["hostPlatform"] = "x86_64-linux" m2_config["nixpkgs"]["hostPlatform"] = "x86_64-linux"
m2_config["clan"]["core"]["vars"]["generators"]["my_shared_generator"] = ( m2_config["clan"]["core"]["vars"]["generators"][
shared_generator.copy() "my_shared_generator"
) ] = shared_generator.copy()
flake.refresh() flake.refresh()
monkeypatch.chdir(flake.path) monkeypatch.chdir(flake.path)
machine1 = Machine(name="machine1", flake=Flake(str(flake.path))) machine1 = Machine(name="machine1", flake=Flake(str(flake.path)))
@@ -803,9 +803,9 @@ def test_migration(
my_service = config["clan"]["core"]["facts"]["services"]["my_service"] my_service = config["clan"]["core"]["facts"]["services"]["my_service"]
my_service["public"]["my_value"] = {} my_service["public"]["my_value"] = {}
my_service["secret"]["my_secret"] = {} my_service["secret"]["my_secret"] = {}
my_service["generator"]["script"] = ( my_service["generator"][
'echo -n hello > "$facts"/my_value && echo -n hello > "$secrets"/my_secret' "script"
) ] = 'echo -n hello > "$facts"/my_value && echo -n hello > "$secrets"/my_secret'
my_generator = config["clan"]["core"]["vars"]["generators"]["my_generator"] my_generator = config["clan"]["core"]["vars"]["generators"]["my_generator"]
my_generator["files"]["my_value"]["secret"] = False my_generator["files"]["my_value"]["secret"] = False
my_generator["files"]["my_secret"]["secret"] = True my_generator["files"]["my_secret"]["secret"] = True
@@ -875,9 +875,9 @@ def test_fails_when_files_are_left_from_other_backend(
regenerate=False, regenerate=False,
) )
# Will raise. It was secret before, but now it's not. # Will raise. It was secret before, but now it's not.
my_secret_generator["files"]["my_secret"]["secret"] = ( my_secret_generator["files"]["my_secret"][
False # secret -> public (NOT OK) "secret"
) ] = False # secret -> public (NOT OK)
# WIll not raise. It was not secret before, and it's secret now. # WIll not raise. It was not secret before, and it's secret now.
my_value_generator["files"]["my_value"]["secret"] = True # public -> secret (OK) my_value_generator["files"]["my_value"]["secret"] = True # public -> secret (OK)
flake.refresh() flake.refresh()
@@ -932,12 +932,12 @@ def test_invalidation(
monkeypatch.chdir(flake.path) monkeypatch.chdir(flake.path)
cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"]) cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"])
machine = Machine(name="my_machine", flake=Flake(str(flake.path))) machine = Machine(name="my_machine", flake=Flake(str(flake.path)))
value1 = get_var( value1 = get_machine_var(
str(machine.flake.path), machine.name, "my_generator/my_value" str(machine.flake.path), machine.name, "my_generator/my_value"
).printable_value ).printable_value
# generate again and make sure nothing changes without the invalidation data being set # generate again and make sure nothing changes without the invalidation data being set
cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"]) cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"])
value1_new = get_var( value1_new = get_machine_var(
str(machine.flake.path), machine.name, "my_generator/my_value" str(machine.flake.path), machine.name, "my_generator/my_value"
).printable_value ).printable_value
assert value1 == value1_new assert value1 == value1_new
@@ -946,13 +946,13 @@ def test_invalidation(
flake.refresh() flake.refresh()
# generate again and make sure the value changes # generate again and make sure the value changes
cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"]) cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"])
value2 = get_var( value2 = get_machine_var(
str(machine.flake.path), machine.name, "my_generator/my_value" str(machine.flake.path), machine.name, "my_generator/my_value"
).printable_value ).printable_value
assert value1 != value2 assert value1 != value2
# generate again without changing invalidation data -> value should not change # generate again without changing invalidation data -> value should not change
cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"]) cli.run(["vars", "generate", "--flake", str(flake.path), "my_machine"])
value2_new = get_var( value2_new = get_machine_var(
str(machine.flake.path), machine.name, "my_generator/my_value" str(machine.flake.path), machine.name, "my_generator/my_value"
).printable_value ).printable_value
assert value2 == value2_new assert value2 == value2_new

9
pkgs/clan-cli/clan_cli/vars/get.py
View File

@@ -8,14 +8,13 @@ from clan_lib.errors import ClanError
from clan_lib.flake import Flake from clan_lib.flake import Flake
from .generate import Var from .generate import Var
from .list import get_vars from .list import get_machine_vars
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
@API.register def get_machine_var(base_dir: str, machine_name: str, var_id: str) -> Var:
def get_var(base_dir: str, machine_name: str, var_id: str) -> Var: vars_ = get_machine_vars(base_dir=base_dir, machine_name=machine_name)
vars_ = get_vars(base_dir=base_dir, machine_name=machine_name)
results = [] results = []
for var in vars_: for var in vars_:
if var.id == var_id: if var.id == var_id:
@@ -41,7 +40,7 @@ def get_var(base_dir: str, machine_name: str, var_id: str) -> Var:
def get_command(machine_name: str, var_id: str, flake: Flake) -> None: def get_command(machine_name: str, var_id: str, flake: Flake) -> None:
var = get_var(str(flake.path), machine_name, var_id) var = get_machine_var(str(flake.path), machine_name, var_id)
if not var.exists: if not var.exists:
msg = f"Var {var.id} has not been generated yet" msg = f"Var {var.id} has not been generated yet"
raise ClanError(msg) raise ClanError(msg)

63
pkgs/clan-cli/clan_cli/vars/list.py
View File

@@ -13,8 +13,7 @@ from .generate import Generator, Prompt, Var, execute_generator
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
@API.register def get_machine_vars(base_dir: str, machine_name: str) -> list[Var]:
def get_vars(base_dir: str, machine_name: str) -> list[Var]:
machine = Machine(name=machine_name, flake=Flake(base_dir)) machine = Machine(name=machine_name, flake=Flake(base_dir))
pub_store = machine.public_vars_store pub_store = machine.public_vars_store
sec_store = machine.secret_vars_store sec_store = machine.secret_vars_store
@@ -32,70 +31,12 @@ def get_vars(base_dir: str, machine_name: str) -> list[Var]:
return all_vars return all_vars
def _get_previous_value(
machine: Machine,
generator: Generator,
prompt: Prompt,
) -> str | None:
if not prompt.persist:
return None
pub_store = machine.public_vars_store
if pub_store.exists(generator, prompt.name):
return pub_store.get(generator, prompt.name).decode()
sec_store = machine.secret_vars_store
if sec_store.exists(generator, prompt.name):
return sec_store.get(generator, prompt.name).decode()
return None
@API.register
def get_generators(base_dir: str, machine_name: str) -> list[Generator]:
from clan_cli.vars.generate import Generator
machine = Machine(name=machine_name, flake=Flake(base_dir))
generators: list[Generator] = Generator.generators_from_flake(
machine_name, machine.flake
)
for generator in generators:
for prompt in generator.prompts:
prompt.previous_value = _get_previous_value(machine, generator, prompt)
return generators
# TODO: Ensure generator dependencies are met (executed in correct order etc.)
# TODO: for missing prompts, default to existing values
# TODO: raise error if mandatory prompt not provided
@API.register
def set_prompts(
base_dir: str, machine_name: str, updates: list[GeneratorUpdate]
) -> None:
from clan_cli.vars.generate import Generator
machine = Machine(name=machine_name, flake=Flake(base_dir))
for update in updates:
generators = Generator.generators_from_flake(machine_name, machine.flake)
for generator in generators:
if generator.name == update.generator:
break
else:
msg = f"Generator '{update.generator}' not found in machine {machine.name}"
raise ClanError(msg)
execute_generator(
machine,
generator,
secret_vars_store=machine.secret_vars_store,
public_vars_store=machine.public_vars_store,
prompt_values=update.prompt_values,
)
def stringify_vars(_vars: list[Var]) -> str: def stringify_vars(_vars: list[Var]) -> str:
return "\n".join([str(var) for var in _vars]) return "\n".join([str(var) for var in _vars])
def stringify_all_vars(machine: Machine) -> str: def stringify_all_vars(machine: Machine) -> str:
return stringify_vars(get_vars(str(machine.flake), machine.name)) return stringify_vars(get_machine_vars(str(machine.flake), machine.name))
def list_command(args: argparse.Namespace) -> None: def list_command(args: argparse.Namespace) -> None:

6
pkgs/clan-cli/clan_cli/vars/set.py
View File

@@ -3,7 +3,7 @@ import logging
import sys import sys
from clan_cli.completions import add_dynamic_completer, complete_machines from clan_cli.completions import add_dynamic_completer, complete_machines
from clan_cli.vars.get import get_var from clan_cli.vars.get import get_machine_var
from clan_cli.vars.prompt import PromptType from clan_cli.vars.prompt import PromptType
from clan_lib.flake import Flake from clan_lib.flake import Flake
from clan_lib.git import commit_files from clan_lib.git import commit_files
@@ -21,7 +21,7 @@ def set_var(machine: str | Machine, var: str | Var, value: bytes, flake: Flake)
else: else:
_machine = machine _machine = machine
if isinstance(var, str): if isinstance(var, str):
_var = get_var(str(flake.path), _machine.name, var) _var = get_machine_var(str(flake.path), _machine.name, var)
else: else:
_var = var _var = var
path = _var.set(value) path = _var.set(value)
@@ -35,7 +35,7 @@ def set_var(machine: str | Machine, var: str | Var, value: bytes, flake: Flake)
def set_via_stdin(machine_name: str, var_id: str, flake: Flake) -> None: def set_via_stdin(machine_name: str, var_id: str, flake: Flake) -> None:
machine = Machine(name=machine_name, flake=flake) machine = Machine(name=machine_name, flake=flake)
var = get_var(str(flake.path), machine_name, var_id) var = get_machine_var(str(flake.path), machine_name, var_id)
if sys.stdin.isatty(): if sys.stdin.isatty():
new_value = ask( new_value = ask(
var.id, var.id,