View Javadoc
1   package org.apache.maven.surefire.common.junit4;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.surefire.report.SafeThrowable;
23  import org.apache.maven.surefire.report.SmartStackTraceParser;
24  import org.apache.maven.surefire.report.StackTraceWriter;
25  import org.junit.runner.notification.Failure;
26  
27  import static org.apache.maven.surefire.util.internal.TestClassMethodNameUtils.extractClassName;
28  import static org.apache.maven.surefire.util.internal.TestClassMethodNameUtils.extractMethodName;
29  import static org.apache.maven.surefire.report.SmartStackTraceParser.stackTraceWithFocusOnClassAsString;
30  
31  /**
32   * Writes out a specific {@link org.junit.runner.notification.Failure} for
33   * surefire as a stacktrace.
34   *
35   * @author Karl M. Davis
36   */
37  public class JUnit4StackTraceWriter
38      implements StackTraceWriter
39  {
40      // Member Variables
41      protected final Failure junitFailure;
42  
43      /**
44       * Constructor.
45       *
46       * @param junitFailure the {@link Failure} that this will be operating on
47       */
48      public JUnit4StackTraceWriter( Failure junitFailure )
49      {
50          this.junitFailure = junitFailure;
51      }
52  
53      /*
54        * (non-Javadoc)
55        *
56        * @see org.apache.maven.surefire.report.StackTraceWriter#writeTraceToString()
57        */
58      @Override
59      public String writeTraceToString()
60      {
61          Throwable t = junitFailure.getException();
62          if ( t != null )
63          {
64              String originalTrace = junitFailure.getTrace();
65              if ( isMultiLineExceptionMessage( t ) )
66              {
67                  // SUREFIRE-986
68                  StringBuilder builder = new StringBuilder( originalTrace );
69                  String exc = t.getClass().getName() + ": ";
70                  if ( originalTrace.startsWith( exc ) )
71                  {
72                      builder.insert( exc.length(), '\n' );
73                  }
74                  return builder.toString();
75              }
76              return originalTrace;
77          }
78          return "";
79      }
80  
81      protected String getTestClassName()
82      {
83          return extractClassName( junitFailure.getDescription().getDisplayName() );
84      }
85  
86      protected String getTestMethodName()
87      {
88          return extractMethodName( junitFailure.getDescription().getDisplayName() );
89      }
90  
91      @Override
92      @SuppressWarnings( "ThrowableResultOfMethodCallIgnored" )
93      public String smartTrimmedStackTrace()
94      {
95          Throwable exception = junitFailure.getException();
96          return exception == null
97              ? junitFailure.getMessage()
98              : new SmartStackTraceParser( getTestClassName(), exception, getTestMethodName() ).getString();
99      }
100 
101     /**
102      * At the moment, returns the same as {@link #writeTraceToString()}.
103      *
104      * @see org.apache.maven.surefire.report.StackTraceWriter#writeTrimmedTraceToString()
105      */
106     @Override
107     public String writeTrimmedTraceToString()
108     {
109         String testClass = getTestClassName();
110         try
111         {
112             Throwable e = junitFailure.getException();
113             return stackTraceWithFocusOnClassAsString( e, testClass );
114         }
115         catch ( Throwable t )
116         {
117             return stackTraceWithFocusOnClassAsString( t, testClass );
118         }
119     }
120 
121     /**
122      * Returns the exception associated with this failure.
123      *
124      * @see org.apache.maven.surefire.report.StackTraceWriter#getThrowable()
125      */
126     @Override
127     public SafeThrowable getThrowable()
128     {
129         return new SafeThrowable( junitFailure.getException() );
130     }
131 
132     private static boolean isMultiLineExceptionMessage( Throwable t )
133     {
134         String msg = t.getLocalizedMessage();
135         if ( msg != null )
136         {
137             int countNewLines = 0;
138             for ( int i = 0, length = msg.length(); i < length; i++ )
139             {
140                 if ( msg.charAt( i ) == '\n' )
141                 {
142                     if ( ++countNewLines == 2 )
143                     {
144                         break;
145                     }
146                 }
147             }
148             return countNewLines > 1 || countNewLines == 1 && !msg.trim().endsWith( "\n" );
149         }
150         return false;
151     }
152 
153 }