public class ExtentTest extends Object implements IAddsMedia<ExtentTest>, RunResult, Serializable
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:
createTest
method are parent-level, always level 0createNode
method are children, always level 1 and greaterModifier and Type | Method and Description |
---|---|
ExtentTest |
addScreenCaptureFromPath(String imagePath)
Adds a snapshot to test or log
|
ExtentTest |
addScreenCaptureFromPath(String imagePath,
String title)
Adds a snapshot to the test or log with title
|
ExtentTest |
addScreencastFromPath(String screencastPath)
Adds a screencast to test or log
|
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(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(GherkinKeyword gherkinKeyword,
String name)
|
ExtentTest |
createNode(GherkinKeyword gherkinKeyword,
String name,
String description)
|
ExtentTest |
createNode(String name)
Creates a node
|
ExtentTest |
createNode(String name,
String description)
Creates a node with description
|
ExtentTest |
debug(Markup m)
Logs an event with
Status.DEBUG and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
debug(String details)
Logs an event
Status.DEBUG with details |
ExtentTest |
debug(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
debug(Throwable t)
Logs an event with
Status.SKIP and exception |
ExtentTest |
debug(Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
error(Markup m)
Logs an event with
Status.ERROR and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
error(String details)
Logs an event
Status.ERROR with details |
ExtentTest |
error(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
error(Throwable t)
Logs an event with
Status.ERROR and exception |
ExtentTest |
error(Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
fail(Markup m)
Logs an event with
Status.FAIL and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
fail(String details)
Logs an event
Status.FAIL with details |
ExtentTest |
fail(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
fail(Throwable t)
Logs an event with
Status.FAIL and exception |
ExtentTest |
fail(Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
fatal(Markup m)
Logs an event with
Status.FATAL and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
fatal(String details)
Logs an event
Status.FATAL with details |
ExtentTest |
fatal(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
fatal(Throwable t)
Logs an event with
Status.FATAL and exception |
ExtentTest |
fatal(Throwable t,
MediaEntityModelProvider provider)
|
ExtentReports |
getExtent()
Returns the
ExtentReports instance associated with this test |
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(String details)
Logs an event with
Status.INFO with details |
ExtentTest |
info(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
info(Throwable t)
Logs an event with
Status.INFO and exception |
ExtentTest |
info(Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
log(Status status,
Markup markup)
|
ExtentTest |
log(Status status,
String details)
Logs an event with
Status and details |
ExtentTest |
log(Status status,
String details,
MediaEntityModelProvider provider)
|
ExtentTest |
log(Status status,
Throwable t)
Logs an event with
Status and exception |
ExtentTest |
log(Status status,
Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
pass(Markup m)
Logs an event with
Status.PASS and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
pass(String details)
Logs an event
Status.PASS with details |
ExtentTest |
pass(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
pass(Throwable t)
Logs an event with
Status.PASS and exception |
ExtentTest |
pass(Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
skip(Markup m)
Logs an event with
Status.SKIP and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
skip(String details)
Logs an event
Status.SKIP with details |
ExtentTest |
skip(String details,
MediaEntityModelProvider provider) |
ExtentTest |
skip(Throwable t)
Logs an event with
Status.SKIP and exception |
ExtentTest |
skip(Throwable t,
MediaEntityModelProvider provider)
|
ExtentTest |
warning(Markup m)
Logs an event with
Status.WARNING and custom Markup such as:
Code block
Label
Table
|
ExtentTest |
warning(String details)
Logs an event
Status.WARNING with details |
ExtentTest |
warning(String details,
MediaEntityModelProvider provider)
|
ExtentTest |
warning(Throwable t)
Logs an event with
Status.WARNING and exception |
ExtentTest |
warning(Throwable t,
MediaEntityModelProvider provider)
|
public ExtentTest createNode(Class<? extends IGherkinFormatterModel> type, String name, String description)
IGherkinFormatterModel
classes:
Example:
test.createNode(Scenario.class, "bddNode", "description");
type
- A IGherkinFormatterModel
typename
- Name of nodedescription
- A short descriptionExtentTest
objectpublic ExtentTest createNode(String name, String description)
name
- Name of nodedescription
- A short descriptionExtentTest
objectpublic ExtentTest createNode(Class<? extends IGherkinFormatterModel> type, String name)
IGherkinFormatterModel
classes such as:
Example:
test.createNode(Scenario.class, "bddNode");
type
- A IGherkinFormatterModel
typename
- Name of nodeExtentTest
objectpublic ExtentTest createNode(GherkinKeyword gherkinKeyword, String name, String description)
Example:
test.createNode(new GherkinKeyword("Scenario"), "bddTest", "description");
gherkinKeyword
- Name of the GherkinKeyword
name
- Name of nodedescription
- A short descriptionExtentTest
public ExtentTest createNode(GherkinKeyword gherkinKeyword, String name)
Example:
test.createNode(new GherkinKeyword("Scenario"), "bddTest");
gherkinKeyword
- Name of the GherkinKeyword
name
- Name of nodeExtentTest
objectpublic ExtentTest createNode(String name)
name
- Name of nodeExtentTest
objectpublic ExtentTest log(Status status, String details, MediaEntityModelProvider provider)
Status
, details and a media object: Screencast
or
ScreenCapture
Example:
test.log(Status.FAIL, "details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
status
- Status
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest log(Status status, String details)
Status
and detailsstatus
- Status
details
- DetailsExtentTest
objectpublic ExtentTest log(Status status, Markup markup)
status
- Status
markup
- Markup
ExtentTest
objectpublic ExtentTest log(Status status, Throwable t, MediaEntityModelProvider provider)
Status
, an exception and a media object: Screencast
or
ScreenCapture
Example:
Exception exception = new NullPointerException(); test.log(Status.FAIL, exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
status
- Status
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest log(Status status, Throwable t)
Status
and exceptionstatus
- Status
t
- Throwable
ExtentTest
objectpublic ExtentTest info(String details, MediaEntityModelProvider provider)
Status.INFO
event with details and a media object:
Screencast
or ScreenCapture
Example:
test.info("details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest info(String details)
Status.INFO
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest info(Throwable t, MediaEntityModelProvider provider)
Status.INFO
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.info(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest info(Throwable t)
Status.INFO
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest info(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest pass(String details, MediaEntityModelProvider provider)
Status.PASS
event with details and a media object:
Screencast
or ScreenCapture
Example:
test.pass("details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest pass(String details)
Status.PASS
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest pass(Throwable t, MediaEntityModelProvider provider)
Status.PASS
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.pass(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest pass(Throwable t)
Status.PASS
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest pass(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest fail(String details, MediaEntityModelProvider provider)
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest fail(String details)
Status.FAIL
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest fail(Throwable t, MediaEntityModelProvider provider)
Status.FAIL
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.fail(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest fail(Throwable t)
Status.FAIL
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest fail(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest fatal(String details, MediaEntityModelProvider provider)
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest fatal(String details)
Status.FATAL
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest fatal(Throwable t, MediaEntityModelProvider provider)
Status.FATAL
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.fatal(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest fatal(Throwable t)
Status.FATAL
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest fatal(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest warning(String details, MediaEntityModelProvider provider)
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest warning(String details)
Status.WARNING
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest warning(Throwable t, MediaEntityModelProvider provider)
Status.WARNING
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.warning(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest warning(Throwable t)
Status.WARNING
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest warning(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest error(String details, MediaEntityModelProvider provider)
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest error(String details)
Status.ERROR
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest error(Throwable t, MediaEntityModelProvider provider)
Status.ERROR
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.error(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest error(Throwable t)
Status.ERROR
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest error(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest skip(String details, MediaEntityModelProvider provider)
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest skip(String details)
Status.SKIP
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest skip(Throwable t, MediaEntityModelProvider provider)
Status.SKIP
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.skip(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest skip(Throwable t)
Status.SKIP
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest skip(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest debug(String details, MediaEntityModelProvider provider)
details
- Detailsprovider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest debug(String details)
Status.DEBUG
with detailsdetails
- DetailsExtentTest
objectpublic ExtentTest debug(Throwable t, MediaEntityModelProvider provider)
Status.DEBUG
event with an exception and a media object:
Screencast
or ScreenCapture
Example:
Exception exception = new NullPointerException(); test.debug(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
t
- Throwable
provider
- A MediaEntityModelProvider
objectExtentTest
objectpublic ExtentTest debug(Throwable t)
Status.SKIP
and exceptiont
- Throwable
ExtentTest
objectpublic ExtentTest debug(Markup m)
m
- Markup
ExtentTest
objectpublic ExtentTest assignCategory(String... category)
category
- Category nameExtentTest
objectpublic ExtentTest assignAuthor(String... author)
author
- Author nameExtentTest
objectpublic ExtentTest assignDevice(String... device)
device
- Device nameExtentTest
objectpublic ExtentTest addScreenCaptureFromPath(String imagePath, String title) throws IOException
IAddsMedia
addScreenCaptureFromPath
in interface IAddsMedia<ExtentTest>
imagePath
- Image pathtitle
- Image titleExtentTest
or Log
IOException
- thrown if the imagePath
of image is not foundpublic ExtentTest addScreenCaptureFromPath(String imagePath) throws IOException
IAddsMedia
addScreenCaptureFromPath
in interface IAddsMedia<ExtentTest>
imagePath
- Image pathExtentTest
or Log
IOException
- thrown if the imagePath
of image is not foundpublic ExtentTest addScreencastFromPath(String screencastPath) throws IOException
IAddsMedia
addScreencastFromPath
in interface IAddsMedia<ExtentTest>
screencastPath
- Screencast pathExtentTest
or Log
IOException
- thrown if the screencastPath
of image is not foundpublic Status getStatus()
public Test getModel()
Test
objectpublic ExtentReports getExtent()
ExtentReports
instance associated with this testExtentReports
instance associated with this testCopyright © 2018. All rights reserved.