Android Unmock Gradle Plugin
Purpose
This is a super simple plugin to be used in combination with the new unit testing feature of the Gradle Plugin / Android Studio. ( http://tools.android.com/tech-docs/unit-testing-support )
It tries to solve the problem that you have to mock each and every Android SDK class (even SparseArray, TextUtils etc.) by allowing you to use selected classes from a real Android-Jarfile.
How to use
Available on jcenter:
Add the plugin to your buildscript dependencies and make sure to use the jcenter repository:
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'de.mobilej.unmock:UnMockPlugin:0.6.4'
}
}
And this to the module's build script:
apply plugin: 'de.mobilej.unmock'Additionally you have to configure which classes to use and where to get the real Android.jar from. e.g:
unMock {
keep "android.widget.BaseAdapter"
keep "android.widget.ArrayAdapter"
keep "android.os.Bundle"
keepStartingWith "android.database.MatrixCursor"
keep "android.database.AbstractCursor"
keep "android.database.CrossProcessCursor"
keepStartingWith "android.text.TextUtils"
keepStartingWith "android.util."
keepStartingWith "android.text."
keepStartingWith "android.content.ContentValues"
keepStartingWith "android.content.ComponentName"
keepStartingWith "android.content.ContentUris"
keepStartingWith "android.content.ContentProviderOperation"
keepStartingWith "android.content.ContentProviderResult"
keepStartingWith "android.content.UriMatcher"
keepStartingWith "android.content.Intent"
keep "android.location.Location"
keepStartingWith "android.content.res.Configuration"
keepStartingWith "org."
keepStartingWith "libcore."
keepStartingWith "com.android.internal.R"
keepStartingWith "com.android.internal.util."
keep "android.net.Uri"
keepAndRename "java.nio.charset.Charsets" to "xjava.nio.charset.Charsets"
}
dependencies {
// dependency to android-all to use
unmock 'org.robolectric:android-all:4.3_r2-robolectric-0'
}
| Statement | Description |
|---|---|
| downloadFrom | here you configure the url to download the android-all.jar from, optionally you can specify a directory to download the file to (e.g. to <mydirectory>) - the default is the tmpdir, DEPRECATED as of 0.6.0: create a unmock dependency |
| keep | keeps the specified class (and it's possibly present inner classes) |
| keepStartingWith | keeps every class which FQN starts with the given string |
| keepAndRename | let you keep a class while renaming it (e.g. needed for classes in the "java" top-level package since these are only allowed to be loaded from the boot classpath) |
| delegateClass | every method (and constructor) in the given class is delegated to de.mobilej.ABridge. Makes it easier to mock things in a framework class you inherit from |
That's it!
Have a look at the example contained in this repository for more details.
Starting from version 0.3.5 you can leave out the configuration closure which will result using defaults (which are shown in the example above).
downloadFrom is now optional. If not given it will use ' https://oss.sonatype.org/content/groups/public/org/robolectric/android-all/4.3_r2-robolectric-0/android-all-4.3_r2-robolectric-0.jar'
If you use any of the keep statements the default configuration will be cleared. (So your own configuration is not adding but replaces the default).
By default the android-all file is downloaded to the system's temporary folder. Some systems purge the temp folder on reboot. In most cases this should be no issue but on unreliable or slow internet conections this might be inconvenient. In that case you could download the android-all file yourself and specify a file:///<path>/<file> url or you can specify a directory to place the downloaded file by specifying to after the url in downloadFrom, e.g.
downloadFrom 'https://oss.sonatype.org/content/groups/public/org/robolectric/android-all/4.3_r2-robolectric-0/android-all-4.3_r2-robolectric-0.jar' to '/yourdirectory_to_download_to'
As of 0.6.0 you should prefer to use a dependency for the android-all.jar
Versions
| Version | Description |
|---|---|
| 0.1.0 | initial public release |
| 0.1.1 | added the '-' matching |
| 0.1.2 | fixed a bug preventing the plugin to work correctly on Windows systems |
| 0.1.3 | the binary is targeting Java 1.7, again |
| 0.2.0 | support class renaming, rebuild jar if build file changed |
| 0.3.0 | use Gradle way of upToDate check, have a DSL for the configuration |
| 0.3.1 | compile with Gradle 2.4 |
| 0.3.2 | lib-sample and some bugfixes (frozen class problem) |
| 0.3.3 | Android Gradle Plugin 1.3.0 compatibility |
| 0.3.5 | Use default config if no configuration closure is given |
| 0.3.6 | Optionally you can specify a directory to download the all-android.jar to |
| 0.4.0 | Support for "delegateClass" added |
| 0.5.0 | ABridge now includes callByte, callDouble and callFloat, this might break tests that rely on ABrdige.callObject to be called in these cases |
| 0.5.1 | Unique names for unmocked-android.jar to workaround an Android Studio problem |
| 0.6.0 | Use Gradle's dependency management to get the android-all.jar, more magic to workaround issues using unmocked Android-6.0+ classes |
| 0.6.1 | Make it work with Gradle 4.0-milestone and Android Gradle plugin to 3.0.0.-alpha1 while keep it working on previous versions |
| 0.6.2 | Make it work with activated Kotlin plugin |
| 0.6.3 | Make it possible to use Gradle 4 with Android Gradle plugin < 3.0 |
| 0.6.4 | Works with kapt3 |
License
Copyright 2015 Björn Quentin 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.