Skip to content

Commit 1e1a869

Browse files
chore(test): readme for e2e-test (#2316)
Signed-off-by: nidhi-singh02 <trippin@berachain.com> Signed-off-by: Cal Bera <calbera@berachain.com> Co-authored-by: Cal Bera <calbera@berachain.com>
1 parent 4c7ff6d commit 1e1a869

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

testing/e2e/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Running BeaconKit with Kurtosis for testing
2+
3+
## What is Kurtosis
4+
5+
[Kurtosis](https://www.kurtosis.com/) is a platform for running distributed
6+
systems on Docker / Kubernetes. It provides a simple, powerful framework for
7+
spinning up and tearing down distributed systems programmatically.
8+
9+
## How to Use
10+
11+
To use BeaconKit with Kurtosis, you'll first need to install the Kurtosis CLI
12+
and its dependencies. You can find instructions for doing so
13+
[here](https://docs.kurtosis.com/install).
14+
15+
### Docker/Test environment
16+
17+
Once you've installed the Kurtosis CLI, you can use it to spin up a Beacon
18+
network with the following command from within the root directory of the
19+
beacon-kit repo:
20+
21+
```bash
22+
make test-e2e
23+
```
24+
If required, add tests under testing/e2e folder.
25+
26+
This will automatically build your beacond docker image from the local source
27+
code, and spin up a Kurtosis network based on the config file in
28+
`testing/e2e/config/defaults.go`.
29+
30+
## Configuration
31+
In case you want to configure(change) the validator set, consider doing changes in `defaultValidators`.
32+
The user can specify the number of replicas they want per type.
33+
34+
All the default configuration are listed in `testing/e2e/config/defaults.go`
35+
36+
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).
37+
38+
## Add your tests
39+
Add your tests in here like how it is done in `TestBasicStartup()`
40+
41+

0 commit comments

Comments
 (0)