Skip to content

docs(development): refresh e2e testing guide for the Chainsaw migration#611

Open
myasnikovdaniil wants to merge 1 commit into
mainfrom
docs/refresh-e2e-testing-chainsaw
Open

docs(development): refresh e2e testing guide for the Chainsaw migration#611
myasnikovdaniil wants to merge 1 commit into
mainfrom
docs/refresh-e2e-testing-chainsaw

Conversation

@myasnikovdaniil

@myasnikovdaniil myasnikovdaniil commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

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 the make test / make login / make proxy sandbox targets (removed), and made no mention of Chainsaw.

Changes

  • Drop the dead hack/e2e.sh link; describe the sandbox flow and the two-part suite: Chainsaw app tests under hack/e2e-chainsaw/ + BATS bootstrap/OpenAPI checks, linking the monorepo's docs/agents/e2e-testing.md.
  • Fix make targets: make testmake e2e; note root make test = apply + e2e.
  • Trim make login / make proxy / the SOCKS5 + Firefox paragraph (targets no longer exist), keeping make exec.

Scoped to docs/next/; frozen versioned docs (v1.4/v1.5) left untouched.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated end-to-end testing guidance to describe the self-contained sandbox workflow, including cluster setup and validation suites.
    • Replaced the previous test commands with the current make apply, make e2e, and make delete workflow.
    • Clarified that make test runs the apply and end-to-end steps together.
    • Simplified dynamic development environment instructions to focus on opening an interactive sandbox shell.

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.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
@netlify

netlify Bot commented Jul 12, 2026

Copy link
Copy Markdown

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit d80535f
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/6a5361c262293d0008da4948
😎 Deploy Preview https://deploy-preview-611--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ea5be74a-9712-4a8b-8505-c11330c4ab37

📥 Commits

Reviewing files that changed from the base of the PR and between 405557d and d80535f.

📒 Files selected for processing (1)
  • content/en/docs/next/development.md

📝 Walkthrough

Walkthrough

The development documentation now describes sandbox-container end-to-end testing, its two test suites, updated Kubernetes test commands, and the simplified make exec workflow for interactive sandbox access.

Changes

Development workflows

Layer / File(s) Summary
Sandbox testing workflow
content/en/docs/next/development.md
The Testing section documents the sandbox container flow, Kyverno Chainsaw and BATS test suites, and the make applymake e2emake delete command sequence.
Dynamic environment access
content/en/docs/next/development.md
The Dynamic Development Environment section replaces extended proxy and Makefile guidance with the make exec instruction.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs update around the e2e testing guide and Chainsaw migration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refresh-e2e-testing-chainsaw

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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".

Suggested change
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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant