com.relevantcodes.extentreports

Class ExtentTest

java.lang.Object

com.relevantcodes.extentreports.ExtentTest

public class ExtentTest
extends Object

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 imgPath) 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
LogStatus	getRunStatus() Provides the current run status of the test
Test	getTest() Returns the underlying test which controls the internal model
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

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

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

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

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

Parameters:

logStatus - Status (see LogStatus)

details - Details of the step

addScreenCapture

public String addScreenCapture(String imgPath)

Adds a snapshot to the log event details

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

Parameters:

imgPath - Path of the image

Returns:

A formed HTML img tag with the supplied path

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

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", ...);

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", ...);

Parameters:

authors - Author name

Returns:

ExtentTest

appendChild

public ExtentTest appendChild(ExtentTest node)

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

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

Returns:

LogStatus

getTest

public Test getTest()

Returns the underlying test which controls the internal model

This allows manipulating the test instance by accessing the internal methods and properties of the test

Returns:

A Test object