parent
1fca451cbd
commit
befd35ac21
55
README.md
55
README.md
|
@ -27,11 +27,13 @@
|
|||
|
||||
**欢迎加入 [YouQu官方兴趣小组](https://youqu.uniontech.com/SIG.html)**
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
YouQu(有趣)是统信公司(Deepin/UOS)开源的一个 Linux 操作系统的自动化测试框架,支持多元化元素定位和断言、用例标签化管理和执行、强大的日志和报告输出等特色功能,同时完美兼容 X11、Wayland 显示协议,环境部署简单,操作易上手。🔥
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">YouQu(有趣)能做什么</h2>
|
||||
## [YouQu(有趣)能做什么]()
|
||||
|
||||
- [x] 💻 Linux 桌面应用 UI 自动化测试
|
||||
- [x] 🌏 Web UI 自动化测试
|
||||
|
@ -41,7 +43,7 @@ YouQu(有趣)是统信公司(Deepin/UOS)开源的一个 Linux 操作系
|
|||
- [ ] ⏲️ Linux 桌面应用性能自动化测试
|
||||
- [ ] 💥 Fuzzy Desktop 桌面模糊测试
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">安装</h2>
|
||||
## [安装]()
|
||||
|
||||
从 PyPI 安装:
|
||||
|
||||
|
@ -51,16 +53,27 @@ $ sudo pip3 install youqu
|
|||
```
|
||||
|
||||
<details>
|
||||
<summary style="color: #FF9933">不加 sudo ?</summary>
|
||||
<pre>
|
||||
其实不加 sudo 也是可以的:<br>
|
||||
pip3 install youqu<br>
|
||||
但某些情况下可能出现 youqu-startproject 命令无法使用,这是因为不加 sudo 时,安装包路径是在 $HOME/.local/lib/pythonX.X/site-packages,而此路径可能不在环境变量(PATH)中,您可以通过添加环境变量的方式使用 youqu-startproject 命令:<br>
|
||||
export PATH=$PATH:$HOME/.local/lib/pythonX.X/site-packages<br>
|
||||
</pre>
|
||||
<summary><b>不加 sudo ?</b></summary>
|
||||
不加 sudo 也是可以的:
|
||||
|
||||
```shell
|
||||
pip3 install youqu
|
||||
```
|
||||
|
||||
但某些情况下可能出现 youqu-startproject 命令无法使用;
|
||||
|
||||
这是因为不加 sudo 时,安装包路径是在 $HOME/.local/lib/pythonX.X/site-packages;
|
||||
|
||||
而此路径可能不在环境变量(PATH)中,您可以通过添加环境变量的方式使用 youqu-startproject 命令:
|
||||
|
||||
```shell
|
||||
export PATH=$PATH:$HOME/.local/lib/pythonX.X/site-packages
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">创建项目</h2>
|
||||
|
||||
## [创建项目]()
|
||||
|
||||
您可以在任意目录下,使用 `youqu-startproject` 命令创建一个项目:
|
||||
|
||||
|
@ -74,7 +87,7 @@ $ youqu-startproject my_project
|
|||
|
||||
![](./docs/assets/install.gif)
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">安装依赖</h2>
|
||||
## [安装依赖]()
|
||||
|
||||
安装部署 YouQu 执行所需环境:
|
||||
|
||||
|
@ -83,7 +96,7 @@ $ cd my_project
|
|||
$ bash env.sh
|
||||
```
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">创建 APP 工程</h2>
|
||||
## [创建 APP 工程]()
|
||||
|
||||
使用 `startapp` 命令自动创建 APP 工程:
|
||||
|
||||
|
@ -108,20 +121,21 @@ my_project
|
|||
|
||||
`apps` 目录下可以存在任意多个 APP 工程。
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">运行</h2>
|
||||
[运行]()
|
||||
-------
|
||||
|
||||
<h3 style="color: #0969DA;font-family: 黑体;">1. 执行管理器</h3>
|
||||
### [1. 执行管理器]()
|
||||
|
||||
在项目根目录下有一个 `manage.py` ,它是一个执行器入口,提供了本地执行、远程执行等的功能。
|
||||
|
||||
<h3 style="color: #0969DA;font-family: 黑体;">2. 本地执行</h3>
|
||||
### [2. 本地执行]()
|
||||
|
||||
|
||||
```shell
|
||||
$ youqu manage.py run
|
||||
```
|
||||
|
||||
<h4 style="color: #0969DA;font-family: 黑体;">2.1. 命令行参数</h4>
|
||||
#### [2.1. 命令行参数]()
|
||||
|
||||
在一些 CI 环境下使用命令行参数会更加方便:
|
||||
|
||||
|
@ -132,13 +146,13 @@ $ youqu manage.py run -a apps/autotest_deepin_some -k "xxx" -t "yyy"
|
|||
|
||||
更多用法可以使用 `-h` 或 `--help` 查看。
|
||||
|
||||
<h4 style="color: #0969DA;font-family: 黑体;">2.2. 配置文件</h4>
|
||||
#### [2.2. 配置文件]()
|
||||
|
||||
通过配置文件配置参数
|
||||
|
||||
在配置文件 [setting/globalconfig.ini](https://github.com/linuxdeepin/youqu/blob/master/setting/globalconfig.ini) 里面支持配置对执行的一些参数进行配置。
|
||||
|
||||
<h3 style="color: #0969DA;font-family: 黑体;">3. 远程执行</h3>
|
||||
### [3. 远程执行]()
|
||||
|
||||
远程执行就是用本地作为服务端控制远程机器执行,远程机器执行的用例相同。
|
||||
|
||||
|
@ -149,10 +163,11 @@ $ youqu manage.py run -a apps/autotest_deepin_some -k "xxx" -t "yyy"
|
|||
$ youqu manage.py remote
|
||||
```
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">贡献</h2>
|
||||
## [贡献]()
|
||||
|
||||
[贡献文档](https://github.com/linuxdeepin/youqu/blob/master/CONTRIBUTING.md)
|
||||
|
||||
<h2 style="color: #0969DA;font-family: 黑体;">开源许可证</h2>
|
||||
|
||||
## [开源许可证]()
|
||||
|
||||
YouQu 在 [GPL-2.0](https://github.com/linuxdeepin/youqu/blob/master/LICENSE) 下发布。
|
||||
|
|
Loading…
Reference in New Issue