diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f8ff2b5 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.mp4 filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore index e60e0b4..887dc44 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,3 @@ coverage.xml xunit.xml coverage/* - -# Video -video* diff --git a/README.md b/README.md index 4df39f7..8618d1d 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ Docker-Android is a docker image built to be used for everything related to mobile website testing and Android project. +

+ Appium Conference 2018 +

+ Emulator - Samsung Device | Emulator - Nexus Device | Real Device :---------------------------:|:---------------------------:|:---------------------------: ![][emulator samsung] |![][emulator nexus] |![][real device] @@ -50,6 +54,7 @@ List of Docker images |OSX / Windows|7.0|24|butomo1989/docker-android-arm-7.0|[![](https://images.microbadger.com/badges/image/butomo1989/docker-android-arm-7.0.svg)](https://microbadger.com/images/butomo1989/docker-android-arm-7.0 "Get your own image badge on microbadger.com")| |OSX / Windows|7.1.1|25|butomo1989/docker-android-arm-7.1.1|[![](https://images.microbadger.com/badges/image/butomo1989/docker-android-arm-7.1.1.svg)](https://microbadger.com/images/butomo1989/docker-android-arm-7.1.1 "Get your own image badge on microbadger.com")| |All |-|-|butomo1989/docker-android-real-device|[![](https://images.microbadger.com/badges/image/butomo1989/docker-android-real-device.svg)](https://microbadger.com/images/butomo1989/docker-android-real-device "Get your own image badge on microbadger.com")| +|Linux|All|All|butomo1989/docker-android-genymotion|[![](https://images.microbadger.com/badges/image/butomo1989/docker-android-genymotion.svg)](https://microbadger.com/images/butomo1989/docker-android-genymotion "Get your own image badge on microbadger.com")| List of Devices --------------- @@ -100,17 +105,17 @@ Quick Start 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***. +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-7.1.1 +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-7.1.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 +- CONNECT\_TO\_GRID=true - APPIUM_HOST="\" - APPIUM_PORT=\ - SELENIUM_HOST="\" @@ -118,10 +123,10 @@ It is also possible to connect appium server that run inside docker-android with To run tests for mobile browser, following parameter can be passed: -- MOBILE\_WEB\_TEST=True +- 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-7.1.1 +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-7.1.1 ``` ### Share Volume @@ -129,7 +134,7 @@ docker run --privileged -d -p 6080:6080 -p 4723:4723 -p 5554:5554 -p 5555:5555 - 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-7.1.1 +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-7.1.1 ``` ### Video Recording @@ -163,6 +168,45 @@ docker-android can be used for building Android project and executing its unit t docker run -it --rm -v $PWD/android-testing/ui/espresso/BasicSample:/root/tmp butomo1989/docker-android-x86-7.1.1 tmp/gradlew build ``` +Proxy +----- + +You can enable proxy inside container by passing following environment variables: + +- HTTP_PROXY="\" +- 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 +

+ + Control android emulator outside container ------------------------------------------ @@ -217,72 +261,71 @@ 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. 1. Install docker-machine-parallels via Homebrew: -```bash -$ brew install docker-machine-parallels -``` + ```bash + $ brew install docker-machine-parallels + ``` 2. Create a virtual machine for running docker images based on the virtual machine tool you use -Create a virtual machine of VMWare Fusion -```bash -$ docker-machine create --driver=vmwarefusion vmware-dev -``` + 2.1. Create a virtual machine of VMWare Fusion + ```bash + $ docker-machine create --driver=vmwarefusion vmware-dev + ``` -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. + 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 -Shutdown the vm by running the command below in the boot2docker vm before you setup it. -```bash -# shutdown -h now -``` + 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)] + 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 -Run as an account other than root to install kvm packages using tce-load. -```bash -# su docker -$ tce-load -wi kvm -``` + 4.1. Run as an account other than root to install kvm packages using tce-load. + ```bash + # su docker + $ tce-load -wi kvm + ``` -Run as root to load kvm module after kvm packages install. -```bash -$ sudo modprobe kvm_intel -``` + 4.2. Run as root to load kvm module after kvm packages install. + ```bash + $ sudo modprobe kvm_intel + ``` -Check if the kvm device is loaded. -```bash -$ ls /dev/kvm -``` + 4.3. Check if the kvm device is loaded. + ```bash + $ ls /dev/kvm + ``` -Check if your CPU supports hardware virtualization now -```bash -$ egrep -c '(vmx|svm)' /proc/cpuinfo -``` + 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. + 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 -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-7.1.1 -``` + 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-7.1.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. + 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. Troubleshooting --------------- @@ -307,6 +350,9 @@ Special Thanks [example of compose file]: [docker-compose]: [1.13.0]: +[Genymotion Cloud]: +[device.json]: +[this docker-compose file]: [adb_connection]: [sms]: [gian christanto]: diff --git a/docker-compose.yml b/docker-compose.yml index 5dbd89e..dbb6327 100755 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,9 +6,9 @@ version: "2.2" services: # Selenium hub selenium_hub: - image: selenium/hub:3.11.0-bismuth + image: selenium/hub:3.12.0-americium ports: - - "4444:4444" + - 4444:4444 # There is a bug for using appium. Issue: https://github.com/butomo1989/docker-android/issues/73 # Real devices @@ -24,10 +24,10 @@ services: # - /dev/bus/usb:/dev/bus/usb # - ~/.android:/root/.android # environment: - # - CONNECT_TO_GRID=True + # - CONNECT_TO_GRID=true # - APPIUM=true # - SELENIUM_HOST=selenium_hub - # - AUTO_RECORD=True + # - AUTO_RECORD=true # - BROWSER_NAME=chrome # Using Appium Docker Android @@ -42,7 +42,7 @@ services: - ~/.android:/root/.android - $PWD/example/sample_apk:/root/tmp environment: - - CONNECT_TO_GRID=True + - CONNECT_TO_GRID=true - SELENIUM_HOST=selenium_hub # Enable it for msite testing #- BROWSER_NAME=chrome @@ -60,14 +60,14 @@ services: - 6080 # Change path of apk that you want to test. I use sample_apk that I provide in folder "example" volumes: - - $PWD/example/sample_apk:/root/tmp + - $PWD/example/sample_apk:/root/tmp/sample_apk - ./video-nexus_7.1.1:/tmp/video environment: - DEVICE=Nexus 5 - - CONNECT_TO_GRID=True + - CONNECT_TO_GRID=true - APPIUM=true - SELENIUM_HOST=selenium_hub - - AUTO_RECORD=True + - AUTO_RECORD=true # Docker-Android for mobile website testing with chrome browser # Chrome browser exists only for version 7.0 and 7.1.1 @@ -85,11 +85,11 @@ services: - ./video-samsung_7.1.1:/tmp/video environment: - DEVICE=Samsung Galaxy S6 - - CONNECT_TO_GRID=True + - CONNECT_TO_GRID=true - APPIUM=true - SELENIUM_HOST=selenium_hub - - MOBILE_WEB_TEST=True - - AUTO_RECORD=True + - MOBILE_WEB_TEST=true + - AUTO_RECORD=true # Docker-Android for mobile website testing with default browser # Default browser exists only for version 5.0.1, 5.1.1 and 6.0 @@ -107,8 +107,8 @@ services: - ./video-samsung_5.1.1:/tmp/video environment: - DEVICE=Samsung Galaxy S6 - - CONNECT_TO_GRID=True + - CONNECT_TO_GRID=true - APPIUM=true - SELENIUM_HOST=selenium_hub - - MOBILE_WEB_TEST=True - - AUTO_RECORD=True + - MOBILE_WEB_TEST=true + - AUTO_RECORD=true diff --git a/docker/Emulator_arm b/docker/Emulator_arm index bf2d504..bec6c0a 100644 --- a/docker/Emulator_arm +++ b/docker/Emulator_arm @@ -1,4 +1,4 @@ -FROM appium/appium:1.7.2-p1 +FROM appium/appium:1.8.1-p2 LABEL maintainer "Budi Utomo " @@ -83,19 +83,18 @@ ENV ANDROID_VERSION=$ANDROID_VERSION \ IMG_TYPE=$IMG_TYPE \ BROWSER=$BROWSER ENV PATH ${PATH}:${ANDROID_HOME}/build-tools -RUN echo y | sdkmanager "platforms;android-${API_LEVEL}" && \ - echo y | sdkmanager "system-images;android-${API_LEVEL};${IMG_TYPE};${SYS_IMG}" && \ - echo y | sdkmanager "emulator" +RUN yes | sdkmanager --licenses && \ + sdkmanager "platforms;android-${API_LEVEL}" "system-images;android-${API_LEVEL};${IMG_TYPE};${SYS_IMG}" "emulator" RUN rm ${ANDROID_HOME}/tools/emulator \ && ln -s ${ANDROID_HOME}/emulator/emulator64-${PROCESSOR} ${ANDROID_HOME}/tools/emulator ENV LD_LIBRARY_PATH=$ANDROID_HOME/emulator/lib64:$ANDROID_HOME/emulator/lib64/qt/lib #============================================== -# Download chrome driver v2.26 -# to be able to use chrome browser in emulator -# Issue: https://github.com/butomo1989/docker-android/commit/6406504f944dae73d0a0c5d8e71a17a47dff9b33 +# Download latest version of chromedriver +# to be able to use Chrome browser in emulator #============================================== -RUN wget -nv -O chrome.zip "https://chromedriver.storage.googleapis.com/2.26/chromedriver_linux64.zip" \ +RUN LATEST_VERSION=$(curl -s https://chromedriver.storage.googleapis.com/LATEST_RELEASE) \ + && wget -nv -O chrome.zip "https://chromedriver.storage.googleapis.com/$LATEST_VERSION/chromedriver_linux64.zip" \ && unzip -x chrome.zip \ && rm chrome.zip diff --git a/docker/Emulator_x86 b/docker/Emulator_x86 index 314f079..f5ed696 100644 --- a/docker/Emulator_x86 +++ b/docker/Emulator_x86 @@ -1,4 +1,4 @@ -FROM appium/appium:1.7.2-p1 +FROM appium/appium:1.8.1-p2 LABEL maintainer "Budi Utomo " @@ -86,7 +86,7 @@ RUN wget -nv -O noVNC.zip "https://github.com/kanaka/noVNC/archive/${NOVNC_SHA} ARG ANDROID_VERSION=5.0.1 ARG API_LEVEL=21 ARG PROCESSOR=x86 -ARG SYS_IMG=x86_64 +ARG SYS_IMG=x86 ARG IMG_TYPE=google_apis ARG BROWSER=android ENV ANDROID_VERSION=$ANDROID_VERSION \ @@ -96,20 +96,15 @@ ENV ANDROID_VERSION=$ANDROID_VERSION \ IMG_TYPE=$IMG_TYPE \ BROWSER=$BROWSER ENV PATH ${PATH}:${ANDROID_HOME}/build-tools -RUN echo y | sdkmanager "platforms;android-${API_LEVEL}" && \ - echo y | sdkmanager "system-images;android-${API_LEVEL};${IMG_TYPE};${SYS_IMG}" && \ - echo y | sdkmanager "emulator" -RUN rm ${ANDROID_HOME}/tools/emulator \ - && ln -s ${ANDROID_HOME}/emulator/emulator64-${PROCESSOR} ${ANDROID_HOME}/tools/emulator -ENV LD_LIBRARY_PATH=$ANDROID_HOME/emulator/lib64:$ANDROID_HOME/emulator/lib64/qt/lib - +RUN yes | sdkmanager --licenses && \ + sdkmanager "platforms;android-${API_LEVEL}" "system-images;android-${API_LEVEL};${IMG_TYPE};${SYS_IMG}" "emulator" #============================================== -# Download chrome driver v2.26 -# to be able to use chrome browser in emulator -# Issue: https://github.com/butomo1989/docker-android/commit/6406504f944dae73d0a0c5d8e71a17a47dff9b33 +# Download latest version of chromedriver +# to be able to use Chrome browser in emulator #============================================== -RUN wget -nv -O chrome.zip "https://chromedriver.storage.googleapis.com/2.26/chromedriver_linux64.zip" \ +RUN LATEST_VERSION=$(curl -s https://chromedriver.storage.googleapis.com/LATEST_RELEASE) \ + && wget -nv -O chrome.zip "https://chromedriver.storage.googleapis.com/$LATEST_VERSION/chromedriver_linux64.zip" \ && unzip -x chrome.zip \ && rm chrome.zip diff --git a/docker/Genymotion b/docker/Genymotion new file mode 100644 index 0000000..329865d --- /dev/null +++ b/docker/Genymotion @@ -0,0 +1,125 @@ +FROM appium/appium:1.8.1-p2 + +LABEL maintainer "Budi Utomo " + +#============= +# Set WORKDIR +#============= +WORKDIR /root + +#================== +# General Packages +#------------------ +# xterm +# Terminal emulator +# supervisor +# Process manager +# socat +# Port forwarder +#------------------ +# Genymotion spec +#------------------ +# bzip2 +# File compression +#------------------ +# NoVNC Packages +#------------------ +# x11vnc +# VNC server for X display +# openbox +# Windows manager +# menu +# Debian menu +# python-numpy +# Numpy, For faster performance: https://github.com/novnc/websockify/issues/77 +# net-tools +# Netstat +#------------------ +# Video Recording +#------------------ +# ffmpeg +# Video recorder +# jq +# Sed for JSON data +#================== +RUN apt-get -qqy update && apt-get -qqy install --no-install-recommends \ + xterm \ + supervisor \ + socat \ + bzip2 \ + x11vnc \ + openbox \ + menu \ + python-numpy \ + net-tools \ + ffmpeg \ + jq \ + && rm -rf /var/lib/apt/lists/* + +#======= +# noVNC +# Use same commit id that docker-selenium uses +# https://github.com/elgalu/docker-selenium/blob/236b861177bd2917d864e52291114b1f5e4540d7/Dockerfile#L412-L413 +#======= +ENV NOVNC_SHA="b403cb92fb8de82d04f305b4f14fa978003890d7" \ + WEBSOCKIFY_SHA="558a6439f14b0d85a31145541745e25c255d576b" +RUN wget -nv -O noVNC.zip "https://github.com/kanaka/noVNC/archive/${NOVNC_SHA}.zip" \ + && unzip -x noVNC.zip \ + && rm noVNC.zip \ + && mv noVNC-${NOVNC_SHA} noVNC \ + && wget -nv -O websockify.zip "https://github.com/kanaka/websockify/archive/${WEBSOCKIFY_SHA}.zip" \ + && unzip -x websockify.zip \ + && mv websockify-${WEBSOCKIFY_SHA} ./noVNC/utils/websockify \ + && rm websockify.zip \ + && ln noVNC/vnc_auto.html noVNC/index.html + +#================================================ +# noVNC Default Configurations +# These Configurations can be changed through -e +#================================================ +ENV DISPLAY=:0 \ + SCREEN=0 \ + SCREEN_WIDTH=1600 \ + SCREEN_HEIGHT=900 \ + SCREEN_DEPTH=16 \ + LOCAL_PORT=5900 \ + TARGET_PORT=6080 \ + TIMEOUT=1 \ + VIDEO_PATH=/tmp/video \ + LOG_PATH=/var/log/supervisor + +#==================== +# Install genymotion +#==================== +ARG GENYMOTION_VERSION=2.12.1 + +ENV GENYMOTION=true \ + GENYMOTION_VERSION=$GENYMOTION_VERSION \ + PATH="${PATH}:/opt/genymobile/genymotion/" \ + APPIUM_LOG=$LOG_PATH/appium.log +RUN wget -nv -O genymotion.bin "https://dl.genymotion.com/releases/genymotion-${GENYMOTION_VERSION}/genymotion-${GENYMOTION_VERSION}-linux_x64.bin" \ + && chmod +x ./genymotion.bin \ + && yes | ./genymotion.bin \ + && rm genymotion.bin +COPY genymotion/generate_config.sh genymotion/geny_start.sh /root/ + +#=============== +# Expose Ports +#--------------- +# 4723 +# Appium port +# 6080 +# noVNC port +# 5555 +# ADB connection port +#=============== +EXPOSE 4723 6080 5555 + +#======================= +# Run docker-genymotion +#======================= +COPY src /root/src +COPY supervisord.conf /root/ +RUN chmod -R +x /root/src && chmod +x /root/supervisord.conf /root/geny_start.sh +RUN gmtool --cloud config use_custom_sdk=on sdk_path=/root +CMD ["./geny_start.sh"] diff --git a/docker/Real_device b/docker/Real_device index 71a65ea..84e22e0 100644 --- a/docker/Real_device +++ b/docker/Real_device @@ -1,4 +1,4 @@ -FROM appium/appium:1.7.2-p1 +FROM appium/appium:1.8.1-p2 LABEL maintainer "Budi Utomo " @@ -38,7 +38,7 @@ WORKDIR /root # Sed for JSON data #================== RUN apt-get -qqy update && apt-get -qqy install --no-install-recommends \ - xterm \ + xterm \ supervisor \ socat \ x11vnc \ @@ -85,7 +85,8 @@ ENV DISPLAY=:0 \ #========================= # Set default variables #========================= -ENV REAL_DEVICE=True +ENV APPIUM_LOG=$LOG_PATH/appium.log +ENV REAL_DEVICE=true ENV BROWSER=android #=============== diff --git a/genymotion/example/geny.yml b/genymotion/example/geny.yml new file mode 100755 index 0000000..134fd6f --- /dev/null +++ b/genymotion/example/geny.yml @@ -0,0 +1,29 @@ +# Note: It requires docker-compose 1.13.0 +# +# Usage: docker-compose up -d +version: "2.2" + +services: + # Selenium hub + selenium_hub: + image: selenium/hub:3.12.0-americium + ports: + - 4444:4444 + + # Please stop this container by using docker stop instead of docker-compose stop + genymotion: + image: butomo1989/docker-android-genymotion + depends_on: + - selenium_hub + ports: + - 6080:6080 + - 4723:4723 + volumes: + - $PWD/sample_apk:/root/tmp/sample_apk + - $PWD/sample_devices:/root/tmp + environment: + - GENY_TEMPLATE=/root/tmp/devices.json + - USER=xxx + - PASS=xxx + - LICENSE=xxx + - CONNECT_TO_GRID=true diff --git a/genymotion/example/sample_apk/sample_apk_debug.apk b/genymotion/example/sample_apk/sample_apk_debug.apk new file mode 100644 index 0000000..fcaa8de Binary files /dev/null and b/genymotion/example/sample_apk/sample_apk_debug.apk differ diff --git a/genymotion/example/sample_devices/devices.json b/genymotion/example/sample_devices/devices.json new file mode 100755 index 0000000..3150d45 --- /dev/null +++ b/genymotion/example/sample_devices/devices.json @@ -0,0 +1,11 @@ +[ + { + "template": "Samsung Galaxy S7 - 6.0.0 - API 23 - 1440x2560", + "device": "SamsungS7V6", + "port": 38727 + }, + { + "template": "Google Nexus 6 - 8.0 - API 26 - 1440x2560", + "device": "Nexus6V8" + } +] diff --git a/genymotion/generate_config.sh b/genymotion/generate_config.sh new file mode 100755 index 0000000..e11dd08 --- /dev/null +++ b/genymotion/generate_config.sh @@ -0,0 +1,81 @@ +#!/bin/bash + +node_config_json=$1 + +if [ -z "$PLATFORM_NAME" ]; then + PLATFORM_NAME="Android" +fi + +if [ -z "$APPIUM_HOST" ]; then + APPIUM_HOST=$(hostname -i) +fi + +if [ -z "$APPIUM_PORT" ]; then + APPIUM_PORT=4723 +fi + +if [ -z "$SELENIUM_HOST" ]; then + SELENIUM_HOST="172.17.0.1" +fi + +if [ -z "$SELENIUM_PORT" ]; then + SELENIUM_PORT=4444 +fi + +if [ -z "$BROWSER_NAME" ]; then + BROWSER_NAME="android" +fi + +if [ -z "$NODE_TIMEOUT" ]; then + NODE_TIMEOUT=300 +fi + +#Get device names +devices=($(adb devices | grep -oP "\K([^ ]+)(?=\sdevice(\W|$))")) +echo "Devices found: ${#devices[@]}" + +#Create capabilities json configs +function create_capabilities() { + capabilities="" + for name in ${devices[@]}; do + os_version="$(adb -s $name shell getprop ro.build.version.release | tr -d '\r')" + capabilities+=$(cat <<_EOF +{ + "platform": "$PLATFORM_NAME", + "platformName": "$PLATFORM_NAME", + "version": "$os_version", + "browserName": "$BROWSER_NAME", + "deviceName": "$name", + "maxInstances": 1, + "applicationName": "$name" + } +_EOF + ) + if [ ${devices[-1]} != $name ]; then + capabilities+=', ' + fi + done + echo "$capabilities" +} + +#Final node configuration json string +nodeconfig=$(cat <<_EOF +{ + "capabilities": [$(create_capabilities)], + "configuration": { + "cleanUpCycle": 2000, + "timeout": $NODE_TIMEOUT, + "proxy": "org.openqa.grid.selenium.proxy.DefaultRemoteProxy", + "url": "http://$APPIUM_HOST:$APPIUM_PORT/wd/hub", + "host": "$APPIUM_HOST", + "port": $APPIUM_PORT, + "maxSession": 6, + "register": true, + "registerCycle": 5000, + "hubHost": "$SELENIUM_HOST", + "hubPort": $SELENIUM_PORT + } +} +_EOF +) +echo "$nodeconfig" > $node_config_json diff --git a/genymotion/geny_start.sh b/genymotion/geny_start.sh new file mode 100755 index 0000000..46ecb95 --- /dev/null +++ b/genymotion/geny_start.sh @@ -0,0 +1,29 @@ +#!/bin/bash +# This script is needed because of https://www.ctl.io/developers/blog/post/gracefully-stopping-docker-containers/ + +if [ -z "$GENY_TEMPLATE" ]; then + GENY_TEMPLATE="/root/tmp/devices.json" +fi + +if [ ! -f "$GENY_TEMPLATE" ]; then + echo "File not found! Nothing to do!" + exit 1 +fi + +getAbort() { + if [ "$GENYMOTION" = true ]; then + contents=$(cat $GENY_TEMPLATE) + echo "ABORT SIGNAL detected! Stopping all created emulators..." + for row in $(echo "${contents}" | jq -r '.[] | @base64'); do + get_value() { + echo ${row} | base64 --decode | jq -r ${1} + } + + gmtool --cloud admin stopdisposable $(get_value '.device') + done + echo "Done" + fi +} +trap 'getAbort; exit' EXIT + +/usr/bin/supervisord --configuration supervisord.conf diff --git a/images/Genymotion_cloud.png b/images/Genymotion_cloud.png new file mode 100644 index 0000000..ba1aa04 Binary files /dev/null and b/images/Genymotion_cloud.png differ diff --git a/images/appiumconf2018.png b/images/appiumconf2018.png new file mode 100644 index 0000000..78f9c61 Binary files /dev/null and b/images/appiumconf2018.png differ diff --git a/images/logo_genymotion.png b/images/logo_genymotion.png new file mode 100644 index 0000000..0303bf9 Binary files /dev/null and b/images/logo_genymotion.png differ diff --git a/release.sh b/release.sh index ecaf2d8..7ee8df6 100755 --- a/release.sh +++ b/release.sh @@ -33,8 +33,8 @@ declare -A list_of_levels=( [6.0]=23 [7.0]=24 [7.1.1]=25 - [8.0]=26 - [8.1]=27 + [8.0]=26 + [8.1]=27 ) declare -A list_of_processors=( diff --git a/revert.sh b/revert.sh new file mode 100644 index 0000000..98b629c --- /dev/null +++ b/revert.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +IMAGE_NAME="butomo1989/docker-android" + +if [ -z "$1" ]; then + read -p "Type : " TYPE +else + TYPE=$1 +fi + +if [ -z "$2" ]; then + read -p "Version : " VERSION +else + VERSION=$2 +fi + +declare -a versions=("7.1.1" "7.0" "6.0" "5.1.1" "5.0.1") + +## now loop through the above array +for v in "${versions[@]}" +do + IMAGE="$IMAGE_NAME-$TYPE-$v" + IMAGE_OLD="$IMAGE:$VERSION" + IMAGE_LATEST="$IMAGE:latest" + echo "Revert image \"$IMAGE_LATEST\" to version \"$IMAGE_OLD\"" + docker pull $IMAGE_OLD + docker tag $IMAGE_OLD $IMAGE_LATEST + docker push $IMAGE_LATEST +done diff --git a/src/app.py b/src/app.py index f3af9e5..1ba4db4 100644 --- a/src/app.py +++ b/src/app.py @@ -105,7 +105,13 @@ def appium_run(avd_name: str): :param avd_name: Name of android virtual device / emulator """ - cmd = 'appium' + DEFAULT_LOG_PATH = '/var/log/supervisor/appium.log' + cmd = 'appium --log {log}'.format(log=os.getenv('APPIUM_LOG', DEFAULT_LOG_PATH)) + + relaxed_security = convert_str_to_bool(str(os.getenv('RELAXED_SECURITY', False))) + logger.info('Relaxed security? {rs}'.format(rs=relaxed_security)) + if relaxed_security: + cmd += ' --relaxed-security' default_web_browser = os.getenv('BROWSER') if default_web_browser == 'chrome': @@ -184,13 +190,17 @@ def run(): prepare_avd(device, avd_name) logger.info('Run emulator...') - cmd = 'emulator -avd {name} -gpu off'.format(name=avd_name) - subprocess.Popen(cmd.split()) - + dp_size = os.getenv('DATAPARTITION', '550m') + with open("/root/android_emulator/config.ini", "a") as cfg: + cfg.write('\ndisk.dataPartition.size={dp}'.format(dp=dp_size)) + cmd = 'emulator/emulator @{name} -gpu off -verbose'.format(name=avd_name) appium = convert_str_to_bool(str(os.getenv('APPIUM', False))) if appium: + subprocess.Popen(cmd.split()) logger.info('Run appium server...') appium_run(avd_name) + else: + result = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE).communicate() if __name__ == '__main__': run() diff --git a/src/appium.sh b/src/appium.sh index d791d6f..2278c70 100644 --- a/src/appium.sh +++ b/src/appium.sh @@ -1,13 +1,62 @@ #!/bin/bash -if [ -z $REAL_DEVICE ]; then - python3 -m src.app -else - CMD="appium" - if [ ! -z "$CONNECT_TO_GRID" ]; then - NODE_CONFIG_JSON="/root/src/nodeconfig.json" - /root/generate_config.sh $NODE_CONFIG_JSON - CMD+=" --nodeconfig $NODE_CONFIG_JSON" - fi - $CMD +if [ -z "$GENY_TEMPLATE" ]; then + GENY_TEMPLATE="/root/tmp/devices.json" +fi + +function prepare_geny_cloud() { + contents=$(cat $GENY_TEMPLATE) + + # Register + gmtool config username="${USER}" password="${PASS}" + gmtool license register "${LICENSE}" + + # Start device(s) + echo "Creating device(s) based on given json file..." + for row in $(echo "${contents}" | jq -r '.[] | @base64'); do + get_value() { + echo ${row} | base64 --decode | jq -r ${1} + } + + template=$(get_value '.template') + device=$(get_value '.device') + port=$(get_value '.port') + + if [[ $port != null ]]; then + echo "Starting \"$device\" with template name \"$template\" on port \"$port\"..." + gmtool --cloud admin startdisposable "${template}" "${device}" --adb-serial-port "${port}" + else + echo "Starting \"$device\" with template name \"$template\"..." + gmtool --cloud admin startdisposable "${template}" "${device}" + fi + done +} + +function run_appium() { + echo "Preparing appium-server..." + CMD="appium --log $APPIUM_LOG" + if [ "$CONNECT_TO_GRID" = true ]; then + NODE_CONFIG_JSON="/root/src/nodeconfig.json" + /root/generate_config.sh $NODE_CONFIG_JSON + CMD+=" --nodeconfig $NODE_CONFIG_JSON" + fi + + if [ "$RELAXED_SECURITY" = true ]; then + CMD+=" --relaxed-security" + fi + + echo "Preparation is done" + $CMD +} + +if [ "$REAL_DEVICE" = true ]; then + echo "Using real device" + run_appium +elif [ "$GENYMOTION" = true ]; then + echo "Using Genymotion" + prepare_geny_cloud + run_appium +else + echo "Using Emulator" + python3 -m src.app fi diff --git a/src/record.sh b/src/record.sh index e4c39bb..1f2f485 100644 --- a/src/record.sh +++ b/src/record.sh @@ -16,12 +16,12 @@ function auto_record() { echo "Auto record: $AUTO_RECORD" sleep 6 - while [ $AUTO_RECORD == "True" ]; do + while [ "$AUTO_RECORD" = true ]; do # Check if there is test running no_test=true while $no_test; do task=$(curl -s localhost:4723/wd/hub/sessions | jq -r '.value') - if [ "$task" == "" ] || [ "$task" == "[]" ]; then + if [ "$task" = "" ] || [ "$task" = "[]" ]; then sleep .5 else start & @@ -30,9 +30,9 @@ function auto_record() { done # Check if test is finished - while [ $no_test == false ]; do + while [ $no_test = false ]; do task=$(curl -s localhost:4723/wd/hub/sessions | jq -r '.value') - if [ "$task" == "" ] || [ "$task" == "[]" ]; then + if [ "$task" = "" ] || [ "$task" = "[]" ]; then stop no_test=true else diff --git a/src/tests/unit/test_app.py b/src/tests/unit/test_app.py index d6e8c15..80da2b2 100644 --- a/src/tests/unit/test_app.py +++ b/src/tests/unit/test_app.py @@ -53,21 +53,25 @@ class TestApp(TestCase): self.assertEqual(app.convert_str_to_bool(True), None) @mock.patch('src.app.prepare_avd') + @mock.patch('builtins.open') @mock.patch('subprocess.Popen') - def test_run_with_appium(self, mocked_avd, mocked_subprocess): + def test_run_with_appium(self, mocked_avd, mocked_open, mocked_subprocess): with mock.patch('src.app.appium_run') as mocked_appium: os.environ['APPIUM'] = str(True) app.run() self.assertTrue(mocked_avd.called) + self.assertTrue(mocked_open.called) self.assertTrue(mocked_subprocess.called) self.assertTrue(mocked_appium.called) @mock.patch('src.app.prepare_avd') + @mock.patch('builtins.open') @mock.patch('subprocess.Popen') - def test_run_withhout_appium(self, mocked_avd, mocked_subprocess): + def test_run_withhout_appium(self, mocked_avd, mocked_open, mocked_subprocess): with mock.patch('src.app.appium_run') as mocked_appium: os.environ['APPIUM'] = str(False) app.run() self.assertTrue(mocked_avd.called) + self.assertTrue(mocked_open.called) self.assertTrue(mocked_subprocess.called) self.assertFalse(mocked_appium.called)