Fix flaky test Test_runDispatcher/gateway_actions_passed #5405
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
A short context timeout makes some tests flaky, but making it longer across the board would unnecessarily make test runs longer. Let's make it customizable per test case.
The flakiness is a result of a 100 miliseconds not always being enough time to dispatch the action in the test environment. The correct way to fix this issue is to run the assertions in an `assert.Eventually` with a longer timeout. Unfortunately, a deficiency in the `testify` testing framework makes it impossible to put the `AssertExpectations` methods in an `assert.Eventually` or `assert.EventuallyWithT` function: stretchr/testify#1414. The workaround is to increase the context timeout for the `gateway actions passed` test case. I'm increasing it from 100ms to 200ms.
andrzej-stencel
changed the title
Test_runDispatcher/gateway_actions_passed
andrzej-stencel
changed the title
Test_runDispatcher/gateway_actions_passed
|
This pull request does not have a backport label. Could you fix it @andrzej-stencel? 🙏
NOTE: |
|
ycombinator
added
the
Team:Elastic-Agent-Control-Plane
|
Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane) |
|
There is discussion on the issue in the description that links to another issue, which links to stretchr/testify#1395; could the approach from this pr be used to make the |
@michel-laterman I don't know what approach you mean, can you elaborate? Let me merge this pull request for now, but I'd be happy to continue the conversation to hopefully find a better solution. |
ycombinator
added
backport-8.15
mergify bot
pushed a commit
that referenced
this pull request
Nov 13, 2024
* refctor: make context timeout adjustable per test case A short context timeout makes some tests flaky, but making it longer across the board would unnecessarily make test runs longer. Let's make it customizable per test case. * Fix flaky test `Test_runDispatcher/gateway_actions_passed` The flakiness is a result of a 100 miliseconds not always being enough time to dispatch the action in the test environment. The correct way to fix this issue is to run the assertions in an `assert.Eventually` with a longer timeout. Unfortunately, a deficiency in the `testify` testing framework makes it impossible to put the `AssertExpectations` methods in an `assert.Eventually` or `assert.EventuallyWithT` function: stretchr/testify#1414. The workaround is to increase the context timeout for the `gateway actions passed` test case. I'm increasing it from 100ms to 200ms. (cherry picked from commit 0efab75)
2 tasks
ycombinator
pushed a commit
that referenced
this pull request
Nov 13, 2024
* refctor: make context timeout adjustable per test case A short context timeout makes some tests flaky, but making it longer across the board would unnecessarily make test runs longer. Let's make it customizable per test case. * Fix flaky test `Test_runDispatcher/gateway_actions_passed` The flakiness is a result of a 100 miliseconds not always being enough time to dispatch the action in the test environment. The correct way to fix this issue is to run the assertions in an `assert.Eventually` with a longer timeout. Unfortunately, a deficiency in the `testify` testing framework makes it impossible to put the `AssertExpectations` methods in an `assert.Eventually` or `assert.EventuallyWithT` function: stretchr/testify#1414. The workaround is to increase the context timeout for the `gateway actions passed` test case. I'm increasing it from 100ms to 200ms. (cherry picked from commit 0efab75) Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
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.
What does this PR do?
Fixes flaky test
Test_runDispatcher/gateway_actions_passedby increasing the timeout from 100ms to 200ms.The flakiness is a result of a 100 miliseconds not always being enough time to dispatch the action in the test environment.
The correct way to fix this issue is to run the assertions in an
assert.Eventuallywith a longer timeout. Unfortunately, a deficiency in thetestifytesting framework makes it impossible to put theAssertExpectationsmethods in anassert.Eventuallyorassert.EventuallyWithTfunction: stretchr/testify#1414.The workaround is to increase the context timeout for the
gateway actions passedtest case. I'm increasing it from 100ms to 200ms.Why is it important?
Flaky tests are evil!
Checklist
[ ] I have made corresponding changes to the documentation[ ] I have made corresponding change to the default configuration files[ ] I have added tests that prove my fix is effective or that my feature works[ ] I have added an entry in./changelog/fragmentsusing the changelog tool[ ] I have added an integration test or an E2E testHow to test this PR locally
$ go test -v ./internal/pkg/agent/application/ -run Test_runDispatcherRelated issues