com.epam.reportportal.cucumber

Class ScenarioReporter

java.lang.Object

com.epam.reportportal.cucumber.AbstractReporter

com.epam.reportportal.cucumber.ScenarioReporter

All Implemented Interfaces:

gherkin.formatter.Formatter, gherkin.formatter.Reporter, java.io.Closeable, java.lang.AutoCloseable

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 and Description
protected com.epam.reportportal.utils.MemoizingSupplier<io.reactivex.Maybe<java.lang.String>>	rootSuiteId

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

COLON_INFIX, currentFeatureContext, currentScenarioContext, ITEM_TREE, launch, SKIPPED_ISSUE_KEY

Constructor Summary

Constructors

Constructor and Description
ScenarioReporter()

Method Summary

Modifier and Type	Method and Description
protected void	afterLaunch() Finish RP launch
protected void	beforeStep(gherkin.formatter.model.Step step, gherkin.formatter.model.Match match) Start Cucumber step
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartHookRequest(boolean isBefore) Extension point to customize test creation event/request
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartStepRequest(gherkin.formatter.model.Step step, java.lang.String stepPrefix, gherkin.formatter.model.Match match) Extension point to customize step creation event/request
protected void	finishRootItem() Finish root suite
protected java.lang.String	getFeatureTestItemType() Return RP test item name mapped to Cucumber feature
protected java.util.Optional<io.reactivex.Maybe<java.lang.String>>	getRootItemId() Returns the ID of the root item of the launch
protected java.lang.String	getScenarioTestItemType() Return RP test item name mapped to Cucumber scenario

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

after, afterFeature, afterHooks, afterScenario, afterStep, background, before, beforeFeature, beforeHooks, beforeScenario, buildFinishTestItemRequest, buildMultilineArgument, buildReportPortal, buildScenarioName, buildStartFeatureRequest, buildStartScenarioRequest, close, done, embedding, endOfScenarioLifeCycle, eof, examples, extractAttributes, feature, finishTestItem, finishTestItem, getAttributes, getCodeRef, getCodeRef, getDescription, getDescription, getParameters, getReportPortal, getTestCaseId, hookFinished, mapLevel, mapStatus, match, reportResult, result, scenario, scenarioOutline, sendLog, sendLog, setReportPortal, startFeature, startHook, startOfScenarioLifeCycle, startScenario, startStep, step, syntaxError, uri, write

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

buildStartStepRequest

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartStepRequest(@Nonnull
                                                                                           gherkin.formatter.model.Step step,
                                                                                           @Nullable
                                                                                           java.lang.String stepPrefix,
                                                                                           @Nonnull
                                                                                           gherkin.formatter.model.Match match)

Description copied from class: AbstractReporter

Extension point to customize step creation event/request

Overrides:

buildStartStepRequest in class AbstractReporter

Parameters:

step - a Cucumber's Step object

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

match - a Cucumber's Match object

Returns:

Request to ReportPortal

beforeStep

protected void beforeStep(gherkin.formatter.model.Step step,
                          gherkin.formatter.model.Match match)

Description copied from class: AbstractReporter

Start Cucumber step

Overrides:

beforeStep in class AbstractReporter

Parameters:

step - Step object

match - Match object

buildStartHookRequest

protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartHookRequest(boolean isBefore)

Description copied from class: AbstractReporter

Extension point to customize test creation event/request

Overrides:

buildStartHookRequest in class AbstractReporter

Parameters:

isBefore - a cucumber hook type object

Returns:

Request to ReportPortal

getFeatureTestItemType

@Nonnull
protected java.lang.String getFeatureTestItemType()

Description copied from class: AbstractReporter

Return RP 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 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()

Description copied from class: AbstractReporter

Returns the ID of the root item of the launch

Specified by:

getRootItemId in class AbstractReporter

Returns:

the ID of the root item of the launch

finishRootItem

protected void finishRootItem()

Finish root suite

afterLaunch

protected void afterLaunch()

Description copied from class: AbstractReporter

Finish RP launch

Overrides:

afterLaunch in class AbstractReporter