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