Conversation
5 tasks
…ldren e2e scenario
Adds two sub-commands to step 001-initial-apply in the
api_docs_with_children e2e scenario:
1. 001-get-sms-api-documents: Verifies that SMS API documents are
persisted on Konnect after the initial apply, checking slugs and
status for sms-errors and sms-authentication, and confirming the
total document count is 4.
2. 002-idempotency: Runs plan --mode apply with the same config and
asserts total_changes: 0, confirming no spurious UPDATE plans are
generated on subsequent runs.
Closes #<issue>
References: portal/visibility step 003-apply-no-op-after-create,
portal/api_with_attributes step 001-get-apis
Agent-Logs-Url: https://github.com/Kong/kongctl/sessions/9ac4af85-d857-457c-9472-90e098a0941a
Co-authored-by: rspurgeon <10521262+rspurgeon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add e2e get-verification and idempotency steps to api_docs_with_children scenario
test(e2e): add get-verification and idempotency steps to api_docs_with_children scenario
Apr 25, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR strengthens the portal/api_docs_with_children E2E scenario by validating that API documents are actually persisted in Konnect after the initial apply, and by adding an idempotency check to catch unexpected UPDATEs on re-plan.
Changes:
- Add a post-apply
get api documents --api-name "SMS API" -o jsonverification step asserting expected slugs/statuses and total document count. - Add an idempotency
plan --mode applystep assertingsummary.total_changes: 0on the same inputs.
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
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.
001-initial-applyin theapi_docs_with_childrenscenario only validated plan changes via expect files — it never confirmed documents were actually persisted on Konnect, and had no idempotency check to catch spurious UPDATE plans on re-apply.Changes
001-get-sms-api-documents— added after000-apply; callsget api documents --api-name "SMS API" -o jsonand assertssms-errorsandsms-authenticationare present withstatus: published, plus total count of 4:002-idempotency— runsplan -f portal.yaml -f apis.yaml --mode applyagainst the same overlay and assertstotal_changes: 0, catching any broken diff logic that would produce spurious UPDATEs on subsequent runs: