com.relevantcodes.extentreports

Class ExtentReports

java.lang.Object

com.relevantcodes.extentreports.ExtentReports

public class ExtentReports
extends Object

ExtentReports (by Anshoo Arora) is a HTML reporting library for Selenium WebDriver for Java which is extremely easy to use and creates beautiful execution reports. It shows test and step summary, test steps and status in a toggle view for quick analysis

Project URL: http://relevantcodes.com/extentreports-for-selenium/

Author:

Anshoo Arora

Constructor Summary

Constructors

Constructor and Description
ExtentReports()

Method Summary

Modifier and Type	Method and Description
void	attachScreenshot(String screenCapturePath) Allows attaching a snapshot as a step.
void	attachScreenshot(String screenCapturePath, String message) Allows attaching a snapshot as a step.
DocumentConfig	config() Returns the DocumentConfig object that allows various configurations to be applied to the report file
void	endTest() Ends the current toggle level
static ExtentReports	get(Class<?> clazz)
static ExtentReports	get(String className)
void	init(String filePath, Boolean replaceExisting) Initializes the reporting by setting the file-path
void	init(String filePath, Boolean replaceExisting, DisplayOrder displayOrder) Initializes the reporting by setting the file-path and test DisplayOrder
void	init(String filePath, Boolean replaceExisting, DisplayOrder displayOrder, GridType gridType) Initializes the reporting by setting the file-path, test DisplayOrder and GridType
void	init(String filePath, Boolean replaceExisting, GridType gridType) Initializes the reporting by setting the file-path and GridType
void	log(LogStatus logStatus, String details) Overloaded method to allow only setting the LogStatus and details of the log event
void	log(LogStatus logStatus, String stepName, String details) Overloaded method to allow LogStatus, stepName and details for the log event
void	log(LogStatus logStatus, String stepName, String details, String screenCapturePath) Provides ability to log events for each started test.
void	setLogLevel(LogLevel logLevel) This allows a log level for the report.
void	startTest(String testName) Calling startTest(arg) generates a toggle for the test in the HTML file and adds all log events under this level.
void	startTest(String testName, String testDescription) Calling startTest(arg, arg) 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()

Method Detail

get

public static ExtentReports get(Class<?> clazz)

Parameters:

clazz - The class that uses a region level ExtentReports object

Returns:

an ExtentReports object

get

public static ExtentReports get(String className)

Parameters:

className - The name of the class that uses a region level ExtentReports object, passed as a string

Returns:

an ExtentReports object

startTest

public void startTest(String testName)

Calling startTest(arg) 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 the log events may not appear, or appear under an incorrect test.

Usage: extent.startTest("MyTestName");

Parameters:

testName - Name of the test that is currently being run and report is being generated for

startTest

public void startTest(String testName,
                      String testDescription)

Calling startTest(arg, arg) 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 the log events may not appear, or appear under an incorrect test.

This overloaded method allows a description to be written for the testName.

Usage: extent.startTest("Test - With Description", "This description will show up under Test.");

Parameters:

testName - Name of the test that is currently being run and report is being generated for

testDescription - Description of the test

endTest

public void endTest()

Ends the current toggle level

log

public void log(LogStatus logStatus,
                String stepName,
                String details,
                String screenCapturePath)

Provides ability to log events for each started test.

Usage: extent.log(LogStatus.INFO, "Image", "Image example:", "C:\\img.png");

It is possible to use relative path for the snapshot. Note: Relative paths starting with '/' and '.' are supported. If you are using an absolute path, 'file:///' will be automatically appended for the image to load correctly.

Usage
extent.log(LogStatus.INFO, "Image", "Image example:", "./pathToImg.png");
extent.log(LogStatus.INFO, "Image", "Image example:", "/pathToImg.png");

Parameters:

logStatus - LogStatus of the log event

stepName - Name of the step

details - Details of the step

screenCapturePath - Path of the snapshot to be attached to step

log

public void log(LogStatus logStatus,
                String stepName,
                String details)

Overloaded method to allow LogStatus, stepName and details for the log event

Usage: extent.log(LogStatus.PASS, "StepName", "PASS Details");

Parameters:

logStatus - LogStatus of the log event

stepName - Name of the step

details - Details of the step

log

public void log(LogStatus logStatus,
                String details)

Overloaded method to allow only setting the LogStatus and details of the log event

Usage: extent.log(LogStatus.INFO, "This step shows usage of log(logStatus, details)");

Parameters:

logStatus - LogStatus of the log event

details - Details of the step

attachScreenshot

public void attachScreenshot(String screenCapturePath,
                             String message)

Allows attaching a snapshot as a step.

Usage: extent.attachScreenshot("pathToImg.png", "This step only attaches a screenshot without a status.");

It is possible to use relative path for the snapshot. Note: Relative paths starting with '/' and '.' are supported. If you are using an absolute path, 'file:///' will be automatically appended for the image to load correctly.

Parameters:

screenCapturePath - Path of the snapshot file

message - Message to attach for the step

attachScreenshot

public void attachScreenshot(String screenCapturePath)

Allows attaching a snapshot as a step.

Usage: extent.attachScreenshot("pathToImg.png");

It is possible to use relative path for the snapshot. Note: Relative paths starting with '/' and '.' are supported. If you are using an absolute path, 'file:///' will be automatically appended for the image to load correctly.

Parameters:

screenCapturePath - Path of the snapshot file

setLogLevel

public void setLogLevel(LogLevel logLevel)

This allows a log level for the report. It filters any LogStatus that does not conform to the level set.

ALLOW_ALL: default setting which passes all log events to the report
FAIL: Allows FAIL and FATAL events sent to the report
WARNING: Allows WARNING and FAIL events to be sent to the report
ERROR: Allows ERROR and FAIL events to be sent to the report
ERRORS_AND_WARNING: Allows Errors, Warnings and FAIL/FATAL events
OFF: No events are allowed to be written to the report

Parameters:

logLevel - Level of logging to be used

config

public DocumentConfig config()

Returns the DocumentConfig object that allows various configurations to be applied to the report file

Returns:

DocumentConfig

init

public void init(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 using the DisplayOrder order 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

init

public void init(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 using the DisplayOrder order 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 BY_OLDEST_TO_LATEST (default) - oldest test at the top, newest at the end BY_LATEST_TO_OLDEST - newest test at the top, oldest at the end

init

public void init(String filePath,
                 Boolean replaceExisting,
                 GridType gridType)

Initializes the reporting by setting the file-path and GridType

Parameters:

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

replaceExisting - Setting to overwrite (TRUE) the existing file or append (FALSE) to it using the DisplayOrder order 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

gridType - Determines the type of grid to be used STANDARD (default) - standard grid with 1 test per row MASONRY - creates a masonry style grid with 2 tests per row

init

public void init(String filePath,
                 Boolean replaceExisting,
                 DisplayOrder displayOrder,
                 GridType gridType)

Initializes the reporting by setting the file-path, test DisplayOrder and GridType

Parameters:

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

replaceExisting - Setting to overwrite (TRUE) the existing file or append (FALSE) to it using the DisplayOrder order 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 BY_OLDEST_TO_LATEST (default) - oldest test at the top, newest at the end BY_LATEST_TO_OLDEST - newest test at the top, oldest at the end

gridType - Determines the type of grid to be used STANDARD (default) - standard grid with 1 test per row MASONRY - creates a masonry style grid with 2 tests per row