TESTING.md

Benchmarking & Testing

Simulation framework (Simpa)

Logging in spectred and simpa can be filtered by either:

The current codebase supports a full in-process network simulation, building an actual DAG over virtual time with virtual delay and benchmarking validation time (following the simulation generation). To see the available commands.

cargo run --release --bin simpa -- --help

The following command will run a simulation to produce 1000 blocks with communication delay of 2 seconds and 8 BPS (blocks per second) while attempting to fill each block with up to 200 transactions.

cargo run --release --bin simpa -- -t=200 -d=2 -b=8 -n=1000

Heap Profiling

Heap-profiling in spectred and simpa can be done by enabling heap feature and profile using the --features argument.

cargo run --bin spectred --profile heap --features=heap

It will produce {bin-name}-heap.json file in the root of the workdir, that can be inspected by the dhat-viewer

Tests

Run unit and most integration tests:

cd rusty-spectre
cargo test --release
// or install nextest and run

Using nextest:

cd rusty-spectre
cargo nextest run --release

Benchmarks

cd rusty-spectre
cargo bench

Logging

Logging in spectred and simpa can be filtered by either:

1. Defining the environment variable RUST_LOG

2. Adding the --loglevel argument like in the following example:

   (cargo run --bin spectred -- --loglevel info,spectre_rpc_core=trace,spectre_grpc_core=trace,consensus=trace,spectre_core=trace) 2>&1 | tee ~/rusty-spectre.log
   

   In this command we set the loglevel to INFO.