com.epam.reportportal.jbehave

Class ReportPortalFormat

java.lang.Object

org.jbehave.core.reporters.Format

com.epam.reportportal.jbehave.ReportPortalFormat

Direct Known Subclasses:

ReportPortalScenarioFormat, ReportPortalStepFormat

public abstract class ReportPortalFormat
extends org.jbehave.core.reporters.Format

A common class for ReportPortal formats, which are for reporting JBehave runs into Report Portal application.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.epam.reportportal.service.tree.TestItemTree	itemTree
protected com.epam.reportportal.utils.MemoizingSupplier<com.epam.reportportal.service.Launch>	launch
protected com.epam.reportportal.service.ReportPortal	rp

Fields inherited from class org.jbehave.core.reporters.Format

ANSI_CONSOLE, CONSOLE, HTML, HTML_TEMPLATE, IDE_CONSOLE, JSON, JSON_TEMPLATE, STATS, TEAMCITY_CONSOLE, TXT, XML, XML_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
ReportPortalFormat(com.epam.reportportal.service.ReportPortal reportPortal) Creates an instance of the formatter class using specific ReportPortal reporter.

Method Summary

Modifier and Type	Method and Description
protected com.epam.ta.reportportal.ws.model.launch.StartLaunchRQ	buildStartLaunchRQ(java.util.Date startTime, com.epam.reportportal.listeners.ListenerParameters parameters) A method for creation a Start Launch request which will be sent to Report Portal.
protected com.epam.reportportal.utils.MemoizingSupplier<com.epam.reportportal.service.Launch>	createLaunch(com.epam.reportportal.service.ReportPortal rp) Returns a supplier which initialize a launch on the first 'get'.
protected abstract ReportPortalStoryReporter	createReportPortalReporter(org.jbehave.core.reporters.FilePrintStreamFactory factory, org.jbehave.core.reporters.StoryReporterBuilder storyReporterBuilder)
org.jbehave.core.reporters.StoryReporter	createStoryReporter(org.jbehave.core.reporters.FilePrintStreamFactory factory, org.jbehave.core.reporters.StoryReporterBuilder storyReporterBuilder) Creates a StoryReporter which will be used to report a Story.
protected void	finishLaunch() Finishes a Launch passed in the method parameters
static ReportPortalFormat	getCurrent() Returns a formatter instance for the current thread.
static java.util.Optional<ReportPortalStoryReporter>	getCurrentStoryReporter() Returns a story reporter for the current thread if any.
com.epam.reportportal.service.tree.TestItemTree	getItemTree()
com.epam.reportportal.service.ReportPortal	getReportPortal()
protected java.lang.Thread	getShutdownHook() Returns a Thread which is supposed to run on test execution shutdown.

Methods inherited from class org.jbehave.core.reporters.Format

name, println, toString

Methods inherited from class java.lang.Object

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

Field Detail

launch

protected final com.epam.reportportal.utils.MemoizingSupplier<com.epam.reportportal.service.Launch> launch

itemTree

protected final com.epam.reportportal.service.tree.TestItemTree itemTree

rp

protected final com.epam.reportportal.service.ReportPortal rp

Constructor Detail

ReportPortalFormat

public ReportPortalFormat(com.epam.reportportal.service.ReportPortal reportPortal)

Creates an instance of the formatter class using specific ReportPortal reporter.

Parameters:

reportPortal - an instance of Report Portal reporter

Method Detail

finishLaunch

protected void finishLaunch()

Finishes a Launch passed in the method parameters

getShutdownHook

protected java.lang.Thread getShutdownHook()

Returns a Thread which is supposed to run on test execution shutdown. By default it finishes the current test execution on Report Portal.

Returns:

a thread to run on JVM shutdown event

buildStartLaunchRQ

protected com.epam.ta.reportportal.ws.model.launch.StartLaunchRQ buildStartLaunchRQ(java.util.Date startTime,
                                                                                    com.epam.reportportal.listeners.ListenerParameters parameters)

A method for creation a Start Launch request which will be sent to Report Portal. You can customize it by overriding the method.

Parameters:

startTime - launch start time, which will be set into the result request

parameters - Report Portal client parameters

Returns:

a Start Launch request instance

createLaunch

protected com.epam.reportportal.utils.MemoizingSupplier<com.epam.reportportal.service.Launch> createLaunch(com.epam.reportportal.service.ReportPortal rp)

Returns a supplier which initialize a launch on the first 'get'.

Parameters:

rp - a ReportPortal class instance which will be used to communicate with the portal

Returns:

a supplier with a lazy-initialized Launch instance

createStoryReporter

public org.jbehave.core.reporters.StoryReporter createStoryReporter(org.jbehave.core.reporters.FilePrintStreamFactory factory,
                                                                    org.jbehave.core.reporters.StoryReporterBuilder storyReporterBuilder)

Creates a StoryReporter which will be used to report a Story.

Specified by:

createStoryReporter in class org.jbehave.core.reporters.Format

Parameters:

factory - JBehave's file print stream factory

storyReporterBuilder - JBehave's StoryReporter builder

Returns:

a Story reporter

createReportPortalReporter

protected abstract ReportPortalStoryReporter createReportPortalReporter(org.jbehave.core.reporters.FilePrintStreamFactory factory,
                                                                        org.jbehave.core.reporters.StoryReporterBuilder storyReporterBuilder)

getReportPortal

@Nonnull
public com.epam.reportportal.service.ReportPortal getReportPortal()

Returns:

a ReportPortal class instance which is used to communicate with the portal

getItemTree

@Nonnull
public com.epam.reportportal.service.tree.TestItemTree getItemTree()

Returns:

a full Test Item Tree with attributes

getCurrent

@Nonnull
public static ReportPortalFormat getCurrent()

Returns a formatter instance for the current thread.

Returns:

a formatter instance for the current thread

getCurrentStoryReporter

@Nonnull
public static java.util.Optional<ReportPortalStoryReporter> getCurrentStoryReporter()

Returns a story reporter for the current thread if any.

Returns:

a story reporter for the current thread if any