com.relevantcodes.extentreports

Class ExtentReports

java.lang.Object

com.relevantcodes.extentreports.ExtentReports

public class ExtentReports
extends Object

Author:

Anshoo

Constructor Summary

Constructors

Constructor and Description
ExtentReports(String filePath, Boolean replaceExisting) Initializes the reporting by setting the file-path
ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder) Initializes the reporting by setting the file-path and test 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
void	close() Closes the underlying stream and clears all resources 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.
com.relevantcodes.extentreports.ReportInstance.ReportConfig	config() Allows various configurations to be applied to the report file
void	endTest(ExtentTest test) Ends the current toggle level
void	flush() Writes all info to the report file
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentReports

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

Initializes the reporting by setting the file-path and test 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

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)

Initializes the reporting by setting the file-path

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

Method Detail

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:

ExtentTest

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:

ExtentTest

endTest

public void endTest(ExtentTest test)

Ends the current toggle level

Parameters:

test - ExtentTest

config

public com.relevantcodes.extentreports.ReportInstance.ReportConfig config()

Allows various configurations to be applied to the report file

Returns:

ReportInstance.ReportConfig

addSystemInfo

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

Add system information to the SystemInfo view

Parameters:

info - SystemInfo values as Key-Value pairs

Returns:

ExtentReports

addSystemInfo

public ExtentReports addSystemInfo(String param,
                                   String value)

Add system information to the SystemInfo view

Parameters:

param - Name of system parameter

value - Value

Returns:

ExtentReports

flush

public void flush()

Writes all info to the report file

close

public void close()

Closes the underlying stream and clears all resources

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.