Gradle Cucumber-JVM Plugin

The gradle cucumber-jvm plugin provides the ability to run cucumber acceptance tests directly from a gradle build. The plugin utilizes the cucumber cli provided by the cucumber-jvm project, while imposing a few constraints to encourage adopters to use cucumber in a gradle friendly manner. Some of constraints include:

A Cucumber test suite should be contained in a single source set.
Glue code should be compiled by gradle and use annotations to glue to the features.
Features should be in the resources folder of the source set representing the test suite.
This plugin generates Cucumber reports based on masterthought's Cucumber reporting project.

The inspiration for this plugin drew heavily from the work of Samuel Brown's Cucumber Plugin and Camilo Ribeiro's Cucumber Gradle Parallel Example.

Compatibility

Tested with Gradle versions: 6.0. Should work with Gradle 7.+ (not released yet at the time of writing this document). Cucumber 4.3 or later, recommended 4.8.+. At least Java 8 required.

Contributors

Jay St.Gelais
Fork from: commercehub-oss/gradle-cucumber-jvm-plugin

Using the plugin in your gradle build script

The following gradle configuration will create a new Cucumber based test suite named cucumberTest and configure it to run up to 3 parallel forks. The cucumberTest source set will depend on the project's main source set.

plugins {
    id 'java'
    id 'com.patdouble.cucumber-jvm' version '0.19'
}

addCucumberSuite 'cucumberTest'

cucumber {
    maxParallelForks = 3
}

cucumberTest {
    stepDefinitionRoots = ['cucumber.steps', 'cucumber.hooks'] // default
    systemProperties = [
        'myVar': 'myValue'
    ]
}

repositories {
    jcenter()
}

dependencies {
    cucumberTestImplementation 'io.cucumber:cucumber-java:4.8.0'
    // To use JUnit assertions in the step definitions:
    cucumberTestImplementation 'junit:junit:4.12'
}

Using legacy plugin application:

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "com.patdouble:gradle-cucumber-jvm-plugin:0.19"
    }
}
apply plugin: 'cucumber-jvm'

The corresponding directory layout will look like this:

src
├── cucumberTest
│   ├── java
│   │   └── cucumber
│   │       └── steps
│   │           └── DemoSteps.java
│   └── resources
│       └── features
│           └── demo.feature
└── main
    ├── java
    │   └── demopackage
    │       └── Demo.java
    └── resources

Running the following command will execute the test suite:

gradle(w) cucumberTest

Using the Kotlin DSL

Gradle also offers to use the new Kotlin DSL for build files. An example build.gradle.kts file might look like this:

plugins {
    id("java")
    id("com.patdouble.cucumber-jvm").version("0.19")
}

cucumber {
    suite("cucumberTest")
    maxParallelForks = 3
}

repositories {
    mavenCentral()
}

dependencies {
    add("cucumberTestImplementation", "io.cucumber:cucumber-java:4.8.0")
    add("cucumberTestImplementation", "junit:junit:4.12")
}

The main difference is that test suites need to be declared inside the cucumber extension. Also, the dependency syntax is different: dependencies of configurations need to be added via the add() function.

Cucumber Task Configuration

Cucumber tasks can be configured at two levels, globally for the project and individually for a test suite. This allows for projects to contain multiple Cucumber test suites that can differ on some properties while inheriting other property values form the project defaults.

Both levels of configuration make the following settings available:

suite("someName"): Method to register a new suite. This can be used as an alternative to calling addCucumberSuite(). If you use the Kotlin DSL it is the only way to register a suite.
stepDefinitionRoots: A list of root packages to scan the classpath for glue code. Defaults to ['cucumber.steps', 'cucumber.hooks'].
featureRoots: A list of root packages to scan the resources folders on the classpath for feature files. Defaults to ['features'].
tags: A list of tags to identify scenarios to run. Default to an empty list.
plugins: A list of cucumber plugins passed for execution. Defaults to an empty list.
isStrict: A boolean value indicating whether scenarios should be evaluated strictly. Defaults to false.
snippets: Indicator to cucumber on what style to use for generated step examples. Valid values include camelcase, underscore. Defaults to camelcase.
maxParallelForks: Maximum number of forked Java processes to start to run tests in parallel. Defaults to 1.
jvmArgs: List of custom jvm arguments to pass to test execution
isMonochrome: A boolean value indicating whether terminal output should be without colours. Defaults to false.
isDryRun: A boolean value indicating whether glue code execution should be skipped. Defaults to false.
ignoreFailures: Property to cause or prevent build failure when cucumber tests fail. Defaults to false.
junitReport: Property to enable/disable JUnit reporting. Defaults to false.

Setting available in tasks only:

systemProperties: Map of properties to values (String → String) to pass to the forked test running JVMs as Java system properties. Defaults to empty map.
jvmArgs: List of arguments to pass to the forked test running JVMs. Defaults to empty list.

Example:

// global configuration
cucumber {
    suite("smokeCucumberTest")
    suite("otherCucumberTest")
    maxParallelForks = 3
}

// tasks configuration
smokeCucumberTest {
    maxParallelForks = 1 // overrides global configuration
    tags = ['@smoke']
    jvmArgs = ['-Xmx1G']
}

otherCucumberTest {
    systemProperties = ['logback.configurationFile' : 'logback-cucumber.xml']
}

Reporting

By default, this plugin will generate reports based on masterthought's Cucumber reporting project.

JUnit reporting can be enabled by setting the junitReport property to true.

kernelsrinivas / gradle-cucumber-jvm-plugin