diff --git a/README.md b/README.md index 8f241a9..196484b 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ Emulator - Samsung Device | Emulator - Nexus Device | Real Device :---------------------------:|:---------------------------:|:---------------------------: ![][emulator samsung] |![][emulator nexus] |![][real device] -Purpose -------- +Purposes +-------- 1. Run UI tests for mobile websites with [appium] 2. Build Android project and run unit tests with the latest build-tools @@ -35,7 +35,8 @@ Advantages compare with other docker-android projects 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. Open source with more features coming +7. Integrated with other cloud solutions, e.g. [Genymotion Cloud](https://www.genymotion.com/cloud/) +8. Open source with more features coming List of Docker images --------------------- @@ -72,7 +73,7 @@ Docker is installed in your system. Quick Start ----------- -1. Run docker-android +1. Run Docker-Android - For ***Linux OS***, please use image name that contains "x86" @@ -95,142 +96,32 @@ Quick Start 3. Open ***http://docker-host-ip-address:6080*** from web browser. -Run Appium Server ------------------ +Custom configurations +--------------------- -Appium is automation test framework to test mobile website and mobile application, including android. To be able to use appium, you need to run appium-server. You run appium server inside docker-android container by ***opening port 4723*** and ***passing an environment variable APPIUM=true***. - -```bash -docker run --privileged -d -p 6080:6080 -p 5554:5554 -p 5555:5555 -p 4723:4723 -e DEVICE="Samsung Galaxy S6" -e APPIUM=true --name android-container butomo1989/docker-android-x86-8.1 -``` - -### Connect to Selenium Grid - -It is also possible to connect appium server that run inside docker-android with selenium grid by passing following environment variables: - -- CONNECT\_TO\_GRID=true -- APPIUM_HOST="\" -- APPIUM_PORT=\ -- SELENIUM_HOST="\" -- SELENIUM_PORT=\ - -To run tests for mobile browser, following parameter can be passed: - -- MOBILE\_WEB\_TEST=true - -```bash -docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" -e APPIUM=true -e CONNECT_TO_GRID=true -e APPIUM_HOST="127.0.0.1" -e APPIUM_PORT=4723 -e SELENIUM_HOST="172.17.0.1" -e SELENIUM_PORT=4444 -e MOBILE_WEB_TEST=true --name android-container butomo1989/docker-android-x86-8.1 -``` -### Custom Emulator Arguments - -If you want to add more arguments for running emulator, you can ***pass an evnironemnt variable EMULATOR_ARGS*** while running docker command. - -```bash -docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" -e EMULATOR_ARGS="-no-snapshot-load -partition-size 512" -e APPIUM=true -e CONNECT_TO_GRID=true -e APPIUM_HOST="127.0.0.1" -e APPIUM_PORT=4723 -e SELENIUM_HOST="172.17.0.1" -e SELENIUM_PORT=4444 -e MOBILE_WEB_TEST=true --name android-container butomo1989/docker-android-x86-8.1 -``` - -### Back & Restore -If you want to backup/reuse the avds created with furture upgrades or for replication, run the container with two extra mounts - -- -v local_backup/.android:/root/.android -- -v local_backup/android_emulator:/root/android_emulator - -```bash -docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -v local_backup/.android:/root/.android -v local_backup/android_emulator:local_backup/android_emulator -e DEVICE="Nexus 5" -e APPIUM=true -e CONNECT_TO_GRID=true -e APPIUM_HOST="127.0.0.1" -e APPIUM_PORT=4723 -e SELENIUM_HOST="172.17.0.1" -e SELENIUM_PORT=4444 --name android-container butomo1989/docker-android-x86-8.1 -``` -For the first run, this will create a new avd and all the changes will be accessible in the `local_backup` directory. - -Now for all future runs, it will reuse the avds. Even this should work with new releases of `docker-android` - - -### Share Volume - -If you want to use appium to test UI of your android application, you need to share volume where the APK is located to folder ***/root/tmp***. - -```bash -docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -v $PWD/example/sample_apk:/root/tmp -e DEVICE="Nexus 5" -e APPIUM=true -e CONNECT_TO_GRID=true -e APPIUM_HOST="127.0.0.1" -e APPIUM_PORT=4723 -e SELENIUM_HOST="172.17.0.1" -e SELENIUM_PORT=4444 --name android-container butomo1989/docker-android-x86-8.1 -``` - -### Video Recording - -You can deactivate auto_record by changing the value to "False" in docker-compose file. e.g. change value to "False" in this [line]. - -### Language - -You can change the language setting of Android Emulator on the fly by passing following environment variable: - -- LANGUAGE="\" -- COUNTRY="\" - -### Docker-Compose - -![][compose] - -There is [example of compose file] to run complete selenium grid and docker-android container as nodes. [docker-compose] version [1.13.0] or higher is required to be able to execute that compose file. - -```bash -docker-compose up -d -``` - -### Google Play Services and Google Play Store - -The Docker "Android Emulator" images contain Google Play Service (v12.8.74) and Google Play Store (v11.0.50). Both applications are downloaded from [apklinker](https://www.apklinker.com/), so please be aware of it in case you use private/company account to that applications. +[This document](README_CUSTOM_CONFIG.md) 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: +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](https://github.com/googlesamples/android-testing). - ```bash - git clone git@github.com:googlesamples/android-testing.git - ``` + ```bash + git clone git@github.com:googlesamples/android-testing.git + ``` 2. Build the project - ```bash - docker run -it --rm -v $PWD/android-testing/ui/espresso/BasicSample:/root/tmp butomo1989/docker-android-x86-8.1 tmp/gradlew build - ``` + ```bash + docker run -it --rm -v $PWD/android-testing/ui/espresso/BasicSample:/root/tmp butomo1989/docker-android-x86-8.1 tmp/gradlew build + ``` -Proxy ------ - -You can enable proxy inside container by passing following environment variables: - -- HTTP_PROXY="\docker\_bridge\_ip\_address>" -- HTTPS_PROXY="\" -- NO_PROXY="localhost" - -Relaxed Security ------ - -Pass environment variable RELAXED_SECURITY=true to disable additional security check to use some advanced features. - -Genymotion ----------- - -![Genymotion](images/logo_genymotion.png) - -Docker-Android supports [Genymotion Cloud]. - -You can easily scale your Appium tests on Genymotion Android virtual devices in the cloud. -Use [device.json] to define the device to start. You can specify the port on which the device will start so you don't need to change the device name in your tests every time you need to run those tests. Then run following command - -```bash -export USER="xxx" -export PASS="xxx" -export LICENSE="xxx" - -docker run -it --rm -p 4723:4723 -v $PWD/genymotion/example/sample_devices:/root/tmp -e USER=$USER -e PASS=$PASS -e LICENSE=$LICENSE butomo1989/docker-android-genymotion -``` - -You can also use [this docker-compose file]. - -

- Docker-Android supports Genymotion Cloud -

+Appium and Selenium Grid +------------------------ +If you want to use Appium and Selenium Grid, you can follow [this document](README_APPIUM_AND_SELENIUM.md). It also contains sample and use cases. Control android emulator outside container ------------------------------------------ @@ -243,15 +134,6 @@ adb connect :5555 **Note:** You need to have Android Debug Bridge (adb) installed in your host machine. -Get rid of unauthorized device popup while connecting to the emulator outside the container ------------------------------------------- - -In order to connect to the emulator using already generated adbkey on your machine you will need to mount your `.android` folder to the container (this is needed only when you work with emulator based on playstore image): - -``` -docker run -v :/root/.android/ ... -``` - SMS Simulation -------------- @@ -290,76 +172,27 @@ SMS Simulation ![][sms] -How to use docker-android in VMWare or Parallels Desktop ---------------- -The following instructions are used for OS X. You'll need [docker-machine-parallels](https://github.com/Parallels/docker-machine-parallels) to create a virtual machine (vm) with tiny core linux for running docker images. After that, you may start the vm you created for VMWare Fusion or Parallels Desktop and run a docker container inside this vm. If you're going to use the android docker of emulator with x86 processor, setup this vm for nested virtualization and kvm support before you run a docker container. +Google Play Services and Google Play Store +------------------------------------------ -1. Install docker-machine-parallels via Homebrew: - ```bash - $ brew install docker-machine-parallels - ``` +Docker-Android contains Google Play Service (v12.8.74) and Google Play Store (v11.0.50). Both applications are downloaded from [apklinker](https://www.apklinker.com/), so please be aware of it in case you use private/company account to that applications. -2. Create a virtual machine for running docker images based on the virtual machine tool you use +VMWARE +------ - 2.1. Create a virtual machine of VMWare Fusion - ```bash - $ docker-machine create --driver=vmwarefusion vmware-dev - ``` +This [document](README_VMWARE.md) shows you how to configure Virtual Machine on VMWARE to be able to run Docker-Android. - 2.2. Create a virtual machine of Parallels Desktop - ```bash - $ docker-machine create --driver=parallels prl-dev - ``` +Cloud +----- - This utility `docker-machine-parallels` will fetch boot2docker.iso to create a vm of VMWare fusion or Parallels Desktop. When the vm is created, you'll see it's booted with VMWare fusion or Parallels Desktop where the network of vm is set to NAT and one IP is assigned. You'll be able to connect to vnc service inside the docker image through that IP. Say it's `10.211.55.3` and we'll use it later. +This [document](README_CLOUD.md) contains information about deploying Docker-Android on cloud services. -3. Setup the virtual machine for nested virtualization support +Genymotion +---------- - 3.1. Shutdown the vm by running the command below in the boot2docker vm before you setup it. - ```bash - # shutdown -h now - ``` +![Genymotion](images/logo_genymotion.png) - If you use VMWare Fusion, go to menu bar > Vitual Machine > Settings > Processors and Memory, expand Advanced options, and select `Enable hypervisor applications in this virtual machine`. - - ![Enable nested virtualization for VMWare Fusion](images/vmwarefusion_enable_nested_virtualization.png) - - If you use Parallels Desktop, open settings screen of that vm and go to `CPU & Memory` under `hardware` tab, expand Advanced settings and select `Enable nested virtualization`. - - ![Enable nested virtualization for Parallels Desktop](images/parallels_enable_nested_virtualization.png) - -4. Enable kvm inside virtual machine - 4.1. Run as an account other than root to install kvm packages using tce-load. - ```bash - # su docker - $ tce-load -wi kvm - ``` - - 4.2. Run as root to load kvm module after kvm packages install. - ```bash - $ sudo modprobe kvm_intel - ``` - - 4.3. Check if the kvm device is loaded. - ```bash - $ ls /dev/kvm - ``` - - 4.4. Check if your CPU supports hardware virtualization now - ```bash - $ egrep -c '(vmx|svm)' /proc/cpuinfo - ``` - - If **0** it means that your CPU doesn't support hardware virtualization. - If **1** or more it does - but you still need to make sure that virtualization is enabled in the BIOS. - -5. You may now run a docker container - 5.1. Let's run a docker image for an emulator with x86 processor. - ```bash - docker run --privileged -d -p 6080:6080 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" --name android-container butomo1989/docker-android-x86-8.1 - ``` - - When the services inside this docker container are running, connect to http://10.211.55.3:6080/vnc.html (the IP we got when the docker machine was created) and login. The emulator with x86 processor should be running on screen. +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](https://www.genymotion.com/cloud/). Docker-Android is integrated with Genymotion on different cloud services, e.g. Genymotion Cloud, AWS, GCP, Alibaba Cloud. Please follow [this document](README_GENYMOTION.md) for more detail. Troubleshooting --------------- @@ -369,11 +202,6 @@ All logs inside container are stored under folder **/var/log/supervisor**. you c docker exec -it android-container tail -f /var/log/supervisor/docker-android.stdout.log ``` -Running on Azure ----------------- -Make sure that the nodes, pods, containers for your emulators are generated within a **VM** of series **Dv3** or **Ev3**. -Reference: https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nested-virtualization - Special Thanks -------------- - [Gian Christanto] for creating a great logo! @@ -384,15 +212,6 @@ Special Thanks [emulator samsung]: [emulator nexus]: [real device]: -[compose]: -[line]: -[example of compose file]: -[utils bash file]: -[docker-compose]: -[1.13.0]: -[Genymotion Cloud]: -[device.json]: -[this docker-compose file]: [adb_connection]: [sms]: [gian christanto]: diff --git a/README_APPIUM_AND_SELENIUM.md b/README_APPIUM_AND_SELENIUM.md new file mode 100644 index 0000000..713b8e4 --- /dev/null +++ b/README_APPIUM_AND_SELENIUM.md @@ -0,0 +1,54 @@ +Run Appium Server +----------------- + +Appium is automation test framework to test mobile website and mobile application, including Android. To be able to use Appium, you need to run appium-server. You run Appium-Server inside docker-android container by ***opening port 4723*** and ***passing an environment variable APPIUM=true***. + +```bash +docker run --privileged -d -p 6080:6080 -p 5554:5554 -p 5555:5555 -p 4723:4723 -e DEVICE="Samsung Galaxy S6" -e APPIUM=true --name android-container butomo1989/docker-android-x86-8.1 +``` + +### Share Volume + +If you want to use appium to test UI of your android application, you need to share volume where the APK is located to folder ***/root/tmp***. + +```bash +docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -v $PWD/example/sample_apk:/root/tmp -e DEVICE="Nexus 5" -e APPIUM=true -e CONNECT_TO_GRID=true -e APPIUM_HOST="127.0.0.1" -e APPIUM_PORT=4723 -e SELENIUM_HOST="172.17.0.1" -e SELENIUM_PORT=4444 --name android-container butomo1989/docker-android-x86-8.1 +``` + +### Connect to Selenium Grid + +It is also possible to connect appium server that run inside docker-android with selenium grid by passing following environment variables: + +- CONNECT\_TO\_GRID=true +- APPIUM_HOST="\" +- APPIUM_PORT=\ +- SELENIUM_HOST="\" +- SELENIUM_PORT=\ + +To run tests for mobile browser, following parameter can be passed: + +- MOBILE\_WEB\_TEST=true + +```bash +docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" -e APPIUM=true -e CONNECT_TO_GRID=true -e APPIUM_HOST="127.0.0.1" -e APPIUM_PORT=4723 -e SELENIUM_HOST="172.17.0.1" -e SELENIUM_PORT=4444 -e MOBILE_WEB_TEST=true --name android-container butomo1989/docker-android-x86-8.1 +``` + +### Video Recording + +You can deactivate auto_record by changing the value to "False" in docker-compose file. e.g. change value to "False" in this [line](docker-compose.yml#L70). + +### Relaxed Security + +Pass environment variable RELAXED_SECURITY=true to disable additional security check to use some advanced features. + +### Docker-Compose + +![][compose] + +There is [example of compose file](docker-compose.yml) to run complete selenium grid and docker-android container as nodes. [docker-compose](https://docs.docker.com/compose/install/) version [1.13.0](https://github.com/docker/compose/releases/tag/1.13.0) or higher is required to be able to execute that compose file. + +```bash +docker-compose up -d +``` + +[compose]: diff --git a/README_CLOUD.md b/README_CLOUD.md new file mode 100644 index 0000000..c0a148e --- /dev/null +++ b/README_CLOUD.md @@ -0,0 +1,5 @@ +Azure +----- + +Make sure that the nodes, pods, containers for your emulators are generated within a **VM** of series **Dv3** or **Ev3**. +Reference: https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nested-virtualization diff --git a/README_CUSTOM_CONFIG.md b/README_CUSTOM_CONFIG.md new file mode 100644 index 0000000..a4b701c --- /dev/null +++ b/README_CUSTOM_CONFIG.md @@ -0,0 +1,39 @@ +Proxy +----- + +You can enable proxy inside container by passing following environment variables: + +- HTTP_PROXY="\docker\_bridge\_ip\_address>" +- HTTPS_PROXY="\" +- NO_PROXY="localhost" + +Language +-------- + +You can change the language setting of Android Emulator on the fly by passing following environment variable: + +- LANGUAGE="\" +- COUNTRY="\" + +Custom Emulator Arguments +------------------------- + +If you want to add more arguments for running emulator, you can ***pass an environment variable EMULATOR_ARGS*** while running docker command. + +```bash +docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" -e EMULATOR_ARGS="-no-snapshot-load -partition-size 512" --name android-container butomo1989/docker-android-x86-8.1 +``` + +Back & Restore +-------------- + +If you want to backup/reuse the avds created with furture upgrades or for replication, run the container with two extra mounts + +- -v local_backup/.android:/root/.android +- -v local_backup/android_emulator:/root/android_emulator + +```bash +docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 -v local_backup/.android:/root/.android -v local_backup/android_emulator:local_backup/android_emulator -e DEVICE="Nexus 5" --name android-container butomo1989/docker-android-x86-8.1 +``` + +For the first run, this will create a new avd and all the changes will be accessible in the `local_backup` directory. Now for all future runs, it will reuse the avds. Even this should work with new releases of `docker-android` diff --git a/README_GENYMOTION.md b/README_GENYMOTION.md new file mode 100644 index 0000000..a23fb72 --- /dev/null +++ b/README_GENYMOTION.md @@ -0,0 +1,28 @@ +Genymotion +---------- + +You can easily scale your Appium tests on Genymotion Android virtual devices in the cloud. + +1. Using Genymotion Cloud + Use [device.json](genymotion/example/sample_devices/devices.json) to define the device to start. You can specify the port on which the device will start so you don't need to change the device name in your tests every time you need to run those tests. Then run following command + + ```bash + export USER="xxx" + export PASS="xxx" + export LICENSE="xxx" + + docker run -it --rm -p 4723:4723 -v $PWD/genymotion/example/sample_devices:/root/tmp -e TYPE=genycloud -e USER=$USER -e PASS=$PASS -e LICENSE=$LICENSE butomo1989/docker-android-genymotion + ``` + +

+ Docker-Android supports Genymotion Cloud +

+ +2. Using Genymotion on AWS + Use [aws.json](genymotion/example/sample_devices/aws.json) to define configuration of EC2 instance and run following command: + + ```bash + docker run -it --rm -p 4723:4723 -v $PWD/genymotion/example/sample_devices:/root/tmp -v ~/.aws:/root/.aws -e TYPE=aws butomo1989/docker-android-genymotion + ``` + +You can also use [this docker-compose file](genymotion/example/geny.yml). diff --git a/README_VMWARE.md b/README_VMWARE.md new file mode 100644 index 0000000..fece74e --- /dev/null +++ b/README_VMWARE.md @@ -0,0 +1,71 @@ +VMWare Fusion on OSX +-------------------- + +The following instructions are used for OS X. You'll need [docker-machine-parallels](https://github.com/Parallels/docker-machine-parallels) to create a virtual machine (vm) with tiny core linux for running docker images. After that, you may start the vm you created for VMWare Fusion or Parallels Desktop and run a docker container inside this vm. If you're going to use the android docker of emulator with x86 processor, setup this vm for nested virtualization and kvm support before you run a docker container. + +1. Install docker-machine-parallels via Homebrew: + ```bash + $ brew install docker-machine-parallels + ``` + +2. Create a virtual machine for running docker images based on the virtual machine tool you use + + 2.1. Create a virtual machine of VMWare Fusion + ```bash + $ docker-machine create --driver=vmwarefusion vmware-dev + ``` + + 2.2. Create a virtual machine of Parallels Desktop + ```bash + $ docker-machine create --driver=parallels prl-dev + ``` + + This utility `docker-machine-parallels` will fetch boot2docker.iso to create a vm of VMWare fusion or Parallels Desktop. When the vm is created, you'll see it's booted with VMWare fusion or Parallels Desktop where the network of vm is set to NAT and one IP is assigned. You'll be able to connect to vnc service inside the docker image through that IP. Say it's `10.211.55.3` and we'll use it later. + +3. Setup the virtual machine for nested virtualization support + + 3.1. Shutdown the vm by running the command below in the boot2docker vm before you setup it. + ```bash + # shutdown -h now + ``` + + If you use VMWare Fusion, go to menu bar > Vitual Machine > Settings > Processors and Memory, expand Advanced options, and select `Enable hypervisor applications in this virtual machine`. + + ![Enable nested virtualization for VMWare Fusion](images/vmwarefusion_enable_nested_virtualization.png) + + If you use Parallels Desktop, open settings screen of that vm and go to `CPU & Memory` under `hardware` tab, expand Advanced settings and select `Enable nested virtualization`. + + ![Enable nested virtualization for Parallels Desktop](images/parallels_enable_nested_virtualization.png) + +4. Enable kvm inside virtual machine + 4.1. Run as an account other than root to install kvm packages using tce-load. + ```bash + # su docker + $ tce-load -wi kvm + ``` + + 4.2. Run as root to load kvm module after kvm packages install. + ```bash + $ sudo modprobe kvm_intel + ``` + + 4.3. Check if the kvm device is loaded. + ```bash + $ ls /dev/kvm + ``` + + 4.4. Check if your CPU supports hardware virtualization now + ```bash + $ egrep -c '(vmx|svm)' /proc/cpuinfo + ``` + + If **0** it means that your CPU doesn't support hardware virtualization. + If **1** or more it does - but you still need to make sure that virtualization is enabled in the BIOS. + +5. You may now run a docker container + 5.1. Let's run a docker image for an emulator with x86 processor. + ```bash + docker run --privileged -d -p 6080:6080 -p 5554:5554 -p 5555:5555 -e DEVICE="Samsung Galaxy S6" --name android-container butomo1989/docker-android-x86-8.1 + ``` + + When the services inside this docker container are running, connect to http://10.211.55.3:6080/vnc.html (the IP we got when the docker machine was created) and login. The emulator with x86 processor should be running on screen.