Module io.cucumber.core
Package io.cucumber.core.options

Class Constants

java.lang.Object
io.cucumber.core.options.Constants
@API(status=STABLE, since="5.0.0") public final class Constants extends Object

  • Field Details

    • ANSI_COLORS_DISABLED_PROPERTY_NAME

      public static final String ANSI_COLORS_DISABLED_PROPERTY_NAME
      Property name used to disable ansi colors in the output (not supported by all terminals): "cucumber.ansi-colors.disabled"

      Ansi colors are enabled by default.

      See Also:

    • CUCUMBER_PROPERTIES_FILE_NAME

      public static final String CUCUMBER_PROPERTIES_FILE_NAME
      File name of cucumber properties file: "cucumber.properties"
      See Also:

    • EXECUTION_DRY_RUN_PROPERTY_NAME

      public static final String EXECUTION_DRY_RUN_PROPERTY_NAME
      Property name used to enable dry-run: "cucumber.execution.dry-run"

      When using dry run Cucumber will skip execution of glue code.

      By default, dry-run is disabled

      See Also:

    • EXECUTION_LIMIT_PROPERTY_NAME

      public static final String EXECUTION_LIMIT_PROPERTY_NAME
      Property name used to limit the number of executed scenarios : "cucumber.execution.limit"

      Limits the number of scenarios to be executed to a specific amount.

      By default scenarios are executed.

      See Also:

    • EXECUTION_ORDER_PROPERTY_NAME

      public static final String EXECUTION_ORDER_PROPERTY_NAME
      Property name used to set execution order: "cucumber.execution.order"

      Valid values are lexical, reverse, random or random:[seed].

      By default, features are executed in lexical file name order and scenarios in a feature from top to bottom.

      See Also:

    • EXECUTION_THREADS_PROPERTY_NAME

      public static final String EXECUTION_THREADS_PROPERTY_NAME
      Property name used to set the number of threads when using the CLI.

      This property only has an effect when used with the CLI. To control parallelism with cucumber-junit, cucumber-junit-platform-engine or cucumber-testng check their respective documentation.

      The number of threads must be a positive number. Defaults to 1.

      See Also:

    • WIP_PROPERTY_NAME

      public static final String WIP_PROPERTY_NAME
      Property name used to enable wip execution: "cucumber.execution.wip"

      When using wip execution Cucumber will fail if there are any passing scenarios.

      By default, wip execution is disabled

      See Also:

    • FEATURES_PROPERTY_NAME

      public static final String FEATURES_PROPERTY_NAME
      Property name used to select features: "cucumber.features"

      A comma separated list of feature paths. A feature path is constructed as [ PATH[.feature[:LINE]*] | URI[.feature[:LINE]*] | @PATH ]

      Examples:

      • src/test/resources/features -- All features in the src/test/resources/features directory
      • classpath:com/example/application -- All features in the com.example.application package
      • in-memory:/features -- All features in the /features directory on an in memory file system supported by FileSystems
      • src/test/resources/features/example.feature:42 -- The scenario or example at line 42 in the example feature file
      • @target/rerun -- All the scenarios in the files in the rerun directory
      • @target/rerun/RunCucumber.txt -- All the scenarios in RunCucumber.txt file
      See Also:

    • FILTER_NAME_PROPERTY_NAME

      public static final String FILTER_NAME_PROPERTY_NAME
      Property name used to set name filter: "cucumber.filter.name"

      Filters scenarios by name based on the provided regex pattern e.g: ^Hello (World|Cucumber)$. Scenarios that do not match the expression are not executed. Combined with "cucumber.filter.tags" using "and" semantics.

      By default, all scenarios are executed

      See Also:

    • FILTER_TAGS_PROPERTY_NAME

      public static final String FILTER_TAGS_PROPERTY_NAME
      Property name used to set tag filter: "cucumber.filter.tags"

      Filters scenarios by tag based on the provided tag expression e.g: @Cucumber and not (@Gherkin or @Zucchini). Scenarios that do not match the expression are not executed. Combined with "cucumber.filter.name" using "and" semantics.

      By default, all scenarios are executed

      See Also:

    • GLUE_PROPERTY_NAME

      public static final String GLUE_PROPERTY_NAME
      Property name to set the glue path: "cucumber.glue"

      A comma separated list of a classpath uri or package name e.g.: com.example.app.steps.

      See Also:

    • GLUE_CLASSES_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="8.0.0") public static final String GLUE_CLASSES_PROPERTY_NAME
      Property name to set the glue classes: "cucumber.glue.classes"

      A comma separated list fully qualified class names e.g.: com.example.StepDefinitionsA, com.example.StepDefinitionsB.

      Classes that explicitly listed as glue are not filtered by either GLUE_INCLUDED_CLASS_NAME_PATTERN_PROPERTY_NAME or GLUE_EXCLUDED_CLASS_NAME_PATTERN_PROPERTY_NAME.

      See Also:

    • GLUE_INCLUDED_CLASS_NAME_PATTERN_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="8.0.0") public static final String GLUE_INCLUDED_CLASS_NAME_PATTERN_PROPERTY_NAME
      Property name to set the pattern for included glue classes: "cucumber.glue.included-class-name-pattern"

      A glue class is included in classpath scanning if the include pattern matches it and the exclude pattern doesn't.

      Example: .*StepDefinitions?|.*Hooks?

      See Also:

    • GLUE_EXCLUDED_CLASS_NAME_PATTERN_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="8.0.0") public static final String GLUE_EXCLUDED_CLASS_NAME_PATTERN_PROPERTY_NAME
      Property name to set the pattern for excluded glue classes: "cucumber.glue.excluded-class-name-pattern"

      A glue class is included in classpath scanning if the include pattern matches it and the exclude pattern doesn't.

      Example: .*UnwantedStepDefinitions?|.*UnwantedHooks?

      See Also:

    • GLUE_HINT_ENABLED_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="8.0.0") public static final String GLUE_HINT_ENABLED_PROPERTY_NAME
      Property name to enable displaying cucumber glue loading hints: "cucumber.glue.hint.enabled"

      Enabling this will make the hints to be displayed if the expected gain is above the threshold.

      Valid values are true, false (default is true).

      See Also:

    • GLUE_HINT_THRESHOLD_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="8.0.0") public static final String GLUE_HINT_THRESHOLD_PROPERTY_NAME
      Property name to define the threshold to display cucumber glue loading hints: "cucumber.glue.hint.threshold"

      Enabling this will make the hints to be displayed if the expected gain is above the threshold.

      The threshold is an ISO-8601 duration string. Defaults to PT0.1S

      See Also:

    • OBJECT_FACTORY_PROPERTY_NAME

      public static final String OBJECT_FACTORY_PROPERTY_NAME
      Property name used to select a specific object factory implementation: "cucumber.object-factory"
      See Also:

    • UUID_GENERATOR_PROPERTY_NAME

      public static final String UUID_GENERATOR_PROPERTY_NAME
      Property name used to select a specific UUID generator implementation: "cucumber.uuid-generator"
      See Also:

    • PLUGIN_PROPERTY_NAME

      public static final String PLUGIN_PROPERTY_NAME
      Property name to enable plugins: "cucumber.plugin"

      A comma separated list of [PLUGIN[:PATH_OR_URL]] e.g: json:target/cucumber.json.

      Built-in formatter PLUGIN types:

      • html
      • pretty
      • progress
      • summary
      • json
      • usage
      • rerun
      • junit
      • testng

      PLUGIN can also be a fully qualified class name, allowing registration of 3rd party plugins.

      See Also:

    • PLUGIN_PUBLISH_ENABLED_PROPERTY_NAME

      public static final String PLUGIN_PUBLISH_ENABLED_PROPERTY_NAME
      Property name to enable publishing cucumber reports: "cucumber.publish.enabled"

      Enabling this will publish test results online.

      Valid values are true, false.

      See Also:

    • PLUGIN_PUBLISH_TOKEN_PROPERTY_NAME

      public static final String PLUGIN_PUBLISH_TOKEN_PROPERTY_NAME
      Property name to publish cucumber reports with bearer token: "cucumber.publish.token"

      Enabling this will publish authenticated test results online.

      See Also:

    • PLUGIN_PUBLISH_URL_PROPERTY_NAME

      public static final String PLUGIN_PUBLISH_URL_PROPERTY_NAME
      Property name to override the cucumber reports publish uri: "cucumber.publish.url"

      Note that setting this property is not sufficient to activate publishing.

      See Also:

    • PLUGIN_PUBLISH_PROXY_PROPERTY_NAME

      public static final String PLUGIN_PUBLISH_PROXY_PROPERTY_NAME
      Property name to set the proxy used to publish cucumber reports .

      Note that setting this property is not sufficient to activate publishing.

      See Also:

    • PLUGIN_PUBLISH_QUIET_PROPERTY_NAME

      public static final String PLUGIN_PUBLISH_QUIET_PROPERTY_NAME
      Property name to suppress publishing advertising banner: "cucumber.publish.quiet"

      Valid values are true, false.

      See Also:

    • SNIPPET_TYPE_PROPERTY_NAME

      public static final String SNIPPET_TYPE_PROPERTY_NAME
      Property name to control naming convention for generated snippets: "cucumber.snippet-type"

      Valid values are underscore or camelcase.

      By defaults are generated using the under score naming convention.

      See Also: