com.relevantcodes.extentreports.ExtentReports 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.net.URL;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.UUID;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.mongodb.MongoClientOptions;
import com.mongodb.MongoClientURI;
import com.mongodb.MongoCredential;
import com.mongodb.ServerAddress;
import com.relevantcodes.extentreports.converters.ReportParser;
import com.relevantcodes.extentreports.converters.TestConverter;
import com.relevantcodes.extentreports.model.Test;
public class ExtentReports extends Report implements Serializable {
private static final long serialVersionUID = -6996595703916138742L;
private static final Logger logger = Logger.getLogger(ExtentReports.class.getName());
/**
*
* Initializes a localized version of Extent HTML report
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param displayOrder
* Determines the order in which your tests will be displayed
*
* - OLDEST_FIRST (default) - oldest test at the top, newest at the end
* - NEWEST_FIRST - newest test at the top, oldest at the end
*
*
* @param networkMode
*
* - ONLINE - creates a single report file with all artifacts
* - OFFLINE - all report artifacts will be stored locally in
%reportFolder%/extentreports
* with the following structure:
*
* - extentreports/css
*
* - extentreports/js
*
*
*
* @param locale
* Locale to adapt for the report. All standard text for the report will be displayed
* in the selected locale.
*/
public ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder, NetworkMode networkMode, Locale locale) {
replaceExisting = replaceExisting == null ? true : replaceExisting;
displayOrder = displayOrder == null ? DisplayOrder.OLDEST_FIRST : displayOrder;
networkMode = networkMode == null ? NetworkMode.ONLINE : networkMode;
locale = locale == null ? Locale.ENGLISH : locale;
setFilePath(filePath);
setReplaceExisting(replaceExisting);
setDisplayOrder(displayOrder);
setNetworkMode(networkMode);
setDocumentLocale(locale);
attach(new HTMLReporter(filePath));
if (!replaceExisting) {
File file = new File(filePath);
if (file.exists()) {
TestConverter converter = new TestConverter(this, file);
converter.createTestList();
convertUpdateLastRunDuration();
// if ExtentX is the report server,
// get the ID to append all results to the same report
ReportParser reportParser = new ReportParser(file);
setMongoDBObjectID(reportParser.getMongoDBObjectID());
}
}
}
/**
*
* Initializes Extent HTML report
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param displayOrder
* Determines the order in which your tests will be displayed
*
* - OLDEST_FIRST (default) - oldest test at the top, newest at the end
* - NEWEST_FIRST - newest test at the top, oldest at the end
*
*
* @param networkMode
*
* - ONLINE - creates a single report file with all artifacts
* - OFFLINE - all report artifacts will be stored locally in
%reportFolder%/extentreports
* with the following structure:
*
* - extentreports/css
*
* - extentreports/js
*
*
*/
public ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder, NetworkMode networkMode) {
this(filePath, replaceExisting, displayOrder, networkMode, null);
}
/**
*
* Initializes a localized version of Extent HTML report. To see a list of supported locales,
* visit: http://extentreports.relevantcodes.com
*
*
* - Default setting
NetworkMode.ONLINE for {@link NetworkMode} is used
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param displayOrder
* Determines the order in which your tests will be displayed
*
* - OLDEST_FIRST (default) - oldest test at the top, newest at the end
* - NEWEST_FIRST - newest test at the top, oldest at the end
*
*
* @param locale
* Locale to adapt for the report. All standard text for the report will be displayed
* in the selected locale.
*/
public ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder, Locale locale) {
this(filePath, replaceExisting, displayOrder, null, locale);
}
/**
*
* Initializes Extent HTML report
*
*
* - Default setting
NetworkMode.ONLINE for {@link NetworkMode} is used
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param displayOrder
* Determines the order in which your tests will be displayed
*
* - OLDEST_FIRST (default) - oldest test at the top, newest at the end
* - NEWEST_FIRST - newest test at the top, oldest at the end
*
*/
public ExtentReports(String filePath, Boolean replaceExisting, DisplayOrder displayOrder) {
this(filePath, replaceExisting, displayOrder, null, null);
}
/**
*
* Initializes a localized version of Extent HTML report. To see a list of supported locales,
* visit: http://extentreports.relevantcodes.com
*
*
* - Default setting
DisplayOrder.OLDEST_FIRST is used for {@link DisplayOrder}
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param networkMode
*
* - ONLINE - creates a single report file with all artifacts
* - OFFLINE - all report artifacts will be stored locally in
%reportFolder%/extentreports
* with the following structure:
*
* - extentreports/css
*
* - extentreports/js
*
*
*
* @param locale
* Locale to adapt for the report. All standard text for the report will be displayed
* in the selected locale.
*/
public ExtentReports(String filePath, Boolean replaceExisting, NetworkMode networkMode, Locale locale) {
this(filePath, replaceExisting, null, networkMode, locale);
}
/**
*
* Initializes Extent HTML report
*
*
* - Default setting
DisplayOrder.OLDEST_FIRST is used for {@link DisplayOrder}
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param networkMode
*
* - ONLINE - creates a single report file with all artifacts
* - OFFLINE - all report artifacts will be stored locally in
%reportFolder%/extentreports
* with the following structure:
*
* - extentreports/css
*
* - extentreports/js
*
*
*/
public ExtentReports(String filePath, Boolean replaceExisting, NetworkMode networkMode) {
this(filePath, replaceExisting, null, networkMode, null);
}
/**
*
* Initializes Extent HTML report
*
*
* - Default setting (true) is used for replaceExisting
* - Default setting
DisplayOrder.OLDEST_FIRST is used for {@link DisplayOrder}
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param networkMode
*
* - ONLINE - creates a single report file with all artifacts
* - OFFLINE - all report artifacts will be stored locally in
%reportFolder%/extentreports
* with the following structure:
*
* - extentreports/css
*
* - extentreports/js
*
*
*/
public ExtentReports(String filePath, NetworkMode networkMode) {
this(filePath, null, null, networkMode, null);
}
/**
*
* Initializes a localized version of Extent HTML report. To see a list of supported locales,
* visit: http://extentreports.relevantcodes.com
*
*
* Note: a new report will be created by default since replaceExisting is
* true by default
*
*
* Examples:
*
*
* - English (default):
new ExtentReports("filePath", Locale.ENGLISH);
* - Spanish locale:
new ExtentReports("filePath", new Locale("es"));
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*
* @param locale
* Locale to adapt for the report. All standard text for the report will be displayed
* in the selected locale.
*/
public ExtentReports(String filePath, Boolean replaceExisting, Locale locale) {
this(filePath, replaceExisting, null, null, locale);
}
/**
*
* Initializes Extent HTML report
*
*
* - Default setting
DisplayOrder.OLDEST_FIRST is used for {@link DisplayOrder}
* - Default setting
NetworkMode.ONLINE for {@link NetworkMode} is used
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param replaceExisting
* Setting to overwrite (TRUE) the existing file or append (FALSE) to it
*
* - true - the file will be replaced with brand new markup, and all existing data
* will be lost. Use this option to create a brand new report
* - false - existing data will remain, new tests will be appended to the existing report.
* If the the supplied path does not exist, a new file will be created.
*
*/
public ExtentReports(String filePath, Boolean replaceExisting) {
this(filePath, replaceExisting, null, null, null);
}
/**
*
* Initializes a localized version of Extent HTML report. To see a list of supported locales,
* visit: http://extentreports.relevantcodes.com
*
*
* Note: a new report will be created by default since replaceExisting is
* true by default
*
*
* Examples:
*
*
* - English (default):
new ExtentReports("filePath", Locale.ENGLISH);
* - Spanish locale:
new ExtentReports("filePath", new Locale("es"));
*
*
* @param filePath
* Path of the file, in .htm or .html format
*
* @param locale
* Locale to adapt for the report. All standard text for the report will be displayed
* in the selected locale.
*/
public ExtentReports(String filePath, Locale locale) {
this(filePath, null, null, null, locale);
}
/**
*
* Initializes Extent HTML report
*
*
* - Default setting (true) is used for replaceExisting
* - Default setting
DisplayOrder.OLDEST_FIRST is used for {@link DisplayOrder}
* - Default setting
NetworkMode.ONLINE for {@link NetworkMode} is used
*
*
* @param filePath
* Path of the file, in .htm or .html format
*/
public ExtentReports(String filePath) {
this(filePath, null, null, null, null);
}
/**
*
* Assign a project name to the report
*
* @param name
* Project name
*
* @return {@link ExtentReports} object
*/
public ExtentReports assignProject(String name) {
setProjectName(name);
return this;
}
/**
*
* Gets the UUID of the report
*
*
* Note: Each time an instance of ExtentReports is created, a unique
* UUID is created for that instance automatically. This unique UUID is also stored
* in the database (if the database reporter is started).
*
* @return
* Report's unique {@link UUID}
*/
public UUID getReportId() {
return getId();
}
/**
*
* Allows performing configuration and customization to the HTML report from
* configuration external file
*
* @param configFile
* Config file (extent-config.xml)
*/
public void loadConfig(File configFile) {
if (!configFile.exists()) {
logger.log(
Level.WARNING,
"Unable to perform report configuration. The file " + configFile.getAbsolutePath() + " was not found."
);
return;
}
if (!configFile.getName().endsWith(".xml")) {
logger.log(
Level.WARNING,
"Unable to perform report configuration. The file " + configFile.getAbsolutePath() + " must be an XML file."
);
return;
}
loadConfig(new Configuration(configFile));
}
/**
*
* Allows performing configuration and customization to the HTML report from URL resource
*
* @param url
* URL pointer to the resource file
*/
public void loadConfig(URL url) {
loadConfig(new Configuration(url));
}
/**
*
* Allows performing configuration and customization to the HTML report from local resource
*
* @param clazz
* The class relative to which the configuration file will be loaded
*
* @param fileName
* Name of the file from the clazz package
*/
@SuppressWarnings("rawtypes")
public void loadConfig(Class clazz, String fileName) {
loadConfig(clazz, null, fileName);
}
/**
*
* Allows performing configuration and customization to the HTML report from local resource.
*
*
* Example: Sonsider the following clazz, basePackagePath
* and fileName:
*
*
* clazz : "com/relevantcodes/extentreports/ExtentReports.class"basePackagePath : "resources"fileName : "extent-config.xml"
*
*
* The above inputs will build the final path as: "com/relevantcodes/extentreports/resources/extent-config.xml"
*
* @param clazz
* The class relative to which the configuration file will be loaded
*
* @param basePackagePath
* The package that contains the configuration file. The basePackagePath is relative
* to the clazz
*
* @param fileName
* Name of the file from the clazz package
*/
@SuppressWarnings("rawtypes")
public void loadConfig(Class clazz, String basePackagePath, String fileName) {
String fullPackagePath =
clazz.getPackage().getName().replace(".", File.separator)
+ File.separator
+ fileName;
if (basePackagePath != null) {
fullPackagePath =
clazz.getPackage().getName().replace(".", File.separator)
+ File.separator
+ basePackagePath
+ File.separator
+ fileName;
}
URL url = getClass().getClassLoader().getResource(fullPackagePath);
if (url == null) {
logger.log(
Level.WARNING,
"Unable to perform report configuration. The package or file " + fullPackagePath + " was not found."
);
return;
}
loadConfig(new Configuration(url));
}
/**
*
* Initializes ExtentX and connects to MongoDB using default host (localhost) and
* port (27017)
*/
public void x() {
attach(new ExtentX());
}
/**
*
* Initializes ExtentX and connects to MongoDB using host and default port (27017)
*
* @param host
* MongoDB's database's host address
*/
public void x(String host) {
attach(new ExtentX(host));
}
/**
*
* Initializes ExtentX and connects to MongoDB
*
* @param host
* The database's host address
*
* @param port
* The port on which the database is running
*/
public void x(String host, int port) {
attach(new ExtentX(host, port));
}
/**
*
* Initializes ExtentX and connects to MongoDB described by a URI
*
*
* Creates a Mongo described by a URI. If only one address is used MongoClient
* will only connect to that node, otherwise it will discover all nodes
*
* @param uri
* The URI
*/
public void x(MongoClientURI uri) {
attach(new ExtentX(uri));
}
/**
*
* Initializes ExtentX and connects to MongoDB based on a (single) mongodb
* node (default port)
*
* @param host
* The database's host address
*
* @param options
* Default query options
*/
public void x(String host, MongoClientOptions options) {
attach(new ExtentX(host, options));
}
/**
*
* Initializes ExtentX and connects to MongoDB
*
* @param addr
* The database address
*/
public void x(ServerAddress addr) {
attach(new ExtentX(addr));
}
/**
*
* Initializes ExtentX and connects to MongoDB. Creates a Mongo based on a list
* of replica set members or a list of mongos.
*
* @param seeds
* List of mongod servers in the same replica set or a list of mongos
* servers in the same sharded cluster
*/
public void x(List seeds) {
attach(new ExtentX(seeds));
}
/**
*
* Initializes ExtentX and connects to MongoDB. Creates a Mongo based on a list
* of replica set members or a list of mongos.
*
* @param seeds
* List of mongod servers in the same replica set or a list of mongos
* servers in the same sharded cluster
*
* @param credentialsList
* The list of credentials used to authenticate all connections
*/
public void x(List seeds, List credentialsList) {
attach(new ExtentX(seeds, credentialsList));
}
/**
*
* Initializes ExtentX and connects to MongoDB based on a list of replica set
* members or a list of mongos
*
* @param seeds
* List of mongod servers in the same replica set or a list of mongos
* servers in the same sharded cluster
*
* @param credentialsList
* The list of credentials used to authenticate all connections
*
* @param options
* Default options
*/
public void x(List seeds, List credentialsList, MongoClientOptions options) {
attach(new ExtentX(seeds, credentialsList, options));
}
/**
*
* Initializes ExtentX and connects to MongoDB
*
* @param seeds
* List of mongod servers in the same replica set or a list of mongos
* servers in the same sharded cluster
*
* @param options
* Default options
*/
public void x(List seeds, MongoClientOptions options) {
attach(new ExtentX(seeds, options));
}
/**
*
* Initializes ExtentX and connects to MongoDB
*
* @param addr
* The database address
*
* @param credentialsList
* The list of credentials used to authenticate all connections
*/
public void x(ServerAddress addr, List credentialsList) {
attach(new ExtentX(addr, credentialsList));
}
/**
*
* Initializes ExtentX and connects to MongoDB
*
* @param addr
* The database address
*
* @param credentialsList
* The list of credentials used to authenticate all connections
*
* @param options
* Default options
*/
public void x(ServerAddress addr, List credentialsList, MongoClientOptions options) {
attach(new ExtentX(addr, credentialsList, options));
}
/**
*
* Initializes ExtentX and connects to MongoDB
*
* @param addr
* The database address
*
* @param options
* Default options
*/
public void x(ServerAddress addr, MongoClientOptions options) {
attach(new ExtentX(addr, options));
}
/**
*
* Starts a custom reporter based upon {@link ReporterType}. The file extension determines if
* the reporter-type will be started.
*
*
* For ReporterType the extension must be .db
*
* @param reporterType {@link ReporterType}
* Type of the reporter to be initialized
*
* @param filePath
* Path of the report source, with the correct extension for the reporter
*
* @return
* An {@link ExtentReports} object
*/
public synchronized ExtentReports startReporter(ReporterType reporterType, String filePath) {
if (reporterType == ReporterType.DB) {
attach(new DBReporter(filePath));
}
return this;
}
/**
*
* Calling startTest() generates a toggle for the test in the HTML file and adds all
* log events under this level. This is a required step and without calling this method
* the toggle will not be created for the test and log will not be added.
*
* @param testName
* Name of the test
*
* @param description
* A short description of the test
*
* @return
* An {@link ExtentTest} object
*/
public synchronized ExtentTest startTest(String testName, String description) {
ExtentTest test = new ExtentTest(testName, description);
updateTestQueue(test);
return test;
}
/**
*
* Calling startTest() generates a toggle for the test in the HTML file and adds all
* log events under this level. This is a required step and without calling this method
* the toggle will not be created for the test and log will not be added.
*
* @param testName
* Name of the test
*
* @return
* An {@link ExtentTest} object
*/
public synchronized ExtentTest startTest(String testName) {
return startTest(testName, "");
}
/**
*
* Ends and prepares the test to be added to the report on flush()
*
*
* If ReporterType.DB is used, a row in the TEST table is created
*
* @param extentTest
* An {@link ExtentTest} object
*/
public synchronized void endTest(ExtentTest extentTest) {
if (extentTest != null && !extentTest.getInternalTest().isChildNode) {
Test test = extentTest.getInternalTest();
// ensure the same test isn't being closed twice
if (!test.hasEnded) {
test.hasEnded = true;
finalizeTest(test);
}
}
}
/**
*
* Add system information to the SystemInfo view
*
* @param info
* SystemInfo values as Key-Value pairs
* @return
* An {@link ExtentReports} object
*/
public ExtentReports addSystemInfo(Map info) {
if (info != null) {
systemInfo.setInfo(info);
}
return this;
}
/**
*
* Add system information to the SystemInfo view
*
* @param param
* Name of system parameter
*
* @param value
* Value of system parameter
*
* @return
* An {@link ExtentReports} object
*/
public ExtentReports addSystemInfo(String param, String value) {
if (param != null) {
systemInfo.setInfo(param, value);
}
return this;
}
/**
*
* Adds logs from test framework tools such as TestNG
*
* @param log
* Log string from the TestRunner
*/
public void setTestRunnerOutput(String log) {
setTestRunnerLogs(log);
}
/**
*
* Appends the HTML file with all the ended tests. There must be at least 1 ended test
* for anything to be appended to the report.
*
*
* Note: If flush() is called before any of the ended tests,
* no information will be appended.
*
*
* Note: If flush() is called while the test is running (not yet ended),
* it will not be appended to the report.
*/
public synchronized void flush() {
removeChildTests();
super.flush();
}
/**
*
* Closes the underlying stream and clears all resources
*
*
* Once close is called, additional information will not be sent to the report. Any
* attempt to flush() will result in a IOException.
*
*
* If any of your test ended abruptly causing any side-affects (not all logs sent
* to ExtentReports, information missing), this method will ensure that the test is
* still appended to the report with a warning message.
*/
public synchronized void close() {
terminate();
if (testList != null) {
testList.clear();
}
}
/**
*
* This method is deprecated and replace with an external configuration file. For more
* information, visit this link:
* http://extentreports.relevantcodes.com/java/version2/docs.html#configuration
*
* @return
* HTMLReporter.Config object
*/
@Deprecated
public HTMLReporter.Config config() {
HTMLReporter hr = new HTMLReporter(null);
return hr.new Config();
}
/**
* Removes all child nodes in testList - a container for parent tests only.
* When flush() is called, it adds all parent tests to the report and child
* tests as nodes. This method makes sure no child tests are added as top-level nodes.
*/
private synchronized void removeChildTests() {
if (testList == null) {
return;
}
Iterator iterator = testList.iterator();
Test t;
while (iterator.hasNext()) {
t = iterator.next().getInternalTest();
if (t.isChildNode) {
iterator.remove();
}
}
}
}