The next generation of JUnit.
Clone or download
Latest commit 5c55b99 Oct 18, 2018
Permalink
Failed to load latest commit information.
.github Fix link Oct 16, 2018
buildSrc Upgrade Bartholdy to 0.1.1 Oct 12, 2018
documentation Support primitive data types in assertNotEquals() Oct 18, 2018
gradle Migrate publishing.gradle to Kotlin DSL Oct 8, 2018
junit-bom Migrate publishing.gradle to Kotlin DSL Oct 8, 2018
junit-jupiter-api Polish contribution Oct 18, 2018
junit-jupiter-engine Polish contribution Oct 18, 2018
junit-jupiter-migrationsupport Migrate testing.gradle to Kotlin DSL Oct 7, 2018
junit-jupiter-params Polish contribution Oct 14, 2018
junit-platform-commons-java-9 Remove reference cycles from 'junit-jupiter-engine' Oct 11, 2018
junit-platform-commons Migrate three build scripts to Kotlin DSL Oct 3, 2018
junit-platform-console-standalone Remove japicc task and related properties Oct 7, 2018
junit-platform-console Migrate :junit-platform-console to Kotlin DSL Oct 7, 2018
junit-platform-engine Migrate :junit-platform-engine to Kotlin DSL Oct 5, 2018
junit-platform-launcher Migrate :junit-platform-launcher to Kotlin DSL Oct 5, 2018
junit-platform-runner Migrate :junit-platform-runner to Kotlin DSL Oct 5, 2018
junit-platform-suite-api Migrate :junit-platform-suite-api to Kotlin DSL Oct 5, 2018
junit-platform-testkit Migrate :junit-platform-testkit to Kotlin DSL Oct 5, 2018
junit-vintage-engine Migrate testing.gradle to Kotlin DSL Oct 7, 2018
platform-tests Polishing Oct 8, 2018
platform-tooling-support-tests Configure CyclesDetector to ignore some packages Oct 11, 2018
src Update to new build script file name Oct 8, 2018
.appveyor.yml Switch to JDK 11 on AppVeyor Oct 8, 2018
.gitattributes Upgrade to Gradle 4.0 Jun 14, 2017
.gitignore Use OpenClover 4.2.0 for coverage (no license required anymore) Oct 8, 2017
.travis.yml Simplify condition preventing deploy stage from being executed Oct 12, 2018
CONTRIBUTING.md Remove custom Surefire provider Sep 27, 2018
LICENSE-notice.md Include 3rd-party libraries license notice Mar 31, 2017
LICENSE.md Remove custom Surefire provider Sep 27, 2018
README.md Restore alphabetical order of modules Oct 5, 2018
build.gradle Migrate publishing.gradle to Kotlin DSL Oct 8, 2018
codecov.yml Codecov: Disable patch status Jan 23, 2018
gradle.properties Remove japicc task and related properties Oct 7, 2018
gradlew Upgrade to Gradle 4.0 Jun 14, 2017
gradlew.bat Upgrade to Gradle 3.0 Aug 15, 2016
jitpack.yml Switch to OpenJDK 11 to build JUnit 5 Sep 9, 2018
settings.gradle.kts Define all versions in single location Oct 5, 2018

README.md

JUnit 5

This repository is the home of the next generation of JUnit, JUnit 5.

Support us on Steady

Latest Releases

  • General Availability (GA): JUnit 5.3.1 (September 11, 2018).
  • Preview (Milestone/Release Candidate): N/A

Documentation

Contributing

Contributions to JUnit 5 are both welcomed and appreciated. For specific guidelines regarding contributions, please see CONTRIBUTING.md in the root directory of the project. Those willing to use milestone or SNAPSHOT releases are encouraged to file feature requests and bug reports using the project's issue tracker. Issues marked with an up-for-grabs label are specifically targeted for community contributions.

Getting Help

Ask JUnit 5 related questions on StackOverflow or chat with the team and the community on Gitter.

Continuous Integration Builds

CI Server OS Status Description
Travis CI Linux, macOS Travis CI build status Official CI build server for JUnit 5. Used to perform quick checks on submitted pull requests and for build matrices including the latest released OpenJDK and early access builds of the next OpenJDK
AppVeyor Windows Build status Used to ensure that JUnit 5 can be built on Windows

Code Coverage

Code coverage using JaCoCo for the latest build is available on Codecov.

A code coverage report can also be generated locally via the Gradle Wrapper by executing gradlew -PenableJaCoCo clean jacocoRootReport. The results will be available in build/reports/jacoco/jacocoRootReport/html/index.html.

Gradle Build Scans

JUnit 5 utilizes Gradle's support for Build Scans. An example build scan for JUnit 5 can be viewed here.

Building from Source

You need JDK-10 to build JUnit 5.

All modules can be built with the Gradle Wrapper using the following command.

gradlew clean assemble

All modules can be tested with the Gradle Wrapper using the following command.

gradlew clean test

Since Gradle has excellent incremental build support, you can usually omit executing the clean task.

Installing in Local Maven Repository

All modules can be installed with the Gradle Wrapper in a local Maven repository for consumption in other projects via the following command.

gradlew clean publishToMavenLocal

Dependency Metadata

The following sections list the dependency metadata for the JUnit Platform, JUnit Jupiter, and JUnit Vintage.

See also http://repo1.maven.org/maven2/org/junit/ for releases and https://oss.sonatype.org/content/repositories/snapshots/org/junit/ for snapshots.

JUnit Platform

  • Group ID: org.junit.platform
  • Version: 1.3.1 or 1.4.0-SNAPSHOT
  • Artifact IDs and Automatic-Module-Name:
    • junit-platform-commons (org.junit.platform.commons)
    • junit-platform-console (org.junit.platform.console)
    • junit-platform-console-standalone (N/A)
    • junit-platform-engine (org.junit.platform.engine)
    • junit-platform-launcher (org.junit.platform.launcher)
    • junit-platform-runner (org.junit.platform.runner)
    • junit-platform-suite-api (org.junit.platform.suite.api)
    • junit-platform-testkit (org.junit.platform.testkit)

JUnit Jupiter

  • Group ID: org.junit.jupiter
  • Version: 5.3.1 or 5.4.0-SNAPSHOT
  • Artifact IDs and Automatic-Module-Name:
    • junit-jupiter-api (org.junit.jupiter.api)
    • junit-jupiter-engine (org.junit.jupiter.engine)
    • junit-jupiter-migrationsupport (org.junit.jupiter.migrationsupport)
    • junit-jupiter-params (org.junit.jupiter.params)

JUnit Vintage

  • Group ID: org.junit.vintage
  • Version: 5.3.1 or 5.4.0-SNAPSHOT
  • Artifact ID and Automatic-Module-Name:
    • junit-vintage-engine (org.junit.vintage.engine)

Bill of Materials (BOM)

  • Group ID: org.junit
  • Artifact ID junit-bom
  • Version: 5.3.1 or 5.4.0-SNAPSHOT

Java Module Names

All published JAR artifacts contain an Automatic-Module-Name manifest attribute whose value is used as the name of the automatic module defined by that JAR file when it is placed on the module path. The names are listed above in the Dependency Metadata section.

This allows test module authors to require well-known JUnit module names as can be seen in the following example:

open module foo.bar {
  requires org.junit.jupiter.api;
  requires org.junit.platform.commons;
  requires org.opentest4j;
}

The junit-platform-console-standalone JAR does not provide an automatic module name as it is not intended to be used as a module.