AVD-Gradle-Plugin

Gradle plugin to assist in managing android virtual devices.

Usage

Installation

In the appropriate build.gradle file(s):

1. Add the jitpack maven repository and classpath dependency

buildscript {
    repositories {
        maven { url "https://jitpack.io" }
    }
    dependencies {
        classpath "com.github.trevjonez:AVD-Gradle-Plugin:0.5.0"
    }
}

2. Apply the plugin

apply plugin: 'AVD'

3. Configure your AVDs to create via the DSL options

/* 
 * Simple configuration example 
 */
AVD {
    acceptAndroidSdkLicense true
    acceptAndroidSdkPreviewLicense true
    acceptHaxmLicense true

    configs {
        'Nexus 5X API 28' {
            avd {
                abi 'x86'
                api 28
                type 'google_apis'
                deviceId 'Nexus 5X'
            }
        }
    }
}

/* 
 * Full DSL Options 
 */
AVD {
    //By default the install task(s) up to date check will run `sdkmanager` to see if an update is available
    //If disabled this will only check if the system image dir is present
    autoUpdate false //default true (optional)
    
    acceptAndroidSdkLicense true //default false (required)
    acceptAndroidSdkPreviewLicense true //default false (required)
    acceptHaxmLicense true //default false (by context)
    
    //Note: if any proxy settings are specified all must be present
    proxyType "http" //default null (optional)
    proxyHost "localhost" //default null (optional)
    proxyPort 8080 //default null (optional)
    
    noHttps true //default false (optional)
    
    configs {
        tablet_25 {
            avd {
                abi "x86" | "x86_64" | "armeabi-v7a" | "arm64-v8a" //(default x86_64)
                api 28 //(default is from com.android.sdklib.SdkVersionInfo.HIGHEST_KNOWN_STABLE_API 26 as of AGP 3.1.4)
                type 'google_apis_playstore' | 'google_apis' | 'default' | 'android-wear' | 'android-tv' //(default google_apis)
                deviceId "pixel" //from `avdmanager list device`
                sdSize "1000M" //optional
                coreCount 2 //optional defaults to # of cores on machine
                configIniProperty("key", "value") //add or overwrite config.ini file property
            }
            launchOption("-wipe-data")
            launchOption("-memory", "2048") //varargs
            timeout 120 //default null (optional) in seconds
        }
    }
}

Tasks

• Install: installSystemImage_${api-level}_${type}_${abi} -> installSystemImage_api26_GoogleApis_x86
• Create: createAvd_${escapedAvdName} -> createAvd_tablet_25
• Start: startAvd_${escapedAvdName} -> startAvd_tablet_25
• Stop: stopAvd_${escapedAvdName} -> stopAvd_tablet_25

Notes on Compatibility

The plugin is developed against specific version of gradle and the android gradle plugin and sdk tools. In most cases using the latest version of gradle is safe but not guaranteed. Currently this has only been tested against osx hosts and should work on any unix machine as well. Highly likely that it won't work on windows. Open issues and lets talk if you need that.

AVD plugin version	Gradle version	Android plugin version
0.5.0	4.9	3.1.4
0.4.0	4.4.1	3.0.1

License

Copyright 2016 Trevor Jones

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.

Running plugin tests.

The happy path tests run in your real android sdk installation due to me being lazy about figuring out how to sandbox the emulator commands. Everything else is ran in temp directories and should not cause any mess to accumulate in the sdk dir of your machine.

Because the tests are mostly end to end and/or functional they do install SDK's and start stop emulators. This means that they will consume a great deal of download bandwidth and disk space. To combat the bandwidth issue and typically save tons of time waiting for large downloads I recommend running a squid proxy with the included config file so that sdkmanager is able to download from the squid cache. You can enable that behavior by creating a local.properties file in the plugin dir of this repo and adding the following options:

useProxy=true
proxyIp=192.168.0.50

This has proved to work well for me using the datadog/squid docker image.

docker create --name squid --publish 3128:3128/tcp --volume /home/tjones/avd-plugin/squid.conf:/etc/squid/squid.conf --volume /home/tjones/avd-plugin/squid/cache:/etc/squid/spool --net=host datadog/squid