prysm-pulse/endtoend
Raul Jordan b0dfc46603
Fix Up READMEs for Mainnet (#7910)
* fix up readmes

* Update README.md

Co-authored-by: Preston Van Loon <preston@prysmaticlabs.com>

Co-authored-by: Preston Van Loon <preston@prysmaticlabs.com>
Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
2020-11-23 18:47:55 +00:00
..
components Add Partial Deposits in E2E (#7801) 2020-11-13 16:35:09 +00:00
evaluators Verify eth1data vote in E2E (#7551) 2020-10-19 19:35:34 +00:00
helpers Prevent Usage of Stdlib File/Dir Writing With Static Analysis (#7685) 2020-11-09 14:27:03 -06:00
params Prevent Usage of Stdlib File/Dir Writing With Static Analysis (#7685) 2020-11-09 14:27:03 -06:00
policies Verify eth1data vote in E2E (#7551) 2020-10-19 19:35:34 +00:00
types E2E cleanup (#7519) 2020-10-14 15:17:33 +00:00
BUILD.bazel Apply testutils assertions: final cleanup (#7003) 2020-08-25 15:23:06 +00:00
endtoend_test.go Add Partial Deposits in E2E (#7801) 2020-11-13 16:35:09 +00:00
geth_deps.go Refactor dependencies, make Prysm "go gettable" (#6053) 2020-05-31 14:44:34 +08:00
minimal_e2e_test.go Verify eth1data vote in E2E (#7551) 2020-10-19 19:35:34 +00:00
minimal_slashing_e2e_test.go Apply testutils assertions: final cleanup (#7003) 2020-08-25 15:23:06 +00:00
README.md Fix Up READMEs for Mainnet (#7910) 2020-11-23 18:47:55 +00:00

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 minimal spec E2E tests, you can run them through bazel with:

bazel test //endtoend:go_default_test --define=ssz=minimal --test_output=streamed