isabella232 / junit5

✅ The 5th major version of the programmer-friendly testing framework for Java and the JVM

JUnit 5

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

Latest Releases

• General Availability (GA): JUnit 5.8.2 (November 28, 2021)
• Preview (Milestone/Release Candidate): n/a

Documentation

• User Guide
• Javadoc
• Release Notes
• Samples

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 community on Gitter.

Continuous Integration Builds

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.

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 Enterprise

JUnit 5 utilizes Gradle Enterprise for Build Scans, Build Cache, and Test Distribution.

The latest Build Scans are available on ge.junit.org. Currently, only core team members can publish Build Scans and use Test Distribution on that server. You can, however, publish a Build Scan to scans.gradle.com by using the --scan parameter explicitly.

The remote Build Cache is enabled by default for everyone so that local builds can reuse task outputs from previous CI builds.

Building from Source

You need JDK 17 to build JUnit 5. Gradle toolchains are used to detect and potentially download additional JDKs for compilation and test execution.

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

Consult the Dependency Metadata section of the User Guide for a list of all artifacts of the JUnit Platform, JUnit Jupiter, and JUnit Vintage.

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