View Javadoc

1   package org.apache.maven.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.File;
23  import java.io.FileWriter;
24  import java.io.IOException;
25  import java.io.PrintWriter;
26  
27  /**
28   * Base class for file reporters.
29   *
30   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
31   */
32  public abstract class AbstractFileReporter
33      extends AbstractTextReporter
34  {
35      private final File reportsDirectory;
36  
37      private final boolean deleteOnStarting;
38  
39      AbstractFileReporter( ReporterConfiguration reporterConfiguration, String format )
40      {
41          super( reporterConfiguration, format );
42  
43          this.reportsDirectory = reporterConfiguration.getReportsDirectory();
44  
45          this.deleteOnStarting = reporterConfiguration.isForkWithTimeout();
46      }
47  
48  
49      public void testSetStarting( ReportEntry report )
50          throws ReporterException
51      {
52          super.testSetStarting( report );
53  
54          File reportFile = getReportFile( report );
55  
56          File reportDir = reportFile.getParentFile();
57  
58          //noinspection ResultOfMethodCallIgnored
59          reportDir.mkdirs();
60  
61          if ( deleteOnStarting && reportFile.exists() )
62          {
63              //noinspection ResultOfMethodCallIgnored
64              reportFile.delete();
65          }
66  
67          try
68          {
69              PrintWriter writer = new PrintWriter( new FileWriter( reportFile ) );
70  
71              writer.println( "-------------------------------------------------------------------------------" );
72  
73              writer.println( "Test set: " + report.getName() );
74  
75              writer.println( "-------------------------------------------------------------------------------" );
76  
77              setWriter( writer );
78          }
79          catch ( IOException e )
80          {
81              throw new ReporterException( "Unable to create file for report: " + e.getMessage(), e );
82          }
83      }
84  
85      private File getReportFile( ReportEntry report )
86      {
87          return new File( reportsDirectory, report.getName() + ".txt" );
88      }
89  
90      public void testSetCompleted( ReportEntry report )
91          throws ReporterException
92      {
93          super.testSetCompleted( report );
94  
95          writer.flush();
96  
97          writer.close();
98  
99          writer = null;
100 
101         if ( isTimedOut() )
102         {
103             deleteIfExisting( getReportFile( report ) );
104         }
105     }
106 }