[Android]Android端末のデバイスファームSTFを構築する

2021-08-092021-08-10

STF

このSTFというのは、AWS Device Farm のように Android端末のデバイスファームを自作できるツールになります。
GitHub – DeviceFarmer/stf: Control and manage Android devices from your browser.

このSTFを構築しておくと会社にあるAndroid端末でも自宅からリモートで接続してデバッグに使用できるようになります。

今回、これがDocker Composeで簡単に構築できるというのを耳にして構築してみました。

準備

まずはDocker ComposeとADBコマンドを使用できるようにします。

Dockerのインストールは下記を参照してインストールしておきます。
Docker Compose のインストール — Docker-docs-ja 19.03 ドキュメント

ADBコマンドはAndroidStudioをインストールすれば一緒についてきます。
そのままだとパスが通って無くて使えないのでパスを通しておきます。

Macの場合だと ~/.bash_profile にADBのパスの設定を追記しておきます。
[user_name]は自分のPCの環境に合わせてください。

export PATH=$PATH:/Users/[user_name]/Library/Android/sdk/platform-tools

source ~/.bash_profile

で反映して適当にadbコマンドが実行できるようになっていればOKです。

最後にdocker-compose.yamlを用意していきます。

STF公式のdocker-compose.yamlが下記にあります。
stf/docker-compose.yaml at master · DeviceFarmer/stf · GitHub

ただ、公式のものはADB用のコンテナ内からUSBに接続したAndroid端末を認識するようになっているのですが、
自分の場合だとうまく認識しなかったのでホストのADBコマンドを直接使うように変更しています。
また、stf の起動オプションに --no-cleanup でインストールしたアプリを端末利用終了時に削除されないようにしています。

下記の設定ファイルのIP:192.168.100.193 の部分を自分のホストのIPに変更すればMacでもWindowsでも構築できるはずです。

今回作成した docker-compose.yaml ファイル

# [DeviceFarmer/stf: Control and manage Android devices from your browser.](https://github.com/DeviceFarmer/stf)

# 使い方
# 1. 192.168.100.193 の部分を自分のホストのIPに変更
# 2. adb start-server
# 3. docker-compose up -d
# 4. http://192.168.100.193:7100 にアクセスすれば管理画面が表示される

version: "3"

services:
  rethinkdb:
    container_name: rethinkdb
    image: rethinkdb:2.3
    restart: unless-stopped
    volumes:
        - "rethinkdb-data:/data"
    command: "rethinkdb --bind all --cache-size 2048"

  # コンテナからUSBがうまく認識しなかったのでホストのadbを使うようにする
  # adb:
  #   container_name: adb
  #   image: devicefarmer/adb:latest
  #   restart: unless-stopped
  #   volumes:
  #     - "/dev/bus/usb:/dev/bus/usb"
  #   privileged: true

  # --adb-host host.docker.internal でホストのadbを使用する　
  #     コンテナを起動する前に adb start-server でadbを立ち上げておくこと
  # --no-cleanup で インストールしたアプリを端末利用終了時に削除されないようする
  # http://192.168.100.193:7100 にアクセスすれば管理画面が表示される

  stf:
    container_name: stf
    image: devicefarmer/stf
    ports:
      - "7100:7100"
      - "7110:7110"
      - "7400-7500:7400-7500"
    environment:
      - TZ=&#039;America/Los_Angeles&#039;
      - RETHINKDB_PORT_28015_TCP=tcp://rethinkdb:28015
      - STF_ADMIN_EMAIL=p1j98x1i@gmail.com
      - STF_ADMIN_NAME=p1j98x1i
    restart: unless-stopped
    command: stf local --public-ip 192.168.100.193 --adb-host host.docker.internal --provider-min-port 7400 --provider-max-port 7500 --no-cleanup

volumes:
  rethinkdb-data: {}