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
AfterSuite	@AfterSuite is used to signal that the annotated method should be executed after all tests in the current test suite.
BeforeSuite	@BeforeSuite is used to signal that the annotated method should be executed before all tests in the current test suite.
ConfigurationParameter	@ConfigurationParameter is a repeatable annotation that specifies a configuration key and value pair to be added to the discovery request when running a test suite on the JUnit Platform.
ConfigurationParameters	@ConfigurationParameters is a container for one or more @ConfigurationParameter declarations.
ConfigurationParametersResource	@ConfigurationParametersResource is a repeatable annotation that specifies a configuration file in Java's properties format on the classpath to be added to the discovery request when running a test suite on the JUnit Platform.
ConfigurationParametersResources	@ConfigurationParametersResources is a container for one or more @ConfigurationParametersResource declarations.
DisableParentConfigurationParameters	Disable parent configuration parameters.
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.
Select	@Select is a repeatable annotation that specifies which tests to select based on prefixed selector identifiers.
SelectClasses	@SelectClasses specifies the classes to select when running a test suite on the JUnit Platform.
SelectClasspathResource	@SelectClasspathResource is a repeatable annotation that specifies a 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	@SelectFile is a repeatable annotation that specifies a file to select when running a test suite on the JUnit Platform.
SelectFiles	@SelectFiles is a container for one or more @SelectFile declarations.
SelectMethod	@SelectMethod is a repeatable annotation that specifies a method to select when running a test suite on the JUnit Platform.
SelectMethods	@SelectMethods is a container for one or more @SelectMethod 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.
Selects	@Selects is a container for one or more @Select declarations.
SelectUris	@SelectUris specifies the URIs to select when running a test suite on the JUnit Platform.
Suite	@Suite marks a 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	Deprecated. since 1.8, in favor of the @Suite support provided by the junit-platform-suite-engine module; to be removed in JUnit Platform 2.0