WIP: docs: describe how we prefer to test new configurations - #18771
Open
justinsb wants to merge 1 commit into
Open
WIP: docs: describe how we prefer to test new configurations#18771justinsb wants to merge 1 commit into
justinsb wants to merge 1 commit into
Conversation
Prefer golden update_cluster integration tests (reviewable terraform output) over bespoke unit tests of model builders; add test-infra e2e jobs for real-cloud verification; add create cluster golden tests when the CLI path needs coverage. Linked from AGENTS.md so both humans and AI coding assistants pick it up.
kubernetes-prow
Bot
added
kind/documentation
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
justinsb
changed the title
kubernetes-prow
Bot
added
the
do-not-merge/work-in-progress
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Adds
docs/contributing/testing_new_configurations.mddescribing our preferred test coverage for new cluster configurations, and links it from AGENTS.md (so both humans and AI coding assistants pick it up):update clusterintegration test (tests/integration/update_cluster/) — the preferred first line of coverage: verifies the rendered terraform end-to-end, and is reviewable as a terraform diff. Explicitly preferred over bespoke unit tests of model builders, which a golden scenario usually makes redundant (e.g. the hand-written model test in GCE: enable NAT64 for IPv6-only clusters #18520 vs the golden scenario in tests: add minimal_gce_ipv6 integration test #18769).build_jobs.py) — when real-cloud verification is needed; canary jobs are fine for WIP features (e.g. kops: add GCE IPv6 kindnet periodic job test-infra#37791).kops create clustergolden test (tests/integration/create_cluster/) — when the CLI/defaulting path itself needs coverage (e.g. GCE IPv6, where the update_cluster golden passed butkops create cluster --ipv6failed outright, see WIP: gce: don't rewrite IPv6-only clusters to IPv4 in the IP-alias path #18770).Also documents the HACK_UPDATE_EXPECTED_IN_PLACE workflow for generating golden output, and the dry-run technique for verifying spec population against a real cloud account without creating resources.
/kind documentation