Skip to content

Latest commit

 

History

History
154 lines (114 loc) · 6.39 KB

README.md

File metadata and controls

154 lines (114 loc) · 6.39 KB
Raw

JUnit 5

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

JUnit 5.0.3 was released on January 15, 2018; JUnit 5.1.0-M2 on January 28, 2018.

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
Jenkins Linux Build Status Official CI build server for JUnit 5
Travis CI Linux Travis CI build status Used to perform quick checks on submitted pull requests and for build matrices including JDK 8 and JDK 9 early access builds
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 the Jenkins CI server and on Codecov.

A code coverage report can also be generated locally by executing gradlew -PenableJaCoCo clean jacocoRootReport. The results will be available in build/reports/jacoco/jacocoRootReport/html/index.html. Alternatively, OpenClover can be used locally via gradlew -PenableClover clean cloverHtmlReport. The results will be available in build/reports/clover/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. Note, however, that the number of listed tests only reflects the Spock tests within the JUnit 5 test suite. To see a full representation of the number of tests executed per project, click on "See console output" on the build scan page.

Building from Source

You need JDK-9 or higher to build JUnit 5. All modules can be built with Gradle using the following command.

gradlew clean assemble

All modules can be tested with Gradle 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 in a local Maven repository for consumption in other projects via the following command.

gradlew clean install

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.0.3 or 1.1.0-M2 or 1.1.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-gradle-plugin (org.junit.platform.gradle.plugin)
    • 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-surefire-provider (org.junit.platform.surefire.provider)

JUnit Jupiter

  • Group ID: org.junit.jupiter
  • Version: 5.0.3 or 5.1.0-M2 or 5.1.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: 4.12.3 or 5.1.0-M2 or 5.1.0-SNAPSHOT
  • Artifact ID and Automatic-Module-Name:
    • junit-vintage-engine (org.junit.vintage.engine)

Java 9 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 Java 9 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.