Skip to content

Commit 9e161b6

Browse files
danceratopzspencer-tb
authored andcommitted
docs(testing-cli-consume): fix hive simulator names post-weld (ethereum#1920)
* docs: fix simulator language post-weld; eest->eels * docs: fix Dockerfile.dev for hive dev mode on macos post-weld * chore(docs): small eest to eels tweak --------- Co-authored-by: spencer <spencer.tb@ethereum.org>
1 parent abe027d commit 9e161b6

9 files changed

Lines changed: 52 additions & 53 deletions

File tree

docs/filling_tests/test_ids.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ The test framework can also generate blockchain tests containing blocks that spa
5555

5656
Each Python test case is also typically parametrized by test type, respectively fixture format. For example, if the test is implemented as a `state_test`, the test framework will additionally generate the following blockchain test fixtures (consisting of a single block with a single transaction):
5757

58-
- a `blockchain_test` which can be tested via the Hive `eest/consume-rlp` simulator (or directly via a dedicated client interface).
59-
- a `blockchain_engine_test` (for post-merge forks) which can be tested via the Hive `eest/consume-engine` simulator.
58+
- a `blockchain_test` which can be tested via the Hive `eels/consume-rlp` simulator (or directly via a dedicated client interface).
59+
- a `blockchain_engine_test` (for post-merge forks) which can be tested via the Hive `eels/consume-engine` simulator.
6060

6161
### Example: The Test IDs generated for `test_chainid`
6262

docs/running_tests/consume/exceptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ uv run consume engine --disable-strict-exception-matching=nimbus-el
9898
Enable verbose client output:
9999

100100
```bash
101-
./hive --sim ethereum/eest/consume-engine \
101+
./hive --sim ethereum/eels/consume-engine \
102102
--docker.output \
103103
--sim.loglevel 5
104104
```

docs/running_tests/execute/hive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Tests can be executed on a local hive-controlled single-client network by running the `execute hive` command.
44

5-
## The `eest/execute-blobs` Simulator
5+
## The `eels/execute-blobs` Simulator
66

77
The `blob_transaction_test` execute test spec sends blob transactions to a running client. Blob transactions are fully supported in execute mode:
88

docs/running_tests/hive/client_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,17 @@ cp -r /path/to/your/go-ethereum ./clients/go-ethereum/go-ethereum-local
102102
Force rebuild base images:
103103

104104
```bash
105-
./hive --docker.pull --sim ethereum/eest/consume-engine
105+
./hive --docker.pull --sim ethereum/eels/consume-engine
106106
```
107107

108108
Force rebuild specific client:
109109

110110
```bash
111-
./hive --docker.nocache "clients/go-ethereum" --sim ethereum/eest/consume-engine
111+
./hive --docker.nocache "clients/go-ethereum" --sim ethereum/eels/consume-engine
112112
```
113113

114114
Show the docker container build output:
115115

116116
```bash
117-
./hive --docker.buildoutput --sim ethereum/eest/consume-engine
117+
./hive --docker.buildoutput --sim ethereum/eels/consume-engine
118118
```

docs/running_tests/hive/common_options.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Common Simulator Options
22

3-
All EEST Hive simulators share common command-line options and patterns.
3+
All execution-specs (EELS) Hive simulators share common command-line options and patterns.
44

55
## Basic Usage
66

7-
While they may be omitted, it's recommended to specify the `fixtures` and `branch` simulator build arguments when running EEST simulators.
7+
While they may be omitted, it's recommended to specify the `fixtures` and `branch` simulator build arguments when running execution-specs simulators.
88

99
For example, this runs "stable" fixtures from the v4.3.0 [latest stable release](../releases.md#standard-releases) and builds the simulator at the v4.3.0 tag:
1010

1111
```bash
12-
./hive --sim ethereum/eest/consume-engine \
12+
./hive --sim ethereum/eels/consume-engine \
1313
--sim.buildarg fixtures=stable@v4.3.0 \
1414
--sim.buildarg branch=v4.3.0 \
1515
--client go-ethereum
@@ -20,15 +20,15 @@ For example, this runs "stable" fixtures from the v4.3.0 [latest stable release]
2020
Run a subset of tests by filtering tests using `--sim.limit=<regex>` to perform a regular expression match against test IDs:
2121

2222
```bash
23-
./hive --sim ethereum/eest/consume-engine --sim.limit ".*eip4844.*"
23+
./hive --sim ethereum/eels/consume-engine --sim.limit ".*eip4844.*"
2424
```
2525

2626
### Collect Only/Dry-Run
2727

2828
The `collectonly:` prefix can be used to inspect which tests would match an expression (dry-run), `--docker.output` must be specified to see the simulator's collection result:
2929

3030
```bash
31-
./hive --sim ethereum/eest/consume-engine \
31+
./hive --sim ethereum/eels/consume-engine \
3232
--sim.buildarg fixtures=stable@v4.3.0 \
3333
--sim.buildarg branch=v4.3.0 \
3434
--docker.output \
@@ -40,7 +40,7 @@ The `collectonly:` prefix can be used to inspect which tests would match an expr
4040
The `id:` prefix can be used to select a single test via its ID (this will automatically escape any special characters in the test case ID):
4141

4242
```console
43-
./hive --sim ethereum/eest/consume-engine \
43+
./hive --sim ethereum/eels/consume-engine \
4444
--sim.buildarg fixtures=stable@v4.3.0 \
4545
--sim.buildarg branch=v4.3.0 \
4646
--docker.output \
@@ -52,21 +52,21 @@ The `id:` prefix can be used to select a single test via its ID (this will autom
5252
To run multiple tests in parallel, use `--sim.parallelism`:
5353

5454
```bash
55-
./hive --sim ethereum/eest/consume-rlp --sim.parallelism 4
55+
./hive --sim ethereum/eels/consume-rlp --sim.parallelism 4
5656
```
5757

5858
### Output Options
5959

6060
See hive log output in the console:
6161

6262
```bash
63-
./hive --sim ethereum/eest/consume-engine --sim.loglevel 5
63+
./hive --sim ethereum/eels/consume-engine --sim.loglevel 5
6464
```
6565

6666
### Container Issues
6767

6868
Increase client timeout:
6969

7070
```bash
71-
./hive --client.checktimelimit=180s --sim ethereum/eest/consume-engine
71+
./hive --client.checktimelimit=180s --sim ethereum/eels/consume-engine
7272
```

docs/running_tests/hive/dev_mode.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Hive Development Mode
22

3-
This section explains how to run EEST simulators using their EEST commands, e.g., `uv run consume engine`, against a Hive "development" server as apposed to using the standalone `./hive` command.
3+
This section explains how to run EELS simulators using their Python-based commands, e.g., `uv run consume engine`, against a Hive "development" server as apposed to using the standalone `./hive` command.
44

55
This avoids running the simulator in a dockerized environment and has several advantages:
66

@@ -18,7 +18,7 @@ This avoids running the simulator in a dockerized environment and has several ad
1818

1919
### Prerequisites
2020

21-
- EEST is installed, see [Installation](../../getting_started/installation.md)
21+
- The execution-specs repo is setup in development mode, see [Installation](../../getting_started/installation.md)
2222
- Hive is built, see [Hive](../hive/index.md#quick-start).
2323

2424
## Hive Dev Setup on Linux
@@ -29,7 +29,7 @@ This avoids running the simulator in a dockerized environment and has several ad
2929
./hive --dev --client go-ethereum --client-file clients.yaml --docker.output
3030
```
3131

32-
2. In a separate shell, configure environment for EEST:
32+
2. In a separate shell, configure environment for execution-specs:
3333

3434
=== "bash/zsh"
3535

@@ -43,7 +43,7 @@ This avoids running the simulator in a dockerized environment and has several ad
4343
set -x HIVE_SIMULATOR http://127.0.0.1:3000
4444
```
4545

46-
3. Run EEST consume commands
46+
3. Run execution-specs `consume` commands
4747

4848
```bash
4949
uv run consume engine --input ./fixtures -k "test_chainid"
@@ -56,37 +56,36 @@ Due to Docker running within a VM on macOS, the host machine and Docker containe
5656

5757
1. Linux VM: Run a Linux virtual machine on your macOS and execute the standard development workflow above from within the VM.
5858
2. Remote Linux: SSH into a remote Linux environment (server or cloud instance) and run development mode there.
59-
3. **Docker Development Image**: Create a containerized EEST environment that runs within Docker's network namespace (recommended).
59+
3. **Docker Development Image**: Create a containerized execution-specs environment that runs within Docker's network namespace (recommended).
6060
6161
The following section details the setup and usage of option 3.
6262
63-
### EEST Docker Development Image
63+
### EELS Docker Development Image
6464
65-
Within the [`eest/`](https://github.com/ethereum/hive/tree/master/simulators/ethereum/eest) directory of hive, a new dockerfile must be created: `Dockerfile.dev`, with the following contents:
65+
Within the [`eels/`](https://github.com/ethereum/hive/tree/master/simulators/ethereum/eels) directory of hive, a new dockerfile must be created: `Dockerfile.dev`, with the following contents:
6666
6767
```docker
6868
FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim
69-
ARG branch=main
70-
ENV GIT_REF=${branch}
69+
ARG branch=""
7170
7271
RUN apt-get update && apt-get install -y git
73-
RUN git init execution-spec-tests && \
74-
cd execution-spec-tests && \
75-
git remote add origin https://github.com/ethereum/execution-spec-tests.git && \
76-
git fetch --depth 1 origin $GIT_REF && \
77-
git checkout FETCH_HEAD;
78-
79-
WORKDIR /execution-spec-tests
72+
RUN git clone --depth 1 https://github.com/ethereum/execution-specs.git && \
73+
cd execution-specs && \
74+
if [ -n "$branch" ]; then \
75+
git fetch --depth 1 origin "$branch" && \
76+
git checkout FETCH_HEAD; \
77+
fi
78+
WORKDIR /execution-specs/packages/testing
8079
RUN uv sync
8180
ENTRYPOINT ["/bin/bash"]
8281
```
8382
84-
This dockerfile will be our entry point for running EEST commands.
83+
This dockerfile will be our entry point for running simulator commands.
8584
86-
### `eest/` Hive Directory Structure
85+
### `eels/` Hive Directory Structure
8786
8887
```tree
89-
├── eest
88+
├── eels
9089
│ ├── Dockerfile.dev
9190
│ ├── consume-block-rlp
9291
│ │ └── Dockerfile
@@ -108,10 +107,10 @@ This dockerfile will be our entry point for running EEST commands.
108107
./hive --dev --dev.addr <LOCAL_IP>:3000 --client go-ethereum --client-file clients.yaml
109108
```
110109
111-
3. In a separate terminal session, build the EEST development image:
110+
3. In a separate terminal session, build the EELS development image:
112111
113112
```bash
114-
cd simulators/ethereum/eest/
113+
cd simulators/ethereum/eels/
115114
docker build -t macos-consume-dev -f Dockerfile.dev .
116115
```
117116
@@ -136,7 +135,7 @@ When Hive runs in dev mode:
136135
3. Keeps the Hive Proxy container running between test executions.
137136
4. Waits for external simulator connections via the API.
138137
139-
This allows EEST's consume commands to connect to the running Hive instance and execute tests interactively.
138+
This allows the EELS's consume commands to connect to the running Hive instance and execute tests interactively.
140139

141140
## More Options Available
142141

docs/running_tests/hive/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Hive
22

3-
@ethereum/hive is a containerized testing framework that helps orchestrate test execution against Ethereum clients. Hive is incredibly extensible; new test suites can be implemented in a module manner as "simulators" that interact with clients to test certain aspects of their behavior. EEST implements several simulators, see [Running Tests](../running.md) for an overview.
3+
@ethereum/hive is a containerized testing framework that helps orchestrate test execution against Ethereum clients. Hive is incredibly extensible; new test suites can be implemented in a module manner as "simulators" that interact with clients to test certain aspects of their behavior. The execution-specs `testing` package implements several simulators, see [Running Tests](../running.md) for an overview.
44

55
## Quick Start
66

docs/running_tests/releases.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
| Format | Consumed by the client | Location in `.tar.gz` release |
88
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
99
| [State Tests](./test_formats/state_test.md) | - directly via a `statetest`-like command<br/> (e.g., [go-ethereum/cmd/evm/staterunner.go](https://github.com/ethereum/go-ethereum/blob/4bb097b7ffc32256791e55ff16ca50ef83c4609b/cmd/evm/staterunner.go)) | `./fixtures/state_tests/` |
10-
| [Blockchain Tests](./test_formats/blockchain_test.md) | - directly via a `blocktest`-like command<br/> (e.g., [go-ethereum/cmd/evm/blockrunner.go](https://github.com/ethereum/go-ethereum/blob/4bb097b7ffc32256791e55ff16ca50ef83c4609b/cmd/evm/blockrunner.go))</br>- using the [RLPeest/consume-rlp Simulator](./running.md#rlp) via block import | `./fixtures/blockchain_tests/` |
11-
| [Blockchain Engine Tests](./test_formats/blockchain_test_engine.md) | - using the [eest/consume-engine Simulator](./running.md#engine) and the Engine API | `./fixtures/blockchain_tests_engine/` |
10+
| [Blockchain Tests](./test_formats/blockchain_test.md) | - directly via a `blocktest`-like command<br/> (e.g., [go-ethereum/cmd/evm/blockrunner.go](https://github.com/ethereum/go-ethereum/blob/4bb097b7ffc32256791e55ff16ca50ef83c4609b/cmd/evm/blockrunner.go))</br>- using the [eels/consume-rlp Simulator](./running.md#rlp) via block import | `./fixtures/blockchain_tests/` |
11+
| [Blockchain Engine Tests](./test_formats/blockchain_test_engine.md) | - using the [eels/consume-engine Simulator](./running.md#engine) and the Engine API | `./fixtures/blockchain_tests_engine/` |
1212
| [Transaction Tests](./test_formats/transaction_test.md) | - using a new simulator coming soon | None; executed directly from Python source,</br>using a release tag |
13-
| Blob Transaction Tests | - using the [eest/execute-blobs Simulator](./execute/hive.md#the-eestexecute-blobs-simulator) and | None; executed directly from Python source,</br>using a release tag |
13+
| Blob Transaction Tests | - using the [eels/execute-blobs Simulator](./execute/hive.md#the-eelsexecute-blobs-simulator) and | None; executed directly from Python source,</br>using a release tag |
1414

1515
## Release URLs and Tarballs
1616

0 commit comments

Comments
 (0)