com.aventstack.extentreports

Class ExtentTest

java.lang.Object

com.aventstack.extentreports.ExtentTest

All Implemented Interfaces:

IAddsMedia, java.io.Serializable

public class ExtentTest
extends java.lang.Object
implements IAddsMedia, java.io.Serializable

Defines a test. You can add logs, snapshots, assign author and categories to a test and its children.

The below log types will all be logged with Status.PASS:

 test.log(Status.PASS, "details");
 test.pass("details");
 test.pass(MarkupHelper.createCodeBlock(code));
 

A few notes:

• Tests started with the createTest method are parent-level, always level 0
• Tests started with the createNode method are children, always level 1 and greater

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
ExtentTest	addScreenCaptureFromPath(java.lang.String imagePath) Adds a snapshot to test or log
ExtentTest	addScreenCaptureFromPath(java.lang.String imagePath, java.lang.String title) Adds a snapshot to the test or log with title
ExtentTest	assignAuthor(java.lang.String author) Assigns an author
ExtentTest	assignCategory(java.lang.String category) Assigns a category or group
ExtentTest	createNode(java.lang.Class<? extends IGherkinFormatterModel> type, java.lang.String name) Creates a BDD-style node representing one of the IGherkinFormatterModel classes such as: Feature Background Scenario Given When Then And
ExtentTest	createNode(java.lang.Class<? extends IGherkinFormatterModel> type, java.lang.String name, java.lang.String description) Creates a BDD-style node with description representing one of the IGherkinFormatterModel classes such as: Feature Background Scenario Given When Then And
ExtentTest	createNode(GherkinKeyword gherkinKeyword, java.lang.String name) Creates a BDD-style node using name of the Gherkin model such as: Feature Background Scenario Given When Then And
ExtentTest	createNode(GherkinKeyword gherkinKeyword, java.lang.String name, java.lang.String description) Creates a BDD-style node with description using name of the Gherkin model such as: Feature Background Scenario Given When Then And
ExtentTest	createNode(java.lang.String name) Creates a node
ExtentTest	createNode(java.lang.String name, java.lang.String description) Creates a node with description
ExtentTest	error(Markup m) Logs an event with Status.ERROR and custom Markup such as: Code block Label Table
ExtentTest	error(java.lang.String details) Logs an event Status.ERROR with details
ExtentTest	error(java.lang.Throwable t) Logs an event with Status.ERROR and exception
ExtentTest	fail(Markup m) Logs an event with Status.FAIL and custom Markup such as: Code block Label Table
ExtentTest	fail(java.lang.String details) Logs an event Status.FAIL with details
ExtentTest	fail(java.lang.Throwable t) Logs an event with Status.FAIL and exception
ExtentTest	fatal(Markup m) Logs an event with Status.FATAL and custom Markup such as: Code block Label Table
ExtentTest	fatal(java.lang.String details) Logs an event Status.FATAL with details
ExtentTest	fatal(java.lang.Throwable t) Logs an event with Status.FATAL and exception
Test	getModel() Returns the underlying test which controls the internal model
Status	getStatus() Provides the current run status of the test or node
ExtentTest	info(Markup m) Logs an event with Status.INFO and custom Markup such as: Code block Label Table
ExtentTest	info(java.lang.String details) Logs an event Status.INFO with details
ExtentTest	info(java.lang.Throwable t) Logs an event with Status.INFO and exception
ExtentTest	log(Status status, Markup markup) Logs an event with Status and custom Markup such as: Code block Label Table
ExtentTest	log(Status status, java.lang.String details) Logs an event with Status and details
ExtentTest	log(Status logStatus, java.lang.Throwable t) Logs an event with Status and exception
ExtentTest	pass(Markup m) Logs an event with Status.PASS and custom Markup such as: Code block Label Table
ExtentTest	pass(java.lang.String details) Logs an event Status.PASS with details
ExtentTest	pass(java.lang.Throwable t) Logs an event with Status.PASS and exception
ExtentTest	skip(Markup m) Logs an event with Status.SKIP and custom Markup such as: Code block Label Table
ExtentTest	skip(java.lang.String details) Logs an event Status.SKIP with details
ExtentTest	skip(java.lang.Throwable t) Logs an event with Status.SKIP and exception
ExtentTest	warning(Markup m) Logs an event with Status.WARNING and custom Markup such as: Code block Label Table
ExtentTest	warning(java.lang.String details) Logs an event Status.WARNING with details
ExtentTest	warning(java.lang.Throwable t) Logs an event with Status.WARNING and exception

Methods inherited from class java.lang.Object

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

Method Detail

createNode

public ExtentTest createNode(java.lang.String name,
                             java.lang.String description)

Creates a node with description

Parameters:

name - Name of node

description - A short description

Returns:

ExtentTest object

createNode

public ExtentTest createNode(java.lang.Class<? extends IGherkinFormatterModel> type,
                             java.lang.String name,
                             java.lang.String description)

Creates a BDD-style node with description representing one of the IGherkinFormatterModel classes such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 test.createNode(Scenario.class, "bddNode", "description");
 

Parameters:

type - A IGherkinFormatterModel type

name - Name of node

description - A short description

Returns:

ExtentTest object

createNode

public ExtentTest createNode(java.lang.Class<? extends IGherkinFormatterModel> type,
                             java.lang.String name)

Creates a BDD-style node representing one of the IGherkinFormatterModel classes such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 test.createNode(Scenario.class, "bddNode");
 

Parameters:

type - A IGherkinFormatterModel type

name - Name of node

Returns:

ExtentTest object

createNode

public ExtentTest createNode(GherkinKeyword gherkinKeyword,
                             java.lang.String name,
                             java.lang.String description)

Creates a BDD-style node with description using name of the Gherkin model such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 test.createNode(new GherkinKeyword("Scenario"), "bddTest", "description");
 

Parameters:

gherkinKeyword - Name of the GherkinKeyword

name - Name of node

description - A short description

Returns:

ExtentTest

createNode

public ExtentTest createNode(GherkinKeyword gherkinKeyword,
                             java.lang.String name)

Creates a BDD-style node using name of the Gherkin model such as:

• Feature
• Background
• Scenario
• Given
• When
• Then
• And

Example:

 test.createNode(new GherkinKeyword("Scenario"), "bddTest");
 

Parameters:

gherkinKeyword - Name of the GherkinKeyword

name - Name of node

Returns:

ExtentTest object

createNode

public ExtentTest createNode(java.lang.String name)

Creates a node

Parameters:

name - Name of node

Returns:

ExtentTest object

log

public ExtentTest log(Status status,
                      java.lang.String details)

Logs an event with Status and details

Parameters:

status - Status

details - Details

Returns:

ExtentTest object

log

public ExtentTest log(Status status,
                      Markup markup)

Logs an event with Status and custom Markup such as:

• Code block
• Label
• Table

Parameters:

status - Status

markup - Markup

Returns:

ExtentTest object

log

public ExtentTest log(Status logStatus,
                      java.lang.Throwable t)

Logs an event with Status and exception

Parameters:

logStatus - Status

t - Throwable

Returns:

ExtentTest object

info

public ExtentTest info(java.lang.String details)

Logs an event Status.INFO with details

Parameters:

details - Details

Returns:

ExtentTest object

info

public ExtentTest info(java.lang.Throwable t)

Logs an event with Status.INFO and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

info

public ExtentTest info(Markup m)

Logs an event with Status.INFO and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

pass

public ExtentTest pass(java.lang.String details)

Logs an event Status.PASS with details

Parameters:

details - Details

Returns:

ExtentTest object

pass

public ExtentTest pass(java.lang.Throwable t)

Logs an event with Status.PASS and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

pass

public ExtentTest pass(Markup m)

Logs an event with Status.PASS and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

fail

public ExtentTest fail(java.lang.String details)

Logs an event Status.FAIL with details

Parameters:

details - Details

Returns:

ExtentTest object

fail

public ExtentTest fail(java.lang.Throwable t)

Logs an event with Status.FAIL and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

fail

public ExtentTest fail(Markup m)

Logs an event with Status.FAIL and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

fatal

public ExtentTest fatal(java.lang.String details)

Logs an event Status.FATAL with details

Parameters:

details - Details

Returns:

ExtentTest object

fatal

public ExtentTest fatal(java.lang.Throwable t)

Logs an event with Status.FATAL and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

fatal

public ExtentTest fatal(Markup m)

Logs an event with Status.FATAL and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

warning

public ExtentTest warning(java.lang.String details)

Logs an event Status.WARNING with details

Parameters:

details - Details

Returns:

ExtentTest object

warning

public ExtentTest warning(java.lang.Throwable t)

Logs an event with Status.WARNING and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

warning

public ExtentTest warning(Markup m)

Logs an event with Status.WARNING and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

error

public ExtentTest error(java.lang.String details)

Logs an event Status.ERROR with details

Parameters:

details - Details

Returns:

ExtentTest object

error

public ExtentTest error(java.lang.Throwable t)

Logs an event with Status.ERROR and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

error

public ExtentTest error(Markup m)

Logs an event with Status.ERROR and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

skip

public ExtentTest skip(java.lang.String details)

Logs an event Status.SKIP with details

Parameters:

details - Details

Returns:

ExtentTest object

skip

public ExtentTest skip(java.lang.Throwable t)

Logs an event with Status.SKIP and exception

Parameters:

t - Throwable

Returns:

ExtentTest object

skip

public ExtentTest skip(Markup m)

Logs an event with Status.SKIP and custom Markup such as:

• Code block
• Label
• Table

Parameters:

m - Markup

Returns:

ExtentTest object

assignCategory

public ExtentTest assignCategory(java.lang.String category)

Assigns a category or group

Parameters:

category - Category name

Returns:

ExtentTest object

assignAuthor

public ExtentTest assignAuthor(java.lang.String author)

Assigns an author

Parameters:

author - Author name

Returns:

ExtentTest object

addScreenCaptureFromPath

public ExtentTest addScreenCaptureFromPath(java.lang.String imagePath,
                                           java.lang.String title)
                                    throws java.io.IOException

Description copied from interface: IAddsMedia

Adds a snapshot to the test or log with title

Specified by:

addScreenCaptureFromPath in interface IAddsMedia

Parameters:

imagePath - Image path

title - Image title

Returns:

Object this method is called from, generally ExtentTest or Log

Throws:

java.io.IOException - thrown if the supplied image from imagePath is not found

addScreenCaptureFromPath

public ExtentTest addScreenCaptureFromPath(java.lang.String imagePath)
                                    throws java.io.IOException

Description copied from interface: IAddsMedia

Adds a snapshot to test or log

Specified by:

addScreenCaptureFromPath in interface IAddsMedia

Parameters:

imagePath - Image path

Returns:

Object this method is called from, generally ExtentTest or Log

Throws:

java.io.IOException - thrown if the supplied image from imagePath is not found

getStatus

public Status getStatus()

Provides the current run status of the test or node

Returns:

Status

getModel

public Test getModel()

Returns the underlying test which controls the internal model

Returns:

Test object