aboutsummaryrefslogtreecommitdiff
path: root/docs/design/2026-06-25-testinfra-validation.org
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-07-09 14:02:20 -0500
committerCraig Jennings <c@cjennings.net>2026-07-09 14:02:20 -0500
commita8f7e9b9c089577b299afc04bd1e1be040197995 (patch)
tree9506262da100139f793926cfb8b75e2f92330044 /docs/design/2026-06-25-testinfra-validation.org
parent9f07851cdb7863fafe046cf83199e3e5a730f49d (diff)
downloadarchsetup-a8f7e9b9c089577b299afc04bd1e1be040197995.tar.gz
archsetup-a8f7e9b9c089577b299afc04bd1e1be040197995.zip
docs: remove personal paths and false co-authorship before release
The repo carries an open task to publish it, and docs/ leaked things a clone could neither use nor should see. Absolute paths under one user's home become the repo root, a home-relative path, or a named variable, so the snippets stay runnable for anyone. The testinfra example takes its user from an env var instead of hardcoding one. References into a private sibling project and into the gitignored tooling directory are replaced by what they mean; as written they were dead links in any clone but the author's. Five documents claimed a co-author who is not a person. An #+AUTHOR line survives conversion into docx, a wiki page, or a PDF, so it is worth being exact about: these documents have one author.
Diffstat (limited to 'docs/design/2026-06-25-testinfra-validation.org')
-rw-r--r--docs/design/2026-06-25-testinfra-validation.org8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/design/2026-06-25-testinfra-validation.org b/docs/design/2026-06-25-testinfra-validation.org
index 5c82aa2..0f81231 100644
--- a/docs/design/2026-06-25-testinfra-validation.org
+++ b/docs/design/2026-06-25-testinfra-validation.org
@@ -106,16 +106,18 @@ scripts/testing/tests/
** Example tests (parity)
#+begin_src python
+TEST_USER = os.environ.get("ARCHSETUP_TEST_USER", "archie")
+
def test_ufw_enabled(host):
assert host.service("ufw").is_enabled
-def test_user_cjennings_exists(host):
- u = host.user("cjennings")
+def test_primary_user_exists(host):
+ u = host.user(TEST_USER)
assert u.exists
assert u.shell == "/usr/bin/zsh"
def test_zshrc_stowed_and_readable(host):
- f = host.file("/home/cjennings/.zshrc")
+ f = host.file(f"/home/{TEST_USER}/.zshrc")
assert f.is_symlink
assert ".dotfiles/" in f.linked_to
assert f.exists # not broken