View Javadoc

1   package org.apache.maven.plugin.surefire.report;
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 java.io.BufferedOutputStream;
23  import java.io.OutputStreamWriter;
24  import java.io.PrintStream;
25  import java.io.PrintWriter;
26  import java.util.List;
27  import org.apache.maven.surefire.report.ReportEntry;
28  import org.apache.maven.surefire.report.ReporterException;
29  
30  /**
31   * Base class for console reporters.
32   *
33   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
34   * @author Kristian Rosenvold
35   */
36  public class ConsoleReporter
37  {
38      public static final String BRIEF = "brief";
39  
40      public static final String PLAIN = "plain";
41  
42      private static final String TEST_SET_STARTING_PREFIX = "Running ";
43  
44      private static final int BUFFER_SIZE = 4096;
45  
46      private final PrintWriter writer;
47  
48  
49      public ConsoleReporter( PrintStream originalSystemOut )
50      {
51          OutputStreamWriter out = new OutputStreamWriter( new BufferedOutputStream( originalSystemOut, BUFFER_SIZE ) );
52          this.writer = new PrintWriter( out );
53      }
54  
55      public void testSetStarting( ReportEntry report )
56          throws ReporterException
57      {
58          writeMessage( getTestSetStartingMessage( report ) );
59      }
60  
61      public void writeMessage( String message )
62      {
63          if ( writer != null )
64          {
65              writer.print( message );
66  
67              writer.flush();
68          }
69      }
70  
71      public void writeLnMessage( String message )
72      {
73          if ( writer != null )
74          {
75              writer.println( message );
76  
77              writer.flush();
78          }
79      }
80  
81      public void testSetCompleted( WrappedReportEntry report, TestSetStats testSetStats, List<String> testResults )
82          throws ReporterException
83      {
84          writeMessage( testSetStats.getTestSetSummary( report ) );
85  
86          if ( testResults != null )
87          {
88              for ( String testResult : testResults )
89              {
90                  writeLnMessage( testResult );
91              }
92          }
93      }
94  
95  
96      public void reset()
97      {
98          if ( writer != null )
99          {
100             writer.flush();
101         }
102     }
103 
104     /**
105      * Get the test set starting message for a report.
106      * eg. "Running org.foo.BarTest ( of group )"
107      *
108      * @param report report whose test set is starting
109      * @return the message
110      */
111     static String getTestSetStartingMessage( ReportEntry report )
112     {
113         StringBuilder message = new StringBuilder();
114         message.append( TEST_SET_STARTING_PREFIX );
115         message.append( report.getNameWithGroup() );
116 
117         message.append( "\n" );
118         return message.toString();
119     }
120 
121 
122 }