CLI command
probierz apps check
Confront every manifest with the world and name each declaration that does not hold, each api journey against the contract the product publishes among them.
Invocation#
probierz apps checkRequired inputs and options#
- No input; every manifest
apps listshows is checked.
Output and state effects#
Writes one verdict per app: ok, every problem with the path or name observed, and unchecked: what cannot be looked for yet, each with why. Each repository a manifest names must be a git checkout of its own under the workspace whose origin is that repository, each paths pattern must match a tracked file, each surface's spec must be where its runner reads it; a journey on a journeys/ surface with no program names the probierz author spec command that writes one. A Skarbiec item is reported unchecked until a secrets alternative answers stado capabilities call. Every step of every .probierz/<app>/api/*.json journey is confronted with the published contract (inventory.apiContract) without sending it: an operation the contract no longer declares, an expected status it no longer answers with, or a field the step asserts (expect) or captures (capture) that its declared answer no longer holds is a problem naming the journey, step and field, so a contract change that breaks a journey is named before the journey runs; a field under a schema that describes no properties is open and fits, and a contract that is missing or cannot be read leaves the api journeys unchecked. It writes nothing; an unchecked item does not set the exit code.
Exact refusals#
contradicted(exit 1) names every app with a problem and every problem after the verdicts are printed. A manifest that cannot be read (not YAML, or not the manifest's shape) is its app's problem,its manifest cannot be read: <why>, beside every other verdict, never the end of the check; a check that cannot run, git not answering, refuses the command. Discovery refusals (no workspace named, a manifest git does not track, one app declared twice) are those ofapps list. Real tests: tests/manifest/check/world.rs and, for the contract, tests/manifest/check/contract.rs.
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. runprobierz 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 withprobierz 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. rungit -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 adoptorprobierz author manifestwrite it), or name an appprobierz apps listlists.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, withgit 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 byprobierz author spec.
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.