接口自动化方案之Httprunner

1、接口自动化平台要求

• 接口用例方便编写且灵活

• 支持数据驱动

• 支持接口文档管理

• 支持UI用例管理

• 支持管理自动化用例

• 代码要求：Python

• 支持定时

• 支持持续集成

• 平台及脚本易维护

• 支持可视化报告

• 兼容pytest框架

• 支持性能测试

• 易推行到全组测试人员

2、Httprunner介绍

• 一款专门做接口测试的主流框架，用例可以通过Fiddler/Charles等抓包工具形成，支持Yaml数据驱动

3、Httprunner（3.x)都有哪些核心功能呢？

• 集成了requests库强大功能，在处理https请求上更加优雅人性化

• 提供了yaml，json的case编写格式，并以pytest方式，更编译和优雅的运行（比较方便的编辑转换后python语言的测试case）

• 利用har的优势，方便的录制和导出并生成测试case

• 提供了一些列的机制支持一些复杂的测试场景

• 通过debugtalk.py插件支持自定义函数的编写

• 通过jmespath，方便对返回的json进行校验

• 通过pytest的强大插件生态补充了Httprunner的功能

• 通过allure，让测试报告更加美观，可读性更强

• 通过和locust的结合，很方便利用Httprunner进行接口的性能测试

• Httprunner以命令行方式运行，也更方便接入CI/CD

4、Httprunner具体实现步骤

4.1 录制用例

• 打开代理工具Charles，操作一遍测试的接口

  6HLUsA.png
• 导出.har格式抓包结果 6HLgMj.png
• 通过工具自带命令har2case导出成yml或者json文件（用例） 6HOFOA.png 6HONfU.png

• 通过命令工具hrun执行yml文件，直接输出测试结果，同时输出Python代码

  6HOdl4.png

4.2 修改断言

• 如下图： 6bkuVS.png

4.3 数据驱动

• 在 YAML/JSON 中直接指定参数列表，如["password1", "password2", "password3"]：该种方式最为简单易用，适合参数列表比较小的情况

• 通过parameterize（可简写为P）函数引用 CSV文件，如${parameterize(account.csv)}，该种方式需要准备 CSV数据文件，适合数据量比较大的情况

  • CSV文件中的第一行必须为参数名称，从第二行开始为参数值，每个（组）值占一行

  • 若同一个 CSV 文件中具有多个参数，则参数名称和数值的间隔符需实用英文逗号

    6bAiZT.png

• 调用 debugtalk.py 中自定义的函数生成参数列表，如${gen_app_version()}，该种方式最为灵活，可通过自定义 Python 函数实现任意场景的数据驱动机制，当需要动态生成参数列表时也需要选择该种方式

4.4 场景类用例使用分层机制（接口-模块-场景）

• 项目 - 接口描述（api）- 测试模块（suite）- 测试场景（testcases）

• 项目下，通过 api 描述接口，一个 api 可包括一个或多个接口，可在 api 下合理规划实现项目模块概念的管理

• 一个测试用例中由 config 和多个 test 组成，config 传输参数值（数据量大时可传递csv），test 调用 api 实现一个测试步骤，多个 test 实现一个功能或者场景的测试过程

• 通过人为的管理 suite 和 testcases 两部分，将常用的功能小模块放进 suite 中管理，将多个独立的业务场景测试模块放进 testcases 中管理

  • 实现接口的分层定义描述后，我们就可以避免接口的重复定义

    6bU0Fe.png

  • 接口模块封装：如上图所示，场景A和场景C都包含了注册新账号（API_1/2）和查看登录状态（API_6），场景A和场景B都包含了登录已有账号（API_3/4/5），场景B和场景C都包含了注销登录（API_7/8）

    6bdn5F.png

  • 我们也可以将系统的常用功能封装为模块（suite），只需要在模块中定义一次，然后就可以在测试场景中重复进行引用，从而避免了模块功能的重复描述

    图片 图片

  • 脚手架工具：在 HttpRunner 中实现了一个脚手架工具，可以快速创建项目的目录结构。该想法来源于 Django 的 django-admin.py startproject project_name，使用方式也与 Django 类似，只需要通过 --startproject 指定新项目的名称即可

    6bqbT0.png

4.5 jenkins、github、gitlab实现集成

• jenkins通过git拉取代码

  6by76g.png

• 支持多种定时构建方式，如按每天、每天的几点等等，也可以使用github、gitlab触发，如github/gitlab收到push代码后，jenkins会收到通知，然后自动去执行自动化任务

  6bWy1P.png

• 执行指令

  6bfFBD.png

• 测试报告

  6bfGNj.png

• 钉钉推送

  6bf0DU.png 6bfg81.png

4.6 输出报告

• html report 6b4mOf.png
• allure report 6bhPGn.png

5、HttprunnerManager

• 项目管理：新增项目、列表展示及相关操作，支持用例批量上传(标准化的HttpRunner json和yaml用例脚本)

• 模块管理：为项目新增模块，用例和配置都归属于module，module和project支持同步和异步方式

• 用例管理：分为添加config与test子功能，config定义全部变量和request等相关信息 request可以为公共参数和请求头，也可定义全部变量

• 场景管理：可以动态加载可引用的用例，跨项目、跨模快，依赖用例列表支持拖拽排序和删除

• 运行方式：可单个test，单个module，单个project，也可选择多个批量运行，支持自定义测试计划，运行时可以灵活选择配置和环境，

• 分布执行：单个用例和批量执行结果会直接在前端展示，模块和项目执行可选择为同步或者异步方式，

• 环境管理：可添加运行环境，运行用例时可以一键切换环境

• 报告查看：所有异步执行的用例均可在线查看报告，可自主命名，为空默认时间戳保存，

• 定时任务：可设置定时任务，遵循crontab表达式，可在线开启、关闭，完毕后支持邮件通知

• 持续集成：jenkins对接

6、HttprunnerManager流程说明

• 登录后首先选择新增一个项目，录入一些基本信息 图片
• 用例或者配置信息是属于模块的，所以为刚才添加的项目添加子模块，默认只有一级子模块 图片
• 添加完毕后我们可以看到项目列表或者模块列表相关信息，可以看到下属一个子模块，用例配置都为 0 图片
• 平台已经支持环境管理，当前这一步不是必须的，接口 url 建议只写地址，host 和 port 单独写在环境里面比较好 图片

• 接下来就是添加用例或者配置,注意：用例里的 variables 支持定义变量，在当前 test 有效，也就是说 request 的请求数据，headers，validate 都可以 (fun()) 方式引用，config 可以录入接口的基本请求参数和 headers，只需在用例的 include 引入就好

  图片 图片 图片 图片
• 配置或者用例添加好后可以在列表查看，可以单个用例或者用例批量运行，同步方式 图片
• 也可以按照模块或者项目单个或者批量形式，默认异步执行 图片
• 支持添加定时任务，crotnab表达式，注意模块为空就是整个项目为维度，当然也支持模块级的定时任务 图片
• 任务可以在线查看，可以开启或者关闭删除等，但是不支持二次编辑，如果信息错误必须删除重新添加 图片
• 所有异步执行的或者定时任务报告都会存储在数据库，可在线查看 图片
• 任务执行状态可在线查看，实时监控，需要自己更改 base.html 任务监控 a 标签的 url 地址，为 flower 服务 ip 地址即可 图片
• 需二次修改，需支持内置函数页，可自行创建属于自己的 py 文件，写入属于自己的业务函数，方便自己负责的项目的接口信息的调用等等 图片
• 需二次修改，需支持类似Eolinker关于管理接口文档的部分 6bomOx.png

7、人员分工大致安排

• 第一步，用例是通过抓包获取的，所以对url、请求参数及数据类型、返回参数及数据类型要求高，不能出现不规范或者不统一，所以需要统一一个人对接，确认无误后发给编写自动化用例的测试人员，测试人员进行用例组织，如csv、内部函数调用等

• 第二步，参与编写的测试人员需根据模块去讨论该模块中哪些模块（如登录成功后添加商品）、接口出现重复调用，先进行规范的封装

• 第三步，将封装的单个接口、模块进行场景组织，如：登录--添加商品--添加采购单

• 第四步，进行集成和输出报告

8、后期人员培训

• 导入到可以使用httprunnerManager直接操作（类似postman）

• 可以使用httprunner录制（抓包--转yaml--修改断言等）脚本，导入到httprunnerManager

• 参与脚本录制及代码编写