Package 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 Interfaces Summary
    Annotation Interface
    Description
    @Configuration specifies the configuration key and value pairs to be added to the discovery request when running a test suite on the JUnit Platform.
    @Configurations is a container for one or more @Configuration declarations.
    @ExcludeClassNamePatterns specifies regular expressions that are used to match against fully qualified class names when running a test suite on the JUnit Platform.
    @ExcludeEngines specifies the IDs of TestEngines to be excluded when running a test suite on the JUnit Platform.
    @ExcludePackages specifies the packages to be excluded when running a test suite on the JUnit Platform.
    @ExcludeTags specifies the tags or tag expressions to be excluded when running a test suite on the JUnit Platform.
    @IncludeClassNamePatterns specifies regular expressions that are used to match against fully qualified class names when running a test suite on the JUnit Platform.
    @IncludeEngines specifies the IDs of TestEngines to be included when running a test suite on the JUnit Platform.
    @IncludePackages specifies the packages to be included when running a test suite on the JUnit Platform.
    @IncludeTags specifies the tags or tag expressions to be included when running a test suite on the JUnit Platform.
    @SelectClasses specifies the classes to select when running a test suite on the JUnit Platform.
    @SelectClasspathResource specifies the classpath resource to select when running a test suite on the JUnit Platform.
    @SelectClasspathResources is a container for one or more @SelectClasspathResource declarations.
    @SelectDirectories specifies the directories to select when running a test suite on the JUnit Platform.
    @SelectFiles specifies the files to select when running a test suite on the JUnit Platform.
    @SelectFiles is a container for one or more @SelectFile declarations.
    @SelectModules specifies the modules to select when running a test suite on the JUnit Platform.
    @SelectPackages specifies the names of packages to select when running a test suite on the JUnit Platform.
    @SelectUris specifies the uris to select when running a test suite on the JUnit Platform.
    @Suite marks class as a test suite on the JUnit Platform.
    @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 specifies that technical names should be used instead of display names when running a test suite on the JUnit Platform.