openstf/stf

STF (Smartphone Test Farm) 镜像文档

重要提示

• 该项目及OpenSTF组织的其他项目已停止积极开发，仅作为社区资源提供。
• 可查看https://github.com/openstf/stf/network%E8%8E%B7%E5%8F%96%E5%8F%AF%E8%83%BD%E6%B4%BB%E8%B7%83%E5%BC%80%E5%8F%91%E7%9A%84%E5%88%86%E6%94%AF%E3%80%82
• 开发已迁移至https://github.com/DeviceFarmer%E7%BB%84%E7%BB%87%E3%80%82DockerHub%E4%B8%8A%E7%9A%84%E6%9C%80%E5%90%8E%E7%89%88%E6%9C%AC%E4%B8%BA**3.4.2**%EF%BC%8Cnpmjs%E4%B8%8A%E4%B8%BA**3.4.1**%E3%80%82

镜像概述

STF（Smartphone Test Farm）是一个Web应用，用于从浏览器远程调试智能手机、智能手表及其他设备。最初由CyberAgent开发，用于管理超过160台设备，现主要由HeadSpin及社区贡献者支持。通过STF，用户可在浏览器中实时控制设备，进行应用测试、设备监控和管理。

核心功能与特性

设备支持

• Android系统：支持2.3.3（SDK level 10）至9.0（SDK level 28）版本
• 特殊版本：支持Wear 5.1（不支持5.0）、Fire OS、CyanogenMod等基于Android的发行版
• 无需root：当前所有功能均无需设备root权限

远程控制功能

• 实时屏幕查看：刷新率可达30-40 FPS（取决于设备规格和Android版本），支持旋转
• 键盘输入：支持原生键盘输入、元键、复制粘贴（部分旧设备可能需手动长按粘贴）
• 多点触控：通过minitouch支持触摸屏多点操作；普通屏幕可按Alt键实现双指缩放/旋转
• APK管理：拖放安装并启动APK文件（自动检测并启动清单中指定的主活动）
• 反向端口转发：通过minirev实现本地服务器访问，无需同网络
• 浏览器集成：实时检测已安装浏览器，支持一键打开网页
• Shell命令：执行shell命令并查看实时输出
• 日志查看：显示和过滤设备日志
• ADB远程连接：支持adb connect远程连接设备，兼容Android Studio等IDE及Chrome远程调试工具
• 文件资源管理器：访问设备文件系统
• 实验性VNC支持：开发中功能

设备管理功能

• 库存监控：显示设备连接状态（在线/离线/未授权/未连接）、使用者信息
• 高级搜索：支持按电话号码、IMEI、ICCID、Android版本、运营商等属性搜索
• 物理定位：设备屏幕显示红色标识信息，便于物理查找
• 电池监控：跟踪电池电量和健康状态
• Play Store账户管理：列出、移除和添加账户（部分设备可能不支持添加）
• 硬件规格显示：展示设备硬件详细信息

预订与分区系统（管理员功能）

• 分区系统：分配设备组给不同项目或组织（无限期）
• 预订系统：限时（如5天内每天3:00-4:00）为用户组预留设备
• 组管理：创建、搜索、删除组，查看组状态（活跃/就绪/待处理）及属性（名称、所有者、设备、用户、时间等）

用户与设备管理（管理员功能）

• 用户管理：创建用户、按属性搜索、删除用户、设置用户组配额
• 设备管理：按属性搜索设备、批量移除符合条件的设备

其他功能

• REST API：提供简单的REST接口

使用场景

• 移动应用开发团队远程调试多型号设备
• 测试团队进行跨设备兼容性测试
• 设备实验室集中管理大量测试设备
• 教学或演示中远程操作设备

环境要求

• 依赖服务：RethinkDB（≥2.2）
• 网络：设备与STF服务需网络连通，ADB配置正确

使用方法

Docker快速启动

需先启动RethinkDB：

bash
docker run -d --name rethinkdb -p 28015:28015 rethinkdb

启动STF服务（开发环境）：

bash
docker run -it --rm \
  --link rethinkdb:rethinkdb \
  -p 7100:7100 \
  -p 7101:7101 \
  -p 7102:7102 \
  openstf/stf stf local --public-ip <your-ip> --rethinkdb-host rethinkdb

访问http://<your-ip>:7100即可使用STF，默认管理员账户：

• 用户名：administrator
• ***：administrator@fakedomain.com

Docker Compose配置示例

yaml
version: '3'
services:
  rethinkdb:
    image: rethinkdb
    ports:
      - "28015:28015"
    volumes:
      - rethinkdb_data:/data/rethinkdb

  stf:
    image: openstf/stf
    depends_on:
      - rethinkdb
    ports:
      - "7100:7100"
      - "7101:7101"
      - "7102:7102"
    environment:
      - STF_ROOT_GROUP_NAME=Common
      - STF_ADMIN_NAME=admin
      - STF_ADMIN_EMAIL=admin@example.com
    command: stf local --public-ip <your-ip> --rethinkdb-host rethinkdb

volumes:
  rethinkdb_data:

配置参数与环境变量

注意事项

• 安全性：进程间通信未加密，设备使用后不会完全重置，敏感环境需谨慎部署
• 硬件依赖：推荐使用稳定的USB hub和供电，避免设备连接不稳定
• 更新：开发版本需拉取代码后重新执行npm install
• 故障排除：设备未显示时，检查USB调试是否开启、ADB授权、供电及USB连接状态

卸载设备端组件

bash
# 卸载STFService
adb uninstall jp.co.cyberagent.stf

# 移除支持二进制文件
adb shell rm /data/local/tmp/minicap \
  /data/local/tmp/minicap.so \
  /data/local/tmp/minitouch \
  /data/local/tmp/minirev