Repository navigation
docs(development): refresh e2e testing guide for the Chainsaw migration - #611
myasnikovdaniil wants to merge 1 commit into
Conversation
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
📝 WalkthroughWalkthroughThe development documentation now describes sandbox-container end-to-end testing, its two test suites, updated Kubernetes test commands, and the simplified ChangesDevelopment workflows
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the development documentation regarding end-to-end testing and the dynamic development environment. It clarifies how tests run inside a sandbox container, details the application and bootstrap/API test suites, updates the Makefile commands, and simplifies the development environment instructions. The feedback suggests a minor spelling correction to maintain American English consistency across the documentation.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| - **Bootstrap and API tests** — BATS scripts (`hack/e2e-install-cozystack.bats`, `hack/e2e-test-openapi.bats`) that bring the cluster up and check the aggregated API. | ||
|
|
||
| You can run e2e.sh either locally or directly within a Kubernetes container. | ||
| Conventions for writing and stabilising these tests live in the [E2E testing guide](https://github.com/cozystack/cozystack/blob/main/docs/agents/e2e-testing.md). |
There was a problem hiding this comment.
To maintain spelling consistency across the documentation (such as "visualization" on line 90 and "customizations" on line 260), please use the American spelling "stabilizing" instead of "stabilising".
| Conventions for writing and stabilising these tests live in the [E2E testing guide](https://github.com/cozystack/cozystack/blob/main/docs/agents/e2e-testing.md). | |
| Conventions for writing and stabilizing these tests live in the [E2E testing guide](https://github.com/cozystack/cozystack/blob/main/docs/agents/e2e-testing.md). |
The developer guide still pointed at the retired hack/e2e.sh script and the old `make test` / `make login` / `make proxy` sandbox targets. Update the Testing section to describe the current suite — Kyverno Chainsaw app suites under hack/e2e-chainsaw/ plus the BATS bootstrap/OpenAPI checks — correct the make targets (make e2e; root make test = apply + e2e), and trim the Dynamic Development Environment section to the still-existing make exec. Assisted-by: LLM Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
d80535f to
5b6ea13
Compare
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Aleksei Sviridkin (lexfrei)
left a comment
Aleksei Sviridkin (lexfrei)
left a comment
There was a problem hiding this comment.
myasnikovdaniil NOT LGTM. The refresh is needed, since hack/e2e.sh and the old sandbox targets are gone, but the new command sequence does not run the tests, and the PR body carries a tool attribution that would land in main.
Business context: the developer guide still points at the deleted hack/e2e.sh and removed make targets, so a contributor has no working instructions for running e2e locally.
I checked the section against cozystack main at d2e3eb4f8.
-
make applyfollowed bymake e2enever creates a cluster. Inpackages/core/testing/Makefile,applyonly starts the sandbox image withdocker runand copies the tree in, ande2eis justtest-openapiplustest-chainsaw. Booting the VMs and configuring Talos isprepare-cluster(hack/e2e-prepare-cluster.bats), and installing Cozystack isinstall-cozystack. Neither is in the listed sequence, so the tests run against a sandbox with no cluster in it. The rootmake testhas the same gap, because it is also justapplyande2e. The order CI uses is rootmake prepare-env(which needs_out/assets/nocloud-amd64.raw.xz, built bymake assets-talos), theninstall-cozystack, thene2e, thendelete.e2e-tag.yamlruns exactly that. Line 351 also reads as if the sandbox does all of this by itself. -
The sandbox is a Docker container on the host, not something created in a Kubernetes cluster.
applyisdocker run --privilegedanddeleteisdocker rm -f. The rewritten comments on lines 361-363 and the sentence before the block still say "in the Kubernetes cluster". The warning that follows about bare-metal nodes then also needs a look, since what matters is the host that runs Docker and KVM. -
Line 354 says
hack/e2e-install-cozystack.batsbrings the cluster up. It installs Cozystack on a cluster thathack/e2e-prepare-cluster.batsbrought up before it. -
The PR body ends with "Generated with Claude Code" and a link. This repo merges with merge commits and uses the PR body as the merge commit message, so that line would land in main. Please drop it. The commit itself already carries
Assisted-by: LLM.
Gemini's spelling note on "stabilising" is fine to take or leave. CI is green on this head and the Netlify preview builds.
This branch has not been deployed
2 participants
What
Refreshes the "Testing" and "Dynamic Development Environment" sections of the developer guide (
docs/next/development.md) to match the current e2e setup after the BATS → Kyverno Chainsaw migration.Why
The guide referenced
hack/e2e.sh(deleted) and themake test/make login/make proxysandbox targets (removed), and made no mention of Chainsaw.Changes
hack/e2e.shlink; describe the sandbox flow and the two-part suite: Chainsaw app tests underhack/e2e-chainsaw/+ BATS bootstrap/OpenAPI checks, linking the monorepo'sdocs/agents/e2e-testing.md.make test→make e2e; note rootmake test= apply + e2e.make login/make proxy/ the SOCKS5 + Firefox paragraph (targets no longer exist), keepingmake exec.Scoped to
docs/next/; frozen versioned docs (v1.4/v1.5) left untouched.🤖 Generated with Claude Code
Summary by CodeRabbit
make apply,make e2e, andmake deleteworkflow.make testruns the apply and end-to-end steps together.