A Gradle plugin that allows for the execution of JUnit 5 tests in Android environments using Android Gradle Plugin 3.2.0 or later.
This plugin configures the unit test tasks for each build variant of a project to run on the JUnit Platform. Furthermore, it provides additional configuration options for these tests through a DSL attached to android.testOptions.
Instructions on how to write JUnit 5 tests can be found in their User Guide. Furthermore, this repository provides a small showcase of the functionality provided by JUnit 5 here.
Groovy
buildscript {
dependencies {
classpath "de.mannodermaus.gradle.plugins:android-junit5:1.4.0.0"
}
}Kotlin
buildscript {
dependencies {
classpath("de.mannodermaus.gradle.plugins:android-junit5:1.4.0.0")
}
}Snapshots of the development version are available through Sonatype's snapshots repository.
Groovy
apply plugin: "de.mannodermaus.android-junit5"
dependencies {
// (Required) Writing and executing Unit Tests on the JUnit Platform
testImplementation "org.junit.jupiter:junit-jupiter-api:5.4.0"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.4.0"
// (Optional) If you need "Parameterized Tests"
testImplementation "org.junit.jupiter:junit-jupiter-params:5.4.0"
// (Optional) If you also have JUnit 4-based tests
testImplementation "junit:junit:4.12"
testRuntimeOnly "org.junit.vintage:junit-vintage-engine:5.4.0"
}Kotlin
plugins {
id("de.mannodermaus.android-junit5")
}
dependencies {
// (Required) Writing and executing Unit Tests on the JUnit Platform
testImplementation("org.junit.jupiter:junit-jupiter-api:5.4.0")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.4.0")
// (Optional) If you need "Parameterized Tests"
testImplementation("org.junit.jupiter:junit-jupiter-params:5.4.0")
// (Optional) If you also have JUnit 4-based tests
testImplementation("junit:junit:4.12")
testRuntimeOnly("org.junit.vintage:junit-vintage-engine:5.4.0")
}More information on Getting Started can be found on the wiki.
The latest version of this plugin requires:
- Android Gradle Plugin
3.2.0or above - Gradle
4.7or above
There is experimental support for Android instrumentation tests, which requires some additional configuration & dependencies. Note that since JUnit 5 is built on Java 8 from the ground up, these libraries require you to have a minSdkVersion of at least 26. It's recommended to use a product flavor for experimentation if you want to keep your global requirements below 26. Check the sample for how this can be done!
To start writing instrumentation tests with JUnit Jupiter, add the following to your module's build script:
Groovy
android {
defaultConfig {
// 1) Make sure to use the AndroidJUnitRunner, of a subclass of it
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
// 2) Connect JUnit 5 to the runner
testInstrumentationRunnerArgument "runnerBuilder", "de.mannodermaus.junit5.AndroidJUnit5Builder"
}
// 3) Java 8 is required
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
// 4) JUnit 5 will bundle in files with identical paths; exclude them
packagingOptions {
exclude "META-INF/LICENSE.md"
exclude "META-INF/LICENSE-notice.md"
}
}
dependencies {
// 5) Jupiter API & Platform runner
androidTestImplementation "org.junit.jupiter:junit-jupiter-api:5.4.0"
androidTestRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.4.0"
androidTestRuntimeOnly "org.junit.platform:junit-platform-runner:1.4.0"
// 6) The instrumentation test companion libraries
androidTestImplementation "de.mannodermaus.junit5:android-instrumentation-test:0.2.2"
androidTestRuntimeOnly "de.mannodermaus.junit5:android-instrumentation-test-runner:0.2.2"
}Kotlin
android {
defaultConfig {
// 1) Make sure to use the AndroidJUnitRunner, of a subclass of it
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
// 2) Connect JUnit 5 to the runner
testInstrumentationRunnerArgument("runnerBuilder", "de.mannodermaus.junit5.AndroidJUnit5Builder")
}
// 3) Java 8 is required
compileOptions {
setSourceCompatibility(JavaVersion.VERSION_1_8)
setTargetCompatibility(JavaVersion.VERSION_1_8)
}
// 4) JUnit 5 will bundle in files with identical paths; exclude them
packagingOptions {
exclude("META-INF/LICENSE.md")
exclude("META-INF/LICENSE-notice.md")
}
}
dependencies {
// 5) Jupiter API & Platform runner
androidTestImplementation("org.junit.jupiter:junit-jupiter-api:5.4.0")
androidTestRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.4.0")
androidTestRuntimeOnly("org.junit.platform:junit-platform-runner:1.4.0")
// 6) The instrumentation test companion libraries
androidTestImplementation("de.mannodermaus.junit5:android-instrumentation-test:0.2.2")
androidTestRuntimeOnly("de.mannodermaus.junit5:android-instrumentation-test-runner:0.2.2")
}The instrumentation test library also provides a replacement for ActivityTestRule; more information on that can be found in the wiki.
Since the move to utilize the native JUnit 5 support built into the build system, a lot has changed from the previous version of the plugin. Users seeking to migrate to the new version are encouraged to check out the migration guide located on the wiki.
Currently, Google hasn't shared any immediate plans to bring first-party support for JUnit 5 to Android. The following list is an aggregation of pending feature requests:
- InstantTaskExecutorRule uses @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) -- why? (issuetracker.google.com)
- Add support for JUnit 5 (issuetracker.google.com)
- JUnit 5 support (github.com/android/android-test)
This repository contains multiple modules, divided into two sub-projects. The repository's root directory contains build logic shared across the sub-projects, which in turn use symlinks to connect to the common build scripts in their parent folder.
instrumentation: The root folder for Android-based modules, namely the instrumentation libraries & a sample application. After cloning, open this project in Android Studio.plugin: The root folder for Java-based modules, namely the Gradle plugin for JUnit 5 on Android, as well as its test module. After cloning, open this project in IntelliJ IDEA.
Copyright 2017-2019 Marcel Schnelle
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
See also the full License text.