testutils: write goroutine dump to file on SucceedsSoon timeout#164551
Open
aerfrei wants to merge 1 commit intocockroachdb:masterfrom
Open
testutils: write goroutine dump to file on SucceedsSoon timeout#164551aerfrei wants to merge 1 commit intocockroachdb:masterfrom
aerfrei wants to merge 1 commit intocockroachdb:masterfrom
Conversation
|
It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR? 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf. |
Contributor
|
Merging to
|
Member
c788513 to
88dc104
Compare
When a SucceedsSoon/SucceedsWithin retry loop times out, the failure message now includes the path to a goroutine dump file written alongside the test output. This helps diagnose what the system was doing instead of reaching the expected state. The dump is written to a file (via datapathutils.DebuggableTempDir) of the form goroutine_dump_<random>.txt. The SQLRunner path previously used require.NoError which bypassed SucceedsWithin entirely; it now delegates to SucceedsWithin directly via a small adapter type that bridges the Fataler/TestFataler interfaces. Informs: cockroachdb#164187
88dc104 to
1f3659d
Compare
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
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.
When a SucceedsSoon/SucceedsWithin retry loop times out, the failure message now includes the path to a goroutine dump file written alongside the test output. This helps diagnose what the system was doing instead of reaching the expected state.
The dump is written to a file (via datapathutils.DebuggableTempDir) of the form goroutine_dump_.txt.
Both SucceedsWithin (in pkg/testutils) and SQLRunner.succeedsWithin (in pkg/testutils/sqlutils) now use the same WriteGoroutineDump helper. The SQLRunner path previously used require.NoError which bypassed SucceedsWithin entirely; it now handles the error directly.
Informs: #164187