Package org.apache.maven.plugin.surefire.report

Class DefaultReporterFactory

java.lang.Object

org.apache.maven.plugin.surefire.report.DefaultReporterFactory

All Implemented Interfaces:

ReportsMerger, ReporterFactory

public class DefaultReporterFactory
extends Object
implements ReporterFactory, ReportsMerger

Provides reporting modules on the plugin side.
Keeps a centralized count of test run results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	DefaultReporterFactory.TestResultType

Field Summary

Fields

Modifier and Type	Field	Description
private final ConsoleLogger	consoleLogger
private Map<String,List<TestMethodStats>>	errorTests
private Map<String,List<TestMethodStats>>	failedTests
private Map<String,List<TestMethodStats>>	flakyTests
private final Integer	forkNumber
private RunStatistics	globalStats
private final Collection<TestSetRunListener>	listeners
private final StartupReportConfiguration	reportConfiguration

Constructor Summary

Constructors

Constructor	Description
DefaultReporterFactory(StartupReportConfiguration reportConfiguration, ConsoleLogger consoleLogger)
DefaultReporterFactory(StartupReportConfiguration reportConfiguration, ConsoleLogger consoleLogger, Integer forkNumber)

Method Summary

Modifier and Type	Method	Description
(package private) final void	addListener(TestSetRunListener listener)
RunResult	close()	Closes the factory, freeing resources allocated in the factory.
private ConsoleOutputReportEventListener	createConsoleOutputReceiver()
private StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry,TestSetStats>	createConsoleReporter()
private StatelessTestsetInfoFileReportEventListener<WrappedReportEntry,TestSetStats>	createFileReporter()
private StatelessReportEventListener<WrappedReportEntry,TestSetStats>	createSimpleXMLReporter()
private StatisticsReporter	createStatisticsReporter()
TestReportListener<TestOutputReportEntry>	createTestReportListener()	Creates a reporter listener.
private void	failure(String s)
RunStatistics	getGlobalRunStatistics()
File	getReportsDirectory()
(package private) static DefaultReporterFactory.TestResultType	getTestResultType(List<ReportEntryType> reportEntries, int rerunFailingTestsCount)	Get the result of a test based on all its runs.
private void	info(String s)
private void	log(String s)
private void	log(String s, boolean success, boolean failures, boolean errors, boolean skipped, boolean flakes)
private void	log(String s, Level level)
void	mergeFromOtherFactories(Collection<DefaultReporterFactory> factories)
private void	mergeTestHistoryResult()	Merge all the TestMethodStats in each TestRunListeners and put results into flakyTests, failedTests and errorTests, indexed by test class and method name.
(package private) boolean	printTestFailures(DefaultReporterFactory.TestResultType type)	Print failed tests and flaked tests.
private void	runCompleted()
void	runStarting()
private void	success(String s)
private void	warning(String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

listeners

private final Collection<TestSetRunListener> listeners

reportConfiguration

private final StartupReportConfiguration reportConfiguration

consoleLogger

private final ConsoleLogger consoleLogger

forkNumber

private final Integer forkNumber

globalStats

private RunStatistics globalStats

flakyTests

private Map<String,List<TestMethodStats>> flakyTests

failedTests

private Map<String,List<TestMethodStats>> failedTests

errorTests

private Map<String,List<TestMethodStats>> errorTests

Constructor Details

DefaultReporterFactory

public DefaultReporterFactory(StartupReportConfiguration reportConfiguration,
 ConsoleLogger consoleLogger)

DefaultReporterFactory

public DefaultReporterFactory(StartupReportConfiguration reportConfiguration,
 ConsoleLogger consoleLogger,
 Integer forkNumber)

Method Details

createTestReportListener

public TestReportListener<TestOutputReportEntry> createTestReportListener()

Description copied from interface: ReporterFactory

Creates a reporter listener.

Specified by:

createTestReportListener in interface ReporterFactory

Returns:

new reporter listener instance

getReportsDirectory

public File getReportsDirectory()

Specified by:

getReportsDirectory in interface ReportsMerger

createConsoleReporter

private StatelessTestsetInfoConsoleReportEventListener<WrappedReportEntry,TestSetStats> createConsoleReporter()

createFileReporter

private StatelessTestsetInfoFileReportEventListener<WrappedReportEntry,TestSetStats> createFileReporter()

createSimpleXMLReporter

private StatelessReportEventListener<WrappedReportEntry,TestSetStats> createSimpleXMLReporter()

createConsoleOutputReceiver

private ConsoleOutputReportEventListener createConsoleOutputReceiver()

createStatisticsReporter

private StatisticsReporter createStatisticsReporter()

mergeFromOtherFactories

public void mergeFromOtherFactories(Collection<DefaultReporterFactory> factories)

Specified by:

mergeFromOtherFactories in interface ReportsMerger

addListener

final void addListener(TestSetRunListener listener)

close

public RunResult close()

Description copied from interface: ReporterFactory

Closes the factory, freeing resources allocated in the factory.

Specified by:

close in interface ReporterFactory

Specified by:

close in interface ReportsMerger

Returns:

The run result

runStarting

public void runStarting()

Specified by:

runStarting in interface ReportsMerger

runCompleted

private void runCompleted()

getGlobalRunStatistics

public RunStatistics getGlobalRunStatistics()

getTestResultType

static DefaultReporterFactory.TestResultType getTestResultType(List<ReportEntryType> reportEntries,
 int rerunFailingTestsCount)

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

Parameters:

reportEntries - the list of test run report type for a given test

rerunFailingTestsCount - configured rerun count for failing tests

Returns:

the type of test result

mergeTestHistoryResult

private void mergeTestHistoryResult()

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.

printTestFailures

boolean printTestFailures(DefaultReporterFactory.TestResultType type)

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

Parameters:

type - the type of results to be printed, could be error, failure or flake

Returns:

true if printed some lines

log

private void log(String s,
 boolean success,
 boolean failures,
 boolean errors,
 boolean skipped,
 boolean flakes)

log

private void log(String s,
 Level level)

log

private void log(String s)

info

private void info(String s)

warning

private void warning(String s)

success

private void success(String s)

failure

private void failure(String s)