com.aventstack.extentreports.reporter

Class ExtentKlovReporter

java.lang.Object

com.aventstack.extentreports.reporter.AbstractReporter

com.aventstack.extentreports.reporter.ConfigurableReporter

com.aventstack.extentreports.reporter.ExtentKlovReporter

All Implemented Interfaces:

IAnalysisStrategyMethod, ExtentReporter, TestListener

public class ExtentKlovReporter
extends ConfigurableReporter

ExtentKlovReporter is a NoSQL database reporter (MongoDB), 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
ExtentKlovReporter(java.lang.String projectName) Initializes the KlovReporter with the project name and default report name
ExtentKlovReporter(java.lang.String projectName, java.lang.String reportName) Initializes the KlovReporter with project and report names

Method Summary

Modifier and Type	Method and Description
<T extends Attribute> void	assignAttribute(Test test, Attribute attribute, java.util.Map<java.lang.String,org.bson.types.ObjectId> nameObjectIdCollection, com.mongodb.client.MongoCollection<org.bson.Document> mongoCollection, TestAttributeTestContextStore<T> attributeContext)
void	flush(ReportAggregates reportAggregates) Write to or update the target source (file, database)
java.util.List<org.bson.types.ObjectId>	getCollectionValues(java.util.Map<java.lang.String,org.bson.types.ObjectId> collection)
org.bson.types.ObjectId	getProjectId() Returns the active Project ID
java.lang.String	getReporterName() Get the reporter name
org.bson.types.ObjectId	getReportId() Returns the active Report ID
ExtentKlovReporter	initKlovServerConnection(java.lang.String url) Initializes the Mongo DB connection with a connection url
ExtentKlovReporter	initMongoDbConnection(java.util.List<com.mongodb.ServerAddress> seeds) Initializes the Mongo DB connection with a list of ServerAddress addresses
ExtentKlovReporter	initMongoDbConnection(java.util.List<com.mongodb.ServerAddress> seeds, com.mongodb.MongoClientOptions options) Initializes the Mongo DB connection with a list of ServerAddress and MongoClientOptions
ExtentKlovReporter	initMongoDbConnection(com.mongodb.MongoClientURI uri) Initialize Mongo DB connection with a MongoClientURI
ExtentKlovReporter	initMongoDbConnection(com.mongodb.ServerAddress addr) Initializes the Mongo DB connection with ServerAddress
ExtentKlovReporter	initMongoDbConnection(com.mongodb.ServerAddress addr, com.mongodb.MongoClientOptions options) Initializes the Mongo DB connection with a ServerAddress and MongoClientOptions
ExtentKlovReporter	initMongoDbConnection(java.lang.String host) Initialize Mongo DB connection with host and default port: 27017
ExtentKlovReporter	initMongoDbConnection(java.lang.String host, int port) Initialize Mongo DB connection with host and post
ExtentKlovReporter	initMongoDbConnection(java.lang.String host, com.mongodb.MongoClientOptions options) Initialize Mongo DB connection with host and MongoClientOptions
void	loadInitializationParams(java.io.InputStream is)
void	loadInitializationParams(java.util.Properties props)
void	loadInitializationParams(java.lang.String propertiesPath)
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	onDeviceAssigned(Test test, Device device) Invoked each time a device 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()
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	onTestRemoved(Test test) Invoked when a test is removed using removeTest()
void	onTestStarted(Test test) Invoked when a test is started using createTest()
ExtentKlovReporter	setProjectName(java.lang.String projectName) Sets the project name
ExtentKlovReporter	setReportName(java.lang.String reportName) Sets the report name
void	start() Starts passing run information to the reporter
void	stop() Stops the reporter.

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

getConfigurationStore, init, loadConfig, loadConfig, loadConfig, loadInternalReporterConfiguration, loadUserConfig, loadXMLConfig, loadXMLConfig, loadXMLConfig, loadXMLConfig

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

autoCreateRelativePathMedia, getAnalysisStrategy, getAuthorContextInfo, getCategoryContextInfo, getDeviceContextInfo, getEndTime, getExceptionContextInfo, getLongRunDuration, getReportStatusStats, getRunDuration, getStartTime, getStatusCollection, getSystemAttributeContext, getTestList, getTestRunnerLogs, setAnalysisStrategy, setEndTime, setStartTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentKlovReporter

public ExtentKlovReporter(java.lang.String projectName)

Initializes the KlovReporter with the project name and default report name

The reportName will be created using the current timestamp

Parameters:

projectName - Name of the project

ExtentKlovReporter

public ExtentKlovReporter(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

setProjectName

public ExtentKlovReporter setProjectName(java.lang.String projectName)

Sets the project name

Parameters:

projectName - Name of the project

Returns:

a ExtentKlovReporter object

setReportName

public ExtentKlovReporter setReportName(java.lang.String reportName)

Sets the report name

Parameters:

reportName - Name of the report

Returns:

a ExtentKlovReporter object

initMongoDbConnection

public ExtentKlovReporter initMongoDbConnection(java.lang.String host)

Initialize Mongo DB connection with host and default port: 27017

Parameters:

host - host name

Returns:

a ExtentKlovReporter object

initMongoDbConnection

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

Initialize Mongo DB connection with host and MongoClientOptions

Parameters:

host - host name

options - MongoClientOptions options

Returns:

a ExtentKlovReporter object

initMongoDbConnection

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

Initialize Mongo DB connection with host and post

Parameters:

host - host name

port - port number

Returns:

a ExtentKlovReporter object

initMongoDbConnection

public ExtentKlovReporter initMongoDbConnection(com.mongodb.MongoClientURI uri)

Initialize Mongo DB connection with a MongoClientURI

Parameters:

uri - MongoClientURI uri

Returns:

a ExtentKlovReporter object

initMongoDbConnection

public ExtentKlovReporter initMongoDbConnection(com.mongodb.ServerAddress addr)

Initializes the Mongo DB connection with ServerAddress

Parameters:

addr - ServerAddress server address

Returns:

a ExtentKlovReporter object

initMongoDbConnection

public ExtentKlovReporter 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

Returns:

a ExtentKlovReporter object

initMongoDbConnection

public ExtentKlovReporter 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

Returns:

a ExtentKlovReporter object

initMongoDbConnection

public ExtentKlovReporter 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

Returns:

a ExtentKlovReporter object

initKlovServerConnection

public ExtentKlovReporter initKlovServerConnection(java.lang.String url)

Initializes the Mongo DB connection with a connection url

Parameters:

url - Url string

Returns:

a ExtentKlovReporter object

loadInitializationParams

public void loadInitializationParams(java.io.InputStream is)

loadInitializationParams

public void loadInitializationParams(java.lang.String propertiesPath)
                              throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

loadInitializationParams

public void loadInitializationParams(java.util.Properties props)

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.

Specified by:

stop in interface ExtentReporter

Overrides:

stop in class AbstractReporter

flush

public void flush(ReportAggregates reportAggregates)

Description copied from interface: ExtentReporter

Write to or update the target source (file, database)

Specified by:

flush in interface ExtentReporter

Overrides:

flush in class AbstractReporter

Parameters:

reportAggregates - a ReportAggregates object

getCollectionValues

public java.util.List<org.bson.types.ObjectId> getCollectionValues(java.util.Map<java.lang.String,org.bson.types.ObjectId> collection)

onTestStarted

public void onTestStarted(Test test)

Description copied from interface: TestListener

Invoked when a test is started using createTest()

Specified by:

onTestStarted in interface TestListener

Overrides:

onTestStarted in class AbstractReporter

Parameters:

test - Test object

onNodeStarted

public void onNodeStarted(Test node)

Description copied from interface: TestListener

Invoked when a node is started using createNode()

Specified by:

onNodeStarted in interface TestListener

Overrides:

onNodeStarted in class AbstractReporter

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

Overrides:

onLogAdded in class AbstractReporter

Parameters:

test - Test object

log - Log object

assignAttribute

public <T extends Attribute> void assignAttribute(Test test,
                                                  Attribute attribute,
                                                  java.util.Map<java.lang.String,org.bson.types.ObjectId> nameObjectIdCollection,
                                                  com.mongodb.client.MongoCollection<org.bson.Document> mongoCollection,
                                                  TestAttributeTestContextStore<T> attributeContext)

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

Overrides:

onCategoryAssigned in class AbstractReporter

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

Overrides:

onAuthorAssigned in class AbstractReporter

Parameters:

test - Test object

author - Author object

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

Overrides:

onScreenCaptureAdded in class AbstractReporter

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

Specified by:

onScreenCaptureAdded in interface TestListener

Overrides:

onScreenCaptureAdded in class AbstractReporter

Parameters:

log - Log object

screenCapture - ScreenCapture object

Throws:

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

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

onTestRemoved

public void onTestRemoved(Test test)

Description copied from interface: TestListener

Invoked when a test is removed using removeTest()

Specified by:

onTestRemoved in interface TestListener

Overrides:

onTestRemoved in class AbstractReporter

Parameters:

test - Test object

onDeviceAssigned

public void onDeviceAssigned(Test test,
                             Device device)

Description copied from interface: TestListener

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

Specified by:

onDeviceAssigned in interface TestListener

Overrides:

onDeviceAssigned in class AbstractReporter

Parameters:

test - Test object

device - Device object

getReporterName

public java.lang.String getReporterName()

Description copied from interface: ExtentReporter

Get the reporter name

Returns:

reporter name