# ATX(AutomatorX) (中文版)
[![Build Status](https://travis-ci.org/NetEaseGame/ATX.svg?branch=master)](https://travis-ci.org/NetEaseGame/ATX)
[![Documentation Status](https://readthedocs.org/projects/atx/badge/?version=latest)](http://atx.readthedocs.org/en/latest/?badge=latest)
[![PyPI](https://img.shields.io/pypi/v/atx.svg)](https://pypi.python.org/pypi/atx)
[![PyPI](https://img.shields.io/pypi/l/atx.svg)]()
[![Gitter](https://badges.gitter.im/codeskyblue/ATX.svg)](https://gitter.im/codeskyblue/ATX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

## Introduction (简介)
ATX(AutomatorX) 是一款开源的自动化测试工具,支持测试iOS平台和Android平台的原生应用、游戏、Web应用。
使用Python来编写测试用例,混合使用图像识别,控件定位技术来完成游戏的自动化。附加专用的IDE来完成脚本的快速编写。

## Hope (愿景)
希望该项目可以让手机应用测试自动化起来,让测试人员摆脱那些枯燥的重复性工作。

## 重要说明
新版本以采用新的uiautomator2替换到原来的[atx-uiautomator](https://github.com/openatx/atx-uiautomator). 历史版本可以通过Tag查看[tag:1.1.3](https://github.com/NetEaseGame/ATX/tree/1.1.3)
测试安卓应用前,需要先进行init操作

```
python -muiautomator2 init
```

用于安卓和iOS原生应用测试的库已经分离出来,可以单独使用(强烈推荐单独使用,一来依赖少、稳定性高,二来写代码的时候还能自动补全)

1. 对于Android应用的测试,如果不需要用到图像识别,推荐使用这个项目[uiautomator2](https://github.com/openatx/uiautomator2)
1. 对于iOS应用的测试,如果不需要用到图像识别,推荐使用这个项目[facebook-wda](https://github.com/openatx/facebook-wda)

BTW: atx-webide已经不在维护

## Features
- [x] 支持iOS, Android 双平台的原生应用,Web应用和游戏
- [x] 支持通过图像识别来定位元素的位置
- [x] 内置自动生成测试报告的功能
- [x] 网页版的脚本编辑器,来帮助快速的写代码

## Discuss (讨论群)
面向游戏行业测试人员,当然也开放给国际友人(PS:中文不知道他们看得懂不)

- QQ: `499563266` PS: 因为我们公司上不了QQ, 所以不会经常上
- 网易内部用户加Popo群 `1347390` 群主 `hzsunshx`
- [Testerhome社区](https://testerhome.com/topics/node78)
- ~~[Gitter Chat Room](https://gitter.im/codeskyblue/AutomatorX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)~~

## Limitation (限制)
- Python >= 2.7 && <= 3.6
- Android 4.1+
- iOS 9.0+ with Mac
- adb >= 1.0.36

## Installation (安装)
准备Python虚拟环境 [Virtualenv]((http://www.jianshu.com/p/08c657bd34f1))

```bash
pip install virtualenv
virtualenv venv

# Linux or Mac
. venv/bin/activate

# Windows
venv\Scripts\activate.bat
```

安装相关的python库

```bash
# install the lastest version of atx
# If feed too slow use douban pypi mirror: -i https://pypi.doubanio.com/simple/
pip install --upgrade --pre atx

# install opencv dependencies
pip install opencv_contrib_python
```

**Android测试依赖**

- ADB

* [Windows adb安装指南](https://github.com/NetEase/AutomatorX/wiki/Win-Installation)
* Mac上的adb可以通过命令行安装 `brew install android-platform-tools`

- [ATX手机助手.apk](https://o8oookdsx.qnssl.com/atx-assistant-1.0.4.apk)

该App为自动化提供了输入法的功能,屏幕常量等功能
命令行安装 `python -m atx install atx-assistant`

**iOS测试依赖**

- WebDriverAgent

由于WebDriverAgent更新过快,atx的一个依赖库[facebook-wda](https://github.com/openatx/facebook-wda)还跟不上他更新的速度,下载完WDA后,请切换到这个版本

```
git reset --hard a8def24ca67f8a74dd709b899c8ea539c9c488ea
```

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

WDA成功启动后,会生成一个用于ATX连接的http地址,比如`http://localhost:8100`

**检查安装是否成功**

```bash
# 查看atx版本号
python -m atx version
# 检查环境配置是否正常
python -m atx doctor
```

**脚本编辑器**(可选)

为了方便快速的写出脚本,提供了三个Web编辑器。

- 自带GUI

自带的使用Tkinter写的编辑器,只提供截图功能,但是比较稳定,启动方法 `python -m atx gui -s ${SERIAL or WDA_URL}`
使用 `python -m atx gui -h` 可以查看更多的选项

- [weditor](https://github.com/openatx/weditor) __beta__ 针对Android和iOS原生应用快速定位元素,自动生成代码

## Getting Started (必看)
* [快速入门文档](docs/QUICKSTART.md)
* [~~如何使用内置的测试报告功能~~](atx/ext/report/README.md)
* [ATX资料快速索引](https://testerhome.com/topics/9091)
* [Testerhome上的ATX有关的文章列表](https://testerhome.com/topics/node78)

内置的测试报告暂时有点问题,最近没时间去修复了。因为ATX底层使用的[uiautomator2](https://github.com/openatx/uiautomator2),测试报告可以用底层库自带的 [SimpleHTMLReport](https://github.com/openatx/uiautomator2/tree/master/uiautomator2/ext/htmlreport)

## APIs (接口文档)
* [常用接口](docs/API.md)
* [iOS的接口文档](https://testerhome.com/topics/7204)

## Other (其他)
* ATX自带的命令行工具 <https://github.com/NetEase/AutomatorX/wiki/Command-Line-Tools>

## Known Issues (常见问题)
If you are having some issues please checkout [wiki](https://github.com/NetEase/AutomatorX/wiki/Common-Issues) first.

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

- 测试中出现的弹窗如何处理?

《iOS弹窗如何自动处理》,仅供参考 https://testerhome.com/topics/9540

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

文件的开头可以加上下面这段代码,强制使用python3的编码体系(默认全部都是unicode)

```python
from __future__ import unicode_literals
```

- 对于python3的非windows系统

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

```shell
export PYTHONIOENCODING=UTF-8
```

## ATX Extentions (扩展功能)
* WebView

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

例子代码

```python
# 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](http://gt.qq.com/)

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

使用方法

1. 首先需要去腾讯GT的主页上,将GT安装到手机上

<http://gt.qq.com>

2. 代码中引入GT扩展

```python
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](atx/ext/gt.py), 这部分代码目前在我看来,易用性一般般,希望使用者能根据具体情况,进行修改,如果是修改具有通用性,欢迎提交PR,我们会负责Review代码。

## 代码导读
`connect` 函数负责根据平台返回相应的类(`atx.drivers.android.AndroidDevice` or `atx.drivers.ios_webdriveragent.IOSDevice`)

图像识别依赖于另一个库 [aircv](https://github.com/netease/aircv), 虽然这个库还不怎么稳定,也还凑合能用吧

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

## Related projects (相关的项目)
1. 基于opencv的图像识别库 <https://github.com/netease/aircv>
2. 感谢作者 <https://github.com/xiaocong> 提供的uiautomator的python封装,相关项目已经fork到了

- <https://github.com/codeskyblue/android-uiautomator-server>
- <https://github.com/codeskyblue/atx-uiautomator>
3. Android input method <https://github.com/macacajs/android-unicode>
3. SikuliX <http://sikulix-2014.readthedocs.org/en/latest/index.html>
4. Blockly <https://github.com/codeskyblue/blockly>

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

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

## License (协议)
This project is under the Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.

NetEaseGame/ATX 的MD的更多相关文章

  1. atx测试框架实现手机应用UI自动化测试

    最近工作中遇到游戏APP需要实现UI自动化测试,这个app中真的是典型的混合App,有Android原生控件,有webview控件,以及游戏操作页面.研究了Appium,发现appium实现跨应用操作 ...

  2. 【转自Testerhome】iOS 真机如何安装 WebDriverAgent

    开始 尽量升级Xcode到最新版,保持iPhone的版本大于9.3 从github上下载代码 git clone https://github.com/facebook/WebDriverAgent ...

  3. Markdown语言.md文件

    转自:http://www.kuqin.com/shuoit/20141125/343459.html 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是 ...

  4. 原来Github上的README.md文件这么有意思——Markdown语言详解

    转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的REA ...

  5. 【转录】原来Github上的README.md文件这么有意思——Markdown语言详解

    之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有过什么了解.但是在看到别人写的项目的README.md里 ...

  6. Markdown语法学习(Github/git.oschina.net上README.md书写规范)(转)

    晚上在更新git.oschina.net项目时,突然想知道README.md后缀的来源,于是搜了下,发现README.md使用了一种小标记语言Markdown的语法,于是简单的看了一个,特转载如下,为 ...

  7. github README.md教程

    github README.md教程 总结 github中README.md通过特殊字符标记和缩进来达到格式控制,也可以用HTML标签来实现格式控制. 教程一: Markdown 的目标是实现「易读易 ...

  8. github里的readme.md

    在github里如何写readme.md https://www.cnblogs.com/guchunli/p/6371040.html----------------------> READM ...

  9. 好用的Markdown编辑器一览 readme.md 编辑查看

    https://github.com/pandao/editor.md https://pandao.github.io/editor.md/examples/index.html Editor.md ...

随机推荐

  1. angularjs学习访问服务器(5)

    (1) 后台AngularController.java代码 package com.amy.controller; import java.util.ArrayList; import java.u ...

  2. Linux环境下安装myeclipse+破解

    1.下载myeclipse安装包,下载myeclipse破解文件. 2.修改myeclipse-pro-2014-GA-offline-installer-linux.run的权限 sudo chmo ...

  3. MYSQL的随机查询的实现方法

    的确是那么回事. MYSQL的随机抽取实现方法.举个例子,要从tablename表中随机提取一条记录,大家一般的写法就是:SELECT * FROM tablename ORDER BY RAND() ...

  4. JAVA中集合转数组遍历

    JAVA中集合的遍历的一种方法时集合转数组遍历,也是就调用Collection中的toArray(). 代码: public static void main(String[] args) {     ...

  5. 平衡二叉树之AVL树

    AVL树(命名来源于作者姓名,Adelson-Velskii和Landis),即平衡二叉树,满足以下的条件: 1)它的左子树和右子树都是AVL树 2)左子树和右子树的高度差不能超过1 从条件1可能看出 ...

  6. ubuntu 重启显卡报错 nvidia

    1.我装玩显卡以后重启报错了 解决了5个小时才解决,先贴个当时报错的图 第一个图是没有加nomodeset 出先的 当你出现第二个图片的时候证明你离成功不远了 从头开始: 1.开机,出现 ubuntu ...

  7. 快速上手Runtime(四)之动态添加方法

    如果一个类方法非常多,加载类到内存的时候也比较耗费资源,可以使用动态给某个类,添加方法解决.做到优化内存,节省资源的效果. // // Person.m // ResolveInstanceMetho ...

  8. jQuery开发者眼中的AngularJS

    文章来源:http://blog.jobbole.com/76265/ AngualrJS是一个很贴心的web应用框架.它有很不错的官方文档和示例:经过在现实环境中的测试著名的TodoMVC proj ...

  9. CloudStack tomcat集成方式分析

    CloudStack 的server.xml和tomcat6.conf都是软连接   CloudStack 在执行脚本时报异常如下:   修改vim /etc/sudoers文件,具体如下     以 ...

  10. Paradox

    克己博伦 当一个无法阻挡的力量,碰到了一个无法移动的物体?如果这个力量移动了物体,那么这个物体就不是无法移动的.如果这个力量没有移动物体,那么这个无法阻挡的力量就被挡了下来. 上帝能造出一个重到他自己 ...