You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,3 +73,19 @@ Documentation on the different components used during spec writing can be found
73
73
## Consensus spec tests
74
74
75
75
Conformance tests built from the executable python spec are available in the [Ethereum Proof-of-Stake Consensus Spec Tests](https://github.com/ethereum/consensus-spec-tests) repo. Compressed tarballs are available in [releases](https://github.com/ethereum/consensus-spec-tests/releases).
76
+
77
+
78
+
## Installation and Usage
79
+
The consensus-specs repo can be used by running the tests locally or inside a docker container.
80
+
81
+
To run the tests locally:
82
+
- Clone the repository with `git clone https://github.com/ethereum/consensus-specs.git`
83
+
- Switch to the directory `cd consensus-specs`
84
+
- Install the dependencies with: `make install_test && make preinstallation && make pyspec`
85
+
- Run the tests with `make citest`
86
+
87
+
To run the tests inside a docker container:
88
+
- Switch to the directory with `cd scripts`
89
+
- Run the script `./build_run_docker_tests.sh`
90
+
- Find the results in a folder called `./testResults`
91
+
- Find more ways to customize the script with `./build_run_docker_tests.sh --h`
Copy file name to clipboardExpand all lines: docker/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,8 @@ Ideally manual running of docker containers is for advanced users, we recommend
13
13
The `scripts/build_run_docker_tests.sh` script will cover most usecases. The script allows the user to configure the fork(altair/bellatrix/capella..), `$IMAGE_NAME` (specifies the container to use), preset type (mainnet/minimal), and test all forks flags. Ideally, this is the main way that users interact with the spec tests instead of running it locally with varying versions of dependencies.
14
14
15
15
E.g:
16
-
-`./build_run_test.sh --p mainnet` will run the mainnet preset tests
17
-
-`./build_run_test.sh --a` will run all the tests across all the forks
18
-
-`./build_run_test.sh --f deneb` will only run deneb tests
16
+
-`./build_run_docker_tests.sh --p mainnet` will run the mainnet preset tests
17
+
-`./build_run_docker_tests.sh --a` will run all the tests across all the forks
18
+
-`./build_run_docker_tests.sh --f deneb` will only run deneb tests
19
19
20
20
Results are always placed in a folder called `./testResults`. The results are `.xml` files and contain the fork they represent and the date/time they were run at.
0 commit comments