com.aventstack.extentreports.reporter

Class KlovReporter

java.lang.Object

com.aventstack.extentreports.reporter.AbstractReporter

com.aventstack.extentreports.reporter.KlovReporter

All Implemented Interfaces:

ExtentReporter, IAnalysisStrategy, ReportAggregatesListener, TestListener

public class KlovReporter
extends AbstractReporter

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.

Field Summary

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

authorContext, categoryContext, configContext, configMap, endTime, exceptionContext, filePath, levels, sc, startTime, systemAttributeContext, templateMap, testList, testRunnerLogs

Constructor Summary

Constructors

Constructor and Description
KlovReporter() Initializes the KlovReporter
KlovReporter(java.lang.String projectName, java.lang.String reportName) Initializes the KlovReporter with project and report names

Method Summary

Modifier and Type	Method and Description
void	flush()
java.lang.String	getKlovUrl()
org.bson.types.ObjectId	getProjectId() Returns the active Project ID
java.lang.String	getProjectName()
org.bson.types.ObjectId	getReportId() Returns the active Report ID
java.lang.String	getReportName()
java.util.List<Test>	getTestList()
void	initKlovServerConnection(java.lang.String url) Initializes the Mongo DB connection with a connection url
void	initMongoDbConnection(java.util.List<com.mongodb.ServerAddress> seeds) Initializes the Mongo DB connection with a list of ServerAddress addresses
void	initMongoDbConnection(java.util.List<com.mongodb.ServerAddress> seeds, java.util.List<com.mongodb.MongoCredential> credentialsList) Initializes the Mongo DB connection with a list of ServerAddress and MongoCredential
void	initMongoDbConnection(java.util.List<com.mongodb.ServerAddress> seeds, java.util.List<com.mongodb.MongoCredential> credentialsList, com.mongodb.MongoClientOptions options) Initializes the Mongo DB connection with a list of ServerAddress, MongoCredential and MongoClientOptions
void	initMongoDbConnection(java.util.List<com.mongodb.ServerAddress> seeds, com.mongodb.MongoClientOptions options) Initializes the Mongo DB connection with a list of ServerAddress and MongoClientOptions
void	initMongoDbConnection(com.mongodb.MongoClientURI uri) Initialize Mongo DB connection with a MongoClientURI
void	initMongoDbConnection(com.mongodb.ServerAddress addr) Initializes the Mongo DB connection with ServerAddress
void	initMongoDbConnection(com.mongodb.ServerAddress addr, java.util.List<com.mongodb.MongoCredential> credentialsList) Initializes the Mongo DB connection with ServerAddress and a list of MongoCredential credentials
void	initMongoDbConnection(com.mongodb.ServerAddress addr, java.util.List<com.mongodb.MongoCredential> credentialsList, com.mongodb.MongoClientOptions options) Initializes the Mongo DB connection with a list of ServerAddress, MongoCredential and MongoClientOptions
void	initMongoDbConnection(com.mongodb.ServerAddress addr, com.mongodb.MongoClientOptions options) Initializes the Mongo DB connection with a ServerAddress and MongoClientOptions
void	initMongoDbConnection(java.lang.String host) Initialize Mongo DB connection with host and default port: 27017
void	initMongoDbConnection(java.lang.String host, int port) Initialize Mongo DB connection with host and post
void	initMongoDbConnection(java.lang.String host, com.mongodb.MongoClientOptions options) Initialize Mongo DB connection with host and MongoClientOptions
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 screencapture 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	setKlovUrl(java.lang.String url) Sets the Klov url
void	setProjectName(java.lang.String projectName) Sets the project name
void	setReportName(java.lang.String reportName) Sets the report name
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

getAnalysisStrategy, getAuthorContextInfo, getCategoryContextInfo, getEndTime, getExceptionContextInfo, getRunDuration, getStartTime, getStatusCount, getSystemAttributeContext, getTestRunnerLogs, loadConfig, loadConfig, loadConfig, loadXMLConfig, loadXMLConfig, setAnalysisStrategy, setAuthorContextInfo, setCategoryContextInfo, setEndTime, setExceptionContextInfo, setStartTime, setStatusCount, setSystemAttributeContext, setTestRunnerLogs

Methods inherited from class java.lang.Object

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

Constructor Detail

KlovReporter

public KlovReporter()

Initializes the KlovReporter

KlovReporter

public KlovReporter(java.lang.String projectName,
                    java.lang.String reportName)

Initializes the KlovReporter with project and report names

Parameters:

projectName - Name of the project

reportName - Name of the report

Method Detail

getProjectName

public java.lang.String getProjectName()

setProjectName

public void setProjectName(java.lang.String projectName)

Sets the project name

Parameters:

projectName - Name of the project

getReportName

public java.lang.String getReportName()

setReportName

public void setReportName(java.lang.String reportName)

Sets the report name

Parameters:

reportName - Name of the report

getKlovUrl

public java.lang.String getKlovUrl()

setKlovUrl

public void setKlovUrl(java.lang.String url)

Sets the Klov url

Note: its mandatory to set the url if you plan to view images on the Klov server

Parameters:

url - Url of Klov Server

initMongoDbConnection

public void initMongoDbConnection(java.lang.String host)

Initialize Mongo DB connection with host and default port: 27017

Parameters:

host - host name

initMongoDbConnection

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

Initialize Mongo DB connection with host and MongoClientOptions

Parameters:

host - host name

options - MongoClientOptions options

initMongoDbConnection

public void initMongoDbConnection(java.lang.String host,
                                  int port)

Initialize Mongo DB connection with host and post

Parameters:

host - host name

port - port number

initMongoDbConnection

public void initMongoDbConnection(com.mongodb.MongoClientURI uri)

Initialize Mongo DB connection with a MongoClientURI

Parameters:

uri - MongoClientURI uri

initMongoDbConnection

public void initMongoDbConnection(com.mongodb.ServerAddress addr)

Initializes the Mongo DB connection with ServerAddress

Parameters:

addr - ServerAddress server address

initMongoDbConnection

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

Initializes the Mongo DB connection with a list of ServerAddress addresses

Parameters:

seeds - A list of ServerAddress server addresses

initMongoDbConnection

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

Initializes the Mongo DB connection with a list of ServerAddress and MongoCredential

Parameters:

seeds - A list of ServerAddress server addresses

credentialsList - A list of MongoCredential credentials

initMongoDbConnection

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

Initializes the Mongo DB connection with a list of ServerAddress, MongoCredential and MongoClientOptions

Parameters:

seeds - A list of ServerAddress server addresses

credentialsList - A list of MongoCredential credentials

options - MongoClientOptions options

initMongoDbConnection

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

Initializes the Mongo DB connection with a list of ServerAddress and MongoClientOptions

Parameters:

seeds - A list of ServerAddress server addresses

options - MongoClientOptions options

initMongoDbConnection

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

Initializes the Mongo DB connection with ServerAddress and a list of MongoCredential credentials

Parameters:

addr - ServerAddress server address

credentialsList - A list of MongoCredential credentials

initMongoDbConnection

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

Initializes the Mongo DB connection with a list of ServerAddress, MongoCredential and MongoClientOptions

Parameters:

addr - A list of ServerAddress server addresses

credentialsList - A list of MongoCredential credentials

options - MongoClientOptions options

initMongoDbConnection

public void initMongoDbConnection(com.mongodb.ServerAddress addr,
                                  com.mongodb.MongoClientOptions options)

Initializes the Mongo DB connection with a ServerAddress and MongoClientOptions

Parameters:

addr - A list of ServerAddress server addresses

options - MongoClientOptions options

initKlovServerConnection

public void initKlovServerConnection(java.lang.String url)

Initializes the Mongo DB connection with a connection url

Parameters:

url - Url string

start

public void start()

Description copied from interface: ExtentReporter

Starts passing run information to the reporter

stop

public void stop()

Description copied from interface: ExtentReporter

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

flush

public void flush()

onTestStarted

public void onTestStarted(Test test)

Description copied from interface: TestListener

Invoked when a test is started using createTest(args)

Parameters:

test - Test object

onNodeStarted

public void onNodeStarted(Test node)

Description copied from interface: TestListener

Invoked when a node is started using createNode(args)

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

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

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

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

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 screencapture is added to log

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

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

Parameters:

reportTestList - list of all tests created by ExtentReports

getTestList

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

getProjectId

public org.bson.types.ObjectId getProjectId()

Returns the active Project ID

Returns:

A ObjectId object

getReportId

public org.bson.types.ObjectId getReportId()

Returns the active Report ID

Returns:

A ObjectId object