Package com.epam.reportportal.cucumber

Class ScenarioReporter

java.lang.Object

com.epam.reportportal.cucumber.AbstractReporter

com.epam.reportportal.cucumber.ScenarioReporter

All Implemented Interfaces:

io.cucumber.plugin.ConcurrentEventListener, io.cucumber.plugin.Plugin

public class ScenarioReporter
extends AbstractReporter

Cucumber reporter for ReportPortal that reports scenarios as test methods.

Mapping between Cucumber and ReportPortal is as follows:

• feature - TEST
• scenario - STEP
• step - log item

Dummy "Root Test Suite" is created because in current implementation of RP test items cannot be immediate children of a launch

Background steps and hooks are reported as part of corresponding scenarios. Outline example rows are reported as individual scenarios with [ROW NUMBER] after the name.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.epam.reportportal.utils.MemoizingSupplier<io.reactivex.Maybe<java.lang.String>>	rootSuiteId

Fields inherited from class com.epam.reportportal.cucumber.AbstractReporter

BACKGROUND_PREFIX, DOCSTRING_DECORATOR, HOOK_, METHOD_OPENING_BRACKET, WORKING_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
ScenarioReporter()

Method Summary

Modifier and Type	Method	Description
protected void	afterLaunch()	Finish RP launch
protected void	beforeLaunch()	Manipulations before the launch starts
protected void	beforeStep(io.cucumber.plugin.event.TestCase testCase, io.cucumber.plugin.event.TestStep testStep)	Start Cucumber step
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartHookRequest(io.cucumber.plugin.event.TestCase testCase, io.cucumber.plugin.event.HookTestStep testStep)	Extension point to customize test creation event/request
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartStepRequest(io.cucumber.plugin.event.TestStep testStep, java.lang.String stepPrefix, java.lang.String keyword)	Extension point to customize test creation event/request
protected void	finishRootItem()	Finish root suite
protected java.lang.String	getFeatureTestItemType()	Return RP launch test item name mapped to Cucumber feature
protected java.util.Optional<io.reactivex.Maybe<java.lang.String>>	getRootItemId()
protected java.lang.String	getScenarioTestItemType()	Return RP launch test item name mapped to Cucumber scenario
protected void	startRootItem()	Start root suite

Methods inherited from class com.epam.reportportal.cucumber.AbstractReporter

afterHooks, afterScenario, afterStep, beforeHooks, beforeScenario, buildFinishTestItemRequest, buildMultilineArgument, buildReportPortal, buildStartFeatureRequest, buildStartLaunchRq, buildStartRuleRequest, buildStartScenarioRequest, embedding, extractAttributes, finishTestItem, finishTestItem, finishTestItem, formatDataTable, getAttributes, getCodeRef, getCodeRef, getCurrent, getDescription, getDescription, getEmbedEventHandler, getHookTypeAndName, getItemTree, getLaunch, getParameters, getReportPortal, getStepName, getTestCaseFinishedHandler, getTestCaseId, getTestCaseId, getTestCaseStartedHandler, getTestRunFinishedHandler, getTestRunStartedHandler, getTestSourceParsedHandler, getTestStepFinishedHandler, getTestStepStartedHandler, getWriteEventHandler, handleEndOfFeature, handleSourceEvents, handleStartOfTestCase, handleTestStepFinished, handleTestStepStarted, mapItemStatus, mapLevel, reportResult, sendLog, sendLog, setEventPublisher, startFeature, startHook, startRule, startScenario, startStep

Methods inherited from class java.lang.Object

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

Field Detail

rootSuiteId

protected com.epam.reportportal.utils.MemoizingSupplier<io.reactivex.Maybe<java.lang.String>> rootSuiteId

Constructor Detail

ScenarioReporter

public ScenarioReporter()

Method Detail

beforeLaunch

protected void beforeLaunch()

Description copied from class: AbstractReporter

Manipulations before the launch starts

Overrides:

beforeLaunch in class AbstractReporter

buildStartStepRequest

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartStepRequest(@Nonnull
                                                                                  io.cucumber.plugin.event.TestStep testStep,
                                                                                  @Nullable
                                                                                  java.lang.String stepPrefix,
                                                                                  @Nullable
                                                                                  java.lang.String keyword)

Description copied from class: AbstractReporter

Extension point to customize test creation event/request

Overrides:

buildStartStepRequest in class AbstractReporter

Parameters:

testStep - a cucumber step object

stepPrefix - a prefix of the step (e.g. 'Background')

keyword - a step keyword (e.g. 'Given')

Returns:

a Request to ReportPortal

beforeStep

protected void beforeStep(@Nonnull
                          io.cucumber.plugin.event.TestCase testCase,
                          @Nonnull
                          io.cucumber.plugin.event.TestStep testStep)

Description copied from class: AbstractReporter

Start Cucumber step

Overrides:

beforeStep in class AbstractReporter

Parameters:

testCase - Cucumber's TestCase object

testStep - a cucumber step object

buildStartHookRequest

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartHookRequest(@Nonnull
                                                                                  io.cucumber.plugin.event.TestCase testCase,
                                                                                  @Nonnull
                                                                                  io.cucumber.plugin.event.HookTestStep testStep)

Description copied from class: AbstractReporter

Extension point to customize test creation event/request

Overrides:

buildStartHookRequest in class AbstractReporter

Parameters:

testCase - Cucumber's TestCase object

testStep - a cucumber step object

Returns:

Request to ReportPortal

getFeatureTestItemType

@Nonnull
protected java.lang.String getFeatureTestItemType()

Description copied from class: AbstractReporter

Return RP launch test item name mapped to Cucumber feature

Specified by:

getFeatureTestItemType in class AbstractReporter

Returns:

test item name

getScenarioTestItemType

@Nonnull
protected java.lang.String getScenarioTestItemType()

Description copied from class: AbstractReporter

Return RP launch test item name mapped to Cucumber scenario

Specified by:

getScenarioTestItemType in class AbstractReporter

Returns:

test item name

getRootItemId

@Nonnull
protected java.util.Optional<io.reactivex.Maybe<java.lang.String>> getRootItemId()

Specified by:

getRootItemId in class AbstractReporter

afterLaunch

protected void afterLaunch()

Description copied from class: AbstractReporter

Finish RP launch

Overrides:

afterLaunch in class AbstractReporter

finishRootItem

protected void finishRootItem()

Finish root suite

startRootItem

protected void startRootItem()

Start root suite