动手造轮 | 一款Bash 脚本 +HTTP 请求工具 +JSON 解析工具组成的测试小工具

数人云开源一款容器管理工具Crane,Crane开发过程中,为了保证API的健壮性和稳定性, 数人云开发团队自制了一套适合Crane API测试的小工具。它也适用于其他接口测试,小数发现很多朋友对它感兴趣,就勤劳地搬运过来,希望能为大家提供一个参考和思路。

针对Crane团队只向外输出API的特点, 选择测试工具是秉着以下原则的:

  • 第一, 功能不要太复杂,学习曲线不能太陡, 功能够用就行;
  • 第二, 可编程要好, 最好不要有界面,程序员友好。

于是一款简单的Bash脚本+HTTP 请求工具+JSON解析工具组成的测试小工具雏形出现了。

下面给大家展现这款工具的构成

Bash脚本: 测试工具的粘合剂, 不是Java也不是Python, 用Bash简单易用,功能强大。 Httpie: 一款类似curl的http工具, 不过比curl简单的多, 尤其是想发个JSON请求时候, 更简单。 jq: jq是一款命令行解析JSON文本的工具, 支持非常多的语法解析构造重组JSON文本。

下面依次给大家介绍一下httpie和jq的基本用法

1. 例子说明如何使用httpie

httpie在terminal下的命令是http, 先来几个简单的例子给演示一下用法。

http get http://httpbin.org/get header:header-content

其中, http是命令, get是请求method, http://httpbin.org 是请求地址, httpbin是一个http的测试服务; 用冒号相连的参数代表着HTTP请求头, 用等号连接为请求body中的JSON键和值。 httpie默认的请求为json请求, 所以不用过多指明,header已经加上了Content-Type:application/json。

http post http://httpbin.org/post header:header-content json-key=json-value

http支持很多命令行选项, 介绍一个有意思的是 --check-status, check-status是把http response的非200值设置成进程的exit code, 比如:

如上所示, 请求一个不存在的地址时候进程退出符号变成了4。 我们将大量使用这个feature来判断返回值。

2. 例子说明如何使用jq

下面我们用几个例子介绍一下jq的用法。

上图演示如何提取一个json的key。

如何提取一个嵌套的key。

提取数组中的元素。

篇幅关系我们不过多展示jq的高级功能, 除了基本的解析和构造以外,jq支持大量的filter, 如有兴趣可参考https://stedolan.github.io/jq/ ... tions

3. Crane测试工具的几个场景

场景一: 我期望测试API的HTTP测试的返回状态比如200, 404, 500

首先bash造了几个基本的函数来输出错误, 和判断状态

使用方法

场景二: 登录过程测试

更多的测试例子可参考https://github.com/Dataman-Clo ... _test

至此,一款可用的测试工具出炉了, 虽然简单,不过功能恰到好处,非常适合我们的场景, 再也不怕API出错发现不了了。 聪明的同事们把这工具配到了jenkins和单元测试一起执行, 出错了还能得到邮件通知, 酷极了。

2 个评论

这个思路不错,我之前开发的github.com/astaxie/bat也是实现了httpie的功能,但是我还是希望结合你类似shell的功能,可以写API的测试。目前还在想法阶段,就缺动手写了
其实我更喜欢ruby来写。

要回复文章请先登录注册