Docker Android Build Box

Introduction

A docker image build with Android build environment.

What Is Inside

It includes the following components:

• Ubuntu 17.10
• Android SDK 16 17 18 19 20 21 22 23 24 25 26 27 28
• Android build tools 17.0.0 18.1.1 19.1.0 20.0.0 21.1.2 22.0.1 23.0.1 23.0.2 23.0.3 24.0.0 24.0.1 24.0.2 24.0.3 25.0.0 25.0.1 25.0.2 25.0.3 26.0.0 26.0.1 26.0.2 27.0.1 27.0.2 27.0.3 28.0.1 28.0.2 28.0.3
• Android NDK r18b
• extra-android-m2repository
• extra-google-m2repository
• extra-google-google_play_services
• Google API add-ons
• Android Emulator
• Constraint Layout
• TestNG
• Python 2, Python 3
• Node.js, npm, React Native
• Ruby, RubyGems
• fastlane
• Kotlin 1.3

Docker Pull

The docker image is publicly automated build on Docker Hub based on the Dockerfile in this repo, so there is no hidden stuff in it. To pull the latest docker image:

docker pull mingc/android-build-box:latest

Hint: Use tag to sepecific a stable version rather than latest of docker image to avoid break your buid. e.g. mingc/android-build-box:v1.2.0. Checkout RELEASES.md to see all the available tags.

Usage

Use the image to build an Android project

You can use this docker image to build your Android project with a single docker command:

cd <android project directory>  # change working directory to your project root directory.
docker run --rm -v `pwd`:/project mingc/android-build-box bash -c 'cd /project; ./gradlew build'

Run docker image with interactive bash shell:

docker run -v `pwd`:/project -it mingc/android-build-box bash

Use the image for a Bitbucket pipeline

If you have an Android project in a Bitbucket repository and want to use its pipeline to build it, you can simply specify this docker image. Here is an example of bitbucket-pipelines.yml

image: mingc/android-build-box:latest

pipelines:
  default:
    - step:
        caches:
          - gradle
          - gradlewrapper
          - androidavd
        script:
          - bash ./gradlew assemble
definitions:
  caches:
    gradlewrapper: ~/.gradle/wrapper
    androidavd: $ANDROID_HOME/.android/avd

The caches are used to store downloaded dependencies from previous builds, to speed up the next builds.

Run an Android emulator in the Docker build machine

Using guidelines from https://medium.com/@AndreSand/android-emulator-on-docker-container-f20c49b129ef and https://spin.atomicobject.com/2016/03/10/android-test-script/ and https://paulemtz.blogspot.com/2013/05/android-testing-in-headless-emulator.html , you can use a script to create and launch an ARM emulator, which can be used for running integration tests or instrumentation tests or unit tests:

#!/bin/bash

# Add missing folder to the PATH, to use sdkmanager and avdmanager
ANDROID_TOOLS=$ANDROID_HOME/tools/bin
PATH=$ANDROID_TOOLS:$PATH

# Download an ARM system image to create an ARM emulator.
sdkmanager "system-images;android-16;default;armeabi-v7a"

# Create an ARM AVD emulator, with a 100 MB SD card storage space. Echo "no"
# because it will ask if you want to use a custom hardware profile, and you don't.
# https://medium.com/@AndreSand/android-emulator-on-docker-container-f20c49b129ef
echo "no" | avdmanager create avd \
    -n Android_4.1_API_16 \
    -k "system-images;android-16;default;armeabi-v7a" \
    -c 100M \
    --force

# Launch the emulator in the background
$ANDROID_HOME/emulator/emulator -avd Android_4.1_API_16 -no-skin -no-audio -no-window -no-boot-anim -gpu off &

Note that x86_64 emulators are not currently supported. See Issue #18 for details.

Docker Build Image

If you want to build the docker image by yourself, you can use following command. The image itself is more than 5 GB, check your free disk space before building it.

docker build -t android-build-box .

Contribution

If you want to enhance this docker image or fix something, feel free to send pull request.

References

• Dockerfile reference
• Best practices for writing Dockerfiles
• Build your own image
• uber android build environment
• Refactoring a Dockerfile for image size