-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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>
- Loading branch information
1 parent
4c7ff6d
commit 1e1a869
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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()` | ||
|
||
|