From 1e1a86965f542bc9cab8af5064aac6e1913ab900 Mon Sep 17 00:00:00 2001 From: Nidhi Singh Date: Fri, 20 Dec 2024 22:53:30 +0530 Subject: [PATCH] chore(test): readme for e2e-test (#2316) Signed-off-by: nidhi-singh02 Signed-off-by: Cal Bera Co-authored-by: Cal Bera --- testing/e2e/README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 testing/e2e/README.md diff --git a/testing/e2e/README.md b/testing/e2e/README.md new file mode 100644 index 0000000000..8387f0fd55 --- /dev/null +++ b/testing/e2e/README.md @@ -0,0 +1,41 @@ +# Running BeaconKit with Kurtosis for testing + +## What is Kurtosis + +[Kurtosis](https://www.kurtosis.com/) is a platform for running distributed +systems on Docker / Kubernetes. It provides a simple, powerful framework for +spinning up and tearing down distributed systems programmatically. + +## How to Use + +To use BeaconKit with Kurtosis, you'll first need to install the Kurtosis CLI +and its dependencies. You can find instructions for doing so +[here](https://docs.kurtosis.com/install). + +### Docker/Test environment + +Once you've installed the Kurtosis CLI, you can use it to spin up a Beacon +network with the following command from within the root directory of the +beacon-kit repo: + +```bash +make test-e2e +``` +If required, add tests under testing/e2e folder. + +This will automatically build your beacond docker image from the local source +code, and spin up a Kurtosis network based on the config file in +`testing/e2e/config/defaults.go`. + +## Configuration +In case you want to configure(change) the validator set, consider doing changes in `defaultValidators`. +The user can specify the number of replicas they want per type. + +All the default configuration are listed in `testing/e2e/config/defaults.go` + +Note: Currently the chainID for this local network is 80087, which is our dev network configuration (this is fixed in the kurtosis env setup and will be made configurable in a future version). To make changes to the 80087 chain spec used, modify parameters [here](https://github.com/berachain/beacon-kit/blob/main/config/spec/devnet.go#L40). + +## Add your tests +Add your tests in here like how it is done in `TestBasicStartup()` + +