/
DefaultReporterFactory.java
501 lines (452 loc) · 17.9 KB
/
DefaultReporterFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
package org.apache.maven.plugin.surefire.report;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.plugin.surefire.StartupReportConfiguration;
import org.apache.maven.plugin.surefire.log.api.ConsoleLogger;
import org.apache.maven.plugin.surefire.log.api.Level;
import org.apache.maven.plugin.surefire.runorder.StatisticsReporter;
import org.apache.maven.surefire.shared.utils.logging.MessageBuilder;
import org.apache.maven.surefire.extensions.ConsoleOutputReportEventListener;
import org.apache.maven.surefire.extensions.StatelessReportEventListener;
import org.apache.maven.surefire.extensions.StatelessTestsetInfoConsoleReportEventListener;
import org.apache.maven.surefire.extensions.StatelessTestsetInfoFileReportEventListener;
import org.apache.maven.surefire.api.report.ReporterFactory;
import org.apache.maven.surefire.api.report.RunListener;
import org.apache.maven.surefire.report.RunStatistics;
import org.apache.maven.surefire.api.report.StackTraceWriter;
import org.apache.maven.surefire.api.suite.RunResult;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.ConcurrentLinkedQueue;
import static org.apache.maven.plugin.surefire.log.api.Level.resolveLevel;
import static org.apache.maven.plugin.surefire.report.ConsoleReporter.PLAIN;
import static org.apache.maven.plugin.surefire.report.DefaultReporterFactory.TestResultType.error;
import static org.apache.maven.plugin.surefire.report.DefaultReporterFactory.TestResultType.failure;
import static org.apache.maven.plugin.surefire.report.DefaultReporterFactory.TestResultType.flake;
import static org.apache.maven.plugin.surefire.report.DefaultReporterFactory.TestResultType.skipped;
import static org.apache.maven.plugin.surefire.report.DefaultReporterFactory.TestResultType.success;
import static org.apache.maven.plugin.surefire.report.DefaultReporterFactory.TestResultType.unknown;
import static org.apache.maven.plugin.surefire.report.ReportEntryType.ERROR;
import static org.apache.maven.plugin.surefire.report.ReportEntryType.FAILURE;
import static org.apache.maven.plugin.surefire.report.ReportEntryType.SUCCESS;
import static org.apache.maven.surefire.shared.utils.logging.MessageUtils.buffer;
import static org.apache.maven.surefire.api.util.internal.ObjectUtils.useNonNull;
/**
* Provides reporting modules on the plugin side.
* <br>
* Keeps a centralized count of test run results.
*
* @author Kristian Rosenvold
*/
public class DefaultReporterFactory
implements ReporterFactory, ReportsMerger
{
private final Collection<TestSetRunListener> listeners = new ConcurrentLinkedQueue<>();
private final StartupReportConfiguration reportConfiguration;
private final ConsoleLogger consoleLogger;
private final Integer forkNumber;
private RunStatistics globalStats = new RunStatistics();
// from "<testclass>.<testmethod>" -> statistics about all the runs for flaky tests
private Map<String, List<TestMethodStats>> flakyTests;
// from "<testclass>.<testmethod>" -> statistics about all the runs for failed tests
private Map<String, List<TestMethodStats>> failedTests;
// from "<testclass>.<testmethod>" -> statistics about all the runs for error tests
private Map<String, List<TestMethodStats>> errorTests;
public DefaultReporterFactory( StartupReportConfiguration reportConfiguration, ConsoleLogger consoleLogger )
{
this( reportConfiguration, consoleLogger, null );
}
public DefaultReporterFactory( StartupReportConfiguration reportConfiguration, ConsoleLogger consoleLogger,
Integer forkNumber )
{
this.reportConfiguration = reportConfiguration;
this.consoleLogger = consoleLogger;
this.forkNumber = forkNumber;
}
@Override
public RunListener createReporter()
{
TestSetRunListener testSetRunListener =
new TestSetRunListener( createConsoleReporter(),
createFileReporter(),
createSimpleXMLReporter(),
createConsoleOutputReceiver(),
createStatisticsReporter(),
reportConfiguration.isTrimStackTrace(),
PLAIN.equals( reportConfiguration.getReportFormat() ),
reportConfiguration.isBriefOrPlainFormat(),
consoleLogger );
addListener( testSetRunListener );
return testSetRunListener;
}
@Override
public File getReportsDirectory()
{
return reportConfiguration.getReportsDirectory();
}
private StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry, TestSetStats> createConsoleReporter()
{
StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry, TestSetStats> consoleReporter =
reportConfiguration.instantiateConsoleReporter( consoleLogger );
return useNonNull( consoleReporter, NullConsoleReporter.INSTANCE );
}
private StatelessTestsetInfoFileReportEventListener<WrappedReportEntry, TestSetStats> createFileReporter()
{
StatelessTestsetInfoFileReportEventListener<WrappedReportEntry, TestSetStats> fileReporter =
reportConfiguration.instantiateFileReporter( forkNumber );
return useNonNull( fileReporter, NullFileReporter.INSTANCE );
}
private StatelessReportEventListener<WrappedReportEntry, TestSetStats> createSimpleXMLReporter()
{
StatelessReportEventListener<WrappedReportEntry, TestSetStats> xmlReporter =
reportConfiguration.instantiateStatelessXmlReporter( forkNumber );
return useNonNull( xmlReporter, NullStatelessXmlReporter.INSTANCE );
}
private ConsoleOutputReportEventListener createConsoleOutputReceiver()
{
ConsoleOutputReportEventListener outputReporter =
reportConfiguration.instantiateConsoleOutputFileReporter( forkNumber );
return useNonNull( outputReporter, NullConsoleOutputReceiver.INSTANCE );
}
private StatisticsReporter createStatisticsReporter()
{
StatisticsReporter statisticsReporter = reportConfiguration.getStatisticsReporter();
return useNonNull( statisticsReporter, NullStatisticsReporter.INSTANCE );
}
@Override
public void mergeFromOtherFactories( Collection<DefaultReporterFactory> factories )
{
for ( DefaultReporterFactory factory : factories )
{
listeners.addAll( factory.listeners );
}
}
final void addListener( TestSetRunListener listener )
{
listeners.add( listener );
}
@Override
public RunResult close()
{
mergeTestHistoryResult();
runCompleted();
for ( TestSetRunListener listener : listeners )
{
listener.close();
}
return globalStats.getRunResult();
}
@Override
public void runStarting()
{
if ( reportConfiguration.isPrintSummary() )
{
log( "" );
log( "-------------------------------------------------------" );
log( " T E S T S" );
log( "-------------------------------------------------------" );
}
}
private void runCompleted()
{
if ( reportConfiguration.isPrintSummary() )
{
log( "" );
log( "Results:" );
log( "" );
}
boolean printedFailures = printTestFailures( failure );
boolean printedErrors = printTestFailures( error );
boolean printedFlakes = printTestFailures( flake );
if ( reportConfiguration.isPrintSummary() )
{
if ( printedFailures | printedErrors | printedFlakes )
{
log( "" );
}
boolean hasSuccessful = globalStats.getCompletedCount() > 0;
boolean hasSkipped = globalStats.getSkipped() > 0;
log( globalStats.getSummary(), hasSuccessful, printedFailures, printedErrors, hasSkipped, printedFlakes );
log( "" );
}
}
public RunStatistics getGlobalRunStatistics()
{
mergeTestHistoryResult();
return globalStats;
}
/**
* Get the result of a test based on all its runs. If it has success and failures/errors, then it is a flake;
* if it only has errors or failures, then count its result based on its first run
*
* @param reportEntries the list of test run report type for a given test
* @param rerunFailingTestsCount configured rerun count for failing tests
* @return the type of test result
*/
// Use default visibility for testing
static TestResultType getTestResultType( List<ReportEntryType> reportEntries, int rerunFailingTestsCount )
{
if ( reportEntries == null || reportEntries.isEmpty() )
{
return unknown;
}
boolean seenSuccess = false, seenFailure = false, seenError = false;
for ( ReportEntryType resultType : reportEntries )
{
if ( resultType == SUCCESS )
{
seenSuccess = true;
}
else if ( resultType == FAILURE )
{
seenFailure = true;
}
else if ( resultType == ERROR )
{
seenError = true;
}
}
if ( seenFailure || seenError )
{
if ( seenSuccess && rerunFailingTestsCount > 0 )
{
return flake;
}
else
{
return seenError ? error : failure;
}
}
else if ( seenSuccess )
{
return success;
}
else
{
return skipped;
}
}
/**
* Merge all the TestMethodStats in each TestRunListeners and put results into flakyTests, failedTests and
* errorTests, indexed by test class and method name. Update globalStatistics based on the result of the merge.
*/
private void mergeTestHistoryResult()
{
globalStats = new RunStatistics();
flakyTests = new TreeMap<>();
failedTests = new TreeMap<>();
errorTests = new TreeMap<>();
Map<String, List<TestMethodStats>> mergedTestHistoryResult = new HashMap<>();
// Merge all the stats for tests from listeners
for ( TestSetRunListener listener : listeners )
{
for ( TestMethodStats methodStats : listener.getTestMethodStats() )
{
List<TestMethodStats> currentMethodStats =
mergedTestHistoryResult.get( methodStats.getTestClassMethodName() );
if ( currentMethodStats == null )
{
currentMethodStats = new ArrayList<>();
currentMethodStats.add( methodStats );
mergedTestHistoryResult.put( methodStats.getTestClassMethodName(), currentMethodStats );
}
else
{
currentMethodStats.add( methodStats );
}
}
}
// Update globalStatistics by iterating through mergedTestHistoryResult
int completedCount = 0, skipped = 0;
for ( Map.Entry<String, List<TestMethodStats>> entry : mergedTestHistoryResult.entrySet() )
{
List<TestMethodStats> testMethodStats = entry.getValue();
String testClassMethodName = entry.getKey();
completedCount++;
List<ReportEntryType> resultTypes = new ArrayList<>();
for ( TestMethodStats methodStats : testMethodStats )
{
resultTypes.add( methodStats.getResultType() );
}
switch ( getTestResultType( resultTypes, reportConfiguration.getRerunFailingTestsCount() ) )
{
case success:
// If there are multiple successful runs of the same test, count all of them
int successCount = 0;
for ( ReportEntryType type : resultTypes )
{
if ( type == SUCCESS )
{
successCount++;
}
}
completedCount += successCount - 1;
break;
case skipped:
skipped++;
break;
case flake:
flakyTests.put( testClassMethodName, testMethodStats );
break;
case failure:
failedTests.put( testClassMethodName, testMethodStats );
break;
case error:
errorTests.put( testClassMethodName, testMethodStats );
break;
default:
throw new IllegalStateException( "Get unknown test result type" );
}
}
globalStats.set( completedCount, errorTests.size(), failedTests.size(), skipped, flakyTests.size() );
}
/**
* Print failed tests and flaked tests. A test is considered as a failed test if it failed/got an error with
* all the runs. If a test passes in ever of the reruns, it will be count as a flaked test
*
* @param type the type of results to be printed, could be error, failure or flake
* @return {@code true} if printed some lines
*/
// Use default visibility for testing
boolean printTestFailures( TestResultType type )
{
final Map<String, List<TestMethodStats>> testStats;
final Level level;
switch ( type )
{
case failure:
testStats = failedTests;
level = Level.FAILURE;
break;
case error:
testStats = errorTests;
level = Level.FAILURE;
break;
case flake:
testStats = flakyTests;
level = Level.UNSTABLE;
break;
default:
return false;
}
boolean printed = false;
if ( !testStats.isEmpty() )
{
log( type.getLogPrefix(), level );
printed = true;
}
for ( Map.Entry<String, List<TestMethodStats>> entry : testStats.entrySet() )
{
List<TestMethodStats> testMethodStats = entry.getValue();
if ( testMethodStats.size() == 1 )
{
// No rerun, follow the original output format
failure( " " + testMethodStats.get( 0 ).getStackTraceWriter().smartTrimmedStackTrace() );
}
else
{
log( entry.getKey(), level );
for ( int i = 0; i < testMethodStats.size(); i++ )
{
StackTraceWriter failureStackTrace = testMethodStats.get( i ).getStackTraceWriter();
if ( failureStackTrace == null )
{
success( " Run " + ( i + 1 ) + ": PASS" );
}
else
{
failure( " Run " + ( i + 1 ) + ": " + failureStackTrace.smartTrimmedStackTrace() );
}
}
log( "" );
}
}
return printed;
}
// Describe the result of a given test
enum TestResultType
{
error( "Errors: " ),
failure( "Failures: " ),
flake( "Flakes: " ),
success( "Success: " ),
skipped( "Skipped: " ),
unknown( "Unknown: " );
private final String logPrefix;
TestResultType( String logPrefix )
{
this.logPrefix = logPrefix;
}
public String getLogPrefix()
{
return logPrefix;
}
}
private void log( String s, boolean success, boolean failures, boolean errors, boolean skipped, boolean flakes )
{
Level level = resolveLevel( success, failures, errors, skipped, flakes );
log( s, level );
}
private void log( String s, Level level )
{
switch ( level )
{
case FAILURE:
failure( s );
break;
case UNSTABLE:
warning( s );
break;
case SUCCESS:
success( s );
break;
default:
info( s );
}
}
private void log( String s )
{
consoleLogger.info( s );
}
private void info( String s )
{
MessageBuilder builder = buffer();
consoleLogger.info( builder.a( s ).toString() );
}
private void warning( String s )
{
MessageBuilder builder = buffer();
consoleLogger.warning( builder.warning( s ).toString() );
}
private void success( String s )
{
MessageBuilder builder = buffer();
consoleLogger.info( builder.success( s ).toString() );
}
private void failure( String s )
{
MessageBuilder builder = buffer();
consoleLogger.error( builder.failure( s ).toString() );
}
}