pytest+yml+allure实现接口自动化框架

​ # 一、源码： github地址： https://github.com/18713341733/ApiFrame 或者可以下载 csdn ： 框架基本搭建完成了，这是最终版。有疑问需要交流的可以+v。 # 二、 实现功能 1、yml管理case 。在yml文件中编辑case 2、get 请求、post 请求 及返回结果的断言 3、与mysql数据库的交互封装 3、数据的传递与依赖： a、实现了单例模式的全局字典，随时可以从字典中取数据、存数据 # 三、框架介绍 ## 3.1 case编写 用户编写case时，需要写两个地方。 1、/data/ 下，yml文件，编写case所需数据 2、/test_case/下，编写case ## 3.2 登录信息维护 大部分的接口，请求，都需要带有token信息。登录信息的维护 登录账号维护：config/user.yml 账号登录并提取登录状态的请求：common/get_login_info.py ## 3.3 数据库信息维护 数据库配置信息：config/db.yml 封装数据库逻辑： 1、pytest 在启动项目时，先与mysql数据库建立连接，拿到conn信息。 在pytest 在项目结束时，关闭数据库连接。 test_case/conftest.py ```commandline # 在执行项目代码之前，最先执行这个方法。autouse=True @pytest.fixture(scope="session", autouse=True) def setup(): # TODO 在执行项目代码之前，最先执行这个方法 print("启动建立数据库连接") # 测试项目资讯平台数据库连接 baidu_manager_conn = get_baidu_manage_db_conn() print("===========开始执行项目===============") yield baidu_manager_conn print("关闭数据库连接") baidu_manager_conn.close() ``` ## 3.4 变量值的来源 来源一： 全局大字典，通过get_value,set_value 方法，保存值，取值 来源二： yml文件中的dependence（前置模块）、teardown(后置模块）   ## 3.5 yml文件格式 对象，map(属性和值) （键值对） ```commandline user: userName: "xiaoming" boss: true birth: 2022/07/13 age: 20 ``` 行内写法: ```commandline user:{userName: "小明",boss: true,birth: 2022/07/13,age: 20} ``` # 四、yml中编写case ## 4.1 注意事项 1、yml文件，是通过缩进表示层级关系的，所在xxx.yml文件中，编写case时，一定要注意缩进。 2、每个yaml文件是一个模块 3、每个模块下，编写case时。一定要保证 case 名称与接口名称一致。 ## 4.2 yml中case讲解 ```commandline /api/abc/abc/abc/page: - name: "获取接口统一鉴权token" request: method: post url: /api/abcf/abc/abc/page headers: Content-Type: application/json datas: username: miaojiang password: 123456 assertion: - - expectation: "'data':" - compare: "in" - ctual_value: - - expectation: "1" - compare: "=" - ctual_value: "$.data.id" ``` 1、yml中接口名称（/api/abc/abc/abc/page），必须与 接口文档中的接口名称保持一致 2、name 为当前case的名称 3、reqeust 填写请求需要的信息。 4、assertion: 断言 最少要有1个断言。上述代码中有2个断言。 expectation 为用户的期望值 compare 比较方式 ctual_value 为实际值。为空时，实际值取的整个response返回值。 想取具体某个字段时，需要使用jsonpath语法。 python中jsonpath的用法_python jsonpath_keer丶的博客-CSDN博客 jsonpath语法 在当前项目example中也有示例。 ### 4.2.1 传参编写 1、传参为空 datas 后面为空就可以了 Content-Type: application/json datas: assertion: 2、传参为josn，写法一 datas 后面直接跟一个字典。这个字典只能写一行。 headers: Content-Type: application/json datas: {"username":"miaojiang","password":"123456","code":"1111"} assertion: 2、传参为josn，写法二 参数为key value的形式。 datas: username: miaojiang password: 123456 assertion: ### 4.2.2 headers编写 后台中，很多接口，都需要一个登录信息的鉴权。 是通过header里的 Authorization 进行鉴权的。 当case需要有这个信息时，在yml里的headers中可以写Authorization，也可以不写这个字段。 框架中，鉴权信息不是通过 headr控制的，是通过 编写case时，传参get_authorization控制的，如 def test_get_info(self,test_data:dict,get_authorization): ### 4.2.3 断言编写 代码如下： assertion: - - expectation: "操作成功" - compare: "in" - ctual_value: - - expectation: "admin" - compare: "=" - ctual_value: "$.data.user.name" 1、支持多个断言 2、断言逻辑是，拿着期望值 expectation 与 实际值 ctual_value 做比较 3、ctual_value:为空时，表示实际值是整个接口返回值response 4、当实际值，想具体取接口返回值中的某一个字段时，使用jsonpath的写法。 如整个返回值为 ```commandline { 'code': 200, 'msg': '操作成功', 'data': { 'user': { 'name': 'miaojiang', 'createTime': '2022-04-25 13:53:01', 'update': None, ``` 想要对比的实际值为data下，user 下的 name 字段。 写法为： ```commandline - ctual_value: "$.data.user.name" ``` 5、 比较方式 compare in 表示 期望值 在 实际值里面。 ```commandline > 期望值 大于 实际值 < 期望值，小于 实际值 ``` # 五、py文件中case编写 类名，与方法名，必须以test_开头。 case 需要登录鉴权信息时，需要传入 get_authorization，如 def test_get_info(self,test_data:dict,get_authorization): # 六、case中依赖数据的处理 ##6.1 编写的接口，依赖另一个接口的数据，处理。在yml文件中，写被依赖的接口数据 举个例子。 ```commandline /goods/getgoods: - name: "演示：获取商品信息" request: method: post url: /api/abc/goods/getGoods headers: Content-Type: application/json datas: {"id": $id} assertion: - - expectation: "成功" - compare: "in" - ctual_value: dependence: request: method: post uri: /api/abc/goods/queryGoodsList headers: Content-Type: application/json datas: {"Platform":"","pageNum":1,"pageSize":10} expectation: id: $.data.list[:1].id ``` 查询商品详情：/goods/getGoods: url: /api/abc/goods/getGoods 需要传一个good id, 但是这个id 不能写死。 我先去获取 商品列表，queryGoodsList ,取第一个商品的 id,将这个id 传给查看 商品详情的接口。 在 getGoods 接口中，传参 id,写不写无所谓。怎么写都行。 重点在于dependence.expectation的取值。 id: $.data.list[:1].id key：value key 为 getGoods 接口中，传参datas 中的key， value ,取值，为依赖接口queryGoodsList 返回值中的，需要的字段取值 用的jsonpath语法 注意： 1、yml中，有依赖的场景再添加dependence， 没有依赖，就不需要添加 dependence 数据 2、dependence 中的uri，如果host 与主接口的host一致，就可以直接写uri，不用写host, http://xxx.xx.xx 如果依赖的接口host，与主接口的host不一致，则需要在dependence 中的uri 中，写全url的路径。 ## 6.2 将依赖的数据进行参数化，从全局变量的字典中取值。 比如，修改商品 的 接口，这个商品的id，不能是写死的，是一个参数化的东西。 第一步： 我在yml文件中，写商品的id 时， 使用 ${id} 的形式。 方式一：datas所有数据写一行 datas: {"id": "${id}","status":"0"} 方式二：datas数据写多行 datas: Platform: "abc" id: "${id}" imgUrl: "http://t" 或者 datas: Platform: "abc" id: ${id} imgUrl