README
¶
End-to-end Testing Package
This is the main project folder of the end-to-end testing suite for Prysm. This performs a full end-to-end test for Prysm, including spinning up an ETH1 dev chain, sending deposits to the deposit contract, and making sure the beacon node and its validators are running and performing properly for a few epochs. It also performs a test on a syncing node, and supports featureflags to allow easy E2E testing of experimental features.
How it works
Through the end2EndConfig struct, you can declare several options such as how many epochs the test should run for, and what BeaconConfig the test should use. You can also declare how many beacon nodes and validator clients are run, the E2E will automatically divide the validators evently among the beacon nodes.
In order to "evaluate" the state of the beacon chain while the E2E is running, there are Evaluators that use the beacon chain node API to determine if the network is performing as it should. This can evaluate for conditions like validator activation, finalization, validator participation and more.
Evaluators have 3 parts, the name for it's test name, a policy which declares which epoch(s) the evaluator should run, and then the evaluation which uses the beacon chain API to determine if the beacon chain passes certain conditions like finality.
Current end-to-end tests
- Minimal Config - 2 beacon nodes, 256 validators, running for 8 epochs
- Minimal Config Slashing Test - 2 beacon nodes, 256 validators, tests attester and proposer slashing
Instructions
If you wish to run all the E2E tests, you can run them through bazel with:
bazel test //endtoend:go_default_test --test_output=streamed --test_arg=-test.v --nocache_test_results
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package components defines utilities to spin up actual beacon node and validator processes as needed by end to end tests.
|
Package components defines utilities to spin up actual beacon node and validator processes as needed by end to end tests. |
|
Package evaluators defines functions which can peer into end to end tests to determine if a chain is running as required.
|
Package evaluators defines functions which can peer into end to end tests to determine if a chain is running as required. |
|
Package helpers defines helper functions to peer into end to end processes and kill processes as needed.
|
Package helpers defines helper functions to peer into end to end processes and kill processes as needed. |
|
Package params defines all custom parameter configurations for running end to end tests.
|
Package params defines all custom parameter configurations for running end to end tests. |
|
Package types includes important structs used by end to end tests, such as a configuration type, an evaluator type, and more.
|
Package types includes important structs used by end to end tests, such as a configuration type, an evaluator type, and more. |