Introduce --redirect-stdout and --redirect-stderr CLI options to redirect STDOUT and STDERR
#3637
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
mobounya
changed the title
added 4 commits
January 14, 2024 15:35
Add method registerMergedStandardStreams in StreamInterceptor to merge stdout and stderr so both can be intercepted in an stdout interceptor. This will keep the relative order for both outputs, which makes it easier to correlate error messages with the corresponding output. Add new configuration parameter junit.platform.output.capture.merge to merge stdout and stderr and publish it as STDOUT_REPORT_ENTRY_KEY to all registered TestExecutionListener instances. Issue: junit-team#3166
Add new CLI options --redirect-stdout and --redirect-stderr to redirect stdout and stderr to a file, if both are set to the same file, stdout and stderr will be merged so we can keep the relative order of messages. This makes it easier to correlate error messages with the corresponding output. Issue: junit-team#3166
Document the changes for the previous two commit in the 5.11.0-M1 release notes and in the user guide. Issue: junit-team#3166
Add @API annotation to new methods. Issue: junit-team#3166
mobounya
force-pushed
the
feat-redirect_stderr_and_stdout
branch
from
1dc0449
to
ae0fce5
Compare
This comment was marked as off-topic.
This comment was marked as off-topic.
sbrannen
changed the title
--redirect-stdout and --redirect-stderr CLI options to redirect STDOUT and STDERR
marcphilipp
requested changes
Oct 23, 2024
There was a problem hiding this comment.
I don't think we should implement this new ConsoleLauncher feature based on the report entries. Instead, the ConsoleLauncher should replace System.out and System.err prior to calling Launcher.execute with PrintStreams writing to files (or the same file). This would allow to configure capturing the output as report entries separately.
|
|
||
| * New optional config parameter `junit.platform.output.capture.merge` that can be used to merge stdout and stderr and | ||
| capture it as stdout. | ||
| * New optional CLI options `--redirect-stdout` and `--redirect-stderr` to redirect stdout and stderr outputs to a file. |
There was a problem hiding this comment.
This needs to go to the release notes of 5.12.0-M1 now
| @@ -73,4 +75,24 @@ public void setTheme(Theme theme) { | |||
| this.theme = theme; | |||
| } | |||
|
|
|||
| @API(status = INTERNAL, since = "5.11") | |||
There was a problem hiding this comment.
Suggested change
| @API(status = INTERNAL, since = "5.11") | |
| @API(status = INTERNAL, since = "5.12") |
same below
Comment on lines
+57
to
+59
| @Option(names = "-redirect-stdout", hidden = true) | ||
| private Path stdout2; | ||
|
|
There was a problem hiding this comment.
We're only maintaining this kind of options for backwards compatibility (we switched to option parsers at some point) but we shouldn't introduce them for new options.
Suggested change
| @Option(names = "-redirect-stdout", hidden = true) | |
| private Path stdout2; |
Comment on lines
+63
to
+65
| @Option(names = "-redirect-stderr", hidden = true) | ||
| private Path stderr2; | ||
|
|
There was a problem hiding this comment.
Suggested change
| @Option(names = "-redirect-stderr", hidden = true) | |
| private Path stderr2; |
Comment on lines
+71
to
+72
| result.setStdoutPath(choose(stdout, stdout2, null)); | ||
| result.setStderrPath(choose(stderr, stderr2, null)); |
There was a problem hiding this comment.
Suggested change
| result.setStdoutPath(choose(stdout, stdout2, null)); | |
| result.setStderrPath(choose(stderr, stderr2, null)); | |
| result.setStdoutPath(stdout); | |
| result.setStderrPath(stderr); |
|
@mobounya Thank you for your PR! Sorry it took us so long to review it. Are you still interested in continuing? |
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.
Overview
Add new CLI options
--redirect-stdoutand--redirect-stderrto redirect stdout and stderr respectively to a file,if both are set to the same file, stdout and stderr will be merged using the configuration parameter
CAPTURE_MERGED_STANDARD_STREAMS_PROPERTY_NAMEand captured from stdout keySTDOUT_REPORT_ENTRY_KEYin a new TestExecutionListener :RedirectStdoutAndStderrListenerIssue: #3166
I hereby agree to the terms of the JUnit Contributor License Agreement.
Definition of Done
@APIannotations