/docker-android

Android in docker solution with noVNC supported and video recording

Primary LanguageShellOtherNOASSERTION

Analytics Join the chat at https://gitter.im/budtmo/docker-android Build Status codecov Codacy Badge GitHub release FOSSA Status Paypal Donate PRs Welcome

Docker-Android is a docker image built to be used for everything related to mobile website testing and Android project.

Emulator - Samsung Device Emulator - Nexus Device Real Device

Purposes

  1. Run UI tests for mobile websites with appium
  2. Build Android project and run unit tests with the latest build-tools
  3. Run UI tests for Android applications with different frameworks (appium, espresso, robotium, etc.)
  4. Run monkey / stress tests
  5. SMS testing

Advantages compare with other docker-android projects

  1. noVNC to see what happen inside docker container
  2. Emulator for different devices / skins, such as Samsung Galaxy S6, LG Nexus 4, HTC Nexus One and more.
  3. Ability to connect to Selenium Grid
  4. Ability to control emulator from outside container by using adb connect
  5. Support real devices with screen mirroring
  6. Ability to record video during test execution for debugging
  7. Integrated with other cloud solutions, e.g. Genymotion Cloud
  8. Open source with more features coming

List of Docker images

OS Android API Browser Browser version Chromedriver Image Size
Linux 5.0.1 21 browser 37.0 2.21 budtmo/docker-android-x86-5.0.1
Linux 5.1.1 22 browser 39.0 2.13 budtmo/docker-android-x86-5.1.1
Linux 6.0 23 browser 44.0 2.18 budtmo/docker-android-x86-6.0
Linux 7.0 24 chrome 51.0 2.23 budtmo/docker-android-x86-7.0
Linux 7.1.1 25 chrome 55.0 2.28 budtmo/docker-android-x86-7.1.1
Linux 8.0 26 chrome 58.0 2.31 budtmo/docker-android-x86-8.0
Linux 8.1 27 chrome 61.0 2.33 budtmo/docker-android-x86-8.1
Linux 9.0 28 chrome 66.0 2.40 budtmo/docker-android-x86-9.0
Linux 10.0 29 chrome 74.0 74.0.3729.6 budtmo/docker-android-x86-10.0
Linux 10.0tv 29 chrome 74.0 74.0.3729.6 budtmo/docker-android-x86-10.0tv
Linux 11.0 30 chrome 83.0 83.0.4103.39 budtmo/docker-android-x86-11.0
All - - - - - budtmo/docker-android-real-device
All All All All All All budtmo/docker-android-genymotion

List of Devices

Type Device Name
Phone Samsung Galaxy S10
Phone Samsung Galaxy S9
Phone Samsung Galaxy S8
Phone Samsung Galaxy S7 Edge
Phone Samsung Galaxy S7
Phone Samsung Galaxy S6
Phone Nexus 4
Phone Nexus 5
Phone Nexus One
Phone Nexus S
Tablet Nexus 7
TV tv_720p
TV tv_1080p

Requirements

Docker is installed in your system.

Quick Start

  1. Your machine need to support virtualization. To check it:

    sudo apt install cpu-checker
kvm-ok

  2. Run Docker-Android

    • For Linux OS, please use image name that contains "x86"

       docker run --privileged -d -p 6080:6080 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" --name android-container budtmo/docker-android-x86-8.1

    • For OSX and Windows OS, please use Virtual Machine that support Virtualization with Ubuntu OS

  3. Verify the ip address of docker host.

    • For OSX, you can find out by using following command:

      docker-machine ip default

    • For different OS, localhost should work.

  4. Open http://docker-host-ip-address:6080 from web browser. Note: Adding ?view_only=true will give user only view only permission.

Custom configurations

This document contains custom configurations of Docker-Android that you might need, e.g. Proxy, Changing language on fly, etc.

Build Android project

Docker-Android can be used for building Android project and executing its unit test. This following steps will illustrate how to build Android project:

  1. Clone this sample test project.

    git clone git@github.com:android/testing-samples.git

  2. Build the project

    docker run -it --rm -v $PWD/testing-samples/ui/espresso/BasicSample:/tmp -w /tmp budtmo/docker-android-x86-8.1 /tmp/gradlew build

Control Android connected to host (Emulator or Real Device)

  1. Create a docker container with this command

    $ docker run --privileged -d -p 6080:6080 -p 5554:5554 -p 5555:5555 -p 4723:4723 --name android-container-appium budtmo/docker-android-real-device

  2. Open noVNC http://localhost:6080

  3. Open terminal by clicking right on noVNC window >> Terminal emulator

  4. To connect to host's adb (make sure your host have adb and connected to the device.)

    $ adb -H host.docker.internal devices

    To specify port, just add -P port_number

    $ adb -H host.docker.internal -P 5037 devices

  5. Now your container can access your host devices. But, you need to add remoteAdbHost and adbPort desired capabilities to make Appium can recognise those devices.

Appium and Selenium Grid

If you want to use Appium and Selenium Grid, you can follow this document. It also contains sample and use cases.

Control android emulator outside container

adb connect <docker-machine-ip-address>:5555

Note: You need to have Android Debug Bridge (adb) installed in your host machine.

SMS Simulation

  1. Using telnet

    • Find the auth_token and copy it.
    docker exec -it android-container cat /root/.emulator_console_auth_token
    • Access emulator using telnet and login with auth_token
    telnet <docker-machine-ip-address> 5554
    • Login with given auth_token from 1.step
    auth <auth_token>
    • Send the sms
    sms send <phone_number> <message>

  2. Using adb

    docker exec -it android-container adb emu sms send <phone_number> <message>

  3. You can also integrate it inside project using adb library.

Google Play Services and Google Play Store

Not installed at this time.

Jenkins

This document gives you information about custom plugin that supports Docker-Android.

VMWARE

This document shows you how to configure Virtual Machine on VMWARE to be able to run Docker-Android.

Cloud

This document contains information about deploying Docker-Android on cloud services.

Genymotion

For you who do not have ressources to maintain the simulator or to buy machines or need different device profiles, you need to give a try to Genymotion Cloud. Docker-Android is integrated with Genymotion on different cloud services, e.g. Genymotion Cloud, AWS, GCP, Alibaba Cloud. Please follow this document or this blog for more detail.

Troubleshooting

All logs inside container are stored under folder /var/log/supervisor. you can print out log file by using docker exec. Example:

docker exec -it android-container tail -f /var/log/supervisor/docker-android.stdout.log

Emulator Skins

The Emulator skins are taken from Android Studio IDE and Samsung Developer Website

Security

All docker images are protected by Polyverse by scrambling the Linux packages. For more information please visit this link

Monitoring

You can use cadvisor combined with influxdb / prometheus and grafana if needed to monitor each running container.

Users

Docker-Android are being used by 100+ countries around the world.

ga-datastudio-docker-android

Stargazers over time

Stargazers over time

Special Thanks

LICENSE

See License

FOSSA Status