KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > mavenplugins > testsuite > report > SurefireReportParser


1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */

17
18  
19 package org.apache.geronimo.mavenplugins.testsuite.report;
20
21 import org.apache.maven.reporting.MavenReportException;
22 import org.codehaus.plexus.util.DirectoryScanner;
23 import org.codehaus.plexus.util.StringUtils;
24 import org.xml.sax.SAXException JavaDoc;
25
26 import javax.xml.parsers.ParserConfigurationException JavaDoc;
27 import java.io.File JavaDoc;
28 import java.io.IOException JavaDoc;
29 import java.text.NumberFormat JavaDoc;
30 import java.util.ArrayList JavaDoc;
31 import java.util.HashMap JavaDoc;
32 import java.util.List JavaDoc;
33 import java.util.ListIterator JavaDoc;
34 import java.util.Locale JavaDoc;
35 import java.util.Map JavaDoc;
36
37 public class SurefireReportParser
38 {
39     private NumberFormat JavaDoc numberFormat = NumberFormat.getInstance();
40
41     private File JavaDoc reportsDirectory;
42
43     private List JavaDoc testSuites = new ArrayList JavaDoc();
44
45     private Locale JavaDoc locale;
46
47     private static final int PCENT = 100;
48
49     public SurefireReportParser()
50     {
51     }
52
53     public SurefireReportParser( File JavaDoc reportsDirectory, Locale JavaDoc locale )
54     {
55         this.reportsDirectory = reportsDirectory;
56
57         setLocale( locale );
58     }
59
60     public List JavaDoc parseXMLReportFiles()
61         throws MavenReportException
62     {
63         if ( reportsDirectory.exists() )
64         {
65             String JavaDoc[] xmlReportFiles = getIncludedFiles( reportsDirectory, "*.xml", "*.txt" );
66
67             for ( int index = 0; index < xmlReportFiles.length; index++ )
68             {
69                 ReportTestSuite testSuite = new ReportTestSuite();
70                 
71                 String JavaDoc currentReport = xmlReportFiles[index];
72
73                 try
74                 {
75                     testSuite.parse( reportsDirectory + "/" + currentReport );
76                 }
77                 catch ( ParserConfigurationException JavaDoc e )
78                 {
79                     throw new MavenReportException( "Error setting up parser for JUnit XML report", e );
80                 }
81                 catch ( SAXException JavaDoc e )
82                 {
83                     throw new MavenReportException( "Error parsing JUnit XML report " + currentReport, e );
84                 }
85                 catch ( IOException JavaDoc e )
86                 {
87                     throw new MavenReportException( "Error reading JUnit XML report " + currentReport, e );
88                 }
89
90                 testSuites.add( testSuite );
91             }
92         }
93
94         return testSuites;
95     }
96
97     protected String JavaDoc parseTestSuiteName( String JavaDoc lineString )
98     {
99         return lineString.substring( lineString.lastIndexOf( "." ) + 1, lineString.length() );
100     }
101
102     protected String JavaDoc parseTestSuitePackageName( String JavaDoc lineString )
103     {
104         return lineString.substring( lineString.indexOf( ":" ) + 2, lineString.lastIndexOf( "." ) );
105     }
106
107     protected String JavaDoc parseTestCaseName( String JavaDoc lineString )
108     {
109         return lineString.substring( 0, lineString.indexOf( "(" ) );
110     }
111
112     public Map JavaDoc getSummary( List JavaDoc suites )
113     {
114         Map JavaDoc totalSummary = new HashMap JavaDoc();
115
116         ListIterator JavaDoc iter = suites.listIterator();
117
118         int totalNumberOfTests = 0;
119
120         int totalNumberOfErrors = 0;
121
122         int totalNumberOfFailures = 0;
123
124         int totalNumberOfSkipped = 0;
125
126         float totalElapsedTime = 0.0f;
127
128         while ( iter.hasNext() )
129         {
130             ReportTestSuite suite = (ReportTestSuite) iter.next();
131
132             totalNumberOfTests += suite.getNumberOfTests();
133
134             totalNumberOfErrors += suite.getNumberOfErrors();
135
136             totalNumberOfFailures += suite.getNumberOfFailures();
137
138             totalNumberOfSkipped += suite.getNumberOfSkipped();
139
140             totalElapsedTime += suite.getTimeElapsed();
141         }
142
143         String JavaDoc totalPercentage = computePercentage( totalNumberOfTests, totalNumberOfErrors, totalNumberOfFailures,
144                                                     totalNumberOfSkipped );
145
146         totalSummary.put( "totalTests", Integer.toString( totalNumberOfTests ) );
147
148         totalSummary.put( "totalErrors", Integer.toString( totalNumberOfErrors ) );
149
150         totalSummary.put( "totalFailures", Integer.toString( totalNumberOfFailures ) );
151
152         totalSummary.put( "totalSkipped", Integer.toString( totalNumberOfSkipped ) );
153
154         totalSummary.put( "totalElapsedTime", numberFormat.format( totalElapsedTime ) );
155
156         totalSummary.put( "totalPercentage", totalPercentage );
157
158         return totalSummary;
159     }
160
161     public void setReportsDirectory( File JavaDoc reportsDirectory )
162     {
163         this.reportsDirectory = reportsDirectory;
164     }
165
166     public File JavaDoc getReportsDirectory()
167     {
168         return this.reportsDirectory;
169     }
170
171     public final void setLocale( Locale JavaDoc locale )
172     {
173         this.locale = locale;
174         numberFormat = NumberFormat.getInstance( locale );
175     }
176
177     public Locale JavaDoc getLocale()
178     {
179         return this.locale;
180     }
181
182     public void setNumberFormat( NumberFormat JavaDoc numberFormat )
183     {
184         this.numberFormat = numberFormat;
185     }
186
187     public NumberFormat JavaDoc getNumberFormat()
188     {
189         return this.numberFormat;
190     }
191
192     public Map JavaDoc getSuitesGroupByPackage( List JavaDoc testSuitesList )
193     {
194         ListIterator JavaDoc iter = testSuitesList.listIterator();
195
196         Map JavaDoc suitePackage = new HashMap JavaDoc();
197
198         while ( iter.hasNext() )
199         {
200             ReportTestSuite suite = (ReportTestSuite) iter.next();
201
202             List JavaDoc suiteList = new ArrayList JavaDoc();
203
204             if ( suitePackage.get( suite.getPackageName() ) != null )
205             {
206                 suiteList = (List JavaDoc) suitePackage.get( suite.getPackageName() );
207             }
208
209             suiteList.add( suite );
210
211             suitePackage.put( suite.getPackageName(), suiteList );
212         }
213
214         return suitePackage;
215     }
216
217     public String JavaDoc computePercentage( int tests, int errors, int failures, int skipped )
218     {
219         float percentage;
220         if ( tests == 0 )
221         {
222             percentage = 0;
223         }
224         else
225         {
226             percentage = ( (float) ( tests - errors - failures - skipped ) / (float) tests ) * PCENT;
227         }
228
229         return numberFormat.format( percentage );
230     }
231
232     public List JavaDoc getFailureDetails( List JavaDoc testSuitesList )
233     {
234         ListIterator JavaDoc iter = testSuitesList.listIterator();
235
236         List JavaDoc failureDetailList = new ArrayList JavaDoc();
237
238         while ( iter.hasNext() )
239         {
240             ReportTestSuite suite = (ReportTestSuite) iter.next();
241
242             List JavaDoc testCaseList = suite.getTestCases();
243
244             if ( testCaseList != null )
245             {
246                 ListIterator JavaDoc caseIter = testCaseList.listIterator();
247
248                 while ( caseIter.hasNext() )
249                 {
250                     ReportTestCase tCase = (ReportTestCase) caseIter.next();
251
252                     if ( tCase.getFailure() != null )
253                     {
254                         failureDetailList.add( tCase );
255                     }
256                 }
257             }
258         }
259
260         return failureDetailList;
261     }
262
263     private String JavaDoc[] getIncludedFiles( File JavaDoc directory, String JavaDoc includes, String JavaDoc excludes )
264     {
265         DirectoryScanner scanner = new DirectoryScanner();
266
267         scanner.setBasedir( directory );
268
269         scanner.setIncludes( StringUtils.split( includes, "," ) );
270
271         scanner.setExcludes( StringUtils.split( excludes, "," ) );
272
273         scanner.scan();
274
275         return scanner.getIncludedFiles();
276     }
277 }
278
Popular Tags