Skip to content

Commit 51c3caf

Browse files
committed
Review readme file
1 parent e061233 commit 51c3caf

1 file changed

Lines changed: 24 additions & 13 deletions

File tree

docker-antithesis/README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,16 @@ dependencies are baked into the image at build time:
2222
1. Forces nix into offline mode (`offline = true`).
2323
2. Exports `CARDANO_PREBUILT_DIR=/opt/cardano` and `_VENV_DIR=/opt/tests-venv`
2424
so `regression.sh` skips all downloads and uses the pre-built artefacts.
25-
3. Emits the Antithesis `setup_complete` lifecycle signal.
26-
4. Hands off to `.github/regression.sh`.
25+
3. In multi-container mode (when `NODE_HOST` is set):
26+
- Polls `NODE_HOST:NODE_PORT` until the node cluster reports ready.
27+
- Starts a local `cardano-submit-api` in the driver container so that
28+
submit-api tests can reach it via `localhost`.
29+
- Starts a TCP proxy forwarding `localhost:<pool1_port>`
30+
`NODE_HOST:<pool1_port>` so `cardano-cli ping` tests work.
31+
- Starts a local HTTP file server for anchor URLs used by governance
32+
tests (`cardano-cli transaction build` fetches anchor hashes via HTTP).
33+
4. Emits the Antithesis `setup_complete` lifecycle signal.
34+
5. Hands off to `.github/regression.sh`.
2735

2836
- `Dockerfile.config` — builds the Antithesis config image (`FROM scratch`)
2937
containing only `docker-compose.yaml`.
@@ -63,7 +71,8 @@ docker push us-central1-docker.pkg.dev/<tenant>/antithesis/config:latest
6371

6472
```bash
6573
docker compose -f docker-antithesis/docker-compose.yaml config
66-
docker compose -f docker-antithesis/docker-compose.yaml up --build
74+
docker compose -f docker-antithesis/docker-compose.yaml up --build \
75+
--abort-on-container-exit --exit-code-from driver
6776
```
6877

6978
To fully simulate the Antithesis no-internet constraint, run inside an
@@ -78,13 +87,15 @@ unshare -n docker compose -f docker-antithesis/docker-compose.yaml up
7887
`NODE_REV` is baked into the image at build time and must **not** be set at
7988
runtime. All other variables are passed through docker-compose as before.
8089

81-
| Variable | Default | Description |
82-
|-------------------|------------|------------------------------------------|
83-
| `CARDANO_CLI_REV` | (built-in) | cardano-cli revision, empty = use node's |
84-
| `DBSYNC_REV` | (disabled) | db-sync revision, empty = disabled |
85-
| `RUN_TARGET` | `tests` | `tests`, `testpr`, or `testnets` |
86-
| `MARKEXPR` | | pytest marker expression |
87-
| `CLUSTERS_COUNT` | | number of local cluster instances |
88-
| `CLUSTER_ERA` | | e.g. `conway` |
89-
| `PROTOCOL_VERSION`| | e.g. `11` |
90-
| `UTXO_BACKEND` | | e.g. `disk`, `mem` |
90+
| Variable | Default | Description |
91+
|--------------------|----------------|------------------------------------------------|
92+
| `CARDANO_CLI_REV` | (built-in) | cardano-cli revision, empty = use node's |
93+
| `DBSYNC_REV` | (disabled) | db-sync revision, empty = disabled |
94+
| `RUN_TARGET` | `tests` | `tests`, `testpr`, or `testnets` |
95+
| `MARKEXPR` | `smoke` | pytest marker expression |
96+
| `SESSION_TIMEOUT` | `1h` | wall-clock limit passed to `timeout(1)` |
97+
| `TESTNET_VARIANT` | `conway_fast` | cluster variant for `prepare_cluster_scripts` |
98+
| `CLUSTERS_COUNT` | `1` | number of local cluster instances |
99+
| `CLUSTER_ERA` | | e.g. `conway` |
100+
| `PROTOCOL_VERSION` | | e.g. `11` |
101+
| `UTXO_BACKEND` | | e.g. `disk`, `mem` |

0 commit comments

Comments
 (0)