Skip to content

majordomus web report tests

The test run: the behavioural cases' report, and the crate's own totals

majordomus web report tests

Usage

majordomus web report tests [OPTIONS]

Arguments

argumentvaluedefaultdescription
--suite <SUITE> required The runner's TSV report (`MJ_TEST_REPORT=<file> bash test/run.sh`)
--crate-output <CRATE_OUTPUT> The output of `cargo test`, for its totals
--repo <PATH> Start the search for the repository root here (default: the current directory) (accepted by every subcommand)
--discovery vcs | filesystem vcs How declarative files are enumerated (accepted by every subcommand)
  • vcs — Tracked files, through the version-control index (the layer's contract)
  • filesystem — A walk of the work tree with the same glob semantics; untracked files included
--strict flag Refuse to proceed when any file of the layer carries an error diagnostic (accepted by every subcommand)
--share <DIR> The tool distribution's share directory (kinds.yaml, schemas/); default: $MAJORDOMUS_SHARE, then the repository's own share/, then the one beside the executable (accepted by every subcommand)
--format text | json text Output shape (accepted by every subcommand)
  • text — Lines for a person
  • json — One JSON document, deterministic
--only <ONLY> Only these surfaces, by discovered id (repeat or separate with commas) (accepted by every subcommand)
--exclude <EXCLUDE> Every surface except these, by discovered id (accepted by every subcommand)

Examples

  • Render the suite's own results into the /tests surface

    The runner writes its report with `MJ_TEST_REPORT=<file> bash test/run.sh`; this renders it, keeps the machine-readable results beside the page, and declares the directory so discovery finds it. Without that file there is nothing to render and the command says so rather than publishing an empty page.

    $ majordomus web report tests --suite target/web/run.tsv

    Verified by the example tests: exits 13.

Where this comes from

Declared once in apps/majordomus-cli/src/cli.rs: clap for the structure, typed Rust metadata beside it for the examples. This page, majordomus web report tests --help, docs/generated/cli.md and docs/generated/cli.json are projections of that one declaration.

The whole command line on one page: the registry's command-line page. The task lifecycle (init, start, finish, doctor, ...) belongs to the shell tool, a different program: Commands and its specification.