com.relevantcodes.extentreports

Class ExtentTest

java.lang.Object

com.relevantcodes.extentreports.ExtentTest

All Implemented Interfaces:

IExtentTestClass

public class ExtentTest
extends Object
implements IExtentTestClass

Defines a node in the report file.

By default, each started node is top-level. If appendChild method is used on any test, it automatically becomes a child-node. When this happens:

• parent test: hasChildNodes = true
• child test: isChildNode = true

Author:

Anshoo

Constructor Summary

Constructors

Constructor and Description
ExtentTest(String testName, String description) Creates a test node as a top-most level test

Method Summary

Modifier and Type	Method and Description
String	addScreenCapture(String imagePath) Adds a snapshot to the log event details
String	addScreencast(String screencastPath) Adds a screen cast to the log event details
ExtentTest	appendChild(ExtentTest node) Appends a child test (another ExtentTest) to the current test
ExtentTest	assignAuthor(String... authors) Assigns author(s) to test
ExtentTest	assignCategory(String... categories) Assigns category to test
String	getDescription() Gets the current test description
Date	getEndedTime() Provides the end time of the current test
LogStatus	getRunStatus() Provides the current run status of the test
Date	getStartedTime() Provides the start time of the current test
ITest	getTest() Returns the interface that exposes some important methods of the underlying test
void	log(LogStatus logStatus, String details) Logs events for the test
void	log(LogStatus logStatus, String stepName, String details) Logs events for the test
void	log(LogStatus logStatus, String stepName, Throwable t) Logs events for the test
void	log(LogStatus logStatus, Throwable t) Logs events for the test
void	setDescription(String description) Sets the current test description
void	setEndedTime(Date endedTime) Allows overriding the default end time of the test
void	setStartedTime(Date startedTime) Allows overriding the default start time of the test

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentTest

public ExtentTest(String testName,
                  String description)

Creates a test node as a top-most level test

Parameters:

testName - Test name

description - A short description of the test

Method Detail

log

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

Logs events for the test

Log event is shown in the report with 4 columns:

• Timestamp
• Status
• StepName
• Details

Specified by:

log in interface IExtentTestClass

Parameters:

logStatus - Status (see LogStatus)

stepName - Name of the step

details - Details of the step

log

public void log(LogStatus logStatus,
                String stepName,
                Throwable t)

Logs events for the test

Log event is shown in the report with 4 columns:

• Timestamp
• Status
• StepName
• Details

Specified by:

log in interface IExtentTestClass

Parameters:

logStatus - Status (see LogStatus)

stepName - Name of the step

t - Exception

log

public void log(LogStatus logStatus,
                Throwable t)

Logs events for the test

Log event is shown in the report with 3 columns:

• Timestamp
• Status
• Details

Specified by:

log in interface IExtentTestClass

Parameters:

logStatus - Status (see LogStatus)

t - Exception

log

public void log(LogStatus logStatus,
                String details)

Logs events for the test

Log event is shown in the report with 3 columns:

• Timestamp
• Status
• Details

Specified by:

log in interface IExtentTestClass

Parameters:

logStatus - Status (see LogStatus)

details - Details of the step

setDescription

public void setDescription(String description)

Sets the current test description

Specified by:

setDescription in interface IExtentTestClass

Parameters:

description - Description of the test

getDescription

public String getDescription()

Gets the current test description

Specified by:

getDescription in interface IExtentTestClass

getStartedTime

public Date getStartedTime()

Provides the start time of the current test

Specified by:

getStartedTime in interface IExtentTestClass

setStartedTime

public void setStartedTime(Date startedTime)

Allows overriding the default start time of the test

Note: when a test is started using extent.startTest(testName), the value for started time is created automatically. This method allows overriding the start time in cases where the actual test had already been run prior to extent logging the test details in the report. An example of this scenario is while using TestNG's IReporter listener and creating the report after the tests have already executed.

Specified by:

setStartedTime in interface IExtentTestClass

Parameters:

startedTime - Test's start time

getEndedTime

public Date getEndedTime()

Provides the end time of the current test

Specified by:

getEndedTime in interface IExtentTestClass

setEndedTime

public void setEndedTime(Date endedTime)

Allows overriding the default end time of the test

Note: when a test is ended using extent.endTest(extentTest), the value for ended time is created automatically. This method allows overriding the end time in cases where the actual test had already been run prior to extent logging the test details in the report. An example of this scenario is while using TestNG's IReporter listener and creating the report after the tests have already executed.

Specified by:

setEndedTime in interface IExtentTestClass

Parameters:

endedTime - Test's end time

addScreenCapture

public String addScreenCapture(String imagePath)

Adds a snapshot to the log event details

Note: this method does not create the screen-capture for the report, it only sets the path of the image file in the report. The user is responsible for capturing the screen and for constructing the path to the image file.

Specified by:

addScreenCapture in interface IExtentTestClass

Parameters:

imagePath - Path of the image in relation to where your report resides

Returns:

A formed HTML img tag

addScreencast

public String addScreencast(String screencastPath)

Adds a screen cast to the log event details

Note: this method does not attach the screen-cast to the report, it only links to the path

Specified by:

addScreencast in interface IExtentTestClass

Parameters:

screencastPath - Path of the screencast

Returns:

A formed HTML video tag with the supplied path

assignCategory

public ExtentTest assignCategory(String... categories)

Assigns category to test

Usage: test.assignCategory("ExtentAPI");
Usage: test.assignCategory("ExtentAPI", "Regression", ...);

Specified by:

assignCategory in interface IExtentTestClass

Parameters:

categories - Category name

Returns:

A ExtentTest object

assignAuthor

public ExtentTest assignAuthor(String... authors)

Assigns author(s) to test

Usage: test.assignAuthor("AuthorName");
Usage: test.assignAuthor("Author1", "Author2", ...);

Specified by:

assignAuthor in interface IExtentTestClass

Parameters:

authors - Author name

Returns:

ExtentTest

appendChild

public ExtentTest appendChild(ExtentTest node)

Appends a child test (another ExtentTest) to the current test

Specified by:

appendChild in interface IExtentTestClass

Parameters:

node - An ExtentTest object. Test that is added as the node.

Returns:

An ExtentTest object. Parent test which adds the node as its child.

getRunStatus

public LogStatus getRunStatus()

Provides the current run status of the test

Specified by:

getRunStatus in interface IExtentTestClass

Returns:

LogStatus

getTest

public ITest getTest()

Returns the interface that exposes some important methods of the underlying test

Specified by:

getTest in interface IExtentTestClass

Returns:

A ITest object