com.relevantcodes.extentreports.ExtentTest Maven / Gradle / Ivy
Show all versions of extentreports Show documentation
/*
* Copyright (c) 2015, Anshoo Arora (Relevant Codes). All rights reserved.
*
* Copyrights licensed under the New BSD License.
*
* See the accompanying LICENSE file for terms.
*/
package com.relevantcodes.extentreports;
import java.io.File;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
import com.relevantcodes.extentreports.model.Author;
import com.relevantcodes.extentreports.model.Category;
import com.relevantcodes.extentreports.model.ExceptionInfo;
import com.relevantcodes.extentreports.model.ITest;
import com.relevantcodes.extentreports.model.Log;
import com.relevantcodes.extentreports.model.ScreenCapture;
import com.relevantcodes.extentreports.model.Screencast;
import com.relevantcodes.extentreports.model.Test;
import com.relevantcodes.extentreports.model.TestAttribute;
import com.relevantcodes.extentreports.utils.ExceptionUtil;
import com.relevantcodes.extentreports.view.ScreencastHtml;
import com.relevantcodes.extentreports.view.ScreenshotHtml;
/**
*
* 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
*/
public class ExtentTest implements IExtentTestClass, Serializable {
private static final long serialVersionUID = 6551590667557434115L;
private LogStatus runStatus = LogStatus.UNKNOWN;
private Test test;
/**
*
* Creates a test node as a top-most level test
*
* @param testName
* Test name
* @param description
* A short description of the test
*/
public ExtentTest(String testName, String description) {
test = new Test();
test.setName(testName == null ? "" : testName.trim());
test.setDescription(description.trim());
}
/**
*
* Logs events for the test
*
*
* Log event is shown in the report with 4 columns:
*
*
* - Timestamp
* - Status
* - StepName
* - Details
*
*
* @param logStatus
* Status (see {@link LogStatus})
*
* @param stepName
* Name of the step
*
* @param details
* Details of the step
*/
@Override
public void log(LogStatus logStatus, String stepName, String details) {
Log evt = new Log();
evt.setLogStatus(logStatus);
evt.setStepName(stepName == null ? null : stepName.trim());
evt.setDetails(details == null ? "" : details.trim());
test.setLog(evt);
test.trackLastRunStatus();
runStatus = test.getStatus();
}
/**
*
* Logs events for the test
*
*
* Log event is shown in the report with 4 columns:
*
*
* - Timestamp
* - Status
* - StepName
* - Details
*
*
* @param logStatus
* Status (see {@link LogStatus})
*
* @param stepName
* Name of the step
*
* @param t
* Exception
*/
@Override
public void log(LogStatus logStatus, String stepName, Throwable t) {
ExceptionInfo exceptionInfo = ExceptionUtil.createExceptionInfo(t, (Test) getTest());
getInternalTest().setException(exceptionInfo);
System.out.println(exceptionInfo.getStackTrace());
String tag = "pre";
String s = exceptionInfo.getStackTrace();
if (s.contains("<") || s.contains(">"))
tag = "textarea";
log(logStatus, stepName, "<" + tag + ">" + exceptionInfo.getStackTrace() + "");
}
/**
*
* Logs events for the test
*
*
* Log event is shown in the report with 3 columns:
*
*
* - Timestamp
* - Status
* - Details
*
*
* @param logStatus
* Status (see {@link LogStatus})
*
* @param t
* Exception
*/
@Override
public void log(LogStatus logStatus, Throwable t) {
log(logStatus, null, t);
}
/**
*
* Logs events for the test
*
*
* Log event is shown in the report with 3 columns:
*
*
* - Timestamp
* - Status
* - Details
*
*
* @param logStatus
* Status (see {@link LogStatus})
*
* @param details
* Details of the step
*/
@Override
public void log(LogStatus logStatus, String details) {
log(logStatus, null, details);
}
/**
*
* Sets the current test description
*
* @param description
* Description of the test
*/
@Override
public void setDescription(String description) {
test.setDescription(description);
}
/**
*
* Gets the current test description
*/
@Override
public String getDescription() {
return test.getDescription();
}
/**
*
* Provides the start time of the current test
*/
@Override
public Date getStartedTime() {
return test.getStartedTime();
}
/**
*
* Allows overriding the default start time of the test
*
*
* Note: when a test is started using extent.startTest(testName),
* the value for started time is created automatically. This method allows
* overriding the start time in cases where the actual test had already been
* run prior to extent logging the test details in the report. An example of
* this scenario is while using TestNG's IReporter listener and
* creating the report after the tests have already executed.
*
* @param startedTime
* Test's start time
*/
@Override
public void setStartedTime(Date startedTime) {
test.setStartedTime(startedTime);
}
/**
*
* Provides the end time of the current test
*/
@Override
public Date getEndedTime() {
return test.getEndedTime();
}
/**
*
* Allows overriding the default end time of the test
*
*
* Note: when a test is ended using extent.endTest(extentTest),
* the value for ended time is created automatically. This method allows
* overriding the end time in cases where the actual test had already been
* run prior to extent logging the test details in the report. An example of
* this scenario is while using TestNG's IReporter listener and
* creating the report after the tests have already executed.
*
* @param endedTime
* Test's end time
*/
@Override
public void setEndedTime(Date endedTime) {
test.setEndedTime(endedTime);
}
/**
*
* Adds a snapshot to the log event details
*
*
* Note: this method does not create the screen-capture for the report, it only
* sets the path of the image file in the report. The user is responsible for
* capturing the screen and for constructing the path to the image file.
*
* @param imagePath
* Path of the image in relation to where your report resides
*
* @return
* A formed HTML img tag
*/
@Override
public String addScreenCapture(String imagePath) {
String screenCaptureHtml = isPathRelative(imagePath)
? ScreenshotHtml.getSource(imagePath).replace("file:///", "")
: ScreenshotHtml.getSource(imagePath);
ScreenCapture img = new ScreenCapture();
img.setSource(screenCaptureHtml);
img.setTestName(test.getName());
img.setTestId(test.getId());
test.setScreenCapture(img);
return screenCaptureHtml;
}
/**
*
* Adds a snapshot to the log event details using a Base64 string
*
* @param base64
* Base64 image string
*
* @return
* A formed HTML img tag
*/
public String addBase64ScreenShot(String base64) {
String screenCaptureHtml = ScreenshotHtml.getBase64Source(base64);
ScreenCapture img = new ScreenCapture();
img.setSource(screenCaptureHtml);
img.setTestName(test.getName());
img.setTestId(test.getId());
test.setScreenCapture(img);
return screenCaptureHtml;
}
/**
*
* 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
*
* @param screencastPath
* Path of the screencast
*
* @return
* A formed HTML video tag with the supplied path
*/
@Override
public String addScreencast(String screencastPath) {
String screencastHtml = isPathRelative(screencastPath)
? ScreencastHtml.getSource(screencastPath).replace("file:///", "")
: ScreencastHtml.getSource(screencastPath);
Screencast sc = new Screencast();
sc.setSource(screencastHtml);
sc.setTestName(test.getName());
sc.setTestId(test.getId());
test.setScreencast(sc);
return screencastHtml;
}
/**
*
* Assigns category to test
*
*
* Usage: test.assignCategory("ExtentAPI");
*
* Usage: test.assignCategory("ExtentAPI", "Regression", ...);
*
* @param categories
* Category name
*
* @return
* A {@link ExtentTest} object
*/
@Override
public ExtentTest assignCategory(String... categories) {
List list = new ArrayList();
for (String c : categories) {
if (!c.trim().equals("") && !list.contains(c)) {
test.setCategory(new Category(c));
}
list.add(c);
}
return this;
}
/**
*
* Assigns author(s) to test
*
*
* Usage: test.assignAuthor("AuthorName");
*
* Usage: test.assignAuthor("Author1", "Author2", ...);
*
* @param authors Author name
* @return {@link ExtentTest}
*/
@Override
public ExtentTest assignAuthor(String... authors) {
List list = new ArrayList();
for (String author : authors) {
if (!author.trim().equals("") && !list.contains(author)) {
test.setAuthor(new Author(author));
}
list.add(author);
}
return this;
}
/**
*
* Appends a child test (another {@link ExtentTest}) to the current test
*
* @param node
* An {@link ExtentTest} object. Test that is added as the node.
*
* @return
* An {@link ExtentTest} object. Parent test which adds the node as its child.
*/
@Override
public ExtentTest appendChild(ExtentTest node) {
Test internalNode = node.getInternalTest();
internalNode.setEndedTime(Calendar.getInstance().getTime());
internalNode.isChildNode = true;
internalNode.trackLastRunStatus();
internalNode.setParentTest(getInternalTest());
test.hasChildNodes = true;
List list = new ArrayList();
// categories to strings
for (TestAttribute attr : this.test.getCategoryList()) {
if (!list.contains(attr.getName())) {
list.add(attr.getName());
}
}
// add all categories to parent-test
for (TestAttribute attr : node.getInternalTest().getCategoryList()) {
if (!list.contains(attr.getName())) {
this.test.setCategory(attr);
}
}
test.setNode(internalNode);
return this;
}
/**
*
* Provides the current run status of the test
*
* @return
* {@link LogStatus}
*/
@Override
public LogStatus getRunStatus() {
return runStatus;
}
/**
*
* Returns the interface that exposes some important methods of the underlying test
*
* @return
* A {@link ITest} object
*/
@Override
public ITest getTest() {
return test;
}
/**
*
* Returns the underlying test which controls the internal model
*
*
* Allows manipulating the test instance by accessing the internal methods
* and properties of the test
*
* @return
* A {@link Test} object
*/
Test getInternalTest() {
return test;
}
/**
*
* Determines if path of the file is relative or absolute
*
* @param path
* Path of the file
*
* @return
* Boolean
*/
private Boolean isPathRelative(String path) {
if (path.indexOf("http") == 0 || !new File(path).isAbsolute()) {
return true;
}
return false;
}
}