HttpRunner

HttpRunner版本对比
HttpRunner 安装与使用
- 安装
- - HttpRunner4.x
  - HttpRunner3.x
- 使用
- - 方式一：录制生成用例
  - - 步骤1：导出har文件
    - 步骤2：转化成测试用例文件
    - 步骤3：执行测试用例
  - 方式二：手工编写测试用例

HttpRunner 是一个支持 HTTP(S)/HTTP2/WebSocket/RPC 等网络协议的开源的通用测试框架，涵盖接口测试、性能测试、数字体验监测等测试类型。用户通过编写YAML或JSON文档即可实现自动化测试、性能测试、线上监控、持续集成等多种测试需求，该API 测试工具简单易用，功能强大，具有丰富的插件化机制和高度的可扩展能力。

HttpRunner官方文档链接

HttpRunner的特征：

支持与 HAR/Postman/Swagger/Curl/JMeter 等工具对接，可使用 HAR/Postman/Swagger/curl 等生成测试用例，轻松实现用例生成和转换
测试用例支持 YAML/JSON/go test/pytest 格式，可通过录制的方式快速生成用例，上手简单，使用方便，并且支持格式互相转换
支持灵活的自定义函数和 hook 机制，参数变量、数据驱动、结果断言等机制一应俱全，轻松适应各种复杂场景

HttpRunner框架优点：

继承 Requests 的全部特性，轻松实现 HTTP(S) 的各种测试需求
编写YAML或JSON格式的testcase，转译成pytestcase来运行测试
使用变量/提取/验证/钩子机制，创建case和复用case
重写pytest，可以利用pytest的各种插件
使用allure项目生成功能丰富的报告
使用jmespath，提取和验证json响应变得前所未有的简单。
基于 HAR 实现接口录制和用例生成功能（har2case）

HttpRunner框架运行原理：

HttpRunner 会把json、yml格式的case转换成pytest用例，再使用重写的类来执行测试

HttpRunner版本对比

目前HttpRunner 已经进入到 v4.x 版本了，使用率较广的版本是HttpRunner2.x和HttpRunner3.x，每一个大版本实现思路和命令上都具有显著的差异

版本	v1	v2	v3	HttpRunner+	v4
发布时间	2018.03.07	2019.01.01	2020.03.10	2021.11.18	2022.05.01
开发语言	Python	Python	Python	Golang	Golang + Python
网络协议	HTTP(S)/1.1	HTTP(S)/1.1	HTTP(S)/1.1	HTTP(S)/1.1	多协议 HTTP(S)/HTTP2/WebSocket/TCP/RPC
脚本格式类型	YAML/JSON	YAML/JSON	YAML/JSON/pytest	YAML/JSON	YAML/JSON/pytest/gotest
脚本格式校验	❌	jsonschema	❌	❌	TODO
脚本编写语法提示	❌	❌	pytest 链式调用	gotest 链式调用	gotest 链式调用 + pytest 链式调用
脚本执行引擎	Python unittest	Python unittest	Python pytest	Go 自研	Go 自研 + Python pytest
插件化语言（debugtalk.xx）	Python	Python	Python	多语言（Go/Python）	多语言（Go/Python/Java/etc）
参数提取机制	regex + 点分隔符	jmespath + regex + 点分隔符	jmespath	jmespath + regex	jmespath + regex
skip 机制	✅	❌	❌	❌	TODO
接口测试报告	html 自研（jinja2）	html 自研（jinja2）	pytest-html/allure	html 自研（Go template）	html 自研（Go template） + pytest-html/allure(待实现)
运行环境依赖	Python 2.7/3.3+	Python 2.7/3.5+	Python 3.7+ pytest	无需依赖	Go 引擎无需依赖 pytest 引擎依赖 Python 3.7+

注：v4 中斜体代表当前还未支持，但计划会实现

HttpRunner v4.0 同时采用了 Golang/Python 两种编程语言，底层会有两套相对独立的执行引擎，目标是兼具 Golang 的高性能和 pytest 的丰富生态。

关键差异点对比如下：

引擎	Go	Python
脚本类型	YAML/JSON/gotest	YAML/JSON/pytest
网络协议	多协议 HTTP(S)/HTTP2/WebSocket/TCP/RPC	HTTP(S)
脚手架工具	hrp startproject	/
用例生成工具	hrp har2case	/
脚本转换工具	hrp convert	/
插件化语言	多语言（Go/Python/Java/etc.）	Python
运行环境依赖	与插件语言相关，详见依赖环境说明	Python 3.7+
脚本编写语法提示	gotest 链式调用	pytest 链式调用
运行接口测试	hrp run	hrp pytest
运行性能测试	hrp boom	/
网络性能采集	hrp run –http-stat	/
接口测试报告	html 自研（Go template）	pytest-html/allure

HttpRunner 安装与使用

以下只介绍Windows下 python 方式安装和使用 HttpRunner ，Linux下安装方式官方文档也写得很明确，只需执行一条 shell 命令，即可完成 hrp 的下载和安装操作。

$ bash -c "$(curl -ksSL https://httprunner.com/script/install.sh)"

安装

HttpRunner 存储于 PyPI, 支持通过pip命令安装，推荐安装到虚拟环境下，这样的话不同的虚拟环境可以使用不同版本的 HttpRunner，有人喜欢用 HttpRunner3.x版本的内容，有人喜欢最新版本的内容，如果嫌麻烦，可以安装HttpRunner3.x版本

pip3 install httprunner  （默认安装最新版本）
pip3 install httprunner==3.1.4 0  （安装HttpRunner3.x版本）

查看 HttpRunner 版本：httprunner -V 或 hrun -V

查看可以使用的功能选项：httprunner -h

HttpRunner4.x

安装HttpRunner4.x后，还不能使用 hrp 命令行工具，这一步需要手动配置，需要下载编译产物，在 GitHub Releases 页面中，自行选择版本进行下载

在 C 盘根目录下创建 HttpRunner 目录（自定义目录），将下载的压缩包解压之后的hrp.exe 文件放在该目录下

在「我的电脑=>属性=>高级系统设置=>环境变量」配置中，在 PATH 下新增系统变量，将 C:\\HttpRunner 写入 PATH

启动虚拟环境，执行命令hrp -v，若显示hrp版本号，则说明配置成功

HttpRunner3.x

安装HttpRunner3.x后，以下5个命令会写入系统环境变量配置，不需要下载编译产物和配置相关内容了，使用hrun指令即可。

httprunner ：主命令，用于所有功能。hrun ：指令 httprunner run 的别名，用于运行YAML/JSON/Pytest 测试用例。hmake : 指令 httprunner make 的别名，将YAML/JSON用例转换成pytest用例。har2case ：指令 httprunner har2case 的别名，将HAR文件转换成 YAML/JSON 用例。locust : 利用locust 运行性能测试。locust 是一个单独的命令， locust 运行开始阶段时，monkey patch ssl避免递归错误

启动虚拟环境，执行命令hrun -V，若显示版本号，则说明配置成功

使用

方式一：录制生成用例

步骤1：导出har文件

通过fiddler/Charles等抓包工具进行抓包，生成har文件，放到项目目录中

fiddler点击File > Export Sessions > Selected Sessions > ，选择httparchive v1.2格式，导出文件到项目目录下

步骤2：转化成测试用例文件

HttpRunner3.x 使用 httprunner har2case 指令将 HAR 包转换为 JSON/YAML/pytest 测试用例， httprunner make 指令将 JSON/YAML 测试用例转换为 pytest 形态

har2case xxx.har     将HAR文件默认转换成pytest
har2case -2y xxx.har    将HAR文件转换成YAML文件
har2case -2j xxx.har    将HAR文件转换成Json文件

HttpRunner4.x将所有的转换功能都集中在 hrp convert 一个指令中。通过执行 hrp convert -h 可以查询该指令的功能简介、用法和各个选项的介绍：

$ hrp convert -h
convert to JSON/YAML/gotest/pytest testcasesUsage:hrp convert $path... [flags]Flags:-h, --help                help for convert-d, --output-dir string   specify output directory, default to the same dir with har file-p, --profile string      specify profile path to override headers (except for auto-generated headers) and cookies--to-gotest           convert to gotest scripts (TODO)--to-json             convert to JSON scripts (default true)--to-pytest           convert to pytest scripts--to-yaml             convert to YAML scriptsGlobal Flags:--log-json           set log to json format-l, --log-level string   set log level (default "INFO")

除了转换成JSON/YAML/pytest 类型的文件，HttpRunner4.x还支持将 HAR 包转换为gotest测试用例（gotest测试用例不进行说明）

hrp convert xxx.har              将HAR文件默认转换成转换成Json文件    文件名为xxx_test.json
hrp convert xxx.har --to-yaml   将HAR文件转换成YAML文件            文件名为xxx_test.yaml
hrp convert xxx.har --to-json   将HAR文件转换成Json文件            文件名为xxx_test.json
hrp convert xxx.har --to-pytest 将HAR文件转换成pytest文件
hrp convert xxx.har --to-gotest 将HAR文件转换成gotest文件

执行hrp convert xxx.har --to-pytest命令，会先将 xxx.har转化成xxx_test.json，然后再将xxx_test.json转化成xxx_test_test.py

hrp convert 指令支持指定目录输出，--output-dir 后接测试用例的期望输出目录的路径，用于将转换生成的测试用例输出到对应的文件夹

hrp convert xxx.har --to-pytest --output-dir ./cases 输入文件到当前目录下的cases文件夹中

步骤3：执行测试用例

JSON/YAML(/pytes)类型的测试用例文件，HttpRunner3.x 使用hrun命令执行，HttpRunner4.x 使用hrp run命令执行

hrun xxx.json            执行json格式的测试用例
hrun xxx.yaml           执行yaml格式的测试用例hrp run xxx.json       执行json格式的测试用例
hrp run xxx.yaml        执行yaml格式的测试用例hrp run cases/         执行cases文件夹下的测试用例

HttpRunner4.x 也可以使用hrun命令执行测试用例文件，但hrp run命令控制台打印日志会更加详细，同时，hrp run命令还支持执行文件夹中的测试用例

pytest文件可通过pytest命令执行该测试用例文件

pytest xxx.py

目前的 HttpRunner 支持运行 pytest 的测试用例进行接口测试。由于 HttpRunner wraps pytest，因此 pytest 所有的参数都可以与 hrp 命令一起使用

$ hrp pytest  [options] [file_or_dir] [file_or_dir] [...]hrp pytest testcases/py_test.py --html=/report/index.html  --junit-xml=/report/report.xml
执行testcases文件夹下的py_test.py测试用例文件，并输入html和xml格式的测试报告

方式二：手工编写测试用例

pytest 、 YAML 和 JSON 格式的测试用例完全等价，包含的信息内容也完全相同。

在httprunner中，测试用例组织主要基于三个概念：

测试用例集(testsuite)：对应一个YAML/JSON/Python文件，包含单个或多个测试用例文件。通俗来将，测试用例集就是「一堆」测试用例。对应地，HttpRunner 除了支持指定单个文件来运行某一测试用例，也支持指定多个文件或指定文件夹来运行一整个测试用例集
测试用例(testcase)：对应一个YAML/JSON/Python文件，包含单个或多个测试步骤。
测试步骤(teststep)：对应YAML/JSON/Python中 teststeps 下的一个节点，描述单次接口测试的全部内容，包括发起接口请求、解析响应结果、检验结果等。

pytest 、 YAML 和 JSON 格式的测试用例，用例结构整体结构都包含两部分：

config：每个测试用例都必须有config部分，作为整个测试用例的全局配置项，用于配置用例
teststeps：包含测试步骤相关信息，测试用例存在顺序关系，运行时将从前往后依次运行各个测试步骤，其中步骤可以引用其他测试用例

用例配置项（config）名称	含义
name（必填）	用例名称描述，将在log和报告中展示
verify（非必填）	客户端是否进行 SSL 校验（todo）
base_url（非必填）	测试用例中的通用Host，例如https://httprunner.com，若base_url被指定，测试步骤中的url只能写相对路径
headers（非必填）	定义测试用例级别的请求头
environs（非必填）	配置环境变量（如果未指定则会从 .env 文件导入）
variables（非必填）	定义的全局变量，作用域为整个用例，每个测试步骤都可以引用config variables。测试步骤中的 step variables 优先级高于 config variables
parameters（非必填）	全局参数，用于实现数据化驱动，作用域为整个用例
parameters_setting（非必填）	配置参数驱动的具体策略
think_time（非必填）	配置思考时间的具体策略、超时时间限制等
websocket（非必填）	配置 WebSocket 断开重连的最大次数和间隔等（todo）
export（非必填）	导出当前测试用例中的变量
weight（非必填）	性能测试过程中，分配给当前测试用例的虚拟用户权重
path（非必填）	当前测试用例所在路径（通常不需要手工填写）

测试步骤类型	含义	适用的测试步骤
name（必填）	用例步骤描述，将在log和报告中展示
request（必填）	用于发起 HTTP 请求的步骤类型，包含method、url、params、headers、cookies等请求信息（method和url必填）
api（非必填）	用于引用 API 的步骤类型
testcase（非必填）	用于引用其他测试用例的步骤类型
transaction（非必填）	用于定义一个事务
rendezvous（非必填）	集合点
think_time（非必填）	思考时间
websocket（非必填）	用于发起 WebSocket 请求的步骤类型
variables（非必填）	局部变量	通用
setup_hooks（非必填）	前置函数	request/api/websocket
teardown_hooks（非必填）	后置函数	request/api/websocket
extract（非必填）	变量提取。参数提取格式，变量名: body.属性名，指从响应体body里提取属性的值	request/api/websocket
validate（非必填）	结果校验	request/api/websocket
export（非必填）	导出变量	testcase

test.yaml

config:name: classinfovariables: {}verify: false
teststeps:- name: "getclass"request:method: GETurl: http://127.0.0.1:8080/api/mgr/sq_mgr/params:action: list_coursepagenum: "1"pagesize: "20"headers:Accept: application/json, text/plain, */*Accept-Encoding: gzip, deflate, brAccept-Language: zh-CN,zh;q=0.9Connection: keep-aliveHost: 127.0.0.1:8080Referer: http://127.0.0.1:8080/mgr/ps/mgr/index.htmlUser-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.0.0 Safari/537.36X-CSRFToken: ABjPB9CYXuc0dPy8Wu2hJppDVu1sdhWRrfoWPBM7DimSrMtkHVUAoNAXeWqOIh0dcookies:csrftoken: ABjPB9CYXuc0dPy8Wu2hJppDVu1sdhWRrfoWPBM7DimSrMtkHVUAoNAXeWqOIh0dsessionid: b1g42w3ynatxpphy0fhahpdi7g4pn2vgextract: msg: body.msgcookie: header.Set-Cookievalidate:- check: status_codeassert: equalsexpect: 200msg: assert response status code- eq: ["body.msg","成功"]

test.json

{"config": {"name": "classinfo"},"teststeps": [{"name": "getclass","request": {"method": "GET","url": "http://127.0.0.1:8080/api/mgr/sq_mgr/","params": {"action": "list_course","pagenum": "1","pagesize": "20"},"headers": {"Accept": "application/json, text/plain, */*","Accept-Encoding": "gzip, deflate, br","Accept-Language": "zh-CN,zh;q=0.9","Connection": "keep-alive","Host": "127.0.0.1:8080","Referer": "http://127.0.0.1:8080/mgr/ps/mgr/index.html","User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.0.0 Safari/537.36","X-CSRFToken": "ABjPB9CYXuc0dPy8Wu2hJppDVu1sdhWRrfoWPBM7DimSrMtkHVUAoNAXeWqOIh0d","sec-ch-ua-platform": "\"Windows\""},"cookies": {"csrftoken": "ABjPB9CYXuc0dPy8Wu2hJppDVu1sdhWRrfoWPBM7DimSrMtkHVUAoNAXeWqOIh0d","sessionid": "b1g42w3ynatxpphy0fhahpdi7g4pn2vg"}},"validate": [{"check": "status_code","assert": "equals","expect": 200,"msg": "assert response status code"},{"check": "body.msg","assert": "equals","expect": "成功","msg": "assert response body msg"}]}]
}

YAML 和 JSON 是两种常用的定义结构化数据的格式，YAML 与 JSON 各有优劣，用户在编写测试用例的时可以根据自己的喜好和使用场景来进行选择，不过二者具有较强的相似性：

编写风格：YAML 必须使用空格来表示缩进，并且对空格具体数量没有要求，只需要相同层级左侧对齐即可，这种缩进风格简洁且易于阅读，针对同一测试用例，YAML 文件的篇幅通常要比带缩进的 JSON 文件简短很多，用户可以较快地把握整体结构，但是对于手动编写 YAML 测试用例的场景而言，则需要重点注意相同层级左侧对齐，否则很容易导致测试用例的加载错误。JSON 的编写风格则是频繁地使用 {} [] 和 “"，对缩进并没有严格要求（习惯上还是采用良好的缩进风格来便于阅读），正是由于额外的符号过多，容易降低阅读和手工编写上的体验
功能多样性：在功能方面，YAML 是 JSON 的超集，YAML 有许多 JSON 缺乏的附加功能，包括注释、可扩展数据类型、关系锚、不带引号的字符串等等，尤其是添加注释的功能在编写测试用例供他人阅读时尤为实用，而 JSON 只支持数值、字符串、布尔值、数组、对象和空值六种数据类型。
解析效率：与 YAML 相比，JSON 对机器来说更容易解析，序列化/反序列化的速度更快

HttpRunner相关推荐

Httprunner测试
自动化测试===Httprunner测试框架介绍项目地址: https://github.com/HttpRunner/HttpRunner 中文手册: http://cn.httprunner.o ...
Httprunner生成Allure格式HTML报告
目录 1. 前言 2. httprunner v2.x版本的报告 2.1 使用ExtentReport模板生成报告 2.2 指定ExtentReport为默认模板 3. httprunner v3.x ...
HttpRunner环境部署-踩坑篇
1.git clone https://github.com/HttpRunner/HttpRunner.git 到本地 2.查看目前正在使用的Python版本:pyenv versions,默认只有 ...
httprunner框架学习总结
目前在开发通用接口平台,已经完成参数引擎,内置函数引擎,执行引擎,API抽离等工作,突然发现了httprunner这个优秀的开源APItest框架,初步研究发现httprunner各方面都很优秀,遂进 ...
HttpRunner自动化框架学习笔记
一.简单介绍 HttpRunner 是一款面向 HTTP(S) 协议的通用测试框架,只需编写维护一份 YAML/JSON 脚本,即可实现自动化测试.性能测试.线上监控.持续集成等多种测试需求. 支持p ...
【框架学习分享】HttpRunner
今天文章分为两部分 :) PART1 HttpRunner内容分享/ PART2 关于后厂村儿 10 Minutes HttpRunner: PART 1 首先感谢作者开源
转为yaml python_python 如何使用HttpRunner做接口自动化测试
作者:星安果来源:AirPython 1. 前言原始测试金子塔包含 3 层,分别是:UI 自动化测试.接口服务测试.单元测试其中, 单元测试是对软件的最小可测试单元进行检查和验证,也是产生效率最 ...
综合前置接口报文规范_浅谈用HttpRunner进行接口自动化测试
在参与我们测试平台开发的时候,结识了HttpRunne这个优秀的开源接口测试框架,初步研究发现HttpRunner可以非常方便.非常高效地实现接口自动化测试. 01HttpRunner和常用接口测试框 ...
python runner功能_Python 如何使用 HttpRunner 做接口自动化测试
点击上方"软测小生",选择"加为星标" 第一时间关注软件测试原创干货! 1. 前言原始测试金子塔包含 3 层,分别是:UI 自动化测试.接口服务测试.单元测试 ...
HTTPRunner学习笔记
HttpRunner 是一款面向 HTTP(S) 协议的通用测试框架,只需编写维护一份 YAML/JSON 脚本,即可实现自动化测试.性能测试.线上监控.持续集成等多种测试需求. 在yaml文件中组织 ...

HttpRunner

HttpRunner

HttpRunner版本对比

HttpRunner 安装与使用

安装

HttpRunner4.x

HttpRunner3.x

使用

方式一：录制生成用例

步骤1：导出har文件

步骤2：转化成测试用例文件

步骤3：执行测试用例

方式二：手工编写测试用例

HttpRunner相关推荐

最新文章

热门文章