com.aventstack.extentreports.ExtentTest Maven / Gradle / Ivy
package com.aventstack.extentreports;
import java.io.IOException;
import java.io.Serializable;
import java.util.Arrays;
import com.aventstack.extentreports.gherkin.model.IGherkinFormatterModel;
import com.aventstack.extentreports.markuputils.Markup;
import com.aventstack.extentreports.model.Author;
import com.aventstack.extentreports.model.Category;
import com.aventstack.extentreports.model.Device;
import com.aventstack.extentreports.model.ExceptionInfo;
import com.aventstack.extentreports.model.Log;
import com.aventstack.extentreports.model.Media;
import com.aventstack.extentreports.model.ScreenCapture;
import com.aventstack.extentreports.model.Test;
import com.aventstack.extentreports.utils.ExceptionUtil;
import com.aventstack.extentreports.utils.StringUtil;
/**
* 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
*
*/
public class ExtentTest implements IAddsMedia, RunResult, Serializable {
private static final long serialVersionUID = 9199820968410788862L;
/**
* An instance of {@link ExtentReports} to which this {@link ExtentTest} belongs
*/
private transient ExtentReports extent;
/**
* Internal model
*/
private Test test;
/**
* Creates a BDD style parent test representing one of the
* {@link IGherkinFormatterModel} classes. This method would ideally be used for
* creating the parent, ie {@link Feature).
*
*
* - {@link com.aventstack.extentreports.gherkin.model.Feature}
* - {@link com.aventstack.extentreports.gherkin.model.Background}
* - {@link com.aventstack.extentreports.gherkin.model.Scenario}
* - {@link com.aventstack.extentreports.gherkin.model.Given}
* - {@link com.aventstack.extentreports.gherkin.model.When}
* - {@link com.aventstack.extentreports.gherkin.model.Then}
* - {@link com.aventstack.extentreports.gherkin.model.And}
*
*
*
* Example:
*
*
*
* extent.createTest(Feature.class, "Feature Name", "Description");
*
*
* @param extent An {@link ExtentReports} object
* @param type A {@link IGherkinFormatterModel} type
* @param name Test name
* @param description Test description
*/
ExtentTest(ExtentReports extent, Class type, String name, String description) {
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("testName cannot be null or empty");
}
this.extent = extent;
test = new Test();
test.setName(name.trim());
test.setDescription(description == null ? "" : description.trim());
if (type != null) {
test.setBddType(type);
}
}
/**
* Create a test with description
*
* @param extent An {@link ExtentReports} object
* @param testName Test name
* @param description Test description
*/
ExtentTest(ExtentReports extent, String testName, String description) {
this(extent, null, testName, description);
}
/**
* Creates a BDD-style node with description representing one of the
* {@link IGherkinFormatterModel} classes:
*
*
* - {@link com.aventstack.extentreports.gherkin.model.Feature}
* - {@link com.aventstack.extentreports.gherkin.model.Background}
* - {@link com.aventstack.extentreports.gherkin.model.Scenario}
* - {@link com.aventstack.extentreports.gherkin.model.Given}
* - {@link com.aventstack.extentreports.gherkin.model.When}
* - {@link com.aventstack.extentreports.gherkin.model.Then}
* - {@link com.aventstack.extentreports.gherkin.model.And}
*
*
*
* Example:
*
*
*
* test.createNode(Scenario.class, "bddNode", "description");
*
*
* @param type A {@link IGherkinFormatterModel} type
* @param name Name of node
* @param description A short description
*
* @return {@link ExtentTest} object
*/
public synchronized ExtentTest createNode(Class type, String name, String description) {
if (name == null || name.isEmpty())
throw new IllegalArgumentException("nodeName cannot be null or empty");
ExtentTest t;
if (type == null) {
t = new ExtentTest(extent, name, description);
} else {
t = new ExtentTest(extent, type, name, description);
}
applyCommonNodeSettings(t);
addNodeToReport(t);
return t;
}
/**
* Creates a node with description
*
* @param name Name of node
* @param description A short description
*
* @return {@link ExtentTest} object
*/
public synchronized ExtentTest createNode(String name, String description) {
if (name == null || name.isEmpty())
throw new IllegalArgumentException("nodeName cannot be null or empty");
ExtentTest t = new ExtentTest(extent, name, description);
applyCommonNodeSettings(t);
addNodeToReport(t);
return t;
}
/**
* Creates a BDD-style node representing one of the
* {@link IGherkinFormatterModel} classes such as:
*
*
* - {@link com.aventstack.extentreports.gherkin.model.Feature}
* - {@link com.aventstack.extentreports.gherkin.model.Background}
* - {@link com.aventstack.extentreports.gherkin.model.Scenario}
* - {@link com.aventstack.extentreports.gherkin.model.Given}
* - {@link com.aventstack.extentreports.gherkin.model.When}
* - {@link com.aventstack.extentreports.gherkin.model.Then}
* - {@link com.aventstack.extentreports.gherkin.model.And}
*
*
*
* Example:
*
*
*
* test.createNode(Scenario.class, "bddNode");
*
*
* @param type A {@link IGherkinFormatterModel} type
* @param name Name of node
*
* @return {@link ExtentTest} object
*/
public ExtentTest createNode(Class type, String name) {
return createNode(type, name, null);
}
/**
* Creates a BDD-style node with description using name of the Gherkin model
* such as:
*
*
* - {@link com.aventstack.extentreports.gherkin.model.Feature}
* - {@link com.aventstack.extentreports.gherkin.model.Background}
* - {@link com.aventstack.extentreports.gherkin.model.Scenario}
* - {@link com.aventstack.extentreports.gherkin.model.Given}
* - {@link com.aventstack.extentreports.gherkin.model.When}
* - {@link com.aventstack.extentreports.gherkin.model.Then}
* - {@link com.aventstack.extentreports.gherkin.model.And}
*
*
*
* Example:
*
*
*
* test.createNode(new GherkinKeyword("Scenario"), "bddTest", "description");
*
*
* @param gherkinKeyword Name of the {@link GherkinKeyword}
* @param name Name of node
* @param description A short description
*
* @return {@link ExtentTest}
*/
public ExtentTest createNode(GherkinKeyword gherkinKeyword, String name, String description) {
Class clazz = gherkinKeyword.getKeyword().getClass();
return createNode(clazz, name, description);
}
/**
* Creates a BDD-style node using name of the Gherkin model such as:
*
*
* - {@link com.aventstack.extentreports.gherkin.model.Feature}
* - {@link com.aventstack.extentreports.gherkin.model.Background}
* - {@link com.aventstack.extentreports.gherkin.model.Scenario}
* - {@link com.aventstack.extentreports.gherkin.model.Given}
* - {@link com.aventstack.extentreports.gherkin.model.When}
* - {@link com.aventstack.extentreports.gherkin.model.Then}
* - {@link com.aventstack.extentreports.gherkin.model.And}
*
*
*
* Example:
*
*
*
* test.createNode(new GherkinKeyword("Scenario"), "bddTest");
*
*
* @param gherkinKeyword Name of the {@link GherkinKeyword}
* @param name Name of node
*
* @return {@link ExtentTest} object
*/
public ExtentTest createNode(GherkinKeyword gherkinKeyword, String name) {
return createNode(gherkinKeyword, name, null);
}
/**
* Creates a node
*
* @param name Name of node
*
* @return {@link ExtentTest} object
*/
public ExtentTest createNode(String name) {
return createNode(name, null);
}
private synchronized void applyCommonNodeSettings(ExtentTest extentTest) {
extentTest.getModel().setLevel(test.getLevel() + 1);
extentTest.getModel().setParent(getModel());
test.getNodeContext().add(extentTest.getModel());
}
private void addNodeToReport(ExtentTest extentNode) {
extent.addNode(extentNode.getModel());
}
/**
* Logs an event with {@link Status}, details and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* test.log(Status.FAIL, "details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param status {@link Status}
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest log(Status status, String details, MediaEntityModelProvider provider) {
Log evt = createLog(status, details);
addMedia(evt, provider);
return addLog(evt);
}
private void addMedia(Log evt, MediaEntityModelProvider provider) {
if (provider != null) {
Class clazz = provider.getMedia().getClass();
if (clazz.equals(ScreenCapture.class)) {
ScreenCapture c = (ScreenCapture) provider.getMedia();
evt.getScreenCaptureContext().add(c);
} else {
}
}
}
/**
* Logs an event with {@link Status} and details
*
* @param status {@link Status}
* @param details Details
*
* @return An {@link ExtentTest} object
*/
public ExtentTest log(Status status, String details) {
return log(status, details, null);
}
/**
* Logs an event with {@link Status} and custom {@link Markup} such as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param status {@link Status}
* @param markup {@link Markup}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest log(Status status, Markup markup) {
String details = markup.getMarkup();
return log(status, details);
}
private ExtentTest addLog(Log evt) {
getModel().getLogContext().add(evt);
getModel().end();
extent.addLog(getModel(), evt);
if (!evt.getScreenCaptureContext().isEmpty()) {
try {
extent.addScreenCapture(evt, evt.getScreenCaptureContext().getLast());
} catch (IOException e) {
e.printStackTrace();
}
}
return this;
}
private Log createLog(Status status) {
Log evt = new Log(getModel());
evt.setStatus(status);
evt.setSequence(test.getLogContext().size() + 1);
return evt;
}
private Log createLog(Status status, String details) {
Log evt = createLog(status);
evt.setDetails(details == null ? "" : details.trim());
return evt;
}
/**
* Logs an event with {@link Status}, an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.log(Status.FAIL, exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param status {@link Status}
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest log(Status status, Throwable t, MediaEntityModelProvider provider) {
ExceptionInfo exceptionInfo = new ExceptionInfo();
exceptionInfo.setThrowable(t);
exceptionInfo.setExceptionName(ExceptionUtil.getExceptionHeadline(t));
exceptionInfo.setStackTrace(ExceptionUtil.getStackTrace(t));
Log evt = createLog(status);
evt.setExceptionInfo(exceptionInfo);
getModel().getExceptionInfoContext().add(exceptionInfo);
addMedia(evt, provider);
return addLog(evt);
}
/**
* Logs an event with {@link Status} and exception
*
* @param status {@link Status}
* @param t {@link Throwable}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest log(Status status, Throwable t) {
return log(status, t, null);
}
/**
* Logs an event with {@link ExceptionInfo}
*
* @param status {@link Status}
* @param exceptionInfo{@link ExceptionInfo}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest log(Status status, ExceptionInfo exceptionInfo) {
Log evt = createLog(status);
evt.setExceptionInfo(exceptionInfo);
getModel().getExceptionInfoContext().add(exceptionInfo);
return addLog(evt);
}
/**
* Logs an Status.INFO event with details and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* test.info("details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest info(String details, MediaEntityModelProvider provider) {
log(Status.INFO, details, provider);
return this;
}
/**
* Logs an event with Status.INFO with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest info(String details) {
return info(details, null);
}
/**
* Logs an Status.INFO event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.info(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest info(Throwable t, MediaEntityModelProvider provider) {
log(Status.INFO, t, provider);
return this;
}
/**
* Logs an event with Status.INFO and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest info(Throwable t) {
return info(t, null);
}
/**
* Logs an event with Status.INFO and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return {@link ExtentTest} object
*/
public ExtentTest info(Markup m) {
log(Status.INFO, m);
return this;
}
/**
* Logs an Status.PASS event with details and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* test.pass("details", MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest pass(String details, MediaEntityModelProvider provider) {
log(Status.PASS, details, provider);
return this;
}
/**
* Logs an event Status.PASS with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest pass(String details) {
return pass(details, null);
}
/**
* Logs an Status.PASS event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.pass(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest pass(Throwable t, MediaEntityModelProvider provider) {
log(Status.PASS, t, provider);
return this;
}
/**
* Logs an event with Status.PASS and exception
*
* @param t {@link Throwable}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest pass(Throwable t) {
return pass(t, null);
}
/**
* Logs an event with Status.PASS and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest pass(Markup m) {
log(Status.PASS, m);
return this;
}
/**
* Logs an Status.FAIL event with details and a media object:
* {@link ScreenCapture}
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest fail(String details, MediaEntityModelProvider provider) {
log(Status.FAIL, details, provider);
return this;
}
/**
* Logs an event Status.FAIL with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest fail(String details) {
return fail(details, null);
}
/**
* Logs an Status.FAIL event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.fail(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest fail(Throwable t, MediaEntityModelProvider provider) {
log(Status.FAIL, t, provider);
return this;
}
/**
* Logs an event with Status.FAIL and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest fail(Throwable t) {
return fail(t, null);
}
/**
* Logs an event with Status.FAIL and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return {@link ExtentTest} object
*/
public ExtentTest fail(Markup m) {
log(Status.FAIL, m);
return this;
}
/**
* Logs an Status.DATAL event with an exception and a media object:
* {@link ScreenCapture}
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest fatal(String details, MediaEntityModelProvider provider) {
log(Status.FATAL, details, provider);
return this;
}
/**
* Logs an event Status.FATAL with details
*
* @param details Details
*
* @return An {@link ExtentTest} object
*/
public ExtentTest fatal(String details) {
log(Status.FATAL, details);
return this;
}
/**
* Logs an Status.FATAL event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.fatal(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest fatal(Throwable t, MediaEntityModelProvider provider) {
log(Status.FATAL, t, provider);
return this;
}
/**
* Logs an event with Status.FATAL and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest fatal(Throwable t) {
log(Status.FATAL, t);
return this;
}
/**
* Logs an event with Status.FATAL and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest fatal(Markup m) {
log(Status.FATAL, m);
return this;
}
/**
* Logs an Status.WARNING event with an exception and a media
* object: {@link ScreenCapture}
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest warning(String details, MediaEntityModelProvider provider) {
log(Status.WARNING, details, provider);
return this;
}
/**
* Logs an event Status.WARNING with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest warning(String details) {
return warning(details, null);
}
/**
* Logs an Status.WARNING event with an exception and a media
* object: {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.warning(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest warning(Throwable t, MediaEntityModelProvider provider) {
log(Status.WARNING, t, provider);
return this;
}
/**
* Logs an event with Status.WARNING and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest warning(Throwable t) {
return warning(t, null);
}
/**
* Logs an event with Status.WARNING and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return An {@link ExtentTest} object
*/
public ExtentTest warning(Markup m) {
log(Status.WARNING, m);
return this;
}
/**
* Logs an Status.ERROR event with an exception and a media object:
* {@link ScreenCapture}
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest error(String details, MediaEntityModelProvider provider) {
log(Status.ERROR, details, provider);
return this;
}
/**
* Logs an event Status.ERROR with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest error(String details) {
return error(details, null);
}
/**
* Logs an Status.ERROR event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.error(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest error(Throwable t, MediaEntityModelProvider provider) {
log(Status.ERROR, t, provider);
return this;
}
/**
* Logs an event with Status.ERROR and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest error(Throwable t) {
return error(t, null);
}
/**
* Logs an event with Status.ERROR and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return {@link ExtentTest} object
*/
public ExtentTest error(Markup m) {
log(Status.ERROR, m);
return this;
}
/**
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest skip(String details, MediaEntityModelProvider provider) {
log(Status.SKIP, details, provider);
return this;
}
/**
* Logs an event Status.SKIP with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest skip(String details) {
return skip(details, null);
}
/**
* Logs an Status.SKIP event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.skip(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest skip(Throwable t, MediaEntityModelProvider provider) {
log(Status.SKIP, t, provider);
return this;
}
/**
* Logs an event with Status.SKIP and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest skip(Throwable t) {
return skip(t, null);
}
/**
* Logs an event with Status.SKIP and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return {@link ExtentTest} object
*/
public ExtentTest skip(Markup m) {
log(Status.SKIP, m);
return this;
}
/**
* Logs an Status.DEBUG event with an exception and a media object:
* {@link ScreenCapture}
*
* @param details Details
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest debug(String details, MediaEntityModelProvider provider) {
log(Status.DEBUG, details, provider);
return this;
}
/**
* Logs an event Status.DEBUG with details
*
* @param details Details
*
* @return {@link ExtentTest} object
*/
public ExtentTest debug(String details) {
return debug(details, null);
}
/**
* Logs an Status.DEBUG event with an exception and a media object:
* {@link ScreenCapture}
*
*
* Example:
*
*
*
* Exception exception = new NullPointerException();
* test.debug(exception, MediaEntityBuilder.createScreenCaptureFromPath("screen.png").build());
*
*
* @param t {@link Throwable}
* @param provider A {@link MediaEntityModelProvider} object
*
* @return An {@link ExtentTest} object
*/
public ExtentTest debug(Throwable t, MediaEntityModelProvider provider) {
log(Status.DEBUG, t, provider);
return this;
}
/**
* Logs an event with Status.SKIP and exception
*
* @param t {@link Throwable}
*
* @return {@link ExtentTest} object
*/
public ExtentTest debug(Throwable t) {
return debug(t, null);
}
/**
* Logs an event with Status.DEBUG and custom {@link Markup} such
* as:
*
*
* - Code block
* - Label
* - Table
*
*
* @param m {@link Markup}
*
* @return {@link ExtentTest} object
*/
public ExtentTest debug(Markup m) {
log(Status.DEBUG, m);
return this;
}
/**
* Assigns a category or group
*
* @param category Category name
*
* @return {@link ExtentTest} object
*/
public ExtentTest assignCategory(String... category) {
if (category == null) {
return this;
}
Arrays.stream(category).filter(StringUtil::isNotNullOrEmpty).forEach(c -> {
Category cat = new Category(c.replace(" ", ""));
test.getCategoryContext().add(cat);
extent.assignCategory(test, cat);
});
return this;
}
/**
* Assigns an author
*
* @param author Author name
*
* @return {@link ExtentTest} object
*/
public ExtentTest assignAuthor(String... author) {
Arrays.stream(author).filter(StringUtil::isNotNullOrEmpty).forEach(x -> {
Author a = new Author(x.replace(" ", ""));
test.getAuthorContext().add(a);
extent.assignAuthor(test, a);
});
return this;
}
/**
* Assign a device
*
* @param device Device name
*
* @return {@link ExtentTest} object
*/
public ExtentTest assignDevice(String... device) {
Arrays.stream(device).filter(StringUtil::isNotNullOrEmpty).forEach(x -> {
Device d = new Device(x.replace(" ", ""));
test.getDeviceContext().add(d);
extent.assignDevice(test, d);
});
return this;
}
@Override
public ExtentTest addScreenCaptureFromPath(String imagePath, String title) throws IOException {
if (imagePath == null || imagePath.isEmpty())
throw new IllegalArgumentException("imagePath cannot be null or empty");
ScreenCapture screenCapture = new ScreenCapture();
screenCapture.setPath(imagePath);
if (title != null) {
screenCapture.setName(title);
}
/*
* if (test.getObjectId() != null) {
* screenCapture.setTestObjectId(test.getObjectId()); }
*/
extent.addScreenCapture(test, screenCapture);
return addScreenCapture(screenCapture);
}
private ExtentTest addScreenCapture(ScreenCapture screenCapture) {
test.getScreenCaptureContext().add(screenCapture);
/*
* if (test.getObjectId() != null) { int sequence =
* test.getScreenCaptureList().size();
* screenCapture.setTestObjectId(test.getObjectId());
* screenCapture.setSequence(sequence); }
*/
return this;
}
@Override
public ExtentTest addScreenCaptureFromPath(String imagePath) throws IOException {
return addScreenCaptureFromPath(imagePath, null);
}
@Override
public ExtentTest addScreenCaptureFromBase64String(String s, String title) {
ScreenCapture screenCapture = new ScreenCapture();
screenCapture.setBase64String(s);
screenCapture.setName(title);
/*
* if (test.getObjectId() != null)
* screenCapture.setTestObjectId(test.getObjectId());
*/
try {
extent.addScreenCapture(test, screenCapture);
} catch (IOException e) {
}
return addScreenCapture(screenCapture);
}
@Override
public ExtentTest addScreenCaptureFromBase64String(String s) {
return addScreenCaptureFromBase64String(s, null);
}
/**
* Provides the current run status of the test or node
*
* @return {@link Status}
*/
public Status getStatus() {
extent.generateRecentStatus();
return getModel().getStatus();
}
/**
* Returns the underlying test which controls the internal model
*
* @return {@link Test} object
*/
public Test getModel() {
return test;
}
/**
* Returns the {@link ExtentReports} instance associated with this test
*
* @return the {@link ExtentReports} instance associated with this test
*/
public ExtentReports getExtent() {
return extent;
}
void setUseManualConfiguration(Boolean b) {
getModel().setUsesManualConfiguration(b);
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy