Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SUREFIRE-1887] Trim stacktraces to include relevant lines #574

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

MrFix93
Copy link

@MrFix93 MrFix93 commented Oct 29, 2022

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):
image

After (with trimStackTrace = true):
image

After releasing and collecting feedback, we propose to make trimStackTrace to 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:

  • Make sure there is a JIRA issue filed
    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.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [SUREFIRE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace SUREFIRE-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean install to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (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.

@elharo elharo self-requested a review December 9, 2022 12:43
@elharo elharo self-assigned this 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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@elharo
Copy link
Contributor

elharo commented Dec 9, 2022

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants