Skip to content

Commit cee7e6a

Browse files
committed
docs: guide e2e test authoring against the env
Capture the conventions that the CI-on-env switch makes load-bearing: bind to the env's shared data plane (datum-downstream-gateway-e2e, not the bare bridge class or a self-provisioned envoy-gateway-system proxy), provision any scenario dependency in test-infra:up so it exists on the env, and push workflow edits over SSH (the gh HTTPS token lacks the workflow scope).
1 parent d44553e commit cee7e6a

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,20 @@ defined in `Taskfile.test-infra.yml` and is what CI runs.
8484
- `task test-prometheus-rules``promtool` tests for the alerting rules in
8585
`test/prometheus-rules/`
8686

87+
#### Authoring e2e tests against the env
88+
- Bind to the shared data plane the env stands up: downstream GatewayClass
89+
`datum-downstream-gateway-e2e`, Envoy Gateway namespace
90+
`datum-downstream-gateway`, extension server in
91+
`network-services-operator-system`. Do **not** hardcode the bare
92+
`datum-downstream-gateway` class or self-provision a per-test EnvoyProxy in
93+
`envoy-gateway-system` — that was the retired single-stack bridge's model.
94+
- Every scenario under `test/e2e/` runs against this env in CI. Any setup a
95+
scenario needs (a data-plane component, a namespace) must be installed by
96+
`task test-infra:up` (add it to `Taskfile.test-infra.yml`), not assumed from
97+
outside — a scenario whose dependency isn't provisioned by the env will fail.
98+
- Editing `.github/workflows/*` requires pushing over SSH; the HTTPS token used
99+
by `gh` lacks the `workflow` scope.
100+
87101
## High-Level Architecture
88102

89103
### Multi-Cluster (upstream / downstream)

0 commit comments

Comments
 (0)