HttpRunner接口自动化测试框架

HttpRunner

简介

HttpRunner 是一款面向 HTTP(S) 协议的通用测试框架,只需编写维护一份 YAML/JSON 脚本,即可实现自动化测试、性能测试、线上监控、持续集成等多种测试需求。

核心特性

  • 继承 Requests 的全部特性,轻松实现 HTTP(S) 的各种测试需求
  • 测试用例与代码分离,采用YAML/JSON的形式描述测试场景,保障测试用例具备可维护性
  • 测试用例支持分层机制,充分实现测试用例的复用
  • 测试用例支持参数化和数据驱动机制
  • 使用 skip 机制实现对测试用例的分组执行控制
  • 测试请求支持完善的 hook 机制
  • 支持热加载机制,在文本测试用例中轻松实现复杂的动态计算逻辑
  • 基于 HAR 实现接口录制和用例生成功能(har2case)
  • 结合 Locust 框架,无需额外的工作即可实现分布式性能测试
  • 执行方式采用 CLI 调用,可与 Jenkins 等持续集成工具完美结合
  • 测试结果统计报告简洁清晰,附带详尽统计信息和日志记录
  • 具有可扩展性,便于扩展实现 Web 平台化(HttpRunnerManager)

下载安装

使用pip命令进行安装

1
pip install httprunner

安装后校验是否安装成功,可以使用如下命令进行校验

1
2
3
4
5
hrun -V
1.4.2

har2case -V
0.1.8

若版本号正常显示,则说明安装正常。

入门使用

测试场景

用例设计

HttpRunner 的测试用例支持两种文件格式:YAML 和 JSON。这里以YAML为例。

test_httpbin.yml

1
2
3
4
5
6
7
8
9
10
11
12

- config:
name: httpbin api test
request:
base_url: http://www.httpbin.org
- test:
name: get request
request:
url: /get
method: GET
validate:
- eq: [status_code,200]

  • config:作为整个测试用例集的全局配置项
  • test:对应单个测试用例
  • name 这个test的名字
  • request 这个test具体发送http请求的各种信息, 如下:
  • url 请求的路径 (若config中有定义base_url, 则完整路径是用 base_url + url )
  • method 请求方法 POST, GET等等
  • validate 完成请求后, 所要进行的验证内容. 所有验证内容均通过该test才算通过,否则失败.

相关资料

运行测试

使用hrun执行测试,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
C:\Users\Shuqing>hrun D:\api_test\HttpRunner_test\test_httpbin.yml
get request
INFO GET /get
INFO status_code: 200, response_time(ms): 1967.35 ms, response_length: 273 bytes
INFO start to validate.
.

----------------------------------------------------------------------
Ran 1 test in 1.976s

OK
INFO Start to render Html report ...
INFO Generated Html report: C:\Users\Shuqing\reports\1533092144.html

查看测试报告

打开html报告如下:

httprunner-report.png

HttpRunnerManager

简介

HttpRunnerManager是基于HttpRunner的接口自动化测试平台,该工具是对 HttpRunner的包装和Web图形化, 另外还增加了一些新概念(项目/模块)用来组织用例。
如果对yaml语法格式不熟悉,以及对于httprunner命令不熟悉的可以使用该平台执行接口自动化测试。

项目地址:https://github.com/HttpRunner/HttpRunnerManager

核心特性

  • 项目管理:新增项目、列表展示及相关操作,支持用例批量上传(标准化的HttpRunner json和yaml用例脚本)
  • 模块管理:为项目新增模块,用例和配置都归属于module,module和project支持同步和异步方式
  • 用例管理:分为添加config与test子功能,config定义全部变量和request等相关信息 request可以为公共参数和请求头,也可定义全部变量
  • 场景管理:可以动态加载可引用的用例,跨项目、跨模快,依赖用例列表支持拖拽排序和删除
  • 运行方式:可单个test,单个module,单个project,也可选择多个批量运行,支持自定义测试计划,运行时可以灵活选择配置和环境,
  • 分布执行:单个用例和批量执行结果会直接在前端展示,模块和项目执行可选择为同步或者异步方式,
  • 环境管理:可添加运行环境,运行用例时可以一键切换环境
  • 报告查看:所有异步执行的用例均可在线查看报告,可自主命名,为空默认时间戳保存,
  • 定时任务:可设置定时任务,遵循crontab表达式,可在线开启、关闭,完毕后支持邮件通知
  • 持续集成:jenkins对接,开发中。。。

下载安装

  1. 安装mysql数据库服务端(推荐5.7+),并设置为utf-8编码,创建相应HttpRunnerManager数据库,设置好相应用户名、密码,启动mysql。

  2. 将HttpRunnerManager下载下来,解压放在任意盘符位置,例如我放在D盘根目录,并重命名为HttpRunnerManager

环境配置

HttpRunnerManager支持分布式执行,模块和项目执行可选择为同步或者异步方式,因此需要安装相关依赖工具。

erlang

Erlang是一种通用的面向并发的编程语言,它由瑞典电信设备制造商爱立信所辖的CS-Lab开发,目的是创造一种可以应对大规模并发活动的编程语言和运行环境。

下载地址:http://www.erlang.org/downloads

Rabbitmq

RabbitMQ 是一个由 Erlang 语言开发的 AMQP(高级消息队列协议)的开源实现。它支持多个消息传递协议。RabbitMQ可以部署在分布式和联合配置中,以满足高规模、高可用性的需求,另外安装rabbitmq需要先安装erlang

下载地址:http://www.rabbitmq.com/download.html 下载后双击rabbitmq-server-3.7.7.exe文件进行安装。

安装完成后如下图如所示,选中RabbitMQ Service -start 然后以管理员身份运行。

image

可以通过访问 http://localhost:15672 进行测试,默认的登陆账号为:guest,密码为:guest。

image

相关资料:RabbitMQ Windows环境安装官方手册

数据库配置

打开HttpRunnerManager项目的setting.py文件,进行如下配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'HttpRunnerManager', # 新建数据库名
'USER': 'root', # 数据库登录名
'PASSWORD': '', # 数据库登录密码
'HOST': '127.0.0.1', # 数据库所在服务器ip地址
'PORT': '3306', # 监听端口 默认3306即可
}
}
STATICFILES_DIRS = (
os.path.join(BASE_DIR, 'static'), # 静态文件额外目录
)
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'HttpRunnerManager', # 新建数据库名
'USER': 'root', # 数据库登录名
'PASSWORD': '', # 数据库登录密码
'HOST': '127.0.0.1', # 数据库所在服务器ip地址
'PORT': '3306', # 监听端口 默认3306即可
}
}
STATIC_ROOT = os.path.join(BASE_DIR, 'static')

work配置

修改work配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
djcelery.setup_loader()
CELERY_ENABLE_UTC = True
CELERY_TIMEZONE = 'Asia/Shanghai'
BROKER_URL = 'amqp://guest:guest@127.0.0.1:5672//' if DEBUG else 'amqp://guest:guest@127.0.0.1:5672//'
CELERYBEAT_SCHEDULER = 'djcelery.schedulers.DatabaseScheduler'
CELERY_RESULT_BACKEND = 'djcelery.backends.database:DatabaseBackend'
CELERY_ACCEPT_CONTENT = ['application/json']
CELERY_TASK_SERIALIZER = 'json'
CELERY_RESULT_SERIALIZER = 'json'

CELERY_TASK_RESULT_EXPIRES = 7200 # celery任务执行结果的超时时间,
CELERYD_CONCURRENCY = 1 if DEBUG else 10 # celery worker的并发数 也是命令行-c指定的数目 根据服务器配置实际更改 一般25即可
CELERYD_MAX_TASKS_PER_CHILD = 100 # 每个worker执行了多少任务就会死掉,我建议数量可以大一些,比如200


EMAIL_SEND_USERNAME = 'xxxx@163.com' # 定时任务报告发送邮箱,支持163,qq,sina,企业qq邮箱等,注意需要开通smtp服务
EMAIL_SEND_PASSWORD = 'XXX' # 邮箱密码

安装依赖库文件

打开cmd命令窗口,切换到HttpRunnerManager目录,然后执行下面命令,自动安装需要的依赖库文件。

1
pip install -r requirements.txt

数据库迁移

1
2
python manage.py makemigrations ApiManager #生成数据迁移脚本
python manage.py migrate #应用到db生成数据表

创建超级用户,用户后台管理数据库,并按提示输入相应用户名,密码,邮箱。

1
python manage.py createsuperuser

启动服务

输入下面命令启动服务

1
python manage.py runserver

服务启动成功之后,打开如下地址,可以进入到不同的页面。

httprunner-register

httprunner-login

httprunner-admin

注册登录之后就可以看到平台的界面,接下来就可以创建接口测试的项目和用例了。

httprunner-logined.PNG

HttpRunnerManage 入门使用

创建项目

在首页点击左侧菜单栏新增项目,然后输入项目相关信息。我们接下来将会以httpbin里面的接口来进行测试,所以项目名称命名为:httpbin接口测试

httprun-create-project

创建模块

一个项目会一般分为多个功能模块,我们可以创建不同模块,然后基于不同模块创建测试用例。
在左侧菜单选择模块管理 然后点击新增模块,接下来输入模块信息。 这里我们创建一个模块:HTTP_Methods

httprun-create-model

创建环境

在接口测试过程中,我们有时需要设置base_url来提高用例编写执行效率,我们可以在系统设置中的运行环境来创建。例如我们创建一个base_url操作过程如下图所示:

httprun-environment-create

创建用例

这里以下面接口为例创建用例:

1
http://www.httpbin.org/get #请求方式为GET

点击顶部快捷入口新增用例 然后在用例编辑窗口切换到request来编辑用例,操作步骤如下:

httprun-create-testcase

如上图演示所示,用例名称为test_get_request 用例要归属到项目和具体的模块

运行测试

如下图所示,点击用例测试的运行图标,然后选择运行环境即可执行用例,执行完成之后会自动生成测试报告,可以查看运行的结果。

httprun-runcase

以上我们就完成了单个接口的简单测试,接下来我们要进一步完善用例。

用例配置

header设置

如果想自定义header信息,则可以在用例编辑界面点击add headers,然后配置header信息。操作如下图所示:

httprun-add-headers

请求参数

URL参数

在GET请求中,经常会有在URL中的参数,也就是Query String Parameters 比如在用例 test_get_request 增加一个参数 user=51zxw 操作过程如下:

httprun-add-params

body参数

在Post请求中,请求参数一般放在请求体Request body中,HttpRunner支持form-datajson两种数据格式来传递参数。

这里我们的测试接口如下:请求类型为POST

1
http://httpbin.org/post
form-data

首先创建用例名称为test_post_formdata 用例编辑界面Type选择data,然后点击add data按钮,在下面表单中输入参数名称和值即可。操作过程如下:

httprun-formdata

json

传递Json参数与form-data方法类似,选择Type时选Json 创建用例test_post_jsondata操作流程如下:

httprun-jsondata

获取返回结果

HttpRunnerManager提供了extract功能来从返回结果中提取我们需要的内容。例如前面用例test_get_request执行之后返回结果如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"args": {
"user": "51zxw"
},
"headers": {
"Accept": "*/*",
"Accept-Encoding": "gzip, deflate",
"Connection": "close",
"Host": "httpbin.org",
"User-Agent": "python-requests/2.18.4",
"User-Headers": "zxw2018"
},
"origin": "110.52.4.234",
"url": "http://httpbin.org/get?user=51zxw"
}

如果我们想提取user值放在一个变量里面,那么可以使用extract来提取。在用例编辑界面点击extract/validate标签,然后点击add extract按钮,进行如下配置即可:

extract

其中Key的值response_user就是将返回值存储的变量名,content.args.user表示从返回内容中提取args属性中的user值。下一步再断言设置中,我们可以验证是否获取正确。

断言设置

结合前面提取返回值的内容,我们设置断言验证返回的user值是否和我们预期的一样,首先点击add validate 然后可以进行如下设置:

validate

上面的$response_user表示引用我们之前设置的获取返回值的变量,Comparator表示匹配规则,匹配规则有很多可以点击下拉菜单查看 Expected值表示我们的期望值。

执行用例之后,我们可以看到在测试报告中,断言验证是通过的。

validate-report.

当然如果还想添加其他断言规则,就继续点击add validate 例如设置验证响应状态码为200可以进行如下设置

validate-statuscode.PNG

注意:200数值类型为int

用例组合

有时候我们想把一些单个的接口按照指定顺序组合成为一个业务逻辑模块。比如用户模块,把用户注册、用户登录,用户退出几个用例封装成一个业务逻辑模块,从而形成接分层测试。

实践案例:

将之前的三个用例test_get_request,test_post_formdatatest_post_jsondata封装为一个用例test_method_group 然后执行test_method_group。具体操作如下:

testcase-addgroup.gif

从图中我们可以看出新建一个用例test_method_group,然后可以自由添加单个接口用例,并且可以自由调整用例执行顺序,以及删减用例。

注意:新建组装的用例时, 只能选择单请求的用例进行拼接, 不可选择已组装过的用例。例如再新建一个用例,把test_method_group放进去是不行的。
只能选择包含”不包含别的用例的用例”。

测试计划

测试套件

测试套件(test suite)和我们上面讲的组合用例类似,我们可以把单个用例按照业务逻辑进行组合运行,和组合用例不同的是:测试套件可以包含组合用例,但是组合用例不能包含组合用例。
测试套件是对测试用例的更高一层的封装。

实践案例

创建测试用例集suite_test_methods 包含测试用例test_get_request和组合用例test_method_group 然后执行查看结果。
操作过程如下:

set-testsuite

从上图中我们可以看到创建的测试套件成功执行,加载的测试套件也可以任意调整执行顺序。相关的数据配置会自动从用例的配置中读取,无需再单独配置参数。

上面我们选择的是同步执行方式,我们可以选择异步执行方式,可以在后台执行,然后生成测试报告。

run-asyn.PNG

在异步执行之前我们需要先启动支持异步的相关服务:

1.启动RabbitMQ Server

2.进入到HttpRunnerManager目录,启动worker

1
python manage.py celery -A HttpRunnerManager worker --loglevel=info

3.启动任务监控后台

1
celery flower

celery简介

Celery是一个异步任务队列/基于分布式消息传递的作业队列。它侧重于实时操作,但对调度支持也很好。Celery用于生产系统每天处理数以百万计的任务。Celery是用Python编写的,但该协议可以在任何语言实现。它也可以与其他语言通过webhooks实现。

执行完成之后我们可以在【报告管理】——【查看报告】中看到生成的测试报告。

run-asyn-report.PNG

扩展资料:Python 并行分布式框架 Celery

定时任务

测试套件还支持定时任务,这样方便进行回归测试。
定时任务需要启动定时任务监听器,具体如下:

1
python manage.py celery beat --loglevel=info

平台界面设置步骤为:点击菜单栏左侧【测试计划】-【定时任务】 进入到【系统设置】界面,可以进行如下设置:

setting-run-time

上面定时配置 */10 * * * * 表示每10分钟执行一次,使用的是crontab表达式

执行结果如下图所示,可以看到是每隔10分钟执行一次。

report-crontab.PNG

crontab格式

通过crontab 命令,我们可以在固定的间隔时间执行指定的系统指令或 shell script脚本。时间间隔的单位可以是分钟、小时、日、月、周及以上的任意组合。

分 时 日 月 星期

  • 第1列分钟0~59
  • 第2列小时0~23(0表示子夜)
  • 第3列日1~31
  • 第4列月1~12
  • 第5列星期0~7(0和7表示星期天)
crontab设置案例

每隔1分钟执行一次

1
* * * * *

每30分钟运行一次:

1
*/30 * * * *

每隔1小时执行一次

1
* */1 * * *

每周一到周五早上八点运行

1
* 8 * * 1-5

相关资料:crontab表达式

注意

如果遇到如下报错:

1
2
3
D:\HttpRunnerManager>python manage.py celery beat --loglevel=info
celery beat v3.1.26.post2 (Cipater) is starting.
OSError: [WinError 87] 参数错误。

进入到HttpRunnerManager目录,然后删除celerybeat.pid文件,重启命令即可。

配置管理

前面我们用例的各个参数都是配置在各自用例之中的,如果参数有变化则需要打开对应请求用例来修改,当用例数量较多时,这样操作会比较低效。那么该如何有效解决这个问题呢?

使用HttpRunnerManager的配置管理工具就可以比较好的解决这个问题。我们可以将一些公共的变量,参数、方法、请求头信息都存储在一个配置模块中,这样维护和使用就非常便利。

支持的配置类型包括以下几类:

  • Variables 变量类型
  • Parameters 参数类型
  • Hooks 方法类型
  • Request 请求类型

点击菜单栏左侧的配置管理 然后点击新增配置 或者直接顶部新增配置快捷入口,就可以创建配置。
这里演示VariablesParameters配置

variable配置

如下图所示:创建公共变量com_user 值设为zxw2018 操作过程如下:

config-variable

变量创建完成之后,接下来要引用这个公共变量,在用例test_get_requesttest_post_formdata分别添加公共变量com_user,配置如下:

add-config-var

最后开始引用配置,在用例test_method_group中引用该配置,然后运行即可。操作过程如下:

run-configvar

从上图可以看出,我们设置的配置变量已经在用例生效,下次想修改变量值,只需要修改配置就可以了。

注意

当用例1关联了配置(config)1, 用例2关联了配置(config)2 时,
现在新建一个用例3, 将用例1和用例2都组合进用例3中, 并且用例3关联配置(config)3,
此时执行用例3, 配置(config)1 和 配置(config)2 会被使用么?

答案是不会, 执行用例3时, 只有配置(config)3 会被使用. 在执行的过程中, 用例1和用例2所要引用的变量, 都只会去配置(config)3中找。

Parameters配置

对用例中的某些请求参数, 有时想要测试多种输入情况, 可以为每种情况都编写独立的用例或配置. 但是这样会比较麻烦, 另一种方式是将原来的variables变量定义改为Parameters参数列表来定义. 这个列表中定义需要传入的参数. 然后使用这些参数分别执行一次,也就是参数化。

案例1——单个参数设置

针对用例test_get_request 设置参数para_user 分别取值为[‘zxw2016’,'zxw2017','zxw2018']针对这三个不同的参数来进行接口测试。

config-para

配置好之后,接下来点击用例test_get_request 然后添加参数配置,操作如下所示:

run-config-para

从上图我们可以看出,用例遍历执行了我们设定的三个参数。

案例2——多个参数

对于同时存在多个参数列表, 则需要对其排列组合的每一种情况都执行一次,也就是笛卡尔乘积

例如有xxyy两组参数,对应的变量分别如下

1
2
xx : [xxvalue1, xxvalue2]
yy : [yyvalue1, yyvalue2, yyvalue3]

那么最终会按以下六种情况各执行一次用例:

1
2
3
4
5
6
xx=xxvalue1, yy=yyvalue1
xx=xxvalue1, yy=yyvalue2
xx=xxvalue1, yy=yyvalue3
xx=xxvalue2, yy=yyvalue1
xx=xxvalue2, yy=yyvalue2
xx=xxvalue2, yy=yyvalue3

所以, 当对多个变量使用parameters参数列表时, 特别需要事先考虑清楚用例将会被循环的次数. 避免不必要的测试时间的消耗.

例如在配置表中我们再增加一个参数para_pwd 取值为['666', '888']

config-multi-para.PNG

然后在用例中引用变量para_pwd

testcase-muti-para.PNG

最后执行的结果为6次。

multi-para-report.PNG

参数组合为:

1
2
3
4
5
6
zxw2016,666
zxw2016,888
zxw2017,666
zxw2017,888
zxw2018,666
zxw2018,888
配置参数的作用域

当组合用例中的单个用例引用了配置参数,那么该组合用例下所有的用例都会按照参数组合来执行对应的次数。

例如在test_method_group中用例test_get_request引用了配置参数,那么所有的用例都会执行6次(上面案例中para_userpara_pwd的笛卡儿积),总共为3*6=18次。

config-testsuite.PNG

这样带来一个问题也就是有些没有设置参数的用例也会重复运行,这对整体运行效率会有比较大的影响,

如果只想针对指定的用例遍历设定的参数,那么需要将参数配置在用例中,而不是在公共配置模块中。

例如在用例test_get_request配置参数para_user 取值为['zxw2016', 'zxw2017', 'zxw2018'] 同时删除之前配置模块的对应的参数,以及引用的参数。

test-case-param.PNG

然后执行用例集test_method_group,那么test_get_request会根据设置的三个不同参数运行3次,其他两个接口运行1次。

键值对参数

对于参数间有对应关系的(如用户名:密码)可以按如下方式定义, 这样就避免了无效的排列组合:

1
xx-yy: [[xxvalue1,yyvaule1],  [xxvalue2,yyvalue2]]

组合结果:

1
2
xx=xxvalue1, yy=yyvalue1
xx=xxvalue2, yy=yyvalue2

在使用多个账户/密码进行测试时, 常用这种方式.

例如在用例test_post_formdata中配置如下参数

1
2
3
#用户名密码组合
51zxw2016,666
51zxw2018,888

在用例中进行如下配置

set-para-keyvalue.PNG

import-keybalue-para.PNG

运行测试用例:

keyvalue-report

从运行的报告中我们可以看到,参数按照我们设定的运行。

HttpRunnerManager进阶应用

自定义辅助函数

在一些比较特殊的接口测试过程中,有时需要做一些比较复杂的逻辑处理,比如加解密。针对这些接口我们需要编写一些辅助函数来完成测试。

案例:接口参数md5加密

测试登录接口:http://httpbin.org/post,参数除了userpasswd还需要一个sign参数
sign生成规则为用户名+密码然后进行md5加密。

在项目管理菜单栏中点击debugtalk.py 然后编辑如下代码:

1
2
3
4
5
6
7
8
9
10
# debugtalk.py

import hashlib

def getSign(user,passwd):
str=user+passwd
md5=hashlib.md5()
md5.update(str.encode(encoding='utf-8'))
sign=md5.hexdigest()
return sign

上面代码代表根据用户名密码生成md5摘要信息,并返回结果。

创建用例test_getSign 配置如下:

test_getSign_request.PNG

test_getSign_variables.PNG

从上面的配置可以看出,方法引用格式为:${function($para)}

运行结果如下:

test_getSign_report.PNG

从上面的报告可以看出,sign的值参数为md5算法生成的结果。

Hook

有些接口测试前后需要进行一些特殊的处理,比如初始化操作或者执行完成之后等待操作。
相当于unittest中的setUptearDown方法,HttpRunner也支持类似于这样的方法。其中Hook功能就支持这样的操作。

  • setup_hooks: 在 HTTP 请求发送前执行 hook 函数,主要用于准备工作;也可以实现对请求的 request 内容进行预处理。
  • teardown_hooks: 在 HTTP 请求发送后执行 hook 函数,主要用于测试后的清理工作;也可以实现对响应的 response 进行修改,例如进行加解密等处理。

实践案例

设置接口请求之后如果响应状态码为200就等待0.1s 否则就按照设定的时间等待。

在 debugtalk.py 创建辅助函数sleep() 定义如下:

1
2
3
4
5
6
7
import time

def sleep(response,t):
if response.status_code==200:
time.sleep(0.1)
else:
time.sleep(t)

然后在用例test_get_request中进行设置${time($response,2)}即可。

任务监控

任务监控可以查看节点的状况(包括处理的队列信息等)和task的执行情况

Tips:这里需要做一个小小的修改,因为作者把地址配置按照他自己的运行环境写死了。修改方式为:打开文件D:\HttpRunnerManager\templates\base.html

192.168.91.45修改为:127.0.0.1

1
2
<!-- <li><a href="http://192.168.91.45:5555/dashboard">任 务 监 控</a></li>-->
<li><a href="http://127.0.0.1:5555/dashboard">任 务 监 控</a></li>

设置好之后打开即可看到如下页面:

Flower-index.PNG

线上部署

当前系统是部署在本地环境,如果想部署到线上环境,那么可以参考:Django快速部署简约版 v3.0

视频操作演示

《Python接口自动化测试教程》第七章

参考文档