AutomatorX (atx) (中文版)

简介

该项目是为了让手机应用的一些常规测试可以自动化起来，让测试人员摆脱那些枯燥的重复性工作。基于OpenCV的图像识别技术，有点类似于SikuliX(这东西挺好用的，只是没说要支持手机端)

This project is to make mobile test automated, free people from the boring of repeated job. AutomatorX is a python library base on python-opencv and a lot of outstanding python libs.

ATX is short for AutomatorX

If you are new to atx, it better to start from Quick start tutorial or just view API documentation link

Features

完全的黑盒测试框架，无需知道项目代码，非侵入式
支持iOS, Android，模拟器的自动化测试，两个平台都支持测试第三方应用
使用图像识别完成游戏的自动化
支持WebView（Android）
脚本编辑器用于快速的写脚本
漂亮的测试报告
可以用来测试Windows应用 (这部分没有文档)

Discuss (讨论群)

面向游戏行业测试人员，当然也开放给国际友人(PS：中文不知道他们看得懂不)

Gitter Chat Room
QQ: 497460177 PS: 因为我们公司上不了QQ, 所以不会经常上
网易内部用户目前请直接联系 hzsunshx 或加群 1347390

限制

Python版本限制 >= 2.7 && <= 3.5
Android 4.1+
iOS 9.0+
iOS测试必须要有一个Mac

Installation

安装ATX

最好在virtualenv的环境下安装, 不懂这是啥的可以学习下Andrew_liu写的文章Python--Virtualenv简明教程
```
# virtualenv venv && . venv/bin/activate
pip install --upgrade --pre atx
pip install opencv_contrib_python
```
为了加快下载速度，国内用户可以使用额外的pip参数-i https://pypi.doubanio.com/simple/

装完之后用命令行简单测试下安装是否成功
- python -m atx version 查看atx版本号
- python -m atx doctor 检查环境配置是否正常
Android测试依赖

安装ATX手机助手.apk到手机, 或者手机连接到电脑上用命令行安装 python -m atx install atx-assistant

该App为自动化提供了输入法的功能，屏幕常量等功能
iOS测试依赖

你的iPhone手机需要连接到Mac上，然后Mac安装WebDriverAgent，通常对Xcode部署的人搭WDA的人会遇到不少问题，搞不定继续参考这里 https://testerhome.com/topics/7220

WDA成功启动后，会生成一个用于ATX连接的http地址，比如http://localhost:8100
额外补充的信息
- Win安装
- Mac安装
脚本编辑器

为了方便快速的写出脚本，提供了两个Web编辑器。
- atx-webide 用于写游戏脚本，包括截图，代码编辑
- weditor beta 针对Android和iOS原生应用快速定位元素，自动生成代码

Getting Started （必看）

To get started, it is better to look at the QUICK START
More about the ATX API HERE
iOS的接口文档被放到了testerhome上 https://testerhome.com/topics/7204

There is also a doc for professional users. API ADVANCED

Command Line Tools

There are a lot of command tools along with atx, eg

Screenshot
Screenrecord
Install minicap to android
Apk file parser
Show phone info with JSON
Enable iPhone developer mode

etc... To see the whole list click here

Known Issues

If you are having some issues please checkout wiki first.

为了避免潜在的Python编码问题，代码文件都应该用UTF-8编码格式保存。

对于python2.7 字符串前应该加上u开头，例如u'你好'

文件的开头可以加上下面这段代码，强制使用python3的编码体系(默认全部都是unicode)
```
 from __future__ import unicode_literals
```
对于python3的非windows系统

检查一下sys.stdout.encoding的编码是否是UTF-8，不然中文字符的输出通常会有问题解决办法通常就是在bashrc文件中加入一行
```
 export PYTHONIOENCODING=UTF-8
```

ATX Extentions （扩展功能）

该部分属于atx的扩展插件实现的功能

插件说明

HTML Report

利用此插件可以在ATX自动化跑完之后，自动生成可以HTML报告，详细记录每一步的执行情况

WebView

目前仅限安卓, 具体参考 https://testerhome.com/topics/7232

例子代码

 # coding: utf-8
 import atx
 from atx.ext.chromedriver import ChromeDriver

 d = atx.connect()
 driver = ChromeDriver(d).driver() # return selenium.driver instance
 elem = driver.find_element_by_link_text(u"登录")
 elem.click()
 driver.quit()

PS: 实现这个扩展并不复杂，简单的封装了一下selenium就搞定了

Performance record (For Android)

性能测试直接使用了腾讯开源的GT

PS: 刚写好没多久，你只能在最新的开发版中看到。有可能以后还会修改。

使用方法
1. 首先需要去腾讯GT的主页上，将GT安装到手机上
  
  http://gt.qq.com
2. 代码中引入GT扩展
```
import atx
from atx.ext.gt import GT


d = atx.connect()

gt = GT(d)
gt.start_test('com.netease.my') # start test
# ... do click touch test ...
gt.stop_and_save()
```
3. 运行完测试后，代码会保存到/sdcard/GT/GW/+包名(com.netease.my)目录下，直接使用adb pull下载下来并解析
```
$ adb pull /sdcard/GT/GW/com.netease.my/
```
该部分代码位于 atx/ext/gt.py, 这部分代码目前在我看来，易用性一般般，希望使用者能根据具体情况，进行修改，如果是修改具有通用性，欢迎提交PR，我们会负责Review代码。

代码导读

connect 函数负责根据平台返回相应的类(AndroidDevice or IOSDevice)

图像识别依赖于另一个库 aircv, 虽然这个库还不怎么稳定，也还凑合能用吧

每个平台相关的库都放到了目录 atx/device下，公用的方法在atx/device/device_mixin.py里实现。第三方扩展位于atx/ext目录下。

Articles

让adb install显示进度
Android 屏幕同步和录制工具
安卓手机的快速截图
更多的系列文章 https://testerhome.com/topics/node78

Developer dashboards

Platform Versions, Screen Size, Open GL Version http://developer.android.com/intl/zh-cn/about/dashboards/index.html

Contribution

如何才能让软件变的更好，这其中也一定需要你的参与才行，发现问题去在github提个issue, 一定会有相应的开发人员看到并处理的。文档有错误的话，直接提Issue，或者提PR都可以。由于我平常使用该项目的概率并不怎么高，所有不少问题即使存在我也不会发现，请养成看到问题提Issue的习惯，所有的Issue我都会去处理的，即使当时处理不了，等技术成熟了，我还是会处理。但是如果不提交Issue，说不定我真的会忘掉。

BTW: 有开发能力的也可以先跟开发者讨论下想贡献的内容，并提相应的PR由开发人员审核。

License

This project is under the Apache 2.0 License. See the LICENSE file for the full license text.

android-go/AutomatorX