com.aventstack.extentreports

Class ExtentReports

java.lang.Object

com.aventstack.extentreports.ExtentReports

All Implemented Interfaces:

IReport

public class ExtentReports
extends java.lang.Object

The ExtentReports report client for starting reporters and building reports. For most applications, you should have one ExtentReports instance for the entire JVM.

ExtentReports itself does not build any reports, but allows reporters to access information, which in turn build the said reports. An example of building an HTML report and adding information to ExtentX:

 ExtentHtmlReporter html = new ExtentHtmlReporter("Extent.html");
 ExtentXReporter extentx = new ExtentXReporter("localhost");
 
 ExtentReports extent = new ExtentReports();
 extent.attachReporter(html, extentx);
 
 extent.createTest("TestName").pass("Test Passed");
 
 extent.flush();
 

A few notes:

• It is mandatory to call the flush method to ensure information is written to the started reporters.
• You can create standard and BDD-style tests using the createTest method

See Also:

ExtentTest, GherkinKeyword, IGherkinFormatterModel, Status

Constructor Summary

Constructors

Constructor and Description
ExtentReports()

Method Summary

Modifier and Type	Method and Description
void	attachReporter(ExtentReporter... reporter) Attach a ExtentReporter reporter, allowing it to access all started tests, nodes and logs
ReportConfigurator	config() Provides common report configurations
ExtentTest	createTest(java.lang.Class<? extends IGherkinFormatterModel> type, java.lang.String testName) Creates a BDD-style test representing one of the IGherkinFormatterModel classes such as: Feature Background Scenario Given When Then And
ExtentTest	createTest(java.lang.Class<? extends IGherkinFormatterModel> type, java.lang.String testName, java.lang.String description) Creates a BDD-style test with description representing one of the IGherkinFormatterModel classes such as: Feature Background Scenario Given When Then And
ExtentTest	createTest(GherkinKeyword gherkinKeyword, java.lang.String testName) Creates a BDD-style test using name of the Gherkin model such as: Feature Background Scenario Given When Then And
ExtentTest	createTest(GherkinKeyword gherkinKeyword, java.lang.String testName, java.lang.String description) Creates a BDD-style test with description using name of the Gherkin model such as: Feature Background Scenario Given When Then And
ExtentTest	createTest(java.lang.String testName) Creates a test
ExtentTest	createTest(java.lang.String testName, java.lang.String description) Creates a test with description
void	detachReporter(ExtentReporter... reporter) Detach a ExtentReporter reporter from the collection of started reporters.
void	flush() Writes test information from the started reporters to their output view ExtentHtmlReporter - creates or appends to an HTML file ExtentXReporter - updates database ExtentEmailReporter - creates or appends to an HTML file ExtentLogger - no action taken
TestDisplayOrder	getTestDisplayOrder() Gets the order in which tests are displayed in the report.
void	setReportUsesManualConfiguration(boolean b) Use this setting when building post-execution reports, such as from TestNG IReporter
void	setSystemInfo(java.lang.String k, java.lang.String v) Adds any applicable system information to all started reporters
void	setTestDisplayOrder(TestDisplayOrder order) Sets the order in which tests are displayed in the report.
void	setTestRunnerOutput(java.util.List<java.lang.String> log) Adds logs from test framework tools to the test-runner logs view (if available in the reporter)
void	setTestRunnerOutput(java.lang.String log) Adds logs from test framework tools to the test-runner logs view (if available in the reporter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentReports

public ExtentReports()

Method Detail

attachReporter

public void attachReporter(ExtentReporter... reporter)

Attach a ExtentReporter reporter, allowing it to access all started tests, nodes and logs

Available reporter types are:

• com.aventstack.extentreports.gherkin.model.ExtentHtmlReporter
• com.aventstack.extentreports.gherkin.model.ExtentEmailReporter
• com.aventstack.extentreports.gherkin.model.ExtentXReporter
• com.aventstack.extentreports.gherkin.model.ExtentLogger

Parameters:

reporter - ExtentReporter reporter

detachReporter

public void detachReporter(ExtentReporter... reporter)

Detach a ExtentReporter reporter from the collection of started reporters. Calling this method will stop any additional tests added to the reporter.

Available reporter types are:

• com.aventstack.extentreports.gherkin.model.ExtentHtmlReporter
• com.aventstack.extentreports.gherkin.model.ExtentEmailReporter
• com.aventstack.extentreports.gherkin.model.ExtentXReporter
• com.aventstack.extentreports.gherkin.model.ExtentLogger

Parameters:

reporter - ExtentReporter reporter

createTest

public ExtentTest createTest(java.lang.Class<? extends IGherkinFormatterModel> type,
                             java.lang.String testName,
                             java.lang.String description)

Creates a BDD-style test with description representing one of the IGherkinFormatterModel classes such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 extent.createTest(Feature.class, "bddTest", "description");
 

Note: BDD styling is not available on ExtentX server. Your tests will show as regular nodes 2 levels deep.

Parameters:

type - A IGherkinFormatterModel type

testName - Name of test

description - A short description of the test

Returns:

ExtentTest object

createTest

public ExtentTest createTest(java.lang.Class<? extends IGherkinFormatterModel> type,
                             java.lang.String testName)

Creates a BDD-style test representing one of the IGherkinFormatterModel classes such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 extent.createTest(Feature.class, "bddTest");
 

Note: BDD styling is not available on ExtentX server. Your tests will show as regular nodes 2 levels deep.

Parameters:

type - A IGherkinFormatterModel type

testName - Name of test

Returns:

ExtentTest object

createTest

public ExtentTest createTest(GherkinKeyword gherkinKeyword,
                             java.lang.String testName,
                             java.lang.String description)

Creates a BDD-style test with description using name of the Gherkin model such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 extent.createTest(new GherkinKeyword("Feature"), "bddTest", "description");
 

Note: BDD styling is not available on ExtentX server. Your tests will show as regular nodes 2 levels deep.

Parameters:

gherkinKeyword - Name of the GherkinKeyword

testName - Name of test

description - A short description of the test

Returns:

ExtentTest object

createTest

public ExtentTest createTest(GherkinKeyword gherkinKeyword,
                             java.lang.String testName)

Creates a BDD-style test using name of the Gherkin model such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 extent.createTest(new GherkinKeyword("Feature"), "bddTest", "description");
 

Note: BDD styling is not available on ExtentX server. Your tests will show as regular nodes 2 levels deep.

Parameters:

gherkinKeyword - Name of the GherkinKeyword

testName - Name of test

Returns:

ExtentTest object

createTest

public ExtentTest createTest(java.lang.String testName,
                             java.lang.String description)

Creates a test with description

Parameters:

testName - Name of test

description - A short test description

Returns:

ExtentTest object

createTest

public ExtentTest createTest(java.lang.String testName)

Creates a test

Parameters:

testName - Name of test

Returns:

ExtentTest object

flush

public void flush()

Writes test information from the started reporters to their output view

• ExtentHtmlReporter - creates or appends to an HTML file
• ExtentXReporter - updates database
• ExtentEmailReporter - creates or appends to an HTML file
• ExtentLogger - no action taken

setTestDisplayOrder

public void setTestDisplayOrder(TestDisplayOrder order)

Sets the order in which tests are displayed in the report. Note: this setting applies globally to all started reporters.

Parameters:

order - TestDisplayOrder

getTestDisplayOrder

public TestDisplayOrder getTestDisplayOrder()

Gets the order in which tests are displayed in the report.

Returns:

TestDisplayOrder

setSystemInfo

public void setSystemInfo(java.lang.String k,
                          java.lang.String v)

Adds any applicable system information to all started reporters

Example:

 extent.setSystemInfo("HostName", "AventStack-PC");
 

Parameters:

k - Name of system variable

v - Value of system variable

setTestRunnerOutput

public void setTestRunnerOutput(java.util.List<java.lang.String> log)

Adds logs from test framework tools to the test-runner logs view (if available in the reporter)

Parameters:

log - Log string from the test runner frameworks such as TestNG or JUnit

setTestRunnerOutput

public void setTestRunnerOutput(java.lang.String log)

Adds logs from test framework tools to the test-runner logs view (if available in the reporter)

Parameters:

log - Log string from the test runner frameworks such as TestNG or JUnit

setReportUsesManualConfiguration

public void setReportUsesManualConfiguration(boolean b)

Use this setting when building post-execution reports, such as from TestNG IReporter

Parameters:

b - Set to true if building reports at the end of execution with manual configuration

config

public ReportConfigurator config()

Provides common report configurations

Returns:

A ReportConfigurator object