Skip to content

docs: validate and update E2E test docs#4834

Draft
bm54cloud wants to merge 5 commits into
zarf-dev:mainfrom
bm54cloud:2477-e2e-doc-improvement
Draft

docs: validate and update E2E test docs#4834
bm54cloud wants to merge 5 commits into
zarf-dev:mainfrom
bm54cloud:2477-e2e-doc-improvement

Conversation

@bm54cloud
Copy link
Copy Markdown
Contributor

@bm54cloud bm54cloud commented Apr 17, 2026

Description

This PR aims to:

  • Update dependencies required in E2E testing docs
  • Clarify Kubernetes cluster configuration needed for E2E testing
  • Reduce tribal knowledge by validating the testing E2E testing docs are correct and identify/correct any knowledge gaps in the documentation

Related Issue

Relates to #2477

Checklist before merging

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 17, 2026

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 7b44029
🔍 Latest deploy log https://app.netlify.com/projects/zarf-docs/deploys/6a10bcb119f4850008fb2f4c
😎 Deploy Preview https://deploy-preview-4834--zarf-docs.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.

@bm54cloud bm54cloud force-pushed the 2477-e2e-doc-improvement branch from 560fc30 to 2e67c9c Compare April 24, 2026 22:06
@bm54cloud
Copy link
Copy Markdown
Contributor Author

bm54cloud commented Apr 24, 2026

@brandtkeller @AustinAbro321 Can I get some early feedback on the //Verify cluster connectivity section I added in 20_zarf_init_test.go. Originally was trying to work in main_test.go to verify cluster, but skipK8sEnvVar did not work as I expected it to. I left my original thought process in main_test.go commented out. This is what the error in 20_zarf_init_test.go would look like, so it would fail early. More so just wondering if putting it in 20_zarf_init_test.go is good or if you would truly prefer it in main_test.go.

Screenshot 2026-04-24 at 3 55 48 PM

@brandtkeller
Copy link
Copy Markdown
Member

@brandtkeller @AustinAbro321 Can I get some early feedback on the //Verify cluster connectivity section I added in 20_zarf_init_test.go. Originally was trying to work in main_test.go to verify cluster, but skipK8sEnvVar did not work as I expected it to. I left my original thought process in main_test.go commented out. This is what the error in 20_zarf_init_test.go would look like, so it would fail early. More so just wondering if putting it in 20_zarf_init_test.go is good or if you would truly prefer it in main_test.go.

This is a great fallback but I would love to hear more about what limitations or constraints you ran into regarding main_test.go (this doesn't have to be the location/solution if we deem an appropriate solution is something along what you have currently - but I do want to capture notes).

I would point out that the current solution is limited to specific test commands. The out of the box test-e2e would likely run through all non-cluster e2e tests before failing and any filter of cluster e2e tests that run while not using 20_ would also not be covered.

@bm54cloud bm54cloud force-pushed the 2477-e2e-doc-improvement branch from 2e67c9c to 7b44029 Compare May 22, 2026 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants