Cucumber Agent for ReportPortal

DISCLAIMER: We use Google Analytics for sending anonymous usage information such as agent's and client's names, and their versions after a successful launch start. This information might help us to improve both ReportPortal backend and client sides. It is used by the ReportPortal team only and is not supposed for sharing with 3rd parties.

• Compatibility matrix
• Dependencies
• Install Reporter
  • Scenario Reporter
  • Step reporter
  • reportportal.properties
  • Parameters
  • Proxy Configuration
  • How to provide parameters
  • Parameters loading order
• Configuration
• Events

Compatibility matrix for cucumber agents

Installation

Add to POM.xml

dependency

<dependency>
  <groupId>com.epam.reportportal</groupId>
  <artifactId>agent-java-cucumber</artifactId>
  <version>5.1.2</version>
</dependency>

Install Reporter

As Cucumber runs your features, it calls out to any number of listener objects to let them know how it’s progressing. These listeners are notified at various points throughout the run of features. This principle is used to notify ReportPortal about your tests progress in real-time. ReportPortal supports two kinds of Reporters. Both of them allow you to report your execution progress to ReportPortal, but there are some differences in report structure.

Scenario Reporter

Step Reporter

Step Reporter propagates the most traditional for ReportPortal test structure keeping your scenarios and steps inside as separate entities. In opposite, Scenario Reporter use scenario as the base point and does not separate step from each other which is sometimes more convenient for BDD users.

Enabling StepReporter:

@RunWith(Cucumber.class)
@CucumberOptions(plugin = {"pretty", "com.epam.reportportal.cucumber.StepReporter"})
public class RunCukesTest {
}

Enabling ScenarioReporter:

@RunWith(Cucumber.class)
@CucumberOptions(plugin = {"pretty", "com.epam.reportportal.cucumber.ScenarioReporter"})
public class RunCukesTest {
}

Configuration

Copy you configuration from UI of Report Portal at User Profile section

or

In order to start using of agent, user should configure property file "reportportal.properties" in such format:

reportportal.properties

rp.endpoint = https://web.demo.reportportal.io
rp.username = default
rp.uuid = 5145b879-83d9-4692-8b07-928cc4b2af7a
rp.launch = default_TEST_EXAMPLE
rp.project = default_project

## OPTIONAL PARAMETERS
rp.tags = TAG1;TAG2
rp.keystore.resource = reportportal-client-v2.jks
rp.keystore.password = reportportal

rp.batch.size.logs = 5

Parameters

User should provide next parameters to agent. These are only examples, for the aclual list of parameters please look into client-java repository.

Launch name can be edited once, and should be edited once, before first execution. As usual, parts of launches are fixed for a long time. Keeping the same name for launch, here we will understand a fixed list of suites under launch, will help to have a history trend, and on UI instances of the same launch will be saved with postfix "#number", like "Test Launch #1", "Test Launch #2" etc.

If mandatory properties are missed client throw exception IllegalArgumentException.

Proxy configuration

The client uses standard java proxy mechanism. If you are new try Java networking and proxies page.

Ways to set up properties:

a. reportportal.properties file b. command line properties (-Dhttps.proxyHost=localhost)

How to provide parameters

There are two way to load parameters.

• Load from properties file

Properties file should have name: “reportportal.properties”. Properties file can be situated on the class path (in the project directory).

If listener can’t find properties file it throws FileNotFoundException. By default “reportportal.properties” exists in the reportportall-client.jar, but user can create his own “reportportal.properties” file and put in class path.

• Use system variables

Parameters loading order

Client loads properties in the next order. Every next level overrides previous:

a. Properties file. Client loads all known to him properties (specified in the "Input Parameters" section) from "reportportal.properties" file.

b. Environment variables. If environment variables with names specified in the "Input Parameters" section exist client reload existing properties from environment variables.

c. JVM variables. If JVM variables with names specified in the "Input Parameters" section exist, client overrides existing ones from JVM variables.

Events

• URI - saves story URI to be sent to ReportPortal afterwards
• Feature - notifies ReportPortal that some feature has started
• startOfScenarioLifeCycle - Runs before-* hooks for the scenario
• scenario - notifies ReportPortal that scenario has been finished
• Before - used to finish previously started hook
• step - collects step to be sent to ReportPortal afterwards
• Examples - generates data being sent to ReportPortal to report examples table
• background - notifies ReportPortal that before-* hooks have been finished
• Match - notify ReportPortal that next step of current scenario is started
• Result - notify ReportPortal that step has finished and after-* hooks should be started (if any)
• After - notify ReportPortal that after-* hook has finished
• Embedding/Write - sends log to ReportPortal
• endOfScenarioLifeCycle - notifies ReportPortal that after-* hooks of scenario has been finished
• eof - notifies ReportPortal that test feature execution is finished
• done - IS NOT processed by ReportPortal agent
• close - notifies ReportPortal that test execution is finished
• SyntaxError - IS NOT processed by ReportPortal agent
• ScenarioOutline - IS NOT processed by ReportPortal agent