Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tests(deck): add deck integration tests #12980

Merged
merged 2 commits into from
Jun 11, 2024
Merged

tests(deck): add deck integration tests #12980

merged 2 commits into from
Jun 11, 2024

Conversation

samugi
Copy link
Member

@samugi samugi commented May 6, 2024

Summary

These tests are meant to catch changes in Kong that result in incompatibilities with decK.

The approach used here is to configure all the bundled plugins in Kong and a few other entities and confirm that deck dump + sync executes without errors.

This new workflow "continues-on-error" instead of producing failures on CI: changes in gateway schemas might have to be merged despite making decK fail, the purpose of this is to notify about such incompatibilities. When those failures are detected, the workflow posts a review in the PR requesting changes, and a link to the failing run.

The review is then dismissed if new changes are pushed to the PR that make the workflow pass. <-- not anymore: branch protection rules prevent this

Checklist

  • The Pull Request has tests
  • A changelog file has been created under changelog/unreleased/kong or skip-changelog label added on PR if changelog is unnecessary. README.md
  • (no) There is a user-facing docs PR against https://github.com/Kong/docs.konghq.com - PUT DOCS PR HERE

Issue reference

KAG-4236

@samugi samugi marked this pull request as draft May 6, 2024 07:57
@github-actions github-actions bot added chore Not part of the core functionality of kong, but still needed cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee labels May 6, 2024
@samugi samugi force-pushed the test/deck-integration branch from 848a0ac to 36d07e9 Compare May 6, 2024 07:59
@samugi samugi removed the cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee label May 6, 2024
@github-actions github-actions bot added core/admin-api cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee labels May 6, 2024
@samugi samugi removed the cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee label May 6, 2024
@samugi samugi force-pushed the test/deck-integration branch from 36d07e9 to 73e79bd Compare May 6, 2024 09:40
@github-actions github-actions bot added the cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee label May 6, 2024
@samugi samugi force-pushed the test/deck-integration branch 2 times, most recently from 96c451f to 24746fb Compare May 6, 2024 09:59
Copy link
Contributor

github-actions bot commented May 6, 2024

decK integration tests

✅ passed successfully.

@samugi samugi force-pushed the test/deck-integration branch 6 times, most recently from 9cddf0c to 81fe3ce Compare May 6, 2024 11:07
@samugi samugi removed cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee core/admin-api labels May 6, 2024
@samugi samugi marked this pull request as ready for review May 6, 2024 11:33
@samugi samugi marked this pull request as draft May 10, 2024 15:53
@samugi
Copy link
Member Author

samugi commented May 10, 2024

re-drafting to explore the option of using a review (by the bot) instead of a comment, to make the failures more visible when they occur

Edit: done

@samugi samugi force-pushed the test/deck-integration branch from 81fe3ce to 8705c79 Compare May 13, 2024 13:53
@github-actions github-actions bot added cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee core/admin-api labels May 13, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

decK integration tests

⚠️ failure detected. Please check the workflow logs for more details.

@samugi samugi force-pushed the test/deck-integration branch 3 times, most recently from 43ece33 to edd4ea5 Compare May 13, 2024 15:19
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

decK integration tests

⚠️ failure detected. Please check the workflow logs for more details.

@samugi samugi force-pushed the test/deck-integration branch from d4f3389 to c4d7cf0 Compare May 13, 2024 15:24
@samugi samugi marked this pull request as ready for review May 13, 2024 15:55
samugi added 2 commits June 11, 2024 14:52
These tests are meant to catch changes in Kong
that result in incompatibilities with decK.

The approach used here is to configure all the
bundled plugins in Kong and a few other entities
and confirm that deck dump + sync executes without
errors.

This new workflow "continues-on-error" instead of
producing failures on CI: changes in gateway
schemas might have to be merged despite making
decK fail, the purpose of this is to notify about
such incompatibilities. When those failures are
detected, the workflow posts a review in the PR
requesting changes and with a link to the failing
run.

The review is then dismissed if new changes
are pushed to the PR that make the workflow pass.
@samugi samugi force-pushed the test/deck-integration branch from c4d7cf0 to f03c57a Compare June 11, 2024 12:52
@samugi samugi merged commit 7302e73 into master Jun 11, 2024
24 checks passed
@samugi samugi deleted the test/deck-integration branch June 11, 2024 17:02
@team-gateway-bot
Copy link
Collaborator

Successfully created cherry-pick PR for master:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-pick kong-ee schedule this PR for cherry-picking to kong/kong-ee chore Not part of the core functionality of kong, but still needed core/admin-api size/L skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants