Module org.junit.platform.suite.api

Package org.junit.platform.suite.api

Annotations for configuring a test suite on the JUnit Platform.

JUnit 4 Suite Support

Test suites can be run on the JUnit Platform in a JUnit 4 environment via @RunWith(JUnitPlatform.class) with the junit-platform-runner.

JUnit 5 Suite Support

Test suites can be run on the JUnit Platform in a JUnit 5 environment via @Suite with the junit-platform-suite-engine.

  • Annotation Types Summary
    Annotation Type Description
    ConfigurationParameter
    @Configuration specifies the configuration key and value pairs to be added to the discovery request when running a test suite on the JUnit Platform.
    ConfigurationParameters
    @Configurations is a container for one or more @Configuration declarations.
    ExcludeClassNamePatterns
    @ExcludeClassNamePatterns specifies regular expressions that are used to match against fully qualified class names when running a test suite on the JUnit Platform.
    ExcludeEngines
    @ExcludeEngines specifies the IDs of TestEngines to be excluded when running a test suite on the JUnit Platform.
    ExcludePackages
    @ExcludePackages specifies the packages to be excluded when running a test suite on the JUnit Platform.
    ExcludeTags
    @ExcludeTags specifies the tags or tag expressions to be excluded when running a test suite on the JUnit Platform.
    IncludeClassNamePatterns
    @IncludeClassNamePatterns specifies regular expressions that are used to match against fully qualified class names when running a test suite on the JUnit Platform.
    IncludeEngines
    @IncludeEngines specifies the IDs of TestEngines to be included when running a test suite on the JUnit Platform.
    IncludePackages
    @IncludePackages specifies the packages to be included when running a test suite on the JUnit Platform.
    IncludeTags
    @IncludeTags specifies the tags or tag expressions to be included when running a test suite on the JUnit Platform.
    SelectClasses
    @SelectClasses specifies the classes to select when running a test suite on the JUnit Platform.
    SelectClasspathResource
    @SelectClasspathResource specifies the classpath resource to select when running a test suite on the JUnit Platform.
    SelectClasspathResources
    @SelectClasspathResources is a container for one or more @SelectClasspathResource declarations.
    SelectDirectories
    @SelectDirectories specifies the directories to select when running a test suite on the JUnit Platform.
    SelectFile
    @SelectFiles specifies the files to select when running a test suite on the JUnit Platform.
    SelectFiles
    @SelectFiles is a container for one or more @SelectFile declarations.
    SelectModules
    @SelectModules specifies the modules to select when running a test suite on the JUnit Platform.
    SelectPackages
    @SelectPackages specifies the names of packages to select when running a test suite on the JUnit Platform.
    SelectUris
    @SelectUris specifies the uris to select when running a test suite on the JUnit Platform.
    Suite
    @Suite marks class as a test suite on the JUnit Platform.
    SuiteDisplayName
    @SuiteDisplayName is used to declare a custom display name for the annotated test class that is executed as a test suite on the JUnit Platform.
    UseTechnicalNames
    @UseTechnicalNames specifies that technical names should be used instead of display names when running a test suite on the JUnit Platform.