From b11066e770ff48ba3a3e1ad64a986e371cf60e67 Mon Sep 17 00:00:00 2001 From: Aleksei Sviridkin Date: Sat, 8 Aug 2026 11:41:23 +0300 Subject: [PATCH] docs(e2e): name every suite that stayed on the BATS runner Two files enumerated the BATS suites and both stopped one short. The global catch in .chainsaw.yaml describes itself as the Chainsaw analog of the EXIT-trap host snapshot in hack/cozytest.sh, and said that runner "only covers the BATS install/openapi tests". The README said cluster bootstrap and the OpenAPI checks remain BATS and named only two files. Both miss e2e-prepare-cluster.bats, which packages/core/testing/Makefile drives through the same runner, and which is the suite whose failures leave the sandbox in the state hardest to reconstruct afterwards. docs/agents/e2e-testing.md already listed all three, so the count was answerable from the tree; it just disagreed with itself depending on which file you opened. The .chainsaw.yaml paragraph is reflowed because the correction is longer than the line it replaces; no other wording changed. Assisted-By: Claude Signed-off-by: Aleksei Sviridkin --- hack/e2e-chainsaw/.chainsaw.yaml | 16 ++++++++-------- hack/e2e-chainsaw/README.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/hack/e2e-chainsaw/.chainsaw.yaml b/hack/e2e-chainsaw/.chainsaw.yaml index edac3d749..ffc1842ae 100644 --- a/hack/e2e-chainsaw/.chainsaw.yaml +++ b/hack/e2e-chainsaw/.chainsaw.yaml @@ -28,14 +28,14 @@ spec: # Global failure handler: on any test error, capture a crust-gather snapshot of # the HOST cluster BEFORE Chainsaw's cleanup deletes the test's resources. This # is the Chainsaw analog of the per-failed-test EXIT-trap host snapshot in - # hack/cozytest.sh (which only covers the BATS install/openapi tests) — without - # it the Chainsaw app suite uploads a cozyreport.tgz with zero per-test - # snapshots. Combines additively with the per-test events/describe catches in - # each suite; the nested-tenant snapshot for the kubernetes-* tests is captured - # separately by hack/e2e-chainsaw/_lib/run-kubernetes.sh while its LB is alive. - # The snapshot lands under the _out/cozyreport/snapshots// tree that - # hack/cozyreport.sh folds into the uploaded artifact, so each failed test - # keeps its own `crust-gather serve`-able cluster state. + # hack/cozytest.sh (which covers the BATS prepare-cluster, install and openapi + # tests) — without it the Chainsaw app suite uploads a cozyreport.tgz with zero + # per-test snapshots. Combines additively with the per-test events/describe + # catches in each suite; the nested-tenant snapshot for the kubernetes-* tests + # is captured separately by hack/e2e-chainsaw/_lib/run-kubernetes.sh while its + # LB is alive. The snapshot lands under the _out/cozyreport/snapshots// + # tree that hack/cozyreport.sh folds into the uploaded artifact, so each failed + # test keeps its own `crust-gather serve`-able cluster state. # # Every catch script below carries an explicit `timeout:`. A Chainsaw script # op is bounded by `timeouts.exec` (5m above) unless it overrides it, and the diff --git a/hack/e2e-chainsaw/README.md b/hack/e2e-chainsaw/README.md index 0e7ac4729..319e7a50f 100644 --- a/hack/e2e-chainsaw/README.md +++ b/hack/e2e-chainsaw/README.md @@ -2,7 +2,7 @@ The Cozystack E2E app suite, written for [Kyverno Chainsaw](https://github.com/kyverno/chainsaw) — a declarative, Kubernetes-native E2E test framework (CNCF, part of the Kyverno project; successor to KUTTL). -This directory replaces the per-app BATS suite that used to live in `hack/e2e-apps/*.bats`. The CI `e2e` job runs `chainsaw test hack/e2e-chainsaw/` after `make install-cozystack`; cluster bootstrap (`hack/e2e-install-cozystack.bats`) and the OpenAPI checks (`hack/e2e-test-openapi.bats`) remain BATS. +This directory replaces the per-app BATS suite that used to live in `hack/e2e-apps/*.bats`. The CI `e2e` job runs `chainsaw test hack/e2e-chainsaw/` after `make install-cozystack`; cluster bootstrap (`hack/e2e-prepare-cluster.bats`, `hack/e2e-install-cozystack.bats`) and the OpenAPI checks (`hack/e2e-test-openapi.bats`) remain BATS. ## Layout