CLI command

probierz refusals check

Hold the declared refusals and the command surface to the error standard.

Invocation#

Shell
probierz refusals check

Required inputs and options#

  • --root <DIR> is the checkout whose tests/ the causes name; the harness when omitted.

Output and state effects#

Checks every cause is declared whole (no empty sentence, no generic sentence, a code other than unknown, a test written as tests/<area>/<file>::<test>), that each named test file under the root declares that test function unless tests/untested-causes.json or a part of it in tests/untested-causes.d/ names the test with why it cannot be provoked there (a listed test that is written after all, or one no cause names, is a problem too), and that every argument of every command has a description, then prints {"operations", "causes", "problems": []}. CI and every release run it.

Exact refusals#

  • below-standard (probierz.refusals, exit 1) at refusals.check, naming the root and each problem: its cause or the command and argument without a description.

Declared refusals#

What probierz refusals list declares for this command at revision d2cd6156e8b8dc6204dab7b46ec0b34b2bb03cea (probierz 0.1.7 (revision unknown, not built from a git checkout)): each cause's id, the operation declaring it, its exit status and code, and its remedy.

  • variable-blank (probierz.harness, exit 1, config): finding the harness PROBIERZ_HARNESS_DIR names: PROBIERZ_HARNESS_DIR is set but blank, so it names no directory. set PROBIERZ_HARNESS_DIR to the Probierz checkout that holds packages/, or unset it so the checkout the binary was built in, the working directory and the installed harness are tried.
  • no-packages (probierz.harness, exit 1, config): finding the harness every command but the instance's configuration reads: {searched} holds no packages/ directory, so there are no journey runners to run. pass --harness, or set PROBIERZ_HARNESS_DIR, to a Probierz checkout that holds packages/, or unset both so the installed harness in Probierz's state directory is used.
  • packages-unexaminable (probierz.harness, exit 1, config): examining {path} for the harness: the operating system would not say what {path} is: {error}. give this user search permission on the directory that holds {path}, or name another checkout with --harness.
  • installed-unwritable (probierz.harness, exit 1, config): writing the runners this binary carries into the installed harness {root}: {path} could not be written: {error}. make {root} a directory this user can write (PROBIERZ_STATE_DIR moves Probierz's state directory), or name a checkout with --harness.
  • operation-unknown (probierz.refusals, exit 2, refused): showing the refusals of {id}: no operation {id} declares its refusals. name one of them, as probierz refusals list prints them.
  • not-json (probierz.refusals, exit 1, config): rendering the declared refusals of {id} as JSON: the catalogue rendered text that is not JSON, which is a defect of its renderer. print the same declarations with --markdown, and report the operation to Probierz's maintainers with this line.
  • below-standard (probierz.refusals, exit 1, refused): holding the declared refusals to the error standard under {root}: {count} problems: {problems}. write each named test, or list it in {root}/tests/untested-causes.d/ with why it cannot be provoked there, and describe each argument named; pass --root with the checkout whose tests the catalogue names.

Source snapshot#

Generated from the Rust binaries at revision 99a74945a3598a8d73b6c6cbe5aae4f283becea3 of Probierz's private source repository.

Combined help SHA-256: 77529678a61237f774b59e76df0d1907cb749ef5da56d2ed913b040793b7d30b; binary SHA-256: be9e0eaff0e6ea50403a0c6f6d467697a4eac676f9523b8dc13a596d2b5526c5.