Module org.junit.jupiter.engine
Package org.junit.jupiter.engine

Class Constants

java.lang.Object
org.junit.jupiter.engine.Constants
@API(status=STABLE, since="5.0") public final class Constants extends Object
Collection of constants related to the JupiterTestEngine.
Since:
5.0
See Also:

  • Field Details

    • EXTENSIONS_AUTODETECTION_INCLUDE_PROPERTY_NAME

      public static final String EXTENSIONS_AUTODETECTION_INCLUDE_PROPERTY_NAME
      Property name used to include patterns for auto-detecting extensions: "junit.jupiter.extensions.autodetection.include"

      Pattern Matching Syntax

      If the property value consists solely of an asterisk (*), all extensions will be included. Otherwise, the property value will be treated as a comma-separated list of patterns where each individual pattern will be matched against the fully qualified class name (FQCN) of each extension. Any dot (.) in a pattern will match against a dot (.) or a dollar sign ($) in a FQCN. Any asterisk (*) will match against one or more characters in a FQCN. All other characters in a pattern will be matched one-to-one against a FQCN.

      Examples

      • *: includes all extensions.
      • org.junit.*: includes every extension under the org.junit base package and any of its subpackages.
      • *.MyExtension: includes every extension whose simple class name is exactly MyExtension.
      • *System*: includes every extension whose FQCN contains System.
      • *System*, *Dev*: includes every extension whose FQCN contains System or Dev.
      • org.example.MyExtension, org.example.TheirExtension: includes extensions whose FQCN is exactly org.example.MyExtension or org.example.TheirExtension.

      Note: A class that matches both an inclusion and exclusion pattern will be excluded.

      See Also:

    • EXTENSIONS_AUTODETECTION_EXCLUDE_PROPERTY_NAME

      public static final String EXTENSIONS_AUTODETECTION_EXCLUDE_PROPERTY_NAME
      Property name used to exclude patterns for auto-detecting extensions: "junit.jupiter.extensions.autodetection.exclude"

      Pattern Matching Syntax

      If the property value consists solely of an asterisk (*), all extensions will be excluded. Otherwise, the property value will be treated as a comma-separated list of patterns where each individual pattern will be matched against the fully qualified class name (FQCN) of each extension. Any dot (.) in a pattern will match against a dot (.) or a dollar sign ($) in a FQCN. Any asterisk (*) will match against one or more characters in a FQCN. All other characters in a pattern will be matched one-to-one against a FQCN.

      Examples

      • *: excludes all extensions.
      • org.junit.*: excludes every extension under the org.junit base package and any of its subpackages.
      • *.MyExtension: excludes every extension whose simple class name is exactly MyExtension.
      • *System*: excludes every extension whose FQCN contains System.
      • *System*, *Dev*: excludes every extension whose FQCN contains System or Dev.
      • org.example.MyExtension, org.example.TheirExtension: excludes extensions whose FQCN is exactly org.example.MyExtension or org.example.TheirExtension.

      Note: A class that matches both an inclusion and exclusion pattern will be excluded.

      See Also:

    • DEACTIVATE_CONDITIONS_PATTERN_PROPERTY_NAME

      public static final String DEACTIVATE_CONDITIONS_PATTERN_PROPERTY_NAME
      Property name used to provide patterns for deactivating conditions: "junit.jupiter.conditions.deactivate"

      Pattern Matching Syntax

      If the property value consists solely of an asterisk (*), all conditions will be deactivated. Otherwise, the property value will be treated as a comma-separated list of patterns where each individual pattern will be matched against the fully qualified class name (FQCN) of each registered condition. Any dot (.) in a pattern will match against a dot (.) or a dollar sign ($) in a FQCN. Any asterisk (*) will match against one or more characters in a FQCN. All other characters in a pattern will be matched one-to-one against a FQCN.

      Examples

      • *: deactivates all conditions.
      • org.junit.*: deactivates every condition under the org.junit base package and any of its subpackages.
      • *.MyCondition: deactivates every condition whose simple class name is exactly MyCondition.
      • *System*: deactivates every condition whose FQCN contains System.
      • *System*, *Dev*: deactivates every condition whose FQCN contains System or Dev.
      • org.example.MyCondition, org.example.TheirCondition: deactivates conditions whose FQCN is exactly org.example.MyCondition or org.example.TheirCondition.
      See Also:

    • DEACTIVATE_ALL_CONDITIONS_PATTERN

      public static final String DEACTIVATE_ALL_CONDITIONS_PATTERN
      Wildcard pattern which signals that all conditions should be deactivated: "*"
      See Also:

    • DEFAULT_DISPLAY_NAME_GENERATOR_PROPERTY_NAME

      public static final String DEFAULT_DISPLAY_NAME_GENERATOR_PROPERTY_NAME
      Property name used to set the default display name generator class name: "junit.jupiter.displayname.generator.default"
      See Also:

    • EXTENSIONS_AUTODETECTION_ENABLED_PROPERTY_NAME

      public static final String EXTENSIONS_AUTODETECTION_ENABLED_PROPERTY_NAME
      Property name used to enable auto-detection and registration of extensions via Java's ServiceLoader mechanism: "junit.jupiter.extensions.autodetection.enabled"

      The default behavior is not to perform auto-detection.

      See Also:

    • EXTENSIONS_TIMEOUT_THREAD_DUMP_ENABLED_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="5.12") public static final String EXTENSIONS_TIMEOUT_THREAD_DUMP_ENABLED_PROPERTY_NAME
      Property name used to enable dumping the stack of all threads to System.out when a timeout has occurred.

      This behavior is disabled by default.

      Since:
      5.12
      See Also:

    • DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME

      public static final String DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME
      Property name used to set the default test instance lifecycle mode: "junit.jupiter.testinstance.lifecycle.default"
      See Also:

    • PARALLEL_EXECUTION_ENABLED_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String PARALLEL_EXECUTION_ENABLED_PROPERTY_NAME
      Property name used to enable parallel test execution: "junit.jupiter.execution.parallel.enabled"

      By default, tests are executed sequentially in a single thread.

      Since:
      5.3
      See Also:

    • DEFAULT_PARALLEL_EXECUTION_MODE

      @API(status=STABLE, since="5.10") public static final String DEFAULT_PARALLEL_EXECUTION_MODE
      Property name used to set the default test execution mode: "junit.jupiter.execution.parallel.mode.default"
      See Also:

    • DEFAULT_CLASSES_EXECUTION_MODE_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_CLASSES_EXECUTION_MODE_PROPERTY_NAME
      Property name used to set the default test execution mode for top-level classes: "junit.jupiter.execution.parallel.mode.classes.default"
      See Also:

    • PARALLEL_CONFIG_STRATEGY_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String PARALLEL_CONFIG_STRATEGY_PROPERTY_NAME
      Property name used to select the ParallelExecutionConfigurationStrategy: "junit.jupiter.execution.parallel.config.strategy"

      Potential values: dynamic (default), fixed, or custom.

      Since:
      5.3
      See Also:

    • PARALLEL_CONFIG_FIXED_PARALLELISM_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String PARALLEL_CONFIG_FIXED_PARALLELISM_PROPERTY_NAME
      Property name used to set the desired parallelism for the fixed configuration strategy: "junit.jupiter.execution.parallel.config.fixed.parallelism"

      No default value; must be a positive integer.

      Since:
      5.3
      See Also:

    • PARALLEL_CONFIG_FIXED_MAX_POOL_SIZE_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="5.10") public static final String PARALLEL_CONFIG_FIXED_MAX_POOL_SIZE_PROPERTY_NAME
      Property name used to configure the maximum pool size of the underlying fork-join pool for the fixed configuration strategy: "junit.jupiter.execution.parallel.config.fixed.max-pool-size"

      Value must be an integer and greater than or equal to "junit.jupiter.execution.parallel.config.fixed.parallelism"; defaults to 256 + fixed.parallelism.

      Note: This property only takes affect on Java 9+.

      Since:
      5.10
      See Also:

    • PARALLEL_CONFIG_FIXED_SATURATE_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="5.10") public static final String PARALLEL_CONFIG_FIXED_SATURATE_PROPERTY_NAME
      Property name used to disable saturation of the underlying fork-join pool for the fixed configuration strategy: "junit.jupiter.execution.parallel.config.fixed.saturate"

      When set to false the underlying fork-join pool will reject additional tasks if all available workers are busy and the maximum pool-size would be exceeded.

      Value must either true or false; defaults to true.

      Note: This property only takes affect on Java 9+.

      Since:
      5.10
      See Also:

    • PARALLEL_CONFIG_DYNAMIC_FACTOR_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String PARALLEL_CONFIG_DYNAMIC_FACTOR_PROPERTY_NAME
      Property name used to set the factor to be multiplied with the number of available processors/cores to determine the desired parallelism for the dynamic configuration strategy: "junit.jupiter.execution.parallel.config.dynamic.factor"

      Value must be a positive decimal number; defaults to 1.

      Since:
      5.3
      See Also:

    • PARALLEL_CONFIG_CUSTOM_CLASS_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String PARALLEL_CONFIG_CUSTOM_CLASS_PROPERTY_NAME
      Property name used to specify the fully qualified class name of the ParallelExecutionConfigurationStrategy to be used for the custom configuration strategy: "junit.jupiter.execution.parallel.config.custom.class"
      Since:
      5.3
      See Also:

    • DEFAULT_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all testable and lifecycle methods: "junit.jupiter.execution.timeout.default".
      See Also:

    • DEFAULT_TESTABLE_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_TESTABLE_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all testable methods: "junit.jupiter.execution.timeout.testable.method.default".
      See Also:

    • DEFAULT_TEST_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_TEST_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @Test methods: "junit.jupiter.execution.timeout.test.method.default".
      See Also:

    • DEFAULT_TEST_TEMPLATE_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_TEST_TEMPLATE_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @TestTemplate methods: "junit.jupiter.execution.timeout.testtemplate.method.default".
      See Also:

    • DEFAULT_TEST_FACTORY_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_TEST_FACTORY_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @TestFactory methods: "junit.jupiter.execution.timeout.testfactory.method.default".
      See Also:

    • DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all lifecycle methods: "junit.jupiter.execution.timeout.lifecycle.method.default".
      See Also:

    • DEFAULT_BEFORE_ALL_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_BEFORE_ALL_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @BeforeAll methods: "junit.jupiter.execution.timeout.beforeall.method.default".
      See Also:

    • DEFAULT_BEFORE_EACH_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_BEFORE_EACH_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @BeforeEach methods: "junit.jupiter.execution.timeout.beforeeach.method.default".
      See Also:

    • DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @AfterEach methods: "junit.jupiter.execution.timeout.aftereach.method.default".
      See Also:

    • DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAME
      Property name used to set the default timeout for all @AfterAll methods: "junit.jupiter.execution.timeout.afterall.method.default".
      See Also:

    • TIMEOUT_MODE_PROPERTY_NAME

      @API(status=STABLE, since="5.10") public static final String TIMEOUT_MODE_PROPERTY_NAME
      Property name used to configure whether timeouts are applied to tests: "junit.jupiter.execution.timeout.mode".
      See Also:

    • DEFAULT_TEST_METHOD_ORDER_PROPERTY_NAME

      @API(status=STABLE, since="5.9") public static final String DEFAULT_TEST_METHOD_ORDER_PROPERTY_NAME
      Property name used to set the default method orderer class name: "junit.jupiter.testmethod.order.default"
      See Also:

    • DEFAULT_TEST_CLASS_ORDER_PROPERTY_NAME

      @API(status=STABLE, since="5.9") public static final String DEFAULT_TEST_CLASS_ORDER_PROPERTY_NAME
      Property name used to set the default class orderer class name: "junit.jupiter.testclass.order.default"
      See Also:

    • TEMP_DIR_SCOPE_PROPERTY_NAME

      @Deprecated @API(status=DEPRECATED, since="5.8") public static final String TEMP_DIR_SCOPE_PROPERTY_NAME
      Deprecated.
      Property name used to set the scope of temporary directories created via the @TempDir annotation: "junit.jupiter.tempdir.scope"
      See Also:

    • DEFAULT_TIMEOUT_THREAD_MODE_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="5.9") public static final String DEFAULT_TIMEOUT_THREAD_MODE_PROPERTY_NAME
      Property name used to set the default timeout thread mode.
      Since:
      5.9
      See Also:

    • DEFAULT_TEMP_DIR_FACTORY_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="5.10") public static final String DEFAULT_TEMP_DIR_FACTORY_PROPERTY_NAME
      Property name used to set the default factory for temporary directories created via the @TempDir annotation: "junit.jupiter.tempdir.factory.default"
      Since:
      5.10
      See Also:

    • DEFAULT_TEST_CLASS_INSTANCE_CONSTRUCTION_EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME

      @API(status=EXPERIMENTAL, since="5.12") public static final String DEFAULT_TEST_CLASS_INSTANCE_CONSTRUCTION_EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME
      Property name used to set the default extension context scope for extensions that participate in test instantiation: "junit.jupiter.extensions.testinstantiation.extensioncontextscope.default"
      Since:
      5.12
      See Also: