almanak test¶
fork test tooling: operator file and one lifecycle
almanak test run¶
one supervised fork lifecycle: admission, decisions, teardown, verdict
usage: almanak test run [-h] [--config CONFIG] [--strategy STRATEGY]
--gateway-config GATEWAY_CONFIG --env-file ENV_FILE
--output OUTPUT [--decisions DECISIONS]
[--advance ADVANCE] [--through-exit]
[--param KEY=VALUE] [--production-parameters]
[--idle IDLE] [--format {text,json}] [--json]
[directory]
| Option | Details | Description |
|---|---|---|
directory |
Path; default . |
|
--config |
Path | |
--strategy |
Path | |
--gateway-config |
Path; required | operator provider, account and execution settings |
--env-file |
Path; required | private provider credentials read only by the operator gateway |
--output |
Path; required | new fork workspace directory |
--decisions |
positive; default 3 |
most decisions before teardown |
--advance |
positive | seconds of fork time between decisions (default: the decision interval; a shorter step is raised to reach the next due decision) |
--through-exit |
keep deciding after the first entry, up to --decisions, so the strategy's own later intents and exit execute before teardown | |
--param |
set a strategy.parameters value in the fork workspace's copy of the config (read as a YAML scalar, on top of strategy.test_parameters); repeatable | |
--production-parameters |
do not apply strategy.test_parameters: fork with the production strategy.parameters values plus any --param | |
--idle |
positive; default 3 |
with --through-exit, consecutive holds after the entry that end the decisions early (default 3); raise it, or --advance, when the strategy waits longer between steps |
--format |
one of text, json |
|
--json |
almanak test config¶
generate a fork operator file from the author configuration
usage: almanak test config [-h] [--config CONFIG] [--strategy STRATEGY]
--env-file ENV_FILE [--block BLOCK]
[--output OUTPUT] [--force] [--format {text,json}]
[--json]
[directory]
| Option | Details | Description |
|---|---|---|
directory |
Path; default . |
|
--config |
Path | |
--strategy |
Path | |
--env-file |
Path; required | private provider credentials |
--block |
whole | anchor block (default: latest; one chain only) |
--output |
Path | write the operator file here |
--force |
replace an existing --output | |
--format |
one of text, json |
|
--json |