Need help with android-junit5?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

mannodermaus
516 Stars 30 Forks Apache License 2.0 335 Commits 12 Opened issues

Description

Testing with JUnit 5 for Android.

Services available

!
?

Need anything else?

Contributors list

No Data

android-junit5 CircleCI

Logo

A Gradle plugin that allows for the execution of JUnit 5 tests in Android environments using Android Gradle Plugin 3.5.0 or later.

How?

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.

Download

Kotlin
buildscript {
  dependencies {
    classpath("de.mannodermaus.gradle.plugins:android-junit5:1.6.2.0")
  }
}
Groovy
buildscript {
  dependencies {
    classpath "de.mannodermaus.gradle.plugins:android-junit5:1.6.2.0"
  }
}


Snapshots of the development version are available through Sonatype's

snapshots
repository.

Setup

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.7.0")
  testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0")

  // (Optional) If you need "Parameterized Tests"
  testImplementation("org.junit.jupiter:junit-jupiter-params:5.7.0")

  // (Optional) If you also have JUnit 4-based tests
  testImplementation("junit:junit:4.13")
  testRuntimeOnly("org.junit.vintage:junit-vintage-engine:5.7.0")
}
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.7.0"
  testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.7.0"

  // (Optional) If you need "Parameterized Tests"
  testImplementation "org.junit.jupiter:junit-jupiter-params:5.7.0"

  // (Optional) If you also have JUnit 4-based tests
  testImplementation "junit:junit:4.13"
  testRuntimeOnly "org.junit.vintage:junit-vintage-engine:5.7.0"
}


More information on Getting Started can be found on the wiki.

Requirements

The latest version of this plugin requires: * Android Gradle Plugin

3.5.0
or above * Gradle
6.1.1
or above

Instrumentation Test Support

There is experimental support for Android instrumentation tests, which requires some additional configuration & dependencies. Furthermore, because JUnit 5 is built on Java 8 from the ground up, its instrumentation tests will only run on devices running Android 8.0 (API 26) or newer. Older phones will skip the execution of these tests completely, marking them as "ignored".

To start writing instrumentation tests with JUnit Jupiter, make the following changes to your module's build script:

Kotlin
android {
  defaultConfig {
    // 1) Make sure to use the AndroidJUnitRunner, or a subclass of it. This requires a dependency on androidx.test:runner, too!
    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*")
  }
}
dependencies {
  // 5) Jupiter API & Test Runner, if you don't have it already
  androidTestImplementation("androidx.test:runner:1.2.0")
  androidTestImplementation("org.junit.jupiter:junit-jupiter-api:5.7.0")

  // 6) The instrumentation test companion libraries
  androidTestImplementation("de.mannodermaus.junit5:android-test-core:1.2.0")
  androidTestRuntimeOnly("de.mannodermaus.junit5:android-test-runner:1.2.0")
}
Groovy
android {
  defaultConfig {
    // 1) Make sure to use the AndroidJUnitRunner, or a subclass of it. This requires a dependency on androidx.test:runner, too!
    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*"
  }
}

dependencies {
  // 5) Jupiter API & Test Runner, if you don't have it already
  androidTestImplementation "androidx.test:runner:1.2.0"
  androidTestImplementation "org.junit.jupiter:junit-jupiter-api:5.7.0"

  // 6) The instrumentation test companion libraries
  androidTestImplementation "de.mannodermaus.junit5:android-test-core:1.2.0"
  androidTestRuntimeOnly "de.mannodermaus.junit5:android-test-runner:1.2.0"
}

The

android-test-core
artifact includes an extension point for the
ActivityScenario
API; more information on that can be found in the wiki.

Official Support

At this time, 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:

Building Locally

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.

License

Copyright 2017-2020 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.