Backport of Introduce randomized timings and reproducible randomization into controller integration tests. into release/1.17.x#19575
Merged
mkeeler merged 1 commit intoNov 8, 2023
Conversation
hc-github-team-consul-core
force-pushed
the
backport/chaos-controller-testing/freely-civil-pug
branch
from
5b6e6d4 to
21379c8
Compare
hc-github-team-consul-core
force-pushed
the
backport/chaos-controller-testing/freely-civil-pug
branch
from
21379c8 to
5b6e6d4
Compare
|
|
github-team-consul-core-pr-approver
approved these changes
Nov 8, 2023
Collaborator
github-team-consul-core-pr-approver
left a comment
github-team-consul-core-pr-approver
left a comment
There was a problem hiding this comment.
Auto approved Consul Bot automated PR
…roller integration tests. As the V2 architecture hinges on eventual consistency and controllers reconciling the existing state in response to writes, there are potential issues we could run into regarding ordering and timing of operations. We want to be able to guarantee that given a set of resources the system will always eventually get to the desired correct state. The order of resource writes and delays in performing those writes should not alter the final outcome of reaching the desired state. To that end, this commit introduces arbitrary randomized delays before performing resources writes into the `resourcetest.Client`. Its `PublishResources` method was already randomizing the order of resource writes. By default, no delay is added to normal writes and deletes but tests can opt-in via either passing hard coded options when creating the `resourcetest.Client` or using the `resourcetest.ConfigureTestCLIFlags` function to allow processing of CLI parameters. In addition to allowing configurability of the request delay min and max, the client also has a configurable random number generator seed. When Using the CLI parameter helpers, a test log will be written noting the currently used settings. If the test fails then you can reproduce the same delays and order randomizations by providing the seed during the previous test failure. # Conflicts: # internal/catalog/catalogtest/run_test.go # internal/catalog/catalogtest/test_integration_v2beta1.go # test/integration/consul-container/test/catalog/catalog_test.go
mkeeler
force-pushed
the
backport/chaos-controller-testing/freely-civil-pug
branch
from
290e2d8 to
64a48e4
Compare
mkeeler
deleted the
backport/chaos-controller-testing/freely-civil-pug
branch
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
4 participants
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.
Backport
This PR is auto-generated from #19393 to be assessed for backporting due to the inclusion of the label backport/1.17.
🚨
The person who merged in the original PR is:
@mkeeler
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.
The below text is copied from the body of the original PR.
Description
As the V2 architecture hinges on eventual consistency and controllers reconciling the existing state in response to writes, there are potential issues we could run into regarding ordering and timing of operations. We want to be able to guarantee that given a set of resources the system will always eventually get to the desired correct state. The order of resource writes and delays in performing those writes should not alter the final outcome of reaching the desired state.
To that end, this commit introduces arbitrary randomized delays before performing resources writes into the
resourcetest.Client. ItsPublishResourcesmethod was already randomizing the order of resource writes. By default, no delay is added to normal writes and deletes but tests can opt-in via either passing hard coded options when creating theresourcetest.Clientor using theresourcetest.ConfigureTestCLIFlagsfunction to allow processing of CLI parameters.In addition to allowing configurability of the request delay min and max, the client also has a configurable random number generator seed. When Using the CLI parameter helpers, a test log will be written noting the currently used settings. If the test fails then you can reproduce the same delays and order randomizations by providing the seed during the previous test failure.
Testing & Reproduction steps
go test -min-request-delay 100 -max-request-delay 2000 .ran multiple times within both the internal/catalog/catalogtest and test/integration/consul-container/test/catalog packages. All runs were successful and it takes about 5m for each run with these settings. * The default delay settings of 10ms/50ms run in about 7s on my laptop where they previously took ~2.5s.Overview of commits