This is a fork of @JakeWharton's plugin. Updates gradle versions and allows for running junit tests in IDEA.

Gradle Android Unit Testing Plugin

A Gradle plugin which enables good 'ol fashioned unit tests for Android builds.

This plugin is primarily focused on enabling Robolectric tests using gradle. The Android framework is not built with unit testing in mind. As such, the canonical framework to facilitate unit testing on the JVM is Robolectric.

Compatibility

Currently known to work with Gradle 1.10, Android Gradle Plugin 0.9.x, Android Studio 0.5.1, and IntelliJ IDEA 13.

Getting Started

If you are starting a new app, or want to try this plugin in the simplest possible environment, the easiest way to start is to use deckard-gradle.

deckard-gradle illustrates how to run Robolectric and Espresso tests in Intellij, Android Studio or the command-line.

Basic Usage for JUnit / Robolectric

Add the plugin to your buildscript's dependencies section:

classpath 'org.robolectric.gradle:gradle-android-test-plugin:0.9.+'

Apply the android-test plugin:

apply plugin: 'android-test'

Add test-only dependencies using the androidTestCompile configuration:

androidTestCompile 'junit:junit:4.10'
androidTestCompile 'org.robolectric:robolectric:2.1.+'
androidTestCompile 'com.squareup:fest-android:1.0.+'

Write your tests in src/test/java/! You can also add per-build type and per-flavor tests by using the same folder naming conventions (e.g., src/testPaid/java/, src/testDebug/java/).

Run your tests by calling gradle clean test.

Configuration using DSL

androidTest {
    // configure the set of classes for JUnit tests
    include '**/*Test.class'
    exclude '**/espresso/**/*.class'

    // configure max heap size of the test JVM
    maxHeapSize = "2048m"
}

Importing into your IDE (IntelliJ or Android Studio)

In a nutshell, you should be able to import into these IDEs (and continuously sync when you change your build.gradle).

It bears repeating, though: if you see the dreaded Stub! exception:

!!! JUnit version 3.8 or later expected:

java.lang.RuntimeException: Stub!
at junit.runner.BaseTestRunner.<init>(BaseTestRunner.java:5)
at junit.textui.TestRunner.<init>(TestRunner.java:54)
at junit.textui.TestRunner.<init>(TestRunner.java:48)
at junit.textui.TestRunner.<init>(TestRunner.java:41)

...you will have to hand-edit your dependencies (in the IDE for IntelliJ, or hand-editing your IML file in Studio). See deckard-gradle for details.

Robolectric 2.2 or earlier

Version 2.3 of Robolectric will support this plugin out of the box (see here). Until then, you can use the following test runner:

import org.junit.runners.model.InitializationError;
import org.robolectric.AndroidManifest;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.annotation.Config;
import org.robolectric.res.Fs;

public class RobolectricGradleTestRunner extends RobolectricTestRunner {
 public RobolectricGradleTestRunner(Class<?> testClass) throws InitializationError {
   super(testClass);
 }

 @Override protected AndroidManifest getAppManifest(Config config) {
   String manifestProperty = System.getProperty("android.manifest");
   if (config.manifest().equals(Config.DEFAULT) && manifestProperty != null) {
     String resProperty = System.getProperty("android.resources");
     String assetsProperty = System.getProperty("android.assets");
     return new AndroidManifest(Fs.fileFromPath(manifestProperty), Fs.fileFromPath(resProperty),
         Fs.fileFromPath(assetsProperty));
   }
   return super.getAppManifest(config);
 }
}

Just annotate your test classes with @RunWith(RobolectricGradleTestRunner.class) or subclass this test runner if you have other customizations.

Plugin Development

The example/ dir contains a project which covers a few configurations for the plugin to work with.

1. Run ./gradlew install in the root. This will build the plugin and install it into a local Maven repository.
2. In the example/ folder, run ../gradlew clean check to build and run the unit tests.
3. Open example/build/test-report/index.html in the browser.

Debugging

You can run the plugin in the debugger, but it takes some setup.

1. Execute this at the root of your project:

   GRADLE_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5006" ./gradlew test --no-daemon -Dorg.gradle.debug=true
   

2. Point a remote debugger to port 5006. In Intellij set up 'Remote' Debug configuration and set the port (actual port can be changed)
3. In IntelliJ, to break at breakpoints inside of our plugin or other gradle code you will need to put the appropriate JARs on your classpath, and then attach the source. It's a bit of a hack but it is possible in IntelliJ, anyway :).

Releasing (Mac OSX specific)

0. Make sure Travis is passing and the version in build.gradle is bumped

1. Install GPG; homebrew works: 'brew install gpg'

2. Create or retrieve GPG keypair; see the sonatype docs for more info on how to use GPG for signing.

3. Check your GPG install works by typing 'gpg --list-keys'. You should see something like this:

   /Users/pivotal/.gnupg/pubring.gpg
   ---------------------------------
   pub   4096R/FAE67CFD 2013-08-30 [expires: 2018-08-29]
   uid                  Pivotal Robolectric (Mike and Corey) <android-developers@pivotallabs.com>
   sub   4096R/87EAC09D 2013-08-30 [expires: 2018-08-29]

4. Set up passwords and other stuff in ~/.gradle/gradle.properties:

      nexusUsername=<e.g. 'pivotal'>
      nexusPassword=<your nexus password>
      signing.keyId=<id matching above output of gpg --list-keys>
      signing.password=<gpg private key passphrase>
      signing.secretKeyRingFile=<home directory>/.gnupg/secring.gpg
   

5. Run ./gradlew uploadArchives When successful, the artifact will be in a staging repository on oss.sonatype.org.

6. Promote the artifact on Sonatype

7. Go to http://oss.sonatype.org and login.

8. Find the staging repository by clicking (on the left) on 'Staging Repositories' under 'Build Promotion'. The newly pushed artifact should be the last item on the list.

9. On the toolbar up top, press 'close'. This operation will take a while so you may need to refresh, but eventually the staging repository will be "closed" - look under the 'activity' tab when you've got it selected and you should see the various steps of the closing process

10. Once closed, you can press 'Release' in the toolbar. Again this will take some time, but when it's done there will no longer be an entry in the 'staging repositories' section. You can find the newly published artifact by browsing the normal repository.

11. Wait. It will take some time before it appears on Maven Central - usually a few hours but less than a day.

Future Directions

• Change use of 'androidTestCompile' to 'testCompile' - more like standard Java plugin
• Pull in bits of SuperJugy's plugin, especially the single-test command-line support && better code structure
• Maybe disappear if we can get the Android Tools team to support JUnit out of the box

License

Copyright 2013 Square, Inc.
          2014 Pivotal Labs

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.