Overriding tags to be filtered using command line through Gradle

[Arc-E-Tect]

I'm tying to override the configuration for which tags to run from the Gradle command line.

Following Java class is used to setup Cucumber:

@Suite
@IncludeEngines("cucumber")
@SelectClasspathResource("com/arc_e_tect")
@ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "pretty," +
        "html:build/reports/bdd-test/Cucumber.html")
@ConfigurationParameter(key = FILTER_TAGS_PROPERTY_NAME, value = "not @ignore and not @wip")
@ConfigurationParameter(key = GLUE_PROPERTY_NAME, value = "com.arc_e_tect.book.sedr")
public class RunBddTest {
}

This is my relevant Gradle setup using the Test Suite concept:

[...]

testing {
    suites {
        test {
            useJUnitJupiter()
        }

        bddTest(JvmTestSuite) {
            dependencies {
                implementation project()
            }

            sources {
                java {
                    srcDirs = ['src/bdd-test/java']
                }
                resources {
                    srcDirs = ['src/bdd-test/resources']
                }
            }

            targets {
                configureEach {
                    testTask.configure {
                        mustRunAfter(test)
                    }
                }
            }
        }

    }
}

bddTest {
    systemProperty "cucumber.filter.tags", System.getProperty("cucumber.filter.tags")
}

[...]

I have scenarios tagged with @SunnyFlow and @CloudyFlow.

When I run ./gradlew bddTest all scenarios are executed, unless annotated with @ignore or @wip. This works.

Now I want to execute only the sunny flows, so I call: ./gradlew bddTest -Dcucumber.filter.tags="@SunnyFlow" and I would expect that only the scenarios tagged with @SunnyFlow would be executed, but it doesn't work. Still all scenarios are executed.

Any thoughts where I am missing something?

Using Java 17, Gradle 8.13, Cucumber 7.21

Thanks,
Iwan

[mpkorstanje]

The JUnit annotation @ConfigurationParameter takes precedence over the system properties. See https://junit.org/junit5/docs/current/user-guide/#running-tests-config-params

You'd have to remove the annotation and configure Gradle to use a default value for cucumber.filter.tags if none was provided.

I'm far from a Gradle expert so don't know how to do that.

[Arc-E-Tect]

Thanks, that was a helpful detail.

I updated the build.gradle file, it now has this definition:

bddTest {
    systemProperty("cucumber.filter.tags", System.getProperty("cucumber_filter_tags", "not @ignore and not @wip"))
}

This will use the system property cucumber_filter_tags when present and otherwise default to "not @ignore and not @wip".

I renamed the system property to cucumber_filter_tags because it seems that it is not possible to specify dot-separated properties from the command line. Well, I didn't get it to work.

Now the call is done through ./gradlew bddTest -Dcucumber_filter_tags="@SunnyFlow" to run only the scenarios with tag @SunnyFlow.

All works like a charm.