com.relevantcodes.extentreports

Class ExtentReports

java.lang.Object

com.relevantcodes.extentreports.LogSettings

com.relevantcodes.extentreports.ExtentReports

public class ExtentReports
extends LogSettings

Field Summary

Fields

Modifier and Type	Field and Description
protected File	configFile
protected SuiteTimeInfo	suiteTimeInfo
protected com.relevantcodes.extentreports.SystemInfo	systemInfo
protected List<ExtentTest>	testList

Constructor Summary

Constructors

Constructor and Description
ExtentReports(String filePath) Initializes Extent HTML report Default setting (true) is used for replaceExisting Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder Default setting NetworkMode.ONLINE for NetworkMode is used
ExtentReports(String filePath, Boolean replaceExisting) Initializes Extent HTML report Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder Default setting NetworkMode.ONLINE for NetworkMode is used
ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder) Initializes Extent HTML report Default setting NetworkMode.ONLINE for NetworkMode is used
ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder, NetworkMode networkMode) Initializes Extent HTML report
ExtentReports(String filePath, Boolean replaceExisting, NetworkMode networkMode) Initializes Extent HTML report Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder
ExtentReports(String filePath, NetworkMode networkMode) Initializes Extent HTML report Default setting (true) is used for replaceExisting Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder

Method Summary

Modifier and Type	Method and Description
ExtentReports	addSystemInfo(Map<String,String> info) Add system information to the SystemInfo view
ExtentReports	addSystemInfo(String param, String value) Add system information to the SystemInfo view
protected void	addTest(Test test)
protected void	attach(IReporter reporter)
void	close() Closes the underlying stream and clears all resources
HTMLReporter.Config	config() Deprecated.
protected void	detach(IReporter reporter)
void	endTest(ExtentTest extentTest) Ends and prepares the test to be added to the report on flush()
void	flush() Appends the HTML file with all the ended tests.
protected Map<String,List<Test>>	getCategoryTestMap()
protected Map<String,String>	getConfigurationMap()
protected DisplayOrder	getDisplayOrder()
protected String	getFilePath()
protected UUID	getId()
protected List<LogStatus>	getLogStatusList()
protected NetworkMode	getNetworkMode()
protected Boolean	getReplaceExisting()
protected String	getRunDuration()
protected Date	getStartedTime()
protected LogStatus	getStatus()
protected SuiteTimeInfo	getSuiteTimeInfo()
protected com.relevantcodes.extentreports.SystemInfo	getSystemInfo()
protected Map<String,String>	getSystemInfoMap()
protected Test	getTest()
protected List<ExtentTest>	getTestList()
protected List<String>	getTestRunnerLogList()
void	loadConfig(Class clazz, String fileName) Allows performing configuration and customization to the HTML report from local resource
void	loadConfig(Class clazz, String basePackagePath, String fileName) Allows performing configuration and customization to the HTML report from local resource.
protected void	loadConfig(Configuration config)
void	loadConfig(File configFile) Allows performing configuration and customization to the HTML report from configuration external file
void	loadConfig(URL url) Allows performing configuration and customization to the HTML report from URL resource
protected void	setDisplayOrder(DisplayOrder displayOrder)
protected void	setFilePath(String filePath)
protected void	setNetworkMode(NetworkMode networkMode)
protected void	setReplaceExisting(Boolean replaceExisting)
protected void	setStartedTime(long startTime)
protected void	setTestRunnerLogs(String logs)
void	setTestRunnerOutput(String log) Adds logs from test framework tools such as TestNG
ExtentReports	startReporter(ReporterType reporterType, String filePath) Starts a custom reporter based upon ReporterType.
ExtentTest	startTest(String testName) Calling startTest() generates a toggle for the test in the HTML file and adds all log events under this level.
ExtentTest	startTest(String testName, String description) Calling startTest() generates a toggle for the test in the HTML file and adds all log events under this level.
protected void	terminate()
protected void	updateTestStatusList(Test test)

Methods inherited from class com.relevantcodes.extentreports.LogSettings

getLogDateFormat, getLogDateTimeFormat, getLogTimeFormat, getLongDateTimeFormat

Methods inherited from class java.lang.Object

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

Field Detail

suiteTimeInfo

protected SuiteTimeInfo suiteTimeInfo

systemInfo

protected com.relevantcodes.extentreports.SystemInfo systemInfo

testList

protected List<ExtentTest> testList

configFile

protected File configFile

Constructor Detail

ExtentReports

public ExtentReports(String filePath,
                     Boolean replaceExisting,
                     DisplayOrder displayOrder,
                     NetworkMode networkMode)

Initializes Extent HTML report

Parameters:

filePath - Path of the file, in .htm or .html format

replaceExisting - Setting to overwrite (TRUE) the existing file or append (FALSE) to it

• true - the file will be replaced with brand new markup, and all existing data will be lost. Use this option to create a brand new report
• false - existing data will remain, new tests will be appended to the existing report. If the the supplied path does not exist, a new file will be created.

displayOrder - Determines the order in which your tests will be displayed

• OLDEST_FIRST (default) - oldest test at the top, newest at the end
• NEWEST_FIRST - newest test at the top, oldest at the end

networkMode -

• ONLINE - creates a single report file with all artifacts
• OFFLINE - all report artifacts will be stored locally in %reportFolder%/extentreports with the following structure:
  - extentreports/css
  - extentreports/js

ExtentReports

public ExtentReports(String filePath,
                     Boolean replaceExisting,
                     DisplayOrder displayOrder)

Initializes Extent HTML report

• Default setting NetworkMode.ONLINE for NetworkMode is used

Parameters:

filePath - Path of the file, in .htm or .html format

replaceExisting - Setting to overwrite (TRUE) the existing file or append (FALSE) to it

• true - the file will be replaced with brand new markup, and all existing data will be lost. Use this option to create a brand new report
• false - existing data will remain, new tests will be appended to the existing report. If the the supplied path does not exist, a new file will be created.

displayOrder - Determines the order in which your tests will be displayed

• OLDEST_FIRST (default) - oldest test at the top, newest at the end
• NEWEST_FIRST - newest test at the top, oldest at the end

ExtentReports

public ExtentReports(String filePath,
                     Boolean replaceExisting,
                     NetworkMode networkMode)

Initializes Extent HTML report

• Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder

Parameters:

filePath - Path of the file, in .htm or .html format

replaceExisting - Setting to overwrite (TRUE) the existing file or append (FALSE) to it

• true - the file will be replaced with brand new markup, and all existing data will be lost. Use this option to create a brand new report
• false - existing data will remain, new tests will be appended to the existing report. If the the supplied path does not exist, a new file will be created.

networkMode -

• ONLINE - creates a single report file with all artifacts
• OFFLINE - all report artifacts will be stored locally in %reportFolder%/extentreports with the following structure:
  - extentreports/css
  - extentreports/js

ExtentReports

public ExtentReports(String filePath,
                     NetworkMode networkMode)

Initializes Extent HTML report

• Default setting (true) is used for replaceExisting
• Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder

Parameters:

filePath - Path of the file, in .htm or .html format

networkMode -

• ONLINE - creates a single report file with all artifacts
• OFFLINE - all report artifacts will be stored locally in %reportFolder%/extentreports with the following structure:
  - extentreports/css
  - extentreports/js

ExtentReports

public ExtentReports(String filePath,
                     Boolean replaceExisting)

Initializes Extent HTML report

• Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder
• Default setting NetworkMode.ONLINE for NetworkMode is used

Parameters:

filePath - Path of the file, in .htm or .html format

replaceExisting - Setting to overwrite (TRUE) the existing file or append (FALSE) to it

• true - the file will be replaced with brand new markup, and all existing data will be lost. Use this option to create a brand new report
• false - existing data will remain, new tests will be appended to the existing report. If the the supplied path does not exist, a new file will be created.

ExtentReports

public ExtentReports(String filePath)

Initializes Extent HTML report

• Default setting (true) is used for replaceExisting
• Default setting DisplayOrder.OLDEST_FIRST is used for DisplayOrder
• Default setting NetworkMode.ONLINE for NetworkMode is used

Parameters:

filePath - Path of the file, in .htm or .html format

Method Detail

loadConfig

public void loadConfig(File configFile)

Allows performing configuration and customization to the HTML report from configuration external file

Parameters:

configFile - Config file (extent-config.xml)

loadConfig

public void loadConfig(URL url)

Allows performing configuration and customization to the HTML report from URL resource

Parameters:

url - URL pointer to the resource file

loadConfig

public void loadConfig(Class clazz,
                       String fileName)

Allows performing configuration and customization to the HTML report from local resource

Parameters:

clazz - The class relative to which the configuration file will be loaded

fileName - Name of the file from the clazz package

loadConfig

public void loadConfig(Class clazz,
                       String basePackagePath,
                       String fileName)

Allows performing configuration and customization to the HTML report from local resource.

Example: Sonsider the following clazz, basePackagePath and fileName:

• clazz : "com/relevantcodes/extentreports/ExtentReports.class"
• basePackagePath : "resources"
• fileName : "extent-config.xml"

The above inputs will build the final path as: "com/relevantcodes/extentreports/resources/extent-config.xml"

Parameters:

clazz - The class relative to which the configuration file will be loaded

basePackagePath - The package that contains the configuration file. The basePackagePath is relative to the clazz

fileName - Name of the file from the clazz package

startReporter

public ExtentReports startReporter(ReporterType reporterType,
                                   String filePath)

Starts a custom reporter based upon ReporterType. The file extension determines if the reporter-type will be started.

For ReporterType the extension must be .db

Parameters:

reporterType - ReporterType Type of the reporter to be initialized

filePath - Path of the report source, with the correct extension for the reporter

Returns:

An ExtentReports object

startTest

public ExtentTest startTest(String testName)

Calling startTest() generates a toggle for the test in the HTML file and adds all log events under this level. This is a required step and without calling this method the toggle will not be created for the test and log will not be added.

Parameters:

testName - Name of the test

Returns:

An ExtentTest object

startTest

public ExtentTest startTest(String testName,
                            String description)

Calling startTest() generates a toggle for the test in the HTML file and adds all log events under this level. This is a required step and without calling this method the toggle will not be created for the test and log will not be added.

Parameters:

testName - Name of the test

description - A short description of the test

Returns:

An ExtentTest object

endTest

public void endTest(ExtentTest extentTest)

Ends and prepares the test to be added to the report on flush()

If ReporterType.DB is used, a row in the TEST table is created

Parameters:

extentTest - An ExtentTest object

addSystemInfo

public ExtentReports addSystemInfo(Map<String,String> info)

Add system information to the SystemInfo view

Parameters:

info - SystemInfo values as Key-Value pairs

Returns:

An ExtentReports object

addSystemInfo

public ExtentReports addSystemInfo(String param,
                                   String value)

Add system information to the SystemInfo view

Parameters:

param - Name of system parameter

value - Value of system parameter

Returns:

An ExtentReports object

setTestRunnerOutput

public void setTestRunnerOutput(String log)

Adds logs from test framework tools such as TestNG

Parameters:

log - Log string from the TestRunner

flush

public void flush()

Appends the HTML file with all the ended tests. There must be at least 1 ended test for anything to be appended to the report.

Note: If flush() is called before any of the ended tests, no information will be appended.

Note: If flush() is called while the test is running (not yet ended), it will not be appended to the report.

close

public void close()

Closes the underlying stream and clears all resources

Once close is called, additional information will not be sent to the report. Any attempt to flush() will result in a IOException.

If any of your test ended abruptly causing any side-affects (not all logs sent to ExtentReports, information missing), this method will ensure that the test is still appended to the report with a warning message.

config

@Deprecated
public HTMLReporter.Config config()

Deprecated.

This method is deprecated and replace with an external configuration file. For more information, visit this link: extentreports.relevantcodes.com/java/version2/docs.html#configuration

Returns:

HTMLReporter.Config object

getTestList

protected List<ExtentTest> getTestList()

getLogStatusList

protected List<LogStatus> getLogStatusList()

getStartedTime

protected Date getStartedTime()

getRunDuration

protected String getRunDuration()

getTestRunnerLogList

protected List<String> getTestRunnerLogList()

getConfigurationMap

protected Map<String,String> getConfigurationMap()

getCategoryTestMap

protected Map<String,List<Test>> getCategoryTestMap()

getSystemInfo

protected com.relevantcodes.extentreports.SystemInfo getSystemInfo()

getSystemInfoMap

protected Map<String,String> getSystemInfoMap()

attach

protected void attach(IReporter reporter)

detach

protected void detach(IReporter reporter)

addTest

protected void addTest(Test test)

updateTestStatusList

protected void updateTestStatusList(Test test)

terminate

protected void terminate()

loadConfig

protected void loadConfig(Configuration config)

setTestRunnerLogs

protected void setTestRunnerLogs(String logs)

getTest

protected Test getTest()

setFilePath

protected void setFilePath(String filePath)

getFilePath

protected String getFilePath()

setReplaceExisting

protected void setReplaceExisting(Boolean replaceExisting)

getReplaceExisting

protected Boolean getReplaceExisting()

setDisplayOrder

protected void setDisplayOrder(DisplayOrder displayOrder)

getDisplayOrder

protected DisplayOrder getDisplayOrder()

setNetworkMode

protected void setNetworkMode(NetworkMode networkMode)

getNetworkMode

protected NetworkMode getNetworkMode()

getId

protected UUID getId()

getStatus

protected LogStatus getStatus()

getSuiteTimeInfo

protected SuiteTimeInfo getSuiteTimeInfo()

setStartedTime

protected void setStartedTime(long startTime)