docs: adding flaky test instructions#3931
Merged
alyssawilk merged 3 commits intoenvoyproxy:masterfrom Jul 23, 2018
Merged
Conversation
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
alyssawilk
changed the title
Contributor
Author
|
Per discussion on slack I think I'll also add a global in_tear_down_ function and ignore these 2 failure modes during test tear down and destruction, but these should still be worthwhile for folks who do cleanup inline. |
Member
mattklein123
left a comment
mattklein123
left a comment
There was a problem hiding this comment.
Awesome! Thanks for doing this.
test/integration/README.md
Outdated
| ## Debugging test flakes | ||
|
|
||
| Once you've managed to reproduce your test flake, you get to figure out what's | ||
| doing on. If your failure mode isn't documented below, ideally some combination |
test/integration/README.md
Outdated
| tear-down sequence between upstream, Envoy, and client is somewhat sensitive to | ||
| ordering. If a given unit test does not use the current global variables, for | ||
| example opens multiple client or upstream connections, the test author should be | ||
| aware of test best practives for clean-up which boil down to "Clean up upstream |
test/integration/README.md
Outdated
|
|
||
| As commented in `HttpIntegrationTest::cleanupUpstreamAndDownstream()`, the | ||
| tear-down sequence between upstream, Envoy, and client is somewhat sensitive to | ||
| ordering. If a given unit test does not use the current global variables, for |
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
mattklein123
approved these changes
Jul 23, 2018
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
2 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.
Documenting some common failure modes and repro instructions.
Risk Level: n/a
Testing: relying on existing tests
Docs Changes: yep
Release Notes: n/a
[Optional Fixes #Issue]
[Optional Deprecated:]