Files
FabledSteward/tests/test_ansible_credentials.py
T
bvandeusenandClaude Opus 5.5 c678379646
CI / lint (push) Successful in 2s
CI / integration (push) Successful in 57s
CI / unit (push) Successful in 1m24s
CI / publish (push) Successful in 1m26s
fix(ansible): group names Ansible accepts, and interpreter discovery without the warning (#5334)
Every run warned twice because of Steward's own inventory:
- 'Invalid characters were found in group names': the group 'Docker
  Swarm' went into the inventory as typed. ansible_group_name() cleans it
  to docker_swarm (lower case, [a-z0-9_], never a leading digit); two
  names that clean alike get _2, _3 so neither folds into the other. The
  group page says what plays call it. The display name is unchanged.
- Python interpreter discovery: ansible_env sets
  ANSIBLE_PYTHON_INTERPRETER=auto_silent unless the environment already
  sets one; a target or group's ansible_python_interpreter still wins.

Runs are scoped by target set (steward:group:<id>), not by group name,
and --limit is free text, so neither path depends on the name.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 00:01:54 -04:00

96 lines
3.7 KiB
Python

"""Unit tests for Ansible credential argv/env construction (task 548)."""
import json
from steward.ansible.executor import ansible_env, build_bootstrap, build_credentials
def test_no_creds_is_empty():
assert build_credentials({}, "/td") == ([], [])
assert build_credentials(None, "/td") == ([], [])
def test_ssh_key_via_file():
args, files = build_credentials({"ssh_private_key": "KEYDATA"}, "/td")
assert args == ["--private-key", "/td/id_key"]
assert files == [("/td/id_key", "KEYDATA\n")]
def test_ssh_key_keeps_existing_trailing_newline():
_, files = build_credentials({"ssh_private_key": "KEY\n"}, "/td")
assert files == [("/td/id_key", "KEY\n")]
def test_vault_password_via_file():
args, files = build_credentials({"vault_password": "vpw"}, "/td")
assert args == ["--vault-password-file", "/td/vault_pass"]
assert files == [("/td/vault_pass", "vpw\n")]
def test_become_password_uses_vars_file_not_argv():
pw = "p@ss word"
args, files = build_credentials({"become_password": pw}, "/td")
assert args == ["-e", "@/td/become.yml"]
assert files[0][0] == "/td/become.yml"
assert files[0][1] == "ansible_become_password: " + json.dumps(pw) + "\n"
# The password must never appear on the command line.
assert pw not in " ".join(args)
def test_all_three_combined():
args, files = build_credentials(
{"ssh_private_key": "K", "vault_password": "V", "become_password": "B"}, "/td")
assert "--private-key" in args
assert "--vault-password-file" in args
assert "-e" in args
assert len(files) == 3
def test_ansible_env_host_key_checking_toggle():
assert ansible_env({"host_key_checking": True}, {})["ANSIBLE_HOST_KEY_CHECKING"] == "True"
assert ansible_env({"host_key_checking": False}, {})["ANSIBLE_HOST_KEY_CHECKING"] == "False"
assert ansible_env({}, {})["ANSIBLE_HOST_KEY_CHECKING"] == "False"
# Interpreter discovery stays, without its warning on every run (#5334);
# an interpreter set in the environment is left as it is.
assert ansible_env({}, {})["ANSIBLE_PYTHON_INTERPRETER"] == "auto_silent"
assert ansible_env({}, {"ANSIBLE_PYTHON_INTERPRETER": "/usr/bin/python3"})["ANSIBLE_PYTHON_INTERPRETER"] == "/usr/bin/python3"
assert ansible_env(None, {})["ANSIBLE_HOST_KEY_CHECKING"] == "False"
def test_ansible_env_preserves_base():
env = ansible_env({}, {"FOO": "bar"})
assert env["FOO"] == "bar"
# ── Bootstrap connection override (first-contact provisioning) ─────────────────
def test_bootstrap_empty_is_noop():
assert build_bootstrap({}, "/td") == ([], [])
assert build_bootstrap(None, "/td") == ([], [])
def test_bootstrap_user_only():
args, files = build_bootstrap({"user": "root"}, "/td")
assert args == ["-e", "@/td/bootstrap.yml"]
assert files == [("/td/bootstrap.yml", 'ansible_user: "root"\n')]
def test_bootstrap_password_doubles_as_become_and_stays_off_argv():
pw = "p@ss word"
args, files = build_bootstrap({"user": "admin", "password": pw}, "/td")
assert args == ["-e", "@/td/bootstrap.yml"]
body = files[0][1]
assert 'ansible_user: "admin"\n' in body
assert "ansible_password: " + json.dumps(pw) + "\n" in body
# Bare password becomes the become password too.
assert "ansible_become_password: " + json.dumps(pw) + "\n" in body
# Secret must never reach the command line.
assert pw not in " ".join(args)
def test_bootstrap_explicit_become_password():
_, files = build_bootstrap(
{"user": "u", "password": "sshpw", "become_password": "sudopw"}, "/td")
body = files[0][1]
assert 'ansible_password: "sshpw"\n' in body
assert 'ansible_become_password: "sudopw"\n' in body