[SUREFIRE-1887] Trim stacktraces to include relevant lines #574
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
…ation of the trimStackTrace trimStackTrace is implemented as an option. This change integrates the change of this issue in this feature.
…evant lines are included
elharo
reviewed
Dec 9, 2022
| @@ -64,14 +65,18 @@ public void testWriteTrimmedTraceToString() | |||
| MockThrowable t = new MockThrowable( stackTrace ); | |||
| LegacyPojoStackTraceWriter w = new LegacyPojoStackTraceWriter( "TestSurefire3", "testQuote", t ); | |||
| String out = w.writeTrimmedTraceToString(); | |||
| String expected = "junit.framework.AssertionFailedError: blah\n" + " at junit.framework.Assert.fail(Assert.java:47)\n" + " at TestSurefire3.testQuote(TestSurefire3.java:23)\n"; | |||
| String expected = "junit.framework.AssertionFailedError: blah\n" | |||
There was a problem hiding this comment.
I'm confused. This seems to add an extra line to the output and not remove anything. Is there a test that shows these changes making stack traces simpler?
|
I don't think this is right. Per docs, trimStackTrace controls "Whether to trim the stack trace in the reports to just the lines within the test, or show the full trace." This PR changes that behavior. At a minimum the docs need to be updated in the same PR. However SUREFIRE-1887 is about something different, removing the lines from the framework code, not the user's own code. I'm not sure we can change the existing option to make that possible. It might need a new option instead. |
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.
Following issue SUREFIRE-1887, this PR features an improved version of
trimStackTrace.With this implementation a trimmed stacktrace not only consist of the element(s) in the test class, but extends the stacktrace to include methods calls leading up to the test method.
Before (with
trimStackTrace= true):After (with
trimStackTrace= true):After releasing and collecting feedback, we propose to make
trimStackTraceto be enabled by default. This would greatly reduce the stacktraces and thereby the footprint of build output.Following this checklist to help us incorporate your
contribution quickly and easily:
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
[SUREFIRE-XXX] - Fixes bug in ApproximateQuantiles,where you replace
SUREFIRE-XXXwith the appropriate JIRA issue. Best practiceis to use the JIRA issue title in the pull request title and in the first line of the
commit message.
mvn clean installto make sure basic checks pass. A more thorough check willbe performed on your pull request automatically.
mvn -Prun-its clean install).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.