net.thucydides.core.reports

Class ReportService

java.lang.Object

net.thucydides.core.reports.ReportService

public class ReportService
extends java.lang.Object

Generates different Thucydides reports in a given output directory.

Constructor Summary

Constructors

Constructor and Description
ReportService(Configuration configuration)
ReportService(java.io.File outputDirectory, java.util.Collection<AcceptanceTestReporter> subscribedReporters)
ReportService(java.io.File outputDirectory, java.util.Collection<AcceptanceTestReporter> subscribedReporters, java.util.Collection<AcceptanceTestFullReporter> subscribedFullReporters, EnvironmentVariables environmentVariables) Reports are generated using the test results in a given directory.
ReportService(java.io.File outputDirectory, java.util.Collection<AcceptanceTestReporter> subscribedReporters, EnvironmentVariables environmentVariables)

Method Summary

Modifier and Type	Method and Description
void	generateConfigurationsReport() Store some configuration properties under output directory
void	generateReportsFor(java.util.List<TestOutcome> testOutcomeResults) A test runner can generate reports via Reporter instances that subscribe to the test runner.
static java.util.List<AcceptanceTestFullReporter>	getDefaultFullReporters() The default reporters applicable for standard test runs.
static java.util.List<AcceptanceTestReporter>	getDefaultReporters() The default reporters applicable for standard test runs.
java.util.List<AcceptanceTestFullReporter>	getSubscribedFullReporters()
java.util.List<AcceptanceTestReporter>	getSubscribedReporters()
void	setOutputDirectory(java.io.File outputDirectory)
void	subscribe(AcceptanceTestReporter reporter)
void	useQualifier(java.lang.String qualifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportService

@Inject
public ReportService(Configuration configuration)

ReportService

public ReportService(java.io.File outputDirectory,
                     java.util.Collection<AcceptanceTestReporter> subscribedReporters)

ReportService

public ReportService(java.io.File outputDirectory,
                     java.util.Collection<AcceptanceTestReporter> subscribedReporters,
                     EnvironmentVariables environmentVariables)

ReportService

public ReportService(java.io.File outputDirectory,
                     java.util.Collection<AcceptanceTestReporter> subscribedReporters,
                     java.util.Collection<AcceptanceTestFullReporter> subscribedFullReporters,
                     EnvironmentVariables environmentVariables)

Reports are generated using the test results in a given directory. The actual reports are generated using a set of reporter objects. The report service passes test outcomes to the reporter objects, which generate different types of reports.

Parameters:

outputDirectory - Where the test data is stored, and where the generated reports will go.

subscribedReporters - A set of reporters that generate the actual reports.

Method Detail

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

getSubscribedReporters

public java.util.List<AcceptanceTestReporter> getSubscribedReporters()

getSubscribedFullReporters

public java.util.List<AcceptanceTestFullReporter> getSubscribedFullReporters()

subscribe

public void subscribe(AcceptanceTestReporter reporter)

useQualifier

public void useQualifier(java.lang.String qualifier)

generateReportsFor

public void generateReportsFor(java.util.List<TestOutcome> testOutcomeResults)

A test runner can generate reports via Reporter instances that subscribe to the test runner. The test runner tells the reporter what directory to place the reports in. Then, at the end of the test, the test runner notifies these reporters of the test outcomes. The reporter's job is to process each test run outcome and do whatever is appropriate.

Parameters:

testOutcomeResults - A list of test outcomes to use in report generation. These may be stored in memory (e.g. by a Listener instance) or read from the XML test results.

generateConfigurationsReport

public void generateConfigurationsReport()

Store some configuration properties under output directory

getDefaultReporters

public static java.util.List<AcceptanceTestReporter> getDefaultReporters()

The default reporters applicable for standard test runs.

getDefaultFullReporters

public static java.util.List<AcceptanceTestFullReporter> getDefaultFullReporters()

The default reporters applicable for standard test runs.