利用guardian为你的api应用写测试

2024年1月6日 333次阅读 来源: honhon

要写出一个健壮的程序必须要有测试，测试可以保证上线的代码功能符合预期，防止上线后出现莫须有的损失。对于我们一口气写完的api，匆忙上线往往会导致很糟糕的后果。

那么怎么去写测试来保证我们的api上线后是没问题且符合预期的呢？一个后台工程师为了不背锅，如何去需要保证自己的工作完成得没问题呢？

注意：我们这里讨论的是api符合预期，对于客户端ui显示，不在我们讨论范围内。

我觉得要做好api测试，至少有以下三点：

  1. 测试案例的返回结果符合预期
  2. 测试案例覆盖了所有代码条件
  3. 测试案例的结果数据符合预期

简单的说就是，充分理解业务的情况下，编写出完整的测试案例集，然后通过测试案例集验证了返回结果以及存储数据的准确性。这就是保证api正确的核心。

根据这样的想法，于是编写了一个测试框架 Guardian。Guardian 的使用非常简单，你只需要把你的测试案例信息写成固定的json格式，包括请求信息，预期响应信息，预期的数据信息。然后运行命令，guardian 就会帮你跑完所有测试案例，并验证最终的结果返回输出到终端中。

使用如这个例子：

guardian --tests=./example/tests/entrance.json

SUIT:  users
=================================================
获取用户                                    Ok
-------------------------------------------------
响应比对                                    ✓️
数据比对                                    ✓️
=================================================
修改用户                                    Ok
-------------------------------------------------
响应比对                                    ✓️
数据比对                                    ✓️
=================================================

Ok

SUIT:  orders
=================================================
获取订单                                    Ok
-------------------------------------------------
响应比对                                    ✓️
数据比对                                    ✓️
=================================================
创建订单                                    Ok
-------------------------------------------------
响应比对                                    ✓️
数据比对                                    ✓️
=================================================

Ok

json文件格式

入口文件

选项名子选项名描述格式是否必须例子
databaseport端口字符串是3306
user用户字符串是root
password密码字符串是root
charset字符集字符串是utf8
host地址字符串是127.0.0.1
database数据库名字符串是guardian
tables无案例集对象是{
“users”: [ “users/get.json”, “users/post.json” ],
“orders”: [“orders/get.json”,”orders/post.json”]
}
vars无全局变量对象否{ “host”: “http://127.0.0.1:1235” }
debug无设置为true则会
打印所有返回结果
与数据库查询结果		布尔否false

测试案例

选项名子选项名描述格式是否必须例子
infotitle标题字符串是这是一个标题
description描述字符串是这是一个描述
concurrent无并发数整数否1
requesturlurl字符串是{{host}}/user
method方法有：json, get, post, delete, options, formget, formpost字符串是get
params参数对象或数组否{“id”: 1}
header头部对象否{“token”: “1231313”}
responsebody返回body数据，对象中可以有
通配符，如”*”，表示不匹配		字符串或对象是123
header头部对象否{“token”: “1231313”}
data无验证数据数组否[
{
“sql”: “select name from user where id = 1”,
“result”: [{“name”: “jack”}]
}
]

具体可以参考：

    原文作者：honhon
    原文地址: https://segmentfault.com/a/1190000016620442
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞