com.aventstack.extentreports.reporter

Class ExtentXReporter

java.lang.Object

com.aventstack.extentreports.reporter.AbstractReporter

com.aventstack.extentreports.reporter.ExtentXReporter

All Implemented Interfaces:

ExtentReporter, ReportAggregatesListener, ReportAppendable, TestDisplayOrderSetting, TestListener

public class ExtentXReporter
extends AbstractReporter
implements ReportAppendable

ExtentXReporter is a NoSQL database reporter (MongoDB by default), which updates information in the database which is then used by the ExtentX server to display in-depth analysis.

Constructor Summary

Constructors

Constructor and Description
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds)
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds, java.util.List<com.mongodb.MongoCredential> credentialsList)
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds, java.util.List<com.mongodb.MongoCredential> credentialsList, com.mongodb.MongoClientOptions options)
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds, com.mongodb.MongoClientOptions options)
ExtentXReporter(com.mongodb.MongoClientURI uri)
ExtentXReporter(com.mongodb.ServerAddress addr)
ExtentXReporter(com.mongodb.ServerAddress addr, java.util.List<com.mongodb.MongoCredential> credentialsList)
ExtentXReporter(com.mongodb.ServerAddress addr, java.util.List<com.mongodb.MongoCredential> credentialsList, com.mongodb.MongoClientOptions options)
ExtentXReporter(com.mongodb.ServerAddress addr, com.mongodb.MongoClientOptions options)
ExtentXReporter(java.lang.String host)
ExtentXReporter(java.lang.String host, int port)
ExtentXReporter(java.lang.String host, com.mongodb.MongoClientOptions options)

Method Summary

Modifier and Type	Method and Description
ExtentXReporterConfiguration	config()
void	flush()
org.bson.types.ObjectId	getProjectId()
org.bson.types.ObjectId	getReportId()
java.util.List<Test>	getTestList()
void	onAuthorAssigned(Test test, Author author) Invoked each time an author is assigned to any test/node
void	onCategoryAssigned(Test test, Category category) Invoked each time a category is assigned to any test/node
void	onLogAdded(Test test, Log log) Invoked each time a log is added to any test/node
void	onNodeStarted(Test node) Invoked when a node is started using createNode(args)
void	onScreenCaptureAdded(Log log, ScreenCapture screenCapture) Invoked each time a screenshot is added to log
void	onScreenCaptureAdded(Test test, ScreenCapture screenCapture) Invoked each time a screencapture is added to test
void	onScreencastAdded(Test test, Screencast screencast) Invoked each time a screencast is added
void	onTestStarted(Test test) Invoked when a test is started using createTest(args)
void	setAppendExisting(java.lang.Boolean b)
void	setTestList(java.util.List<Test> reportTestList) Allows sharing the complete list of tests with the reporter
void	start() Starts passing run information to the reporter
void	stop() Stops the reporter.

Methods inherited from class com.aventstack.extentreports.reporter.AbstractReporter

getCategoryContextInfo, getEndTime, getExceptionContextInfo, getRunDuration, getStartTime, getStatusCount, getSystemAttributeContext, getTestDisplayOrder, getTestRunnerLogs, loadConfig, loadConfig, loadConfig, loadXMLConfig, loadXMLConfig, setCategoryContextInfo, setEndTime, setExceptionContextInfo, setStartTime, setStatusCount, setSystemAttributeContext, setTestDisplayOrder, setTestRunnerLogs

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentXReporter

public ExtentXReporter(java.lang.String host)

ExtentXReporter

public ExtentXReporter(java.lang.String host,
                       com.mongodb.MongoClientOptions options)

ExtentXReporter

public ExtentXReporter(java.lang.String host,
                       int port)

ExtentXReporter

public ExtentXReporter(com.mongodb.MongoClientURI uri)

ExtentXReporter

public ExtentXReporter(com.mongodb.ServerAddress addr)

ExtentXReporter

public ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds)

ExtentXReporter

public ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds,
                       java.util.List<com.mongodb.MongoCredential> credentialsList)

ExtentXReporter

public ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds,
                       java.util.List<com.mongodb.MongoCredential> credentialsList,
                       com.mongodb.MongoClientOptions options)

ExtentXReporter

public ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds,
                       com.mongodb.MongoClientOptions options)

ExtentXReporter

public ExtentXReporter(com.mongodb.ServerAddress addr,
                       java.util.List<com.mongodb.MongoCredential> credentialsList)

ExtentXReporter

public ExtentXReporter(com.mongodb.ServerAddress addr,
                       java.util.List<com.mongodb.MongoCredential> credentialsList,
                       com.mongodb.MongoClientOptions options)

ExtentXReporter

public ExtentXReporter(com.mongodb.ServerAddress addr,
                       com.mongodb.MongoClientOptions options)

Method Detail

config

public ExtentXReporterConfiguration config()

start

public void start()

Description copied from interface: ExtentReporter

Starts passing run information to the reporter

Specified by:

start in interface ExtentReporter

stop

public void stop()

Description copied from interface: ExtentReporter

Stops the reporter. Ensures no information is passed to the reporter.

Specified by:

stop in interface ExtentReporter

flush

public void flush()

Specified by:

flush in interface ExtentReporter

onTestStarted

public void onTestStarted(Test test)

Description copied from interface: TestListener

Invoked when a test is started using createTest(args)

Specified by:

onTestStarted in interface TestListener

Parameters:

test - Test object

onNodeStarted

public void onNodeStarted(Test node)

Description copied from interface: TestListener

Invoked when a node is started using createNode(args)

Specified by:

onNodeStarted in interface TestListener

Parameters:

node - Test object

onLogAdded

public void onLogAdded(Test test,
                       Log log)

Description copied from interface: TestListener

Invoked each time a log is added to any test/node

Specified by:

onLogAdded in interface TestListener

Parameters:

test - Test object

log - Log object

onCategoryAssigned

public void onCategoryAssigned(Test test,
                               Category category)

Description copied from interface: TestListener

Invoked each time a category is assigned to any test/node

Specified by:

onCategoryAssigned in interface TestListener

Parameters:

test - Test object

category - Category object

onAuthorAssigned

public void onAuthorAssigned(Test test,
                             Author author)

Description copied from interface: TestListener

Invoked each time an author is assigned to any test/node

Specified by:

onAuthorAssigned in interface TestListener

Parameters:

test - Test object

author - Author

onScreenCaptureAdded

public void onScreenCaptureAdded(Test test,
                                 ScreenCapture screenCapture)
                          throws java.io.IOException

Description copied from interface: TestListener

Invoked each time a screencapture is added to test

Specified by:

onScreenCaptureAdded in interface TestListener

Parameters:

test - Test object

screenCapture - ScreenCapture object

Throws:

java.io.IOException - Exception thrown if the media object is not found

onScreenCaptureAdded

public void onScreenCaptureAdded(Log log,
                                 ScreenCapture screenCapture)
                          throws java.io.IOException

Description copied from interface: TestListener

Invoked each time a screenshot is added to log

Specified by:

onScreenCaptureAdded in interface TestListener

Parameters:

log - Log object

screenCapture - ScreenCapture object

Throws:

java.io.IOException - Exception thrown if the media object is not found

onScreencastAdded

public void onScreencastAdded(Test test,
                              Screencast screencast)
                       throws java.io.IOException

Description copied from interface: TestListener

Invoked each time a screencast is added

Specified by:

onScreencastAdded in interface TestListener

Parameters:

test - Test object

screencast - Screencast object

Throws:

java.io.IOException - Exception thrown if the media object is not found

setTestList

public void setTestList(java.util.List<Test> reportTestList)

Description copied from interface: ReportAggregatesListener

Allows sharing the complete list of tests with the reporter

Specified by:

setTestList in interface ReportAggregatesListener

Parameters:

reportTestList - list of all tests created by ExtentReports

getTestList

public java.util.List<Test> getTestList()

setAppendExisting

public void setAppendExisting(java.lang.Boolean b)

Specified by:

setAppendExisting in interface ReportAppendable

getProjectId

public org.bson.types.ObjectId getProjectId()

getReportId

public org.bson.types.ObjectId getReportId()