CLI command

probierz app check

Confront one manifest with the world: its repositories, path patterns, specs, journey programs, Skarbiec items and api journeys.

Invocation#

Shell
probierz app check <appId>

Required inputs and options#

  • <appId> is required.

Output and state effects#

Writes the verdict as JSON, as apps check does for one app: its problems and its unchecked items, each with why; an empty problem list means its repositories, mapped paths, specs and journey programs all hold and its api journeys fit the published contract.

Exact refusals#

  • Every refusal of loading the manifest, as for app show.
  • contradicted (exit 1) names every problem: a repository that is not a directory under the workspace, not a git repository, inside another repository, or a copy of another repository under a different name; a pattern that matches no tracked file; a spec missing where its runner reads it; an api journey step the published contract no longer fits.

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.

  • workspace-unset (probierz.manifest.discover, exit 1, config): finding the repositories that hold product manifests: this instance names no workspace, so there is no directory of repositories to look in. run probierz config set workspace <directory holding one checkout per repository>.
  • workspace-unreadable (probierz.manifest.discover, exit 1, config): listing {workspace}: the operating system would not list it: {error}. give this user read permission on {workspace}, or set another workspace with probierz config set workspace.
  • listing-failed (probierz.manifest.discover, exit 1, config): asking the git of {repository} which manifests it tracks: {cause}. make {repository} a git repository this user can read.
  • untracked (probierz.manifest.discover, exit 1, config): reading the manifests of {repository}: {file} is not tracked by the repository's git, so no other host and no review sees it. run git -C {repository} add {relative} and commit it, or remove the file.
  • duplicate (probierz.manifest.discover, exit 1, config): finding the manifest of {app}: two repositories declare {app}: {first} and {second}. keep the manifest of {app} in the product's own repository and remove the other.
  • not-found (probierz.manifest.discover, exit 1, config): finding the manifest of {app}: no repository under {workspace} has .probierz/{app}.yaml. add .probierz/{app}.yaml to the product's repository (probierz project adopt or probierz author manifest write it), or name an app probierz apps list lists.
  • file-name-invalid (probierz.manifest.discover, exit 1, config): finding the manifests of {repository}: {file} names app "{app}", which is not an id: letters, digits, '.', '_' and '-', starting with a letter or digit. rename it .probierz/<appId>.yaml with the id it declares, with git mv.
  • repository-name-invalid (probierz.manifest.discover, exit 1, config): finding repository "{name}" in the workspace: a manifest names a checkout directly under the workspace, and "{name}" would name another place. name the checkout by its directory name under the workspace in repositories[].repository.
  • contradicted (probierz.manifest.check, exit 1, config): checking the manifest of {app} against the world: {count} of its declarations do not hold: {problems}. fix each declaration the list names; a missing spec is drafted by probierz author spec.
  • account-malformed (probierz.accounts, exit 1, config): reading the test accounts the manifest of {app} declares: the entry {entry} is not an upper-case variable name mapped to ITEM#FIELD or role:ROLE#FIELD. write each account as NAME: role:<role>#<field> (or NAME: <item>#<field>) under accounts in the manifest of {app}.
  • account-unread (probierz.accounts, exit 69, infra_down): reading the test account {name} of {app} ({reference}) through stado credentials get: {answer}. store the item in Skarbiec with that field (tagged stado:role:<role> for a role), grant this host's store, or set {name} in the run's environment.

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.