test/integration: Capture component setup output #12069
Merged
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
abhinav
added
the
impact/no-changelog-required
This was referenced Feb 3, 2023
Merged
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
Changelog[uncommitted] (2023-02-03) |
abhinav
commented
Feb 3, 2023
| // | ||
| // Use newTestLogWriter to ensure it is flushed | ||
| // of any input when the test finishes. | ||
| type testLogWriter struct { |
There was a problem hiding this comment.
This can likely be re-used elsewhere.
I will defer moving this somewhere shared for when we need it.
justinvp
approved these changes
Feb 3, 2023
Issue #12050 would have been a lot easier to debug if we had been capturing the output of the commands. This changes runComponentSetup to execute bash with `-x` so that every command in the shell script is logged before it's run. This feeds that output into an `io.Writer` that logs to the testing.TB. This way, if the test fails or times out, we'll have a bunch of meaningful log output associated with the tests that ran them. Capturing the command output in a reliable way required introduction of something slightly more complicated than `strings.Split(\n)` because there's a good chance that we'll have partial lines written to the writer. The approach taken by the Writer here is: it will log the input one line at a time usually, but when it sees a partial line, it will buffer it in-memory to be combined with the next write or flush. Approach inspired by https://github.com/uber-go/zap/blob/v1.24.0/zapio/writer.go Refs #12050
abhinav
force-pushed
the
abhinav/verbose-component-setup
branch
from
67de6f9
to
4841686
Compare
|
bors r+ |
|
Build succeeded: |
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.
Issue #12050 would have been a lot easier to debug
if we had been capturing the output of the commands.
This changes runComponentSetup to execute bash with
-xso that every command in the shell script is logged before it's run.
This feeds that output into an
io.Writerthat logs to the testing.TB.This way, if the test fails or times out,
we'll have a bunch of meaningful log output
associated with the tests that ran them.
Capturing the command output in a reliable way
required introduction of something slightly more complicated
than
strings.Split(\n)because there's a good chancethat we'll have partial lines written to the writer.
The approach taken by the Writer here is:
it will log the input one line at a time usually,
but when it sees a partial line, it will buffer it in-memory
to be combined with the next write or flush.
Approach inspired by https://github.com/uber-go/zap/blob/v1.24.0/zapio/writer.go
Refs #12050