update README.md.

This commit is contained in:
guozg 2021-01-02 11:59:52 +08:00 committed by Gitee
parent aa053e46fc
commit 34f8772222
1 changed files with 52 additions and 42 deletions

View File

@ -1,15 +1,20 @@
# pytest_ui_api_fw # pytest_ui_api_fw
#### 介绍 #### 介绍
1该框架是基于pyest、requests、python3 写的一个 api接口自动化测试框架后期会将 接入ui自动化。该接口自动化框架的思想与 ui 自动化测试框架的思想一致使用po模式分为page业务层、case数据层以及base层。
2该框架的数据源为yml文件上手有一定的难度。该框架在后期维护的时候非常方便只需要简单的维护yml文件即可。 1. 该框架是基于pyest、requests、python3 写的一个 api接口自动化测试框架后期会将 接入ui自动化。该接口自动化框架的思想与 ui 自动化测试框架的思想一致使用po模式分为page业务层、case数据层以及base层。
3最后的报告是使用allure 2. 该框架的数据源为yml文件上手有一定的难度。该框架在后期维护的时候非常方便只需要简单的维护yml文件即可。
4本框架已在本公司深度使用通过jenkins持续集成每天会定时执行向测试小组发送执行结果也会不定期的巡检公司生产环境的功能等。 3. 最后的报告是使用allure
5该框架后期还会有多个分支版本这些多分支版本均是来优化和提升执行效率的。 4. 本框架已在本公司深度使用通过jenkins持续集成每天会定时执行向测试小组发送执行结果也会不定期的巡检公司生产环境的功能等。
6由于本人能力有限该框架里会存在着bug也是在所难免的。 5. 该框架后期还会有多个分支版本,这些多分支版本均是来优化和提升执行效率的。
6. 该框架目前支持接口数据的依赖,无论是响应结果的数据依赖,还是请求参数值的依赖,均支持。
7. 该框架支持token依赖由于公司的业务很复杂角色及流程分支我所以在实现框架的时候token的依赖可以每个case有单独的登录获取token也可以每个class下使用一个账号登录获取token。所以在使用这块时有点绕没法像一些互联网公司那样简单明了。
8. 在进行断言的时候,本框架只支持 pytest.assume() 和 hamcrest().断言表达式里有可能使用到jsonpath的语法所以对使用者的要求较高。当时可以自己下载本框架进行修改。
9. 由于本人能力有限该框架里会存在着bug也是在所难免的。
#### 软件架构 #### 软件架构
软件架构说明
#### 安装教程 #### 安装教程
@ -20,9 +25,14 @@
#### 使用说明 #### 使用说明
1. xxxx 1. 使用的时候需要维护三个yml文件。分别为config.yml在config目录下page业务层和case数据层 对应的yml文件如下图所示
2. xxxx ![输入图片说明](https://images.gitee.com/uploads/images/2021/0102/113659_4b263340_7622878.png "屏幕截图.png")
3. xxxx 2. config.yml 为总开关如控制着运行环境的切换等。如我们的环境分别测试环境、测试公网环境以及生产环境。在切换环境的时候只需要更改host的值即可。
![输入图片说明](https://images.gitee.com/uploads/images/2021/0102/114118_cff68aa4_7622878.png "屏幕截图.png")
3. 使用的时候,需要更改登录的参数。
![输入图片说明](https://images.gitee.com/uploads/images/2021/0102/115640_f06181a7_7622878.png "屏幕截图.png")
4. 断言表达式里有时候会使用到jsonpath表达式不会的同学需要自己补习一下。
![输入图片说明](https://images.gitee.com/uploads/images/2021/0102/115905_1a7bdb8e_7622878.png "屏幕截图.png")
#### 参与贡献 #### 参与贡献