藉助 DSL 來簡化 Loadgen 配置
引言
在 上篇文章中，我們介紹瞭如何用 Loadgen 來簡化 HTTP API 的整合測試。在實際使用中會發現，編寫測試時最令人“頭疼”的部分是設計測試的輸入和校驗程式的輸出，而針對後者 Loadgen 提供了豐富的條件測試 [1] 來對響應進行斷言。
回顧上篇文章的示例：
# loadgen.ymlvariables:
- name: id type: sequencerunner:
assert_error: true
assert_invalid: truerequests:
- request:
method: PUT url: $[[env.PIZZA_SERVER]]/test_create_document_$[[id]]
assert:
equals:
_ctx.response.body_json.success: true
register:
- collection: _ctx.response.body_json.collection - request:
method: POST url: $[[env.PIZZA_SERVER]]/$[[collection]]/_doc body: '{"hello": "world"}'
assert:
equals:
_ctx.response.body_json.result: created
上述配置中各請求的斷言只有一條，但如果我們的檢驗邏輯更加複雜，需要組合多重測試條件，比如我們想盡可能多的檢驗響應體中的欄位來提高測試的可靠性，那麼斷言的部分將會迅速膨脹，可讀性也會隨之下降。
例如，針對如下響應：
{
"took": 17,
"timed_out": false,
"hits": {
"total": {
"value": 100,
"relation": "eq"
},
"max_score": 1.0,
"hits": [...]
},
"aggregations": {
"vavg": {
"value": 51.0
},
"vcount": {
"value": 50
},
"vmax": {
"value": 100
},
"vmin": {
"value": 2
},
"vsum": {
"value": 2550
}
}}
我們可能會寫出這樣的配置：
assert: and: - range: _ctx.response.body_json.took: lt: 50 - equals: _ctx.response.status: 200 _ctx.response.body_json.time_out: false _ctx.response.body_json.hits.total.value: 100 _ctx.response.body_json.max_score: 1.0 _ctx.response.body_json.aggregations.vavg.value: 51 _ctx.response.body_json.aggregations.vcount.value: 50 _ctx.response.body_json.aggregations.vmax.value: 100 _ctx.response.body_json.aggregations.vmin.value: 2 _ctx.response.body_json.aggregations.vsum.value: 2550 - regexp: _ctx.response.body_json.hits.total.relation: eq|gt|ge
不難發現，上面的配置看起來與原始的響應結構有很大的差別，寫起來十分繁瑣，看起來也不直觀，為了解決這一問題，我們為 Loadgen 的 YAML 配置設計了一種 DSL [2]。
更直觀的斷言配置
Loadgen DSL 針對各種斷言進行了著重的簡化，比如上述配置我們可以改寫成：
{
took: <50,
time_out: false,
hits: {
total: {
value: 100,
relation: /eq|gt|ge/,
},
},
max_score: 1.0,
aggregations: {
vavg.value: 51,
vcount.value: 50,
vmax.value: 100,
vmin.value: 2,
vsum.value: 2550,
},
}
這樣是不是“清爽”了許多？而且，有沒有發現這個語法和 JSON 很像？沒錯，Loadgen DSL 完全相容 JSON 語法！也就是說，可以直接把響應體複製下來，然後在其基礎上進行修改：
{
// 用 <50 來測試此欄位的值是否小於 50
"took": <50,
// 普通的值將被測試欄位實際值是否與它相等
"timed_out": false,
"hits": {
"total": {
"value": 100,
// 用正規表示式來檢查此欄位的值
"relation": /eq|gt|ge/
},
"max_score": 1.0
},
"aggregations": {
"vavg": {
"value": 51.0
},
"vcount": {
"value": 50
},
"vmax": {
"value": 100
},
"vmin": {
"value": 2
},
"vsum": {
"value": 2550
}
}
}
注意到 Loadgen DSL 中欄位的引號是可以省略的，同時它也支援
not，
and 和
or 的邏輯組合：
{
took: >0 and <50,
relation: "eq" or "gt" or "ge",
hits.total.value: not 0,
}
而對於較複雜的條件測試，比如
prefix/contains/in 等，可以透過函式呼叫語法來實現：
{
blog.title: prefix("INFINI"),
blog.tag: contains("Loadgen"),
blog.status: in(["reviewed", "archived"]),
}
進一步的簡化
以上我們展示了 Loadgen DSL 是如何簡化斷言配置的，回想到上一章開頭所說的，HTTP API 測試中主要就是不斷髮起請求然後校驗其響應，那我們何不在 DSL 中將請求一起解析了呢？
於是，在現有的語法上稍作改進，我們便可以透過如下示例：
PUT $[[env.PIZZA_SERVER]]/test_create_document_$[[id]]
# // 注意這裡，因為我們定義 register 變數，因此需要使用完整語法
# register: [
# {collection: "_ctx.response.body_json.collection"},
# ],
# assert: {
# _ctx.response.body_json.success: true,
# },
POST $[[env.PIZZA_SERVER]]/$[[collection]]/_doc
{"hello": "world"}
# {result: "created"}
來替換掉本文最開頭示例中的
requests 部分。
上述示例提到了“完整語法”，在 Loadgen DSL 中，如下“簡短語法”的配置：
POST $[[env.PIZZA_SERVER]]/$[[collection]]/_doc
{"hello": "world"}
# 200 // 狀態碼是可選的
# {result: "created"}
等同於：
POST $[[env.PIZZA_SERVER]]/$[[collection]]/_doc
{"hello": "world"}
# assert: {
# _ctx.response.status: 200,
# _ctx.response.body_json: {result: "created"},
# }
Tips:
對於
assert欄位，也可以透過元組表示式來使用簡短語法：POST $[[env.PIZZA_SERVER]]/$[[collection]]/_doc {"hello": "world"} # assert: (200, {result: "created"})
對於 Loadgen DSL 詳細的語法定義可以參考本文的 附錄部分。
最後一些最佳化
到目前為止，Loadgen DSL 幾乎可以替換掉 Loadgen YAML 配置的大部分內容，除了
variables 和
runner 這樣的全域性配置項。觀察一下現有的寫法，每個請求都是
METHOD URL 然後緊跟可選的請求體與斷言註釋，其實我們可以在 DSL 的最前面定義一些全域性的選項：
# variables: [
# {name: "id", type: "sequence"},
# ],
# runner: {
# assert_error: true,
# assert_invalid: true,
# },
PUT $[[env.PIZZA_SERVER]]/test_create_document_$[[id]]
# register: [{
# collection: "_ctx.response.body_json.collection",
# }],
# assert: {
# _ctx.response.body_json: {success: true},
# },
POST $[[env.PIZZA_SERVER]]/$[[collection]]/_doc
{"hello": "world"}
# {result: "created"}
上述示例就等價於本文最開頭給出的配置。
附錄：Loadgen DSL 語法定義
以下是 Loadgen DSL 的 BNF [3] 語法定義：
grammer ::= brief | full
brief ::= status? object EOF
full ::= fields EOF
status ::= integer
expr ::= expr1 (infixop expr1)*expr1 ::= literal | array | object | funcall | prefixop expr1 | '(' exprlist ')'exprlist ::= (expr (',' expr)* ','?)?object ::= '{' fields '}'fields ::= (pair (',' pair)* ','?)?pair ::= path ':' expr
path ::= key ('.' key)*key ::= name | string | integer
array ::= '[' exprlist ']'funcall ::= name '(' exprlist ')'literal ::= null | boolean | integer | float | regex | string
ignore ::= whitespace | comment
/* ws: definition */<?TOKENS?>comment ::= '//' char*name ::= ident - keyword
keyword ::= 'null'
| 'true'
| 'false'
| 'not'
| 'and'
| 'or'ident ::= id_start (id_start | '-' | digit)*id_start ::= [_a-zA-Z]prefixop ::= '-'
| '>'
| '<'
| '>='
| '<='
| '=='
| 'not'infixop ::= 'and' | 'or'null ::= 'null'boolean ::= 'true' | 'false'integer ::= digit+exponent ::= ('e' | 'E') ('+' | '-')? integer
float ::= integer exponent | integer '.' integer exponent?digit ::= [0-9]regex ::= '/' ('\/' | char - '/')+ '/'string ::= '"' (escape | char - '"')* '"'
| "'" (escape | char - "'")* "'"escape ::= '\b'
| '\f'
| '\n'
| '\r'
| '\t'
| "\'"
| '\"'
| '\\'
| '\/'char ::= #x9 | [#x20-#xD7FF]
| [#xE000-#xFFFD]
| [#x10000-#x10FFFF]whitespace ::= [#x9#xA#xD#x20]+EOF ::= $
來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/70029458/viewspace-2993357/，如需轉載，請註明出處，否則將追究法律責任。
相關文章
- 藉助ai來分析程式碼，理解程式碼AI
- 藉助babel理解jsxBabelJS
- Go藉助PProf的一次效能優化Go優化
- 藉助 webpack 對專案進行分析優化Web優化
- 如何藉助 Django 來編寫一個 Python Web APIDjangoPythonWebAPI
- 如何在 Android 上藉助 Wine 來執行 Windows AppsAndroidWindowsAPP
- 【前端除錯】- 藉助Performance分析並最佳化效能前端除錯ORM
- 企業如何藉助SEO優化線上聲譽？優化
- 藉助Python 函式進行模組化程式碼Python函式
- 容器化 RDS：藉助火焰圖定位Kubernetes效能問題
- 還在用定時器嗎？藉助 CSS 來監聽事件定時器CSS事件
- 研發團隊如何藉助Gitlab來做程式碼reviewGitlabView
- 藉助 AIDL 理解 Android Binder 機制——Binder 來龍去脈AIAndroid
- 藉助AI助手分析LlamaIndex的工作流視覺化AIIndex視覺化
- 食品企業如何藉助SAP實現高效智慧化管理
- 容器化 RDS：藉助 CSI 擴充套件 Kubernetes 儲存能力套件
- 德國富士通藉助SNP CrystalBridge®簡化其業務結構 合併SAP系統
- 藉助dockerSwarm搭建叢集部署DockerSwarm
- PMC如何藉助數字化技術提升崗位價值？
- 《State of Surivial》是怎樣藉助本地化在日本翻身的？
- 藉助Radamsa變異資料（初探）
- 電腦配置的三種檢視方法 不用藉助軟體怎麼檢視電腦配置
- 全網最佳化：如何藉助好看影片做百度SEO？
- 藉助移動OA數字化辦公，如何從0到1？
- 網站SEO優化效果不好？你藉助長尾關鍵詞優化嗎？網站優化
- AWS Lambda 藉助 Serverless Framework，迅速起飛ServerFramework
- 短影片app原始碼，藉助輪詢最佳化互動體驗APP原始碼
- 汽配行業如何藉助SAP ERP系統實現數字化管理？行業
- 零售行業如何藉助數字化轉型提高業務？行業
- 藉助友盟+U-APM實現安卓效能優化總結安卓優化
- RTS能否藉助移動電競迎來新生？這款遊戲指出了方向遊戲
- mongodb 藉助一致性全備份加oplogs來新增新節點MongoDB
- 解密prompt系列39. RAG之藉助LLM最佳化精排環節解密
- 藉助SD-WAN為安全和自動化的多雲鋪平道路
- 汽車行業如何藉助SAP ERP系統實現精細化管理？行業
- 藉助AI助手如何高效排查SQL問題AISQL
- 藉助AI助手如何高效閱讀原始碼AI原始碼
- 藉助CRM系統提升企業利潤