youqu/README.md

7.8 KiB
Raw Blame History

YouQu

YouQu有趣一个使用简单且功能强大的自动化测试基础框架。

GitHub issues GitHub pull requests GitHub Discussions

PyPI PyPI - License PyPI - Python Version Static Badge

Downloads Downloads Downloads Hits


GitHub | Gitee

在线文档


YouQu有趣是深度公司开源的一个用于 Linux 操作系统的自动化测试框架,支持多元化元素定位和断言、用例标签化管理和执行、强大的日志和报告输出等特色功能,同时完美兼容 X11、Wayland 显示协议,环境部署简单,操作易上手。

YouQu有趣能做什么

  • Linux 桌面应用 UI 自动化测试
  • Linux 桌面应用 DBus/Gsettings 接口自动化测试
  • 命令行自动化测试
  • HTTP 接口自动化测试
  • Web UI 自动化测试
  • Linux 桌面应用性能自动化测试
点击查看爱上 “有趣YouQu” 的 N 个理由
  • 无处不在的代码补全,让编写自动化测试用例成为一种享受;
  • 核心库提供了统一的接口,编写方法时只需要导入一个包就可以使用到核心库提供的所有功能;
  • 除了常用的属性定位、图像识别以外,我们还提供基于 UI 的元素定位方案,其使用简单且高效,效果一定能惊讶到你;
  • 对属性定位的方法进行了二次封装,将编写属性定位的方法变得简单而优雅;
  • 对图像识别定位技术进行功能升级,除了支持单个坐标返回,还支持同一界面下多个相同元素返回多个坐标的功能;
  • 提供用例标签化管理、批量跳过和批量条件跳过的功能,你想不到一个 csv 文件原来能干这么多事情;
  • 提供了功能强大的执行器入口,让你可以方便的在本地执行任何用例集的用例,其丰富的自定义配置项,满足你对执行器所有的幻想;
  • 提供远程执行的功能,可以控制多台机器并行跑,或者分布式跑,这种付费功能现在免费给你用;
  • 提供自动输出日志的功能,你再也不用为每个方法单独写输出日志的代码,一切我们给你搞定了,日志输出不仅内容丰富,颜值也绝对在线,我们还自己设计了一款终端输出主题叫《五彩斑斓的黑》;
  • 提供一键部署自动化测试环境的功能,让你再也不用为环境部署而烦恼;
  • 提供自动生成多种报告的功能,你想输出什么报告形式都行,而且我们在报告中还加入了失败录屏和失败截图的功能;
  • 对断言进行了二次封装,提供更友好化的错误提示,让定位问题精准高效;
  • 不仅支持单条用例超时控制,而且还支持动态控制用例批量执行的总时间,确保 CI 环境下能顺畅运行;
  • 支持本地文件测试套执行、PMS 测试套执行、标签化执行方案,满足你各种场景下的执行需求;
  • 支持基于深度学习的 OCR 功能,可定位可断言,中文识别的天花板;
  • 完美兼容 Wayland 和 X11真正做到一套代码随处执行
  • 支持多种方式的数据回填功能,其中异步回填的方案,完美解决了数据回填的耗时问题;
  • 支持重启交互场景用例的执行,使用方法优雅简洁;

安装

从 PyPI 安装:

$ sudo pip3 install youqu
不加 sudo
其实不加 `sudo` 也是可以的:
pip3 install youqu
但某些情况下可能出现 youqu-startproject 命令无法使用,这是因为不加 sudo 时,安装包路径是在 $HOME/.local/lib/pythonX.X/site-packages而此路径可能不在环境变量PATH您可以通过添加环境变量的方式使用 youqu-startproject 命令:
export PATH=$PATH:$HOME/.local/lib/pythonX.X/site-packages

创建项目

您可以在任意目录下,使用 youqu-startproject 命令创建一个项目:

$ youqu-startproject my_project

如果 youqu-startproject 后面不加参数,默认的项目名称为:youqu

安装依赖

安装部署 YouQu 执行所需环境:

$ cd my_project
$ bash env.sh

创建 APP 工程

使用 startapp 命令自动创建 APP 工程:

$ youqu manage.py startapp autotest_deepin_some

自动创建的 APP 工程遵循完整的 PO 设计模式,让你可以专注于用例和方法的编写维护。

apps 目录下会自动创建一个 APP 工程:autotest_deepin_some,同时新建好工程模板目录和模板文件:

my_project
├── apps
│   ├── autotest_deepin_some  # <----- APP 工程
...     ├── ...

在你的远程 Git 仓库中,只需要保存 APP 工程这部分代码即可。

autotest_deepin_some 是你的 APP 工程名称,在此基础上,你可以快速的开始你的 AT 项目,更重要的是确保创建工程的规范性。

apps 目录下可以存在任意多个 APP 工程。

运行

1. 执行管理器

在项目根目录下有一个 manage.py ,它是一个执行器入口,提供了本地执行、远程执行等的功能。

2. 本地执行

$ youqu manage.py run

2.1. 命令行参数

在一些 CI 环境下使用命令行参数会更加方便:

$ youqu manage.py run -a apps/autotest_deepin_some -k "xxx" -t "yyy"

更多用法可以使用 -h--help 查看。

2.2. 配置文件

通过配置文件配置参数

在配置文件 setting/globalconfig.ini 里面支持配置对执行的一些参数进行配置。

3. 远程执行

远程执行就是用本地作为服务端控制远程机器执行,远程机器执行的用例相同。

使用 remote 命令:

$ youqu manage.py remote

贡献

贡献文档

开源许可证

YouQu 在 GPL-2.0 下发布。