feat(test): add reconfiguration completion detection plugin #12391
Conversation
This file contains 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
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
3 times, most recently
from
94841e9 to
22fbc04
Compare
github-actions
bot
added
the
chore
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
from
22fbc04 to
de990ca
Compare
samugi
approved these changes
Jan 22, 2024
dndx
previously requested changes
Jan 24, 2024
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
3 times, most recently
from
fe7a254 to
e822bc7
Compare
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
3 times, most recently
from
f0dc75a to
bc43602
Compare
hanshuebner
dismissed
dndx’s stale review
Implemented as a tests-only plugin now.
StarlightIbuki
approved these changes
Feb 21, 2024
I think the mechanism is reliable enough. It is still that further synchronization is needed, i.e. when testing plugins that perform asynchronous configuration operations, but for most tests, this should be good enough. |
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
from
bc43602 to
4af2518
Compare
bungle
reviewed
Feb 22, 2024
spec/fixtures/custom_plugins/kong/plugins/reconfiguration-completion/handler.lua
Outdated
Show resolved
Hide resolved
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
from
4af2518 to
a788ec4
Compare
Unlike the previous implementation, this one does not require changes to Kong and its proxy path. It works based on the assumption that the order of admin API changes is preserved. The admin API client marks the end of the changes that it needs to see propagated to the data plane(s) by changing the configuration of this plugin, setting a particular configuration version number. On the proxy path, a header X-Kong-Configuration-Version is sent with that version number. The plugin's access handler verifies that the version number configured in the plugin (on the dataplane) matches the version number requested by the client. If the version numbers do not match, a 503 error is generated, which causes the client to retry. The plugin is available only to busted tests. It needs to be enabled when starting Kong. A new busted test helper function make_synchronized_clients is provided that automatically synchronizes a proxy client and an admin API client. The the test can freely mix invocations to either endpoints. Whenever a change is made through the admin API, the proxy path request is delayed until the change has propagated to the data plane. spec/02-integration/13-vaults/06-refresh-secrets_spec.lua has been updated to use the function as an illustration.
hanshuebner
force-pushed
the
test/reconfiguration-completion-detection-plugin
branch
from
a788ec4 to
eb6f0b6
Compare
hanshuebner
deleted the
test/reconfiguration-completion-detection-plugin
branch
hanshuebner
added
the
cherry-pick kong-ee
|
Successfully created cherry-pick PR for |
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.
Summary
Unlike the previous implementation, this one does not require changes
to Kong and its proxy path. It works based on the assumption that the
order of admin API changes is preserved. The admin API client marks
the end of the changes that it needs to see propagated to the data
plane(s) by changing the configuration of this plugin, setting a
particular configuration version number. On the proxy path, a header
X-Kong-Configuration-Version is sent with that version number. The
plugin's access handler verifies that the version number configured in
the plugin (on the dataplane) matches the version number requested by
the client. If the version numbers do not match, a 503 error is
generated, which causes the client to retry.
The plugin is available only to busted tests. It needs to be enabled
when starting Kong.
A new busted test helper function
make_synchronized_clientsisprovided that automatically synchronizes a proxy client and an admin
API client. The the test can freely mix invocations to either
endpoints. Whenever a change is made through the admin API, the proxy
path request is delayed until the change has propagated to the data
plane. spec/02-integration/13-vaults/06-refresh-secrets_spec.lua has
been updated to use the function as an illustration.
Checklist
changelog/unreleased/kongorskip-changeloglabel added on PR if changelog is unnecessary. README.mdIssue reference
KAG-3265