eth2.0-specs/docker/README.md

## Docker related information

This dockerfile sets up the dependencies required to run consensus-spec tests. The docker image can be locally built with:
- `docker build ./ -t $IMAGE_NAME -f ./docker/Dockerfile`


Handy commands:
- `docker run -it $IMAGE_NAME /bin/sh` will give you a shell inside the docker container to manually run any tests
- `docker run $IMAGE_NAME make citest` will run the make citest command inside the docker container

Ideally manual running of docker containers is for advanced users, we recommend the script based approach described below for most users.

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.

E.g:
- `./build_run_test.sh --p mainnet` will run the mainnet preset tests
- `./build_run_test.sh --a` will run all the tests across all the forks
- `./build_run_test.sh --f deneb` will only run deneb tests

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.
update docker readme 2024-01-10 13:09:32 +00:00			`## Docker related information`

			`This dockerfile sets up the dependencies required to run consensus-spec tests. The docker image can be locally built with:`
			- `docker build ./ -t $IMAGE_NAME -f ./docker/Dockerfile`


			`Handy commands:`
			- `docker run -it $IMAGE_NAME /bin/sh` will give you a shell inside the docker container to manually run any tests
For pytest, replace NUMBER_OF_CORES with auto 2024-07-16 19:16:18 +00:00			- `docker run $IMAGE_NAME make citest` will run the make citest command inside the docker container
update docker readme 2024-01-10 13:09:32 +00:00
			`Ideally manual running of docker containers is for advanced users, we recommend the script based approach described below for most users.`

For pytest, replace NUMBER_OF_CORES with auto 2024-07-16 19:16:18 +00:00			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.
update docker readme 2024-01-10 13:09:32 +00:00
			`E.g:`
For pytest, replace NUMBER_OF_CORES with auto 2024-07-16 19:16:18 +00:00			- `./build_run_test.sh --p mainnet` will run the mainnet preset tests
update docker readme 2024-01-10 13:09:32 +00:00			- `./build_run_test.sh --a` will run all the tests across all the forks
For pytest, replace NUMBER_OF_CORES with auto 2024-07-16 19:16:18 +00:00			- `./build_run_test.sh --f deneb` will only run deneb tests
update docker readme 2024-01-10 13:09:32 +00:00
			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.