com.epam.reportportal.cucumber

Class AbstractReporter

java.lang.Object

com.epam.reportportal.cucumber.AbstractReporter

All Implemented Interfaces:

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

Direct Known Subclasses:

ScenarioReporter, StepReporter

public abstract class AbstractReporter
extends java.lang.Object
implements gherkin.formatter.Formatter, gherkin.formatter.Reporter

Abstract Cucumber formatter/reporter for Report Portal

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COLON_INFIX
protected java.lang.ThreadLocal<RunningContext.FeatureContext>	currentFeatureContext
protected java.lang.ThreadLocal<RunningContext.ScenarioContext>	currentScenarioContext
static com.epam.reportportal.service.tree.TestItemTree	ITEM_TREE
protected java.util.function.Supplier<com.epam.reportportal.service.Launch>	launch
protected static java.lang.String	SKIPPED_ISSUE_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractReporter()

Method Summary

Modifier and Type	Method and Description
void	after(gherkin.formatter.model.Match match, gherkin.formatter.model.Result result)
protected void	afterFeature() Finish current Cucumber feature
protected void	afterHooks(java.lang.Boolean isBefore) Called when before/after-hooks are finished
protected void	afterLaunch() Finish RP launch
protected void	afterScenario() Finish Cucumber scenario
protected void	afterStep(gherkin.formatter.model.Result result) Finish Cucumber step
void	background(gherkin.formatter.model.Background background)
void	before(gherkin.formatter.model.Match match, gherkin.formatter.model.Result result) Cucumber interfaces implementations
protected void	beforeFeature(gherkin.formatter.model.Feature feature) Define Start Cucumber feature RQ
protected void	beforeHooks(boolean isBefore) Called when before/after-hooks are started
protected void	beforeScenario(gherkin.formatter.model.Scenario scenario, java.lang.String outlineIteration) Start Cucumber Feature (if not started) and Scenario
protected void	beforeStep(gherkin.formatter.model.Step step, gherkin.formatter.model.Match match) Start Cucumber step
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ	buildFinishTestItemRequest(io.reactivex.Maybe<java.lang.String> itemId, com.epam.reportportal.listeners.ItemStatus status) Build finish test item request object
protected java.lang.String	buildMultilineArgument(gherkin.formatter.model.Step step) Generate multiline argument (DataTable or DocString) representation
protected com.epam.reportportal.service.ReportPortal	buildReportPortal() Extension point to customize ReportPortal instance
protected java.lang.String	buildScenarioName(gherkin.formatter.model.Scenario scenario) Returns a scenario name
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ	buildStartFeatureRequest(gherkin.formatter.model.Feature feature, java.lang.String uri) Extension point to customize feature creation event/request
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	buildStartScenarioRequest(gherkin.formatter.model.Scenario scenario, java.lang.String uri) Extension point to customize scenario 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
void	close()
void	done()
void	embedding(java.lang.String mimeType, byte[] data) Send a log with data attached.
void	endOfScenarioLifeCycle(gherkin.formatter.model.Scenario scenario)
void	eof()
void	examples(gherkin.formatter.model.Examples examples)
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ>	extractAttributes(java.util.List<gherkin.formatter.model.Tag> tags) Transform tags from Cucumber to RP format
void	feature(gherkin.formatter.model.Feature feature)
protected void	finishTestItem(io.reactivex.Maybe<java.lang.String> itemId) Finish a test item with no specific status
protected void	finishTestItem(io.reactivex.Maybe<java.lang.String> itemId, com.epam.reportportal.listeners.ItemStatus status) Finish a test item with specified status
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ>	getAttributes(gherkin.formatter.model.Match match) Returns static attributes defined by Attributes annotation in code.
protected java.lang.String	getCodeRef(gherkin.formatter.model.Match match) Returns code reference for mapped code
protected java.lang.String	getCodeRef(java.lang.String uri, int line) Returns code reference for feature files by URI and text line number
protected java.lang.String	getDescription(gherkin.formatter.model.Feature feature, java.lang.String uri) Build an item description for a feature
protected java.lang.String	getDescription(gherkin.formatter.model.Scenario scenario, java.lang.String uri) Build an item description for a scenario
protected abstract java.lang.String	getFeatureTestItemType() Return RP test item name mapped to Cucumber feature
protected java.util.List<com.epam.ta.reportportal.ws.model.ParameterResource>	getParameters(gherkin.formatter.model.Step step, java.lang.String codeRef, gherkin.formatter.model.Match match) Returns a list of parameters for a step
static com.epam.reportportal.service.ReportPortal	getReportPortal()
protected abstract java.util.Optional<io.reactivex.Maybe<java.lang.String>>	getRootItemId() Returns the ID of the root item of the launch
protected abstract java.lang.String	getScenarioTestItemType() Return RP test item name mapped to Cucumber scenario
protected com.epam.reportportal.service.item.TestCaseIdEntry	getTestCaseId(gherkin.formatter.model.Match match, java.lang.String codeRef) Return a Test Case ID for mapped code
protected void	hookFinished(gherkin.formatter.model.Match match, gherkin.formatter.model.Result result, java.lang.Boolean isBefore) Called when a specific before/after-hook is finished
protected java.lang.String	mapLevel(java.lang.String cukesStatus) Map Cucumber statuses to RP log levels
protected com.epam.reportportal.listeners.ItemStatus	mapStatus(java.lang.String cukesStatus) Map Cucumber statuses to RP statuses
void	match(gherkin.formatter.model.Match match)
protected void	reportResult(gherkin.formatter.model.Result result, java.lang.String message) Report test item result and error (if present)
void	result(gherkin.formatter.model.Result result)
void	scenario(gherkin.formatter.model.Scenario scenario)
void	scenarioOutline(gherkin.formatter.model.ScenarioOutline scenarioOutline)
protected void	sendLog(java.lang.String message) Send a text log entry to Report Portal with 'INFO' level, using current datetime as timestamp
protected void	sendLog(java.lang.String message, java.lang.String level) Send a text log entry to Report Portal using current datetime as timestamp
protected static void	setReportPortal(com.epam.reportportal.service.ReportPortal reportPortal)
protected io.reactivex.Maybe<java.lang.String>	startFeature(com.epam.ta.reportportal.ws.model.StartTestItemRQ startFeatureRq) Start Cucumber Feature
protected io.reactivex.Maybe<java.lang.String>	startHook(io.reactivex.Maybe<java.lang.String> parentId, com.epam.ta.reportportal.ws.model.StartTestItemRQ rq) Start before/after-hook item on Report Portal
void	startOfScenarioLifeCycle(gherkin.formatter.model.Scenario scenario)
protected io.reactivex.Maybe<java.lang.String>	startScenario(io.reactivex.Maybe<java.lang.String> featureId, com.epam.ta.reportportal.ws.model.StartTestItemRQ startScenarioRq) Start Cucumber Scenario
protected io.reactivex.Maybe<java.lang.String>	startStep(io.reactivex.Maybe<java.lang.String> scenarioId, com.epam.ta.reportportal.ws.model.StartTestItemRQ startStepRq) Start Cucumber Step
void	step(gherkin.formatter.model.Step step)
void	syntaxError(java.lang.String state, java.lang.String event, java.util.List<java.lang.String> legalEvents, java.lang.String uri, java.lang.Integer line)
void	uri(java.lang.String uri)
void	write(java.lang.String text) Send a log entry to Report Portal with 'INFO' level.

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_TREE

public static final com.epam.reportportal.service.tree.TestItemTree ITEM_TREE

COLON_INFIX

protected static final java.lang.String COLON_INFIX

See Also:

Constant Field Values

SKIPPED_ISSUE_KEY

protected static final java.lang.String SKIPPED_ISSUE_KEY

See Also:

Constant Field Values

currentFeatureContext

protected final java.lang.ThreadLocal<RunningContext.FeatureContext> currentFeatureContext

currentScenarioContext

protected final java.lang.ThreadLocal<RunningContext.ScenarioContext> currentScenarioContext

launch

protected final java.util.function.Supplier<com.epam.reportportal.service.Launch> launch

Constructor Detail

AbstractReporter

public AbstractReporter()

Method Detail

getReportPortal

public static com.epam.reportportal.service.ReportPortal getReportPortal()

setReportPortal

protected static void setReportPortal(com.epam.reportportal.service.ReportPortal reportPortal)

buildReportPortal

protected com.epam.reportportal.service.ReportPortal buildReportPortal()

Extension point to customize ReportPortal instance

Returns:

ReportPortal

afterLaunch

protected void afterLaunch()

Finish RP launch

buildScenarioName

protected java.lang.String buildScenarioName(gherkin.formatter.model.Scenario scenario)

Returns a scenario name

Parameters:

scenario - Cucumber's Scenario object

Returns:

scenario name

buildStartScenarioRequest

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartScenarioRequest(@Nonnull
                                                                                               gherkin.formatter.model.Scenario scenario,
                                                                                               @Nonnull
                                                                                               java.lang.String uri)

Extension point to customize scenario creation event/request

Parameters:

scenario - Cucumber's Scenario object

uri - a scenario relative path

Returns:

start test item request ready to send on RP

startFeature

@Nonnull
protected io.reactivex.Maybe<java.lang.String> startFeature(@Nonnull
                                                                     com.epam.ta.reportportal.ws.model.StartTestItemRQ startFeatureRq)

Start Cucumber Feature

Parameters:

startFeatureRq - feature start request

Returns:

feature item id

startScenario

@Nonnull
protected io.reactivex.Maybe<java.lang.String> startScenario(@Nonnull
                                                                      io.reactivex.Maybe<java.lang.String> featureId,
                                                                      @Nonnull
                                                                      com.epam.ta.reportportal.ws.model.StartTestItemRQ startScenarioRq)

Start Cucumber Scenario

Parameters:

featureId - parent feature item id

startScenarioRq - scenario start request

Returns:

scenario item id

beforeScenario

protected void beforeScenario(gherkin.formatter.model.Scenario scenario,
                              java.lang.String outlineIteration)

Start Cucumber Feature (if not started) and Scenario

Parameters:

scenario - Scenario

outlineIteration - - suffix to append to scenario name, can be null

buildFinishTestItemRequest

@Nonnull
protected com.epam.ta.reportportal.ws.model.FinishTestItemRQ buildFinishTestItemRequest(@Nonnull
                                                                                                 io.reactivex.Maybe<java.lang.String> itemId,
                                                                                                 @Nullable
                                                                                                 com.epam.reportportal.listeners.ItemStatus status)

Build finish test item request object

Parameters:

itemId - item ID reference

status - item result status

Returns:

finish request

finishTestItem

protected void finishTestItem(@Nullable
                              io.reactivex.Maybe<java.lang.String> itemId,
                              @Nullable
                              com.epam.reportportal.listeners.ItemStatus status)

Finish a test item with specified status

Parameters:

itemId - an ID of the item

status - the status of the item

afterScenario

protected void afterScenario()

Finish Cucumber scenario

buildStartFeatureRequest

@Nonnull
protected com.epam.ta.reportportal.ws.model.StartTestItemRQ buildStartFeatureRequest(@Nonnull
                                                                                              gherkin.formatter.model.Feature feature,
                                                                                              @Nonnull
                                                                                              java.lang.String uri)

Extension point to customize feature creation event/request

Parameters:

feature - a Cucumber's Feature object

uri - a path to the feature

Returns:

Request to ReportPortal

beforeFeature

protected void beforeFeature(gherkin.formatter.model.Feature feature)

Define Start Cucumber feature RQ

Parameters:

feature - Step feature

afterFeature

protected void afterFeature()

Finish current Cucumber feature

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)

Extension point to customize step creation event/request

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

startStep

@Nonnull
protected io.reactivex.Maybe<java.lang.String> startStep(@Nonnull
                                                                  io.reactivex.Maybe<java.lang.String> scenarioId,
                                                                  @Nonnull
                                                                  com.epam.ta.reportportal.ws.model.StartTestItemRQ startStepRq)

Start Cucumber Step

Parameters:

scenarioId - parent scenario item id

startStepRq - step start request

Returns:

step item id

beforeStep

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

Start Cucumber step

Parameters:

step - Step object

match - Match object

afterStep

protected void afterStep(@Nonnull
                         gherkin.formatter.model.Result result)

Finish Cucumber step

Parameters:

result - Step result

buildStartHookRequest

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

Extension point to customize test creation event/request

Parameters:

isBefore - a cucumber hook type object

Returns:

Request to ReportPortal

startHook

@Nonnull
protected io.reactivex.Maybe<java.lang.String> startHook(@Nonnull
                                                                  io.reactivex.Maybe<java.lang.String> parentId,
                                                                  @Nonnull
                                                                  com.epam.ta.reportportal.ws.model.StartTestItemRQ rq)

Start before/after-hook item on Report Portal

Parameters:

parentId - parent item id

rq - hook start request

Returns:

hook item id

beforeHooks

protected void beforeHooks(boolean isBefore)

Called when before/after-hooks are started

Parameters:

isBefore - - if true, before-hook is finished, if false - after-hook

afterHooks

protected void afterHooks(java.lang.Boolean isBefore)

Called when before/after-hooks are finished

Parameters:

isBefore - - if true, before-hook is finished, if false - after-hook

hookFinished

protected void hookFinished(gherkin.formatter.model.Match match,
                            gherkin.formatter.model.Result result,
                            java.lang.Boolean isBefore)

Called when a specific before/after-hook is finished

Parameters:

match - Match object

result - Hook result

isBefore - - if true, before-hook, if false - after-hook

reportResult

protected void reportResult(@Nonnull
                            gherkin.formatter.model.Result result,
                            @Nullable
                            java.lang.String message)

Report test item result and error (if present)

Parameters:

result - - Cucumber result object

message - - optional message to be logged in addition

getFeatureTestItemType

@Nonnull
protected abstract java.lang.String getFeatureTestItemType()

Return RP test item name mapped to Cucumber feature

Returns:

test item name

getScenarioTestItemType

@Nonnull
protected abstract java.lang.String getScenarioTestItemType()

Return RP test item name mapped to Cucumber scenario

Returns:

test item name

before

public void before(gherkin.formatter.model.Match match,
                   gherkin.formatter.model.Result result)

Cucumber interfaces implementations

Specified by:

before in interface gherkin.formatter.Reporter

result

public void result(gherkin.formatter.model.Result result)

Specified by:

result in interface gherkin.formatter.Reporter

after

public void after(gherkin.formatter.model.Match match,
                  gherkin.formatter.model.Result result)

Specified by:

after in interface gherkin.formatter.Reporter

match

public void match(gherkin.formatter.model.Match match)

Specified by:

match in interface gherkin.formatter.Reporter

embedding

public void embedding(java.lang.String mimeType,
                      byte[] data)

Send a log with data attached.

Specified by:

embedding in interface gherkin.formatter.Reporter

Parameters:

mimeType - an attachment type

data - data to attach

syntaxError

public void syntaxError(java.lang.String state,
                        java.lang.String event,
                        java.util.List<java.lang.String> legalEvents,
                        java.lang.String uri,
                        java.lang.Integer line)

Specified by:

syntaxError in interface gherkin.formatter.Formatter

uri

public void uri(java.lang.String uri)

Specified by:

uri in interface gherkin.formatter.Formatter

feature

public void feature(gherkin.formatter.model.Feature feature)

Specified by:

feature in interface gherkin.formatter.Formatter

scenarioOutline

public void scenarioOutline(gherkin.formatter.model.ScenarioOutline scenarioOutline)

Specified by:

scenarioOutline in interface gherkin.formatter.Formatter

examples

public void examples(gherkin.formatter.model.Examples examples)

Specified by:

examples in interface gherkin.formatter.Formatter

startOfScenarioLifeCycle

public void startOfScenarioLifeCycle(gherkin.formatter.model.Scenario scenario)

Specified by:

startOfScenarioLifeCycle in interface gherkin.formatter.Formatter

background

public void background(gherkin.formatter.model.Background background)

Specified by:

background in interface gherkin.formatter.Formatter

scenario

public void scenario(gherkin.formatter.model.Scenario scenario)

Specified by:

scenario in interface gherkin.formatter.Formatter

step

public void step(gherkin.formatter.model.Step step)

Specified by:

step in interface gherkin.formatter.Formatter

endOfScenarioLifeCycle

public void endOfScenarioLifeCycle(gherkin.formatter.model.Scenario scenario)

Specified by:

endOfScenarioLifeCycle in interface gherkin.formatter.Formatter

done

public void done()

Specified by:

done in interface gherkin.formatter.Formatter

close

public void close()

Specified by:

close in interface gherkin.formatter.Formatter

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

eof

public void eof()

Specified by:

eof in interface gherkin.formatter.Formatter

getRootItemId

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

Returns the ID of the root item of the launch

Returns:

the ID of the root item of the launch

getTestCaseId

@Nullable
protected com.epam.reportportal.service.item.TestCaseIdEntry getTestCaseId(@Nonnull
                                                                                     gherkin.formatter.model.Match match,
                                                                                     @Nullable
                                                                                     java.lang.String codeRef)

Return a Test Case ID for mapped code

Parameters:

match - Cucumber's Match object

codeRef - a code reference

Returns:

Test Case ID entity or null if it's not possible to calculate

getDescription

@Nonnull
protected java.lang.String getDescription(@Nonnull
                                                   gherkin.formatter.model.Scenario scenario,
                                                   @Nonnull
                                                   java.lang.String uri)

Build an item description for a scenario

Parameters:

scenario - a Cucumber's Scenario object

uri - a feature URI

Returns:

item description

getDescription

@Nonnull
protected java.lang.String getDescription(@Nonnull
                                                   gherkin.formatter.model.Feature feature,
                                                   @Nonnull
                                                   java.lang.String uri)

Build an item description for a feature

Parameters:

feature - a Cucumber's Feature object

uri - a feature URI

Returns:

item description

finishTestItem

protected void finishTestItem(io.reactivex.Maybe<java.lang.String> itemId)

Finish a test item with no specific status

Parameters:

itemId - an ID of the item

getCodeRef

@Nullable
protected java.lang.String getCodeRef(@Nonnull
                                                gherkin.formatter.model.Match match)

Returns code reference for mapped code

Parameters:

match - Cucumber's Match object

Returns:

a code reference, or null if not possible to determine (ambiguous, undefined, etc.)

getCodeRef

@Nonnull
protected java.lang.String getCodeRef(@Nonnull
                                               java.lang.String uri,
                                               int line)

Returns code reference for feature files by URI and text line number

Parameters:

uri - a feature URI

line - a scenario line number

Returns:

a code reference

mapStatus

@Nonnull
protected com.epam.reportportal.listeners.ItemStatus mapStatus(@Nullable
                                                                        java.lang.String cukesStatus)

Map Cucumber statuses to RP statuses

Parameters:

cukesStatus - - Cucumber status

Returns:

RP status

mapLevel

@Nonnull
protected java.lang.String mapLevel(@Nullable
                                             java.lang.String cukesStatus)

Map Cucumber statuses to RP log levels

Parameters:

cukesStatus - - Cucumber status

Returns:

regular log level

write

public void write(java.lang.String text)

Send a log entry to Report Portal with 'INFO' level.

Specified by:

write in interface gherkin.formatter.Reporter

Parameters:

text - a log text to send

sendLog

protected void sendLog(java.lang.String message)

Send a text log entry to Report Portal with 'INFO' level, using current datetime as timestamp

Parameters:

message - a text message

sendLog

protected void sendLog(java.lang.String message,
                       java.lang.String level)

Send a text log entry to Report Portal using current datetime as timestamp

Parameters:

message - a text message

level - a log level, see standard Log4j / logback logging levels

getParameters

@Nonnull
protected java.util.List<com.epam.ta.reportportal.ws.model.ParameterResource> getParameters(@Nonnull
                                                                                                     gherkin.formatter.model.Step step,
                                                                                                     @Nullable
                                                                                                     java.lang.String codeRef,
                                                                                                     @Nonnull
                                                                                                     gherkin.formatter.model.Match match)

Returns a list of parameters for a step

Parameters:

step - Cucumber's Step object

codeRef - a method code reference to retrieve parameter types

match - Cucumber's Match object

Returns:

a list of parameters or empty list if none

extractAttributes

@Nonnull
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ> extractAttributes(@Nonnull
                                                                                                                 java.util.List<gherkin.formatter.model.Tag> tags)

Transform tags from Cucumber to RP format

Parameters:

tags - - Cucumber tags

Returns:

set of tags

getAttributes

@Nullable
protected java.util.Set<com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ> getAttributes(gherkin.formatter.model.Match match)

Returns static attributes defined by Attributes annotation in code.

Parameters:

match - Cucumber's Match object

Returns:

a set of attributes or null if no such method provided by the match object

buildMultilineArgument

protected java.lang.String buildMultilineArgument(gherkin.formatter.model.Step step)

Generate multiline argument (DataTable or DocString) representation

Parameters:

step - - Cucumber step object

Returns:

- transformed multiline argument (or empty string if there is none)