利用guardian為你的api應(yīng)用寫測試

JellyBool 發(fā)布于2019-05-29 17:08 / 413人閱讀

摘要：要寫出一個(gè)健壯的程序必須要有測試，測試可以保證上線的代碼功能符合預(yù)期，防止上線后出現(xiàn)莫須有的損失。根據(jù)這樣的想法，于是編寫了一個(gè)測試框架。的使用非常簡單，你只需要把你的測試案例信息寫成固定的格式，包括請求信息，預(yù)期響應(yīng)信息，預(yù)期的數(shù)據(jù)信息。

要寫出一個(gè)健壯的程序必須要有測試，測試可以保證上線的代碼功能符合預(yù)期，防止上線后出現(xiàn)莫須有的損失。對(duì)于我們一口氣寫完的api，匆忙上線往往會(huì)導(dǎo)致很糟糕的后果。

那么怎么去寫測試來保證我們的api上線后是沒問題且符合預(yù)期的呢？一個(gè)后臺(tái)工程師為了不背鍋，如何去需要保證自己的工作完成得沒問題呢？

注意：我們這里討論的是api符合預(yù)期，對(duì)于客戶端ui顯示，不在我們討論范圍內(nèi)。

我覺得要做好api測試，至少有以下三點(diǎn)：

測試案例的返回結(jié)果符合預(yù)期

測試案例覆蓋了所有代碼條件

測試案例的結(jié)果數(shù)據(jù)符合預(yù)期

簡單的說就是，充分理解業(yè)務(wù)的情況下，編寫出完整的測試案例集，然后通過測試案例集驗(yàn)證了返回結(jié)果以及存儲(chǔ)數(shù)據(jù)的準(zhǔn)確性。這就是保證api正確的核心。

根據(jù)這樣的想法，于是編寫了一個(gè)測試框架 Guardian。Guardian 的使用非常簡單，你只需要把你的測試案例信息寫成固定的json格式，包括請求信息，預(yù)期響應(yīng)信息，預(yù)期的數(shù)據(jù)信息。然后運(yùn)行命令，guardian 就會(huì)幫你跑完所有測試案例，并驗(yàn)證最終的結(jié)果返回輸出到終端中。

使用如這個(gè)例子：

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

SUIT:  users
=================================================
獲取用戶                                    Ok
-------------------------------------------------
響應(yīng)比對(duì)                                    ??
數(shù)據(jù)比對(duì)                                    ??
=================================================
修改用戶                                    Ok
-------------------------------------------------
響應(yīng)比對(duì)                                    ??
數(shù)據(jù)比對(duì)                                    ??
=================================================

Ok

SUIT:  orders
=================================================
獲取訂單                                    Ok
-------------------------------------------------
響應(yīng)比對(duì)                                    ??
數(shù)據(jù)比對(duì)                                    ??
=================================================
創(chuàng)建訂單                                    Ok
-------------------------------------------------
響應(yīng)比對(duì)                                    ??
數(shù)據(jù)比對(duì)                                    ??
=================================================

Ok

json文件格式 入口文件

選項(xiàng)名	子選項(xiàng)名	描述	格式	是否必須	例子
database	port	端口	字符串	是	3306
	user	用戶	字符串	是	root
	password	密碼	字符串	是	root
	charset	字符集	字符串	是	utf8
	host	地址	字符串	是	127.0.0.1
	database	數(shù)據(jù)庫名	字符串	是	guardian
tables	無	案例集	對(duì)象	是	{ "users": [ "users/get.json", "users/post.json" ], "orders": ["orders/get.json","orders/post.json"] }
vars	無	全局變量	對(duì)象	否	{ "host": "http://127.0.0.1:1235" }
debug	無	設(shè)置為true則會(huì) 打印所有返回結(jié)果與數(shù)據(jù)庫查詢結(jié)果	布爾	否	false

測試案例

選項(xiàng)名	子選項(xiàng)名	描述	格式	是否必須	例子
info	title	標(biāo)題	字符串	是	這是一個(gè)標(biāo)題
	description	描述	字符串	是	這是一個(gè)描述
concurrent	無	并發(fā)數(shù)	整數(shù)	否	1
request	url	url	字符串	是	{{host}}/user
	method	方法有：json, get, post, delete, options, formget, formpost	字符串	是	get
	params	參數(shù)	對(duì)象或數(shù)組	否	{"id": 1}
	header	頭部	對(duì)象	否	{"token": "1231313"}
response	body	返回body數(shù)據(jù)，對(duì)象中可以有通配符，如"*"，表示不匹配	字符串或?qū)ο?/td>	是	123
	header	頭部	對(duì)象	否	{"token": "1231313"}
data	無	驗(yàn)證數(shù)據(jù)	數(shù)組	否	[ { "sql": "select name from user where id = 1", "result": [{"name": "jack"}] } ]