CLI command

probierz support check

Write to a product's support as a user does, read its answer later, and fail when the answer is late.

Invocation#

Shell
probierz support check <APP>

Required inputs and options#

  • <APP> is the product, as probierz apps list names it. Its manifest declares inventory: {supportCheck: {organization: <the mail alternative's organization>, from: <a test mailbox Probierz writes from>, to: <the address its users write to>, replyMinutes: <minutes an answer is due in>}}.
  • With form: {url: <where the contact form posts>, fields: {<name>: <value>}} beside them, the check is sent through the product's contact form instead of by mail: each field's value with {from} (the test mailbox), {subject} and {message} (the check's words, quoting its id) filled, posted as a browser posts a form (application/x-www-form-urlencoded), marked as Probierz's traffic. Its answer is read from the test mailbox as for mail.

Output and state effects#

Reads the checks kept in test-results/<APP>/support/checks.json; for each one waiting, asks Stado's mail family (message-list) for a message in the test mailbox from the support address quoting the check's id, and keeps the first one's time as answeredAt and the minutes it took as answerMinutes. When none waits, writes a new one from the test mailbox to the support address (message-send, its id the idempotency key, its words in <id>.txt beside the list), or posts it through the declared form, kept with channel: form, the form's address and the status it answered. Prints {app, to, replyMinutes, sent, overdue, checks}. Probierz holds no mailbox credential; the mail alternative does. A schedule runs it as often as the product's support is to be watched.

Exact refusals#

  • reply-overdue (exit 1): a check waited replyMinutes or longer without an answer, naming it and the address, after every check is printed and kept.
  • check-undeclared (exit 1): the manifest's inventory.supportCheck names no organization, from, to or replyMinutes, or a form with no http(s) url or no fields, naming which; no mail is sent or read.
  • form-broken (exit 1): the contact form could not be reached or did not answer 2xx, naming its address and its answer; no check is kept, so the next one posts again.
  • The refusals of Stado's mail family (probierz.alternatives: no Stado, no alternative answering, an answer that is no list of messages).
  • Real test: tests/support/check.rs (sending and reading through the host's Stado and a real mailbox) and tests/support/form.rs (the test product's contact form, with and without contact-broken).

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.

  • state-blank (probierz.config, exit 1, config): finding Probierz's state directory: PROBIERZ_STATE_DIR is set but blank, so it names no directory. set PROBIERZ_STATE_DIR to an absolute directory, or unset it so .probierz in the home directory is used.
  • state-relative (probierz.config, exit 1, config): finding Probierz's state directory: PROBIERZ_STATE_DIR names {path}, which is not an absolute path, so it would mean a different directory in every working directory. set PROBIERZ_STATE_DIR to an absolute directory.
  • unreadable (probierz.config, exit 1, config): reading this instance's configuration at {file}: the file cannot be read: {error}. make {file} a file this user can read, or remove it to set no key.
  • malformed (probierz.config, exit 1, config): reading this instance's configuration at {file}: the file is not a JSON object of keys: {error}. write {file} again with probierz config set, or remove it to set no key.
  • stored-unknown (probierz.config, exit 1, config): reading this instance's configuration at {file}: it holds {key}, which no part of this Probierz reads (a key a release before or after this one declared). remove it with probierz config unset {key}.
  • stored-invalid (probierz.config, exit 1, config): reading {key} from this instance's configuration at {file}: it holds {value}, which is not a {kind}. set it again with probierz config set {key} <value>, or remove it with probierz config unset {key}.
  • unwritable (probierz.config, exit 1, config): writing this instance's configuration at {file}: {step} failed: {error}. make {directory} a directory this user can write, or point PROBIERZ_STATE_DIR at one.
  • key-unknown (probierz.config, exit 2, refused): naming a configuration key: {key} is no key any part of Probierz reads. name one of the listed keys; probierz config list prints what each decides.
  • value-invalid (probierz.config, exit 2, refused): setting {key}: {value} is not a {kind}: {why}. give {key} a {kind}.
  • 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.
  • app-id-invalid (probierz.manifest.load, exit 2, refused): naming an app: "{app}" is not an id: letters, digits, '.', '_' and '-', starting with a letter or digit. name an app probierz apps list lists.
  • manifest-unreadable (probierz.manifest.load, exit 1, config): reading {file}: {error}. write {file} as YAML the reader accepts (its line and column are named), then load it again.
  • manifest-invalid (probierz.manifest.load, exit 1, config): judging {file}: {problem}. fix the declaration in {file}; probierz app check names every problem it has with the world once it loads.
  • manifest-id-mismatch (probierz.manifest.load, exit 1, config): loading the manifest of {app}: {file} is named for {app} and declares appId {declared}. declare appId: {app} in {file}, or rename the file for the app it declares with git mv.
  • stado-missing (probierz.alternatives, exit 1, config): asking Stado which alternative answers: {command}: Stado could not be started: {error}. install Stado (the stado release installer at stado://releases/stado/<version>/<platform>/install.sh) so its alternatives can be asked.
  • none-answers (probierz.alternatives, exit 69, infra_down): finding an alternative of {family} for Probierz: no alternative answered {command}: {cause}. make one of the alternatives Stado names answer (stado capabilities list {family}), or select another order with stado capabilities select {family}.
  • answer-malformed (probierz.alternatives, exit 1, config): reading Stado's answer to {command}: {error}. update Stado to the release whose answer Probierz reads (stado product update stado).
  • program-failed (probierz.alternatives, exit 1, refused): {command}: {cause}. fix what the provider names, or ask Stado for the next alternative with stado capabilities resolve --failed <provider>.
  • placement-unset (probierz.alternatives, exit 1, config): opening a browser: this instance has not decided where a browser may run (browser.placement). run probierz config set browser.placement stado (only on a host Stado places the run on) or local.
  • placement-refused (probierz.alternatives, exit 1, refused): opening a browser: browser.placement is stado and this process is not a job Stado placed. run it through Stado: probierz remote run web --app <app> --host <host>, or the same verb under probierz remote.
  • check-undeclared (probierz.support, exit 1, config): reading how {app}'s support is checked: its manifest's inventory.supportCheck names no {field}. declare inventory: {supportCheck: {organization: <mail organization>, from: <test mailbox>, to: <the address users write to>, replyMinutes: <minutes>}} in the product's manifest.
  • form-broken (probierz.support, exit 1, refused): sending {app}'s support check through its contact form {url}: {problem}. make the form at {url} take a message as a user's browser posts it, or name the address it posts to in inventory.supportCheck.form.url.
  • reply-overdue (probierz.support, exit 1, refused): waiting for {to} to answer the support check {check}: no answer came in the {minutes} minutes {app}'s manifest gives its support. answer the check from {to}, quoting its id, or give support more time in inventory.supportCheck.replyMinutes.

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.