Upon successful installation a set of stests commands are available for execution from within a terminal session. All such commands are prefixed by stests- and allow you to perform tasks:
- updating stack;
- controlling worker daemons;
- controlling interactive sessions;
- cache querying;
- cache updating;
- cache housekeeping;
- launching workload generators;
- viewing on-chain information;
Listed below are the full set of supported commands with the exception of workload generator commands which are documented here.
Prior to interacting with a test network one must register various network assets infrastructure with stests, i.e. registering the network itself plus it's associated set of nodes. Registration is supported within 2 operational contexts:
-
when running stests alongside nctl;
-
when running stests within a Casper Labs SRE setting.
Registers Casper Labs NCTL network assets.
Registers Casper Labs LRT network assets. See (LRT usage)[usage_lrt.md] for further details.
Displays in terminal full set of sests environment variables.
Updates installed stests stack by:
- pulling latest changes from stests GitHub repo;
- updating environment variables;
- updating virtual environment.
The stests worker processes can be run in daemon mode. Process behaviour can be altered by editing the following configuration file:
$HOME/.casperlabs-stests/ops/config/supervisord.conf
Runs worker processes in a single interactive session. Interactive mode is useful in development & smokescreen scenarios.
Starts stests worker processes in daemon mode.
Stops stests worker processes, pauses for 3 seconds, and then restarts processes. Does not flush cache.
Stops stests worker processes, pauses for 3 seconds, flushes cache, and then restarts processes.
Displays in terminal current status of stests processes.
Stops all stests worker processes currently running in daemon mode.
The stests cache is implemented using Redis. It is partitioned into sub-caches: orchestration, monitoring & infrastructure. The cache size grows in proportion to the amount of time a target network is monitored and the number of executed workload generators. The following commands simplify cache housekeeping.
Deletes orchestration & monitoring related cache data.
Deletes infrastructure related cache data. Execution of this command requires subsequent re-registration of network infrastructure.
Displays on-chain account information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--account- Either a 33 byte account id (hex format) or a 32 byte account hash (hex format).
Displays an on-chain account balance.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--account- Either a 33 byte account id (hex format) or a 32 byte account hash (hex format).
Displays an on-chain account hash.
--account- A 33 byte account id (hex format), i.e. a key algo type + public key.
Displays on-chain block information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--block- 32 byte block hash (hex format).
Displays on-chain deploy information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--deploy- 32 byte deploy hash (hex format).
Displays on-chain faucet account information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
Displays on-chain faucet account balance information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
Displays keys associated with a network faucet.
--net- Network name {type}{id}, e.g. nctl1.
Displays information related to the set of networks registered with stests.
Displays set of nodes registered with stests for a particular network.
--net- Network name {type}{id}, e.g. nctl1.
Displays summary information related to a workload generator run. The information is broken down into the various phases/steps that a generator may pass through in it's lifetime.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--type- Run type, e.g. wg-100.
-
--run- Run identifier, e.g. 1.
Displays information about each deploy dispatched during the course of a workload generator run.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--type- Run type, e.g. wg-100.
-
--run- Run identifier, e.g. 1.
Displays summary information regarding workload generator runs. Such information includes number of dispatched deploys plus execution stats & status.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--type- Run type, e.g. wg-100.
-
--status- Run status - e.g. complete.
Displays a node's current state root hash.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
Displays a node's bonding asymmetric ECC key pair.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
Displays on-chain validator account information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
Displays on-chain validator account balance information.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
Displays keys associated with a network validator.
--net- Network name {type}{id}, e.g. nctl1.
Registers a node's bonding key for use in Proof-of-Stake related scenarios.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--path- Absolute path to the node's secret key in PEM format.
Registers a network's faucet key.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--path- Absolute path to the faucet secret key in PEM format.
Registers a network for testing.
--net- Network name {type}{id}, e.g. nctl1.
Updates operational status of a registered network.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--status- Network status.
Registers a network node. When registering the node's mode must be specified as this will affect how stests will interact with the node.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--address- Node public network address: {host}:{port}.
-
--type- Node type, i.e. full | read_only.
Updates the operational status of a registered node.
-
--net- Network name {type}{id}, e.g. nctl1.
-
--node- Node index, e.g. 1.
-
--status- Node status.