diff --git a/README.md b/README.md index a01d94a..ec63024 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # nomos-e2e-tests -Nomos e2e framework used to test various implementations of the Nomos node. +Nomos E2E framework used to test various implementations of the Nomos node. ## Setup and contribute @@ -14,14 +14,39 @@ mkdir -p kzgrs wget https://raw.githubusercontent.com/logos-co/nomos-node/master/tests/kzgrs/kzgrs_test_params -O kzgrs/kzgrs_test_params pre-commit install (optional) Overwrite default vars from src/env_vars.py via env vars or by adding a .env file +(optional) python download_nltk_resources.py # Used when CHECK_LOG_ERRORS=True pytest ``` -Set optional environment variable to search logs for errors after each tests: + +### Additional instructions for dispersal resilience tests + +1. Build prerequisites +```sh +git clone https://github.com/logos-co/nomos-security-tests.git +cd nomos-security-tests +git fetch; git switch test-dispersal-resilience + +git checkout d8bbc464420ef86337df963c64ac2f7c3fd97008 +docker build --no-cache -f testnet/Dockerfile.debug -t nomos-mod-da-d8bbc46:testnet . +# (x86_64) docker build --no-cache -f testnet/Dockerfile -t nomos-mod-da-d8bbc46:testnet . + +git checkout d19a1f3d8c80f654e6cf6139641519f16fe670ec +docker build --no-cache -f testnet/Dockerfile.debug -t nomos-executor-mod-da-d19a1f3:testnet . + +git checkout 7f54114b6c320dc32577b0e8bb85c2d543b4bd56 +docker build --no-cache -f testnet/Dockerfile.debug -t nomos-executor-mod-da-7f54114:testnet . + +git checkout 4a58376ac4956d87502b9fd72b64a756396f2a8d +docker build --no-cache -f testnet/Dockerfile.debug -t nomos-executor-mod-da-4a58376:testnet . +``` + +2. Run tests with `pytest --run-with-mod-da-node tests/dispersal_resilience/test_dispersal_resilience.py` + +### Enable node log search with environment variable: ```shell export CHECK_LOG_ERRORS=True ``` - ## License Licensed and distributed under either of diff --git a/download_nltk_resources.py b/download_nltk_resources.py new file mode 100644 index 0000000..50c6221 --- /dev/null +++ b/download_nltk_resources.py @@ -0,0 +1,10 @@ +import nltk + + +def main(): + nltk.download("punkt") + nltk.download("punkt_tab") + + +if __name__ == "__main__": + main()