JUnit Platform Suite Engine

The JUnit Platform supports the declarative definition and execution of suites of tests from any test engine using the JUnit Platform.

Setup

In addition to the junit-platform-suite-api and junit-platform-suite-engine artifacts, you need at least one other test engine and its dependencies on the classpath. See Dependency Metadata for details regarding group IDs, artifact IDs, and versions.

Required Dependencies

junit-platform-suite-api in test scope: artifact containing annotations needed to configure a test suite
junit-platform-suite-engine in test runtime scope: implementation of the TestEngine API for declarative test suites

Both of the required dependencies are aggregated in the junit-platform-suite artifact which can be declared in test scope instead of declaring explicit dependencies on junit-platform-suite-api and junit-platform-suite-engine.

Transitive Dependencies

junit-platform-suite-commons in test scope
junit-platform-launcher in test scope
junit-platform-engine in test scope
junit-platform-commons in test scope
opentest4j in test scope

@Suite Example

By annotating a class with @Suite it is marked as a test suite on the JUnit Platform. As seen in the following example, selector and filter annotations can then be used to control the contents of the suite.

import org.junit.platform.suite.api.IncludeClassNamePatterns;
import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.Suite;
import org.junit.platform.suite.api.SuiteDisplayName;

@Suite
@SuiteDisplayName("JUnit Platform Suite Demo")
@SelectPackages("example")
@IncludeClassNamePatterns(".*Tests")
class SuiteDemo {
}

Additional Configuration Options

There are numerous configuration options for discovering and filtering tests in a test suite. Please consult the Javadoc of the org.junit.platform.suite.api package for a full list of supported annotations and further details.

@BeforeSuite and @AfterSuite

@BeforeSuite and @AfterSuite annotations can be used on methods inside a @Suite-annotated class. They will be executed respectively before and after all tests of the test suite.

@Suite
@SelectPackages("example")
class BeforeAndAfterSuiteDemo {

	@BeforeSuite
	static void beforeSuite() {
		// executes before the test suite
	}

	@AfterSuite
	static void afterSuite() {
		// executes after the test suite
	}

}