Package com.aventstack.extentreports

Class ExtentTest

java.lang.Object

com.aventstack.extentreports.ExtentTest

All Implemented Interfaces:

RunResult, Serializable

public class ExtentTest
extends Object
implements RunResult, 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	Description
ExtentTest	addScreenCaptureFromBase64String(String base64)
ExtentTest	addScreenCaptureFromBase64String(String base64, String title)
ExtentTest	addScreenCaptureFromPath(String path)
ExtentTest	addScreenCaptureFromPath(String path, String title)
ExtentTest	assignAuthor(String... author)	Assigns an author
ExtentTest	assignCategory(String... category)	Assigns a category or group
ExtentTest	assignDevice(String... device)	Assign a device
ExtentTest	createNode(GherkinKeyword gherkinKeyword, 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, String name, 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(Class<? extends IGherkinFormatterModel> type, String name)	Creates a BDD-style node representing one of the IGherkinFormatterModel classes such as: Feature Background Scenario Given When Then And
ExtentTest	createNode(Class<? extends IGherkinFormatterModel> type, String name, String description)	Creates a BDD-style node with description representing one of the IGherkinFormatterModel classes: Feature Background Scenario Given When Then And
ExtentTest	createNode(String name)	Creates a node
ExtentTest	createNode(String name, String description)	Creates a node with description
ExtentTest	fail(Markup m)	Logs an event with Status.FAIL and custom Markup such as: Code block Label Table
ExtentTest	fail(Media media)	Logs an event with Status.FAIL and ScreenCapture
ExtentTest	fail(String details)	Logs an event Status.FAIL with details
ExtentTest	fail(String details, Media media)	Logs an Status.FAIL event with details and a media object: ScreenCapture
ExtentTest	fail(Throwable t)	Logs an event with Status.FAIL and exception
ExtentTest	fail(Throwable t, Media media)	Logs an Status.FAIL event with an exception and a media object: ScreenCapture
ExtentTest	generateLog(Status status, Markup markup)	Create a non-standard log with details.
ExtentTest	generateLog(Status status, String details)	Create a non-standard log with details.
Status	getStatus()
ExtentTest	info(Markup m)	Logs an event with Status.INFO and custom Markup such as: Code block Label Table
ExtentTest	info(Media media)	Logs an event with Status.INFO and ScreenCapture
ExtentTest	info(String details)	Logs an event with Status.INFO with details
ExtentTest	info(String details, Media media)	Logs an Status.INFO event with details and a media object: ScreenCapture
ExtentTest	info(Throwable t)	Logs an event with Status.INFO and exception
ExtentTest	info(Throwable t, Media media)	Logs an Status.INFO event with an exception and a media object: ScreenCapture
ExtentTest	log(Status status, Markup markup)	Logs an event with Status and custom Markup such as: Code block Label Table
ExtentTest	log(Status status, Markup markup, Media media)	Logs an event with Status and custom Markup such as: Code block Label Table
ExtentTest	log(Status status, Media media)	Logs an event with Status, details and a media object: ScreenCapture
ExtentTest	log(Status status, String details)	Logs an event with Status and details
ExtentTest	log(Status status, String details, Media media)	Logs an event with Status, details and a media object: ScreenCapture
ExtentTest	log(Status status, String details, Throwable t, Media media)	Logs an event with Status, details and a media object: ScreenCapture
ExtentTest	log(Status status, Throwable t)	Logs an event with Status and exception
ExtentTest	log(Status status, Throwable t, Media media)	Logs an event with Status, an exception and a media object: ScreenCapture
ExtentTest	pass(Markup m)	Logs an event with Status.PASS and custom Markup such as: Code block Label Table
ExtentTest	pass(Media media)	Logs an event with Status.PASS and ScreenCapture
ExtentTest	pass(String details)	Logs an event Status.PASS with details
ExtentTest	pass(String details, Media media)	Logs an Status.PASS event with details and a media object: ScreenCapture
ExtentTest	pass(Throwable t)	Logs an event with Status.PASS and exception
ExtentTest	pass(Throwable t, Media media)	Logs an Status.PASS event with an exception and a media object: ScreenCapture
ExtentTest	skip(Markup m)	Logs an event with Status.SKIP and custom Markup such as: Code block Label Table
ExtentTest	skip(Media media)	Logs an event with Status.SKIP and ScreenCapture
ExtentTest	skip(String details)	Logs an event Status.SKIP with details
ExtentTest	skip(String details, Media media)
ExtentTest	skip(Throwable t)	Logs an event with Status.SKIP and exception
ExtentTest	skip(Throwable t, Media media)	Logs an Status.SKIP event with an exception and a media object: ScreenCapture
ExtentTest	warning(Markup m)	Logs an event with Status.WARNING and custom Markup such as: Code block Label Table
ExtentTest	warning(Media media)	Logs an event with Status.WARNING and ScreenCapture
ExtentTest	warning(String details)	Logs an event Status.WARNING with details
ExtentTest	warning(String details, Media media)	Logs an Status.WARNING event with an exception and a media object: ScreenCapture
ExtentTest	warning(Throwable t)	Logs an event with Status.WARNING and exception
ExtentTest	warning(Throwable t, Media media)	Logs an Status.WARNING event with an exception and a media object: ScreenCapture

Methods inherited from class java.lang.Object

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

Method Details

createNode

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

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

• 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(String name,
 String description)

Creates a node with description

Parameters:

name - Name of node

description - A short description

Returns:

ExtentTest object

createNode

public ExtentTest createNode(Class<? extends IGherkinFormatterModel> type,
 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,
 String name,
 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,
 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(String name)

Creates a node

Parameters:

name - Name of node

Returns:

ExtentTest object

generateLog

public ExtentTest generateLog(Status status,
 String details)

Create a non-standard log with details. This is unlike the log method, which creates a fixed table layout with the following columns:

• Timestamp
• Status
• Details

Parameters:

status - Status

details - Text details of the step

Returns:

an ExtentTest object

generateLog

public ExtentTest generateLog(Status status,
 Markup markup)

Create a non-standard log with details. This is unlike the log method, which creates a fixed table layout with the following columns:

• Timestamp
• Status
• Details

generateLog with Markup allows for a user-defined log with any type of markup supported by MarkupHelper.

Parameters:

status - Status

markup - A Markup created by MarkupHelper

Returns:

an ExtentTest object

log

public ExtentTest log(Status status,
 String details,
 Throwable t,
 Media media)

Logs an event with Status, details and a media object: ScreenCapture

Example:

 test.log(Status.FAIL, "details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

status - Status

details - Details

t - A Throwable exception to be logged, enabling the Exception view of certain HTML reporters

media - A Media object

Returns:

An ExtentTest object

log

public ExtentTest log(Status status,
 String details,
 Media media)

Logs an event with Status, details and a media object: ScreenCapture

Example:

 test.log(Status.FAIL, "details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

status - Status

details - Details

media - A Media object

Returns:

An ExtentTest object

log

public ExtentTest log(Status status,
 Media media)

Logs an event with Status, details and a media object: ScreenCapture

Example:

 test.log(Status.FAIL, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

status - Status

media - A Media object

Returns:

An ExtentTest object

log

public ExtentTest log(Status status,
 String details)

Logs an event with Status and details

Parameters:

status - Status

details - Details

Returns:

An ExtentTest object

log

public ExtentTest log(Status status,
 Markup markup,
 Media media)

Logs an event with Status and custom Markup such as:

• Code block
• Label
• Table

Parameters:

status - Status

markup - Markup

media - A Media object provided by MediaEntityBuilder

Returns:

An 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:

An ExtentTest object

log

public ExtentTest log(Status status,
 Throwable t,
 Media media)

Logs an event with Status, an exception and a media object: ScreenCapture

Example:

 Exception exception = new NullPointerException();
 test.log(Status.FAIL, exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

status - Status

t - Throwable

media - A Media object

Returns:

An ExtentTest object

log

public ExtentTest log(Status status,
 Throwable t)

Logs an event with Status and exception

Parameters:

status - Status

t - Throwable

Returns:

An ExtentTest object

info

public ExtentTest info(String details,
 Media media)

Logs an Status.INFO event with details and a media object: ScreenCapture

Example:

 test.info("details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

details - Details

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

info

public ExtentTest info(String details)

Logs an event with Status.INFO with details

Parameters:

details - Details

Returns:

ExtentTest object

info

public ExtentTest info(Throwable t,
 Media media)

Logs an Status.INFO event with an exception and a media object: ScreenCapture

Example:

 Exception exception = new NullPointerException();
 test.info(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

t - A Throwable exception to be logged, enabling the Exception view of certain HTML reporters

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

info

public ExtentTest info(Throwable t)

Logs an event with Status.INFO and exception

Parameters:

t - A Throwable exception to be logged, enabling the Exception view of certain HTML reporters

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

info

public ExtentTest info(Media media)

Logs an event with Status.INFO and ScreenCapture

Parameters:

media - A Media object provided by MediaEntityBuilder

Returns:

ExtentTest object

pass

public ExtentTest pass(String details,
 Media media)

Logs an Status.PASS event with details and a media object: ScreenCapture

Example:

 test.pass("details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

details - Details

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

pass

public ExtentTest pass(String details)

Logs an event Status.PASS with details

Parameters:

details - Details

Returns:

ExtentTest object

pass

public ExtentTest pass(Throwable t,
 Media media)

Logs an Status.PASS event with an exception and a media object: ScreenCapture

Example:

 Exception exception = new NullPointerException();
 test.pass(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

t - Throwable

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

pass

public ExtentTest pass(Throwable t)

Logs an event with Status.PASS and exception

Parameters:

t - Throwable

Returns:

An 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:

An ExtentTest object

pass

public ExtentTest pass(Media media)

Logs an event with Status.PASS and ScreenCapture

Parameters:

media - A Media object provided by MediaEntityBuilder

Returns:

ExtentTest object

fail

public ExtentTest fail(String details,
 Media media)

Logs an Status.FAIL event with details and a media object: ScreenCapture

Parameters:

details - Details

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

fail

public ExtentTest fail(String details)

Logs an event Status.FAIL with details

Parameters:

details - Details

Returns:

ExtentTest object

fail

public ExtentTest fail(Throwable t,
 Media media)

Logs an Status.FAIL event with an exception and a media object: ScreenCapture

Example:

 Exception exception = new NullPointerException();
 test.fail(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

t - Throwable

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

fail

public ExtentTest fail(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

fail

public ExtentTest fail(Media media)

Logs an event with Status.FAIL and ScreenCapture

Parameters:

media - A Media object provided by MediaEntityBuilder

Returns:

ExtentTest object

warning

public ExtentTest warning(String details,
 Media media)

Logs an Status.WARNING event with an exception and a media object: ScreenCapture

Parameters:

details - Details

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

warning

public ExtentTest warning(String details)

Logs an event Status.WARNING with details

Parameters:

details - Details

Returns:

ExtentTest object

warning

public ExtentTest warning(Throwable t,
 Media media)

Logs an Status.WARNING event with an exception and a media object: ScreenCapture

Example:

 Exception exception = new NullPointerException();
 test.warning(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

t - Throwable

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

warning

public ExtentTest warning(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:

An ExtentTest object

warning

public ExtentTest warning(Media media)

Logs an event with Status.WARNING and ScreenCapture

Parameters:

media - A Media object provided by MediaEntityBuilder

Returns:

ExtentTest object

skip

public ExtentTest skip(String details,
 Media media)

Parameters:

details - Details

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

skip

public ExtentTest skip(String details)

Logs an event Status.SKIP with details

Parameters:

details - Details

Returns:

ExtentTest object

skip

public ExtentTest skip(Throwable t,
 Media media)

Logs an Status.SKIP event with an exception and a media object: ScreenCapture

Example:

 Exception exception = new NullPointerException();
 test.skip(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
 

Parameters:

t - Throwable

media - A Media object provided by MediaEntityBuilder

Returns:

An ExtentTest object

skip

public ExtentTest skip(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

skip

public ExtentTest skip(Media media)

Logs an event with Status.SKIP and ScreenCapture

Parameters:

media - A Media object provided by MediaEntityBuilder

Returns:

ExtentTest object

assignCategory

public ExtentTest assignCategory(String... category)

Assigns a category or group

Parameters:

category - Category name

Returns:

ExtentTest object

assignAuthor

public ExtentTest assignAuthor(String... author)

Assigns an author

Parameters:

author - Author name

Returns:

ExtentTest object

assignDevice

public ExtentTest assignDevice(String... device)

Assign a device

Parameters:

device - Device name

Returns:

ExtentTest object

getStatus

public Status getStatus()

Specified by:

getStatus in interface RunResult

addScreenCaptureFromPath

public ExtentTest addScreenCaptureFromPath(String path,
 String title)

addScreenCaptureFromPath

public ExtentTest addScreenCaptureFromPath(String path)

addScreenCaptureFromBase64String

public ExtentTest addScreenCaptureFromBase64String(String base64,
 String title)

addScreenCaptureFromBase64String

public ExtentTest addScreenCaptureFromBase64String(String base64)