Skip to main content

Cucumber

Installation​

Install the mvn package​

Add the dependency to your pom:

<dependency>
    <groupId>io.orangebeard</groupId>
    <artifactId>cucumber-java-listener</artifactId>
    <version>version</version>
    <scope>test</scope>
</dependency>

The source code can be found on GitHub: Cucumber Java Listener

Configuration​

Make sure your Cucumber setup makes use of JUnit to execute scenarios.

Add the following plugin to the list of your plugins (comma separated) to your cucumber.properties in the test resources folder:

cucumber.plugin=io.orangebeard.listener.OrangebeardCucumberListener

Create a new file named orangebeard.properties in the test resources folder. Add the following properties:

orangebeard.endpoint=<ORANGEBEARD-ENDPOINT>
orangebeard.accessToken=<XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX>
orangebeard.project=<PROJECT_NAME>
orangebeard.testset=<TESTSET_NAME>

# optional
orangebeard.description=<DESCRIPTION>
orangebeard.attributes=key:value; value;

For more configuration options (i.e. json config), see: https://docs.orangebeard.io/connecting-test-tools/listener-api-clients/#auto-config

Environment variables​

The properties above can be set as environment variables as well. Environment variables will override property values. In the environment variables, it is allowed to replace the dot by an underscore. for example: orangebeard_endpoint as an environment variable will work as well.