0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-06 02:54:26 +00:00

Files

T

kevinveenbirkenbachandClaude Opus 5 575a5a87ac refactor(layout): sort shipped scripts by language and split the unit suite

Every script a role ships now lives under `files/<language>/`, and the unit
suite is split the same way: `tests/unit/python/` beside new sibling trees for
the other languages. `tests/lint/filesystem/test_role_files_layout.py` keeps it
that way; directories whose shape is dictated from outside carry a `.nocheck`
naming the constraint (Docker build contexts, WordPress mu-plugins, the Joomla
extension, Odoo addons, Playwright suites, the `files/test/test.sh` harness
that `test-e2e-cli` resolves generically).

This cannot be applied in halves. Moving a file and repointing what names it
are the same change: 14 references resolve only at deploy time, so the tree is
green either before or after, never between.

Those 14 were found by static resolution over every reference class, not by the
test suite -- a full `make quality-high` was green while all of them were
broken:

  * 7 `src:` values built from a role variable holding a bare filename
    (svc-bkp-remote-2-local, decidim, espocrm, friendica, joomla, pixelfed x2).
    The variable doubles as the destination name inside the container, so the
    language segment belongs at the call site, not in the variable.
  * `sys-service/tasks/04_base.yml` resolved every consumer's systemd script
    through `first_found(..., errors='strict')` over `files/script.{sh,py}`.
    18 roles ship exactly that and have no template fallback: the play would
    have died on each.
  * `sys-front-inj-javascript` fell back to `<role>/files/javascript.js`; the
    interface now reads `files/javascript/javascript.js`.
  * `sys-front-inj-logout/templates/head_sub.j2` built the cache-busting mtime
    path through `path_absolute(... 'files', ...)`.
  * 4 `ansible.builtin.script:` invocations naming a bare command
    (pull.py, prune.sh, set_postgres_superuser_password.sh, ganesha-serve.sh).
  * `dev-python/files/shell/install.sh` pointed at a sibling role's script.

Depth-dependent paths inside the moved trees were bumped accordingly: 59
`parents[N]` computations, 12 relative climbs, and the per-role recover CLI,
whose path `cli/administration/recover/recoverers.py` still assembled from the
pre-move location.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-08-22 01:31:09 +02:00

1.7 KiB

Raw Blame History

Unit Tests 🧪

This page covers unit testing requirements, framework, and structure. Run unit tests with make test-unit.

Framework 🧰

You MUST use Python unittest as the test framework.
Tests MUST live under tests/unit/.
Mirror the source tree: a file at plugins/lookup/service.py gets its tests at tests/unit/python/plugins/lookup/test_service.py.

Requirements 📋

You MUST add or update unit tests for every *.py file you touch.
Each test MUST cover one isolated behavior. Do not test multiple concerns in a single test method.
You MUST NOT write tests that only assert a file contains a string.
You MUST NOT write tests for non-executable files such as .yml or .j2. Test the code that consumes them instead.
You SHOULD name test methods after the behavior they verify, not the function name alone (e.g. test_needed_false_when_disabled).
You SHOULD cover edge cases: empty inputs, missing keys, and boundary values, not only the happy path.
You MAY use unittest.mock to isolate the unit under test from Ansible internals or external state.

How to Create 🛠️

Identify the module under test (e.g. plugins/lookup/service.py).
Create the matching test file under tests/unit/ if it does not exist.
Subclass unittest.TestCase.
Write one method per behavior. Build hypotheses before writing assertions.
Run make test-unit and verify all tests pass.

Running Specific Tests 🏃

Use INFINITO_TEST_PATTERN to scope the test run to a single file or a glob:

# Run a single test file
make test-unit INFINITO_TEST_PATTERN=test_my_module.py

# Run all files matching a prefix
make test-unit INFINITO_TEST_PATTERN=test_applications*.py

1.7 KiB Raw Blame History