- * Filters features based on the provided regex pattern. + * Filters scenarios by name based on the provided regex pattern e.g: + * {@code ^Hello (World|Cucumber)$}. Scenarios that do not match the + * expression are not executed. *
- * By default no features are filtered + * By default all scenarios are executed */ public static final String FILTER_NAME_PROPERTY_NAME = "cucumber.filter.name"; + /** * Property name used to set tag filter: {@value} *
- * Filters scenarios based on the provided tag expression e.g: - * {@code @Integration and not @Ignored}. Scenarios that do not match the - * expression are not executed. + * Filters scenarios by tag based on the provided tag expression e.g: + * {@code @Cucumber and not (@Gherkin or @Zucchini)}. Scenarios that do not + * match the expression are not executed. *
* By default all scenarios are executed
*/
diff --git a/core/src/main/resources/io/cucumber/core/options/USAGE.txt b/core/src/main/resources/io/cucumber/core/options/USAGE.txt
index 776164f982..a653cb6241 100644
--- a/core/src/main/resources/io/cucumber/core/options/USAGE.txt
+++ b/core/src/main/resources/io/cucumber/core/options/USAGE.txt
@@ -113,18 +113,41 @@ Supported properties are:
```
cucumber.ansi-colors.disabled= # true or false. default: false
+
cucumber.execution.dry-run= # true or false. default: false
+
cucumber.execution.limit= # number of scenarios to execute (CLI only).
+
cucumber.execution.order= # lexical, reverse, random or random:[seed] (CLI only). default: lexical
+
cucumber.execution.strict= # true or false. default: false.
+
cucumber.execution.wip= # true or false. default: false.
-cucumber.features= # command separated paths to feature files. example: path/to/example.feature, path/to/other.feature
-cucumber.filter.name= # regex. example: .*Hello.*
-cucumber.filter.tags= # tag expression. example: @smoke and not @slow
-cucumber.glue= # comma separated package names. example: com.example.glue
-cucumber.plugin= # comma separated plugin strings. example: pretty, json:path/to/report.json
-cucumber.object-factory= # object factory class name. example: com.example.MyObjectFactory
-cucumber.snippet-type= # underscore or camelcase. default: underscore
+ # Fails if there any passing scenarios
+ # CLI only.
+
+cucumber.features= # command separated paths to feature files.
+ # example: path/to/example.feature, path/to/other.feature
+
+cucumber.filter.name= # a regular expression
+ # only scenarios with matching names are executed.
+ # example: ^Hello (World|Cucumber)$
+
+cucumber.filter.tags= # a cucumber tag expression.
+ # only scenarios with matching tags are executed.
+ # example: @Cucumber and not (@Gherkin or @Zucchini)
+
+cucumber.glue= # comma separated package names.
+ # example: com.example.glue
+
+cucumber.plugin= # comma separated plugin strings.
+ # example: pretty, json:path/to/report.json
+
+cucumber.object-factory= # object factory class name.
+ # example: com.example.MyObjectFactory
+
+cucumber.snippet-type= # underscore or camelcase.
+ # default: underscore
```
Each property also has an `UPPER_CASE` and `snake_case` variant. For example
diff --git a/junit-platform-engine/README.md b/junit-platform-engine/README.md
index 524a495b14..a08b2912ed 100644
--- a/junit-platform-engine/README.md
+++ b/junit-platform-engine/README.md
@@ -170,49 +170,53 @@ Note: The `@` is not included.
## Configuration Options ##
Cucumber receives its configuration from the JUnit platform. To see how these
-can be supplied see the JUnit documentation [4.5. Configuration Parameters](https://junit.org/junit5/docs/current/user-guide/#running-tests-config-params).
+can be supplied; see the JUnit documentation [4.5. Configuration Parameters](https://junit.org/junit5/docs/current/user-guide/#running-tests-config-params).
For documentation see [Constants](src/main/java/io/cucumber/junit/platform/engine/Constants.java).
```
cucumber.ansi-colors.disabled= # true or false. default: false
+cucumber.filter.name= # a regular expression
+ # only scenarios with matching names are executed.
+ # example: ^Hello (World|Cucumber)$
+
cucumber.filter.tags= # a cucumber tag expression.
- # only matching scenarios are executed.
- # example: @integration and not @disabled
-
+ # only scenarios with matching tags are executed.
+ # example: @Cucumber and not (@Gherkin or @Zucchini)
+
cucumber.glue= # comma separated package names.
# example: com.example.glue
-
+
cucumber.plugin= # comma separated plugin strings.
# example: pretty, json:path/to/report.json
-
+
cucumber.object-factory= # object factory class name.
# example: com.example.MyObjectFactory
-
+
cucumber.snippet-type= # underscore or camelcase.
# default: underscore
-
+
cucumber.execution.dry-run= # true or false.
# default: false
-
+
cucumber.execution.parallel.enabled= # true or false.
# default: false
-
+
cucumber.execution.parallel.config.strategy= # dynamic, fixed or custom.
# default: dynamic
-
+
cucumber.execution.parallel.config.fixed.parallelism= # positive integer.
# example: 4
-
+
cucumber.execution.parallel.config.dynamic.factor= # positive double.
# default: 1.0
-
+
cucumber.execution.parallel.config.custom.class= # class name.
# example: com.example.MyCustomParallelStrategy
cucumber.execution.exclusive-resources.
+ * Filters features by name based on the provided regex pattern e.g:
+ * {@code ^Hello (World|Cucumber)$}. Scenarios that do not match the
+ * expression are not executed.
+ *
+ * By default all scenarios are executed
+ */
+ public static final String FILTER_NAME_PROPERTY_NAME = io.cucumber.core.options.Constants.FILTER_NAME_PROPERTY_NAME;
+
/**
* Property name used to set tag filter: {@value}
*
- * Filters scenarios based on the provided tag expression e.g:
- * {@code @Integration and not @Ignored}. Scenarios that did not match the
- * expression will be rendered by JUnit as skipped.
+ * Filters scenarios by tag based on the provided tag expression e.g:
+ * {@code @Cucumber and not (@Gherkin or @Zucchini)}. Scenarios that do not
+ * match the expression are not executed.
*
* By default all scenarios are executed
*/
public static final String FILTER_TAGS_PROPERTY_NAME = io.cucumber.core.options.Constants.FILTER_TAGS_PROPERTY_NAME;
+
/**
* Property name to set the glue path: {@value}
*
@@ -53,6 +67,7 @@ public final class Constants {
* @see io.cucumber.core.feature.GluePath
*/
public static final String GLUE_PROPERTY_NAME = io.cucumber.core.options.Constants.GLUE_PROPERTY_NAME;
+
/**
* Property name to enable plugins: {@value}
*
@@ -76,6 +91,7 @@ public final class Constants {
* registration of 3rd party plugins.
*/
public static final String PLUGIN_PROPERTY_NAME = io.cucumber.core.options.Constants.PLUGIN_PROPERTY_NAME;
+
/**
* Property name to select custom object factory implementation: {@value}
*
@@ -83,6 +99,7 @@ public final class Constants {
* that object factory will be used.
*/
public static final String OBJECT_FACTORY_PROPERTY_NAME = io.cucumber.core.options.Constants.OBJECT_FACTORY_PROPERTY_NAME;
+
/**
* Property name to control naming convention for generated snippets:
* {@value}
@@ -92,6 +109,7 @@ public final class Constants {
* By defaults are generated using the under score naming convention.
*/
public static final String SNIPPET_TYPE_PROPERTY_NAME = io.cucumber.core.options.Constants.SNIPPET_TYPE_PROPERTY_NAME;
+
/**
* Property name used to enable parallel test execution: {@value}
*
@@ -102,6 +120,7 @@ public final class Constants {
static final String EXECUTION_EXCLUSIVE_RESOURCES_PREFIX = "cucumber.execution.exclusive-resources.";
static final String READ_WRITE_SUFFIX = ".read-write";
+
/**
* Property template used to describe a mapping of tags to exclusive
* resources: {@value}
@@ -131,6 +150,7 @@ public final class Constants {
public static final String EXECUTION_EXCLUSIVE_RESOURCES_READ_WRITE_TEMPLATE = EXECUTION_EXCLUSIVE_RESOURCES_PREFIX
+ EXECUTION_EXCLUSIVE_RESOURCES_TAG_TEMPLATE_VARIABLE + READ_WRITE_SUFFIX;
static final String READ_SUFFIX = ".read";
+
/**
* Property template used to describe a mapping of tags to exclusive
* resources: {@value}
@@ -143,6 +163,7 @@ public final class Constants {
+ EXECUTION_EXCLUSIVE_RESOURCES_TAG_TEMPLATE_VARIABLE + READ_SUFFIX;
static final String PARALLEL_CONFIG_PREFIX = "cucumber.execution.parallel.config.";
+
/**
* Property name used to determine the desired configuration strategy:
* {@value}
diff --git a/junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/CucumberEngineOptions.java b/junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/CucumberEngineOptions.java
index 0986c61ce0..c93e13f9ce 100644
--- a/junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/CucumberEngineOptions.java
+++ b/junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/CucumberEngineOptions.java
@@ -14,11 +14,14 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
+import java.util.Optional;
+import java.util.regex.Pattern;
import java.util.stream.Collectors;
import static io.cucumber.core.resource.ClasspathSupport.CLASSPATH_SCHEME_PREFIX;
import static io.cucumber.junit.platform.engine.Constants.ANSI_COLORS_DISABLED_PROPERTY_NAME;
import static io.cucumber.junit.platform.engine.Constants.EXECUTION_DRY_RUN_PROPERTY_NAME;
+import static io.cucumber.junit.platform.engine.Constants.FILTER_NAME_PROPERTY_NAME;
import static io.cucumber.junit.platform.engine.Constants.FILTER_TAGS_PROPERTY_NAME;
import static io.cucumber.junit.platform.engine.Constants.GLUE_PROPERTY_NAME;
import static io.cucumber.junit.platform.engine.Constants.OBJECT_FACTORY_PROPERTY_NAME;
@@ -59,11 +62,12 @@ public boolean isWip() {
return false;
}
- public Expression tagFilter() {
- return TagExpressionParser
- .parse(configurationParameters
- .get(FILTER_TAGS_PROPERTY_NAME)
- .orElse(""));
+ Optional