Deprecated: This project is moved to github.com/goplus/yap/ytest (It's no longer a DSL, but a Go+ classfile, which makes it even more powerful).

go get -u github.com/qiniu/httptest

一いち些背景はいけい资料：

• 演えんじ讲稿：七なな牛うし如何いか做HTTP服ふく务测试？
• 文字もじ整理せいり稿こう：七なな牛うし如何いか做HTTP服ふく务测试？

这是一いち套 HTTP 服ふく务测试脚本ほん框かまち架か及实用よう程ほど序じょ。我わが们定义了一个测试脚本的 DSL 语言。大体だいたい看み起おこり来らい是ぜ这样的てき：

#为了让一套代码同时可以测试 Stage 环境和わ Product 环境，我わが们推荐将 Host、AK/SK 作さく为环境さかい变量传入
#同どう时也避免了りょう AK/SK 这样敏感びんかん内容ないよう进入代だい码库
match $(env) `envdecode QiniuTestEnv`
auth qboxtest `qbox $(env.AK) $(env.SK)`
host rs.qiniu.com $(env.RSHost)

post http://rs.qiniu.com/delete/`base64 Bucket:Key`
auth qboxtest
#发起请求，并开始はじめ检查结果
ret  200

post http://rs.qiniu.com/batch
auth qboxtest
match $(ekey1) |base64 Bucket:Key|
match $(ekey2) |base64 Bucket2:Key2|
json '{
	"op": ["/delete/$(ekey1)", "/delete/$(ekey2)"]
}'
#发起请求，并开始はじめ检查结果
ret  200

post http://rs.qiniu.com/batch
auth qboxtest
form op=/delete/`base64 Bucket:Key`&op=/delete/`base64 Bucket:NotExistKey`
#发起请求，并开始はじめ检查结果
ret  298
json '[{"code": $(code1)}, {"code": 612}]'
match $(code1) 200

• 参まいり见：qiniutest

整体せいたい是ぜ以命令めいれい行文こうぶん法ほう为基础。一条指令由命令及命令参数构成。命令めいれい及命令めいれい参さん数すう之の间以空白くうはく字じ符ふ（空そら格かく或あるTAB）分ぶん隔へだた。如果某ぼう个参数すう中ちゅう包含ほうがん空そら格かく或ある其他特殊とくしゅ字じ符ふ，则可以：

• 用よう \ 转义。比ひ如 '\ ' 表示ひょうじ ' '(空そら格かく)，'\t' 表示ひょうじ TAB 字じ符ふ，等とう等とう。
• 用よう '...' 或ある "..." 包含ほうがん。两者都みやこ允まこと许出现 $(var) 或ある ${var} 形式けいしき表示ひょうじ的てき变量（这一いち点てん和わ linux shell 有ゆう很大不同ふどう，详细见后文ぶん “智能ちのう变量” 一いち节）。他た们的区く别在于：'...' 中ちゅう不ふ支持しじ用よう \ 转义，也不支持しじ子こ命令めいれい（见后文ぶん “子こ命令めいれい” 一いち节），出で现任何なん内容ないよう都と当とう作さく普通ふつう字じ符ふ对待。所以ゆえん '\t|abc|' 用よう "..." 来らい表おもて达必须用 "\\t\|abc\|"。

在ざい linux shell 的てき命令めいれい行ぎょう中ちゅう，所有しょゆう的てき输入输出都と是ぜ字じ符ふ串くし，基本きほん上じょう没ぼつ有ゆう类型系けい统可言ごと。这一いち点てん我わが们和 linux shell 有ゆう很大的てき不同ふどう。我わが们的脚あし本有ほんゆう完かん备的类型系けい统。

我わが们支持しじ并仅支持しじ json 文法ぶんぽう所しょ支持しじ的てき所有しょゆう类型。基もと础类型がた包括ほうかつ：number (在ざい Go 语言中ちゅう是ぜ float64）、bool、string。复合类型包括ほうかつ array（在ざい Go 语言里さと面めん是ぜ slice，不ふ是ぜ数すう组）和かず dictionary/object (在ざい Go 语言中ちゅう是ぜ map/interface{})。特とく别需要注意ようちゅうい的てき是ぜ，我わが们的类型系けい统里面めん没ぼつ有ゆう int 类型。null 不ふ是ぜ空そら array，也不是ぜ空そら dictionary，而是空そら object。

由よし于我们采用よう了りょう命令めいれい行文こうぶん法ほう，所以ゆえん表ひょう达类型がた和わ常つね规文法ほう有ゆう一定いってい的てき差さ异。比ひ如 200、'200'、"200" 都と表示ひょうじ同どう一いち个东西にし：number 类型的てき 200。表おもて达字符ふ串くし "200" 必须用よう '"200"' 或ある者もの ""200""。

上面うわつら样例中ちゅう的てき

'[{"code": $(code1)}, {"code": 612}]'

是ぜ一いち个 array，如果我わが们用紧凑文法ぶんぽう写うつし，避免任にん何なん的てき空白くうはく字じ符ふ，可か以写成なり这样：

[{"code":$(code1)},{"code":612}]

当然とうぜん我わが们建议表达复合あい类型的てき时候，尽つき量りょう还是用よう '...' 来らい写うつし，以保证可阅读性せい。

另外，考こう虑到 json 只ただ有ゆう如下这些语法单元：

• array/dictionary/object/string: [...], {...}, null, "..."
• bool: true, false
• number: 0..9, -
• var: $(...) // 我わが们扩展てん的てき语法

我わが们可以增加ぞうか一いち条じょう规则：

• 所有しょゆう a..z 或ある A..Z 开头的てき非ひ true, false, null 文ぶん本ほん，被ひ认为是ぜ合法ごうほう的てき json string。

也就是ぜ说，以下いか这段文ぶん本ほん：

http://rs.qiniu.com/batch

等とう价于：

'"http://rs.qiniu.com/batch"'

另外，对于那な些明确接受せつじゅ string 参さん数すう的てき指令しれい，也可以省略しょうりゃく '"..."' 这样的てき外そと衣ころも。

和かず linux shell 类似，我わが们也支持しじ $(var) 或ある ${var} 格式かくしき的てき变量。但ただし是ぜ，$(var) 并不像ぞう linux shell 那な样，在ざい命令めいれい行ぎょう词法分析ぶんせき阶段就被处理掉了，它是本ほん DSL 代表だいひょう变元的てき语法成分せいぶん，和わ "..." 是ぜ常つね字じ符ふ串くし的てき语法成分せいぶん类似。另外，由ゆかり于我们存在そんざい类型系けい统，所以ゆえん $(var) 表おもて达的不ふ是ぜ一いち段だん文ぶん本ほん，而是一个可能是任意类型的 object。这带来らい这样一いち些差异：

• 支持しじ dictionary/object、array 的てき member 成なり员获取操作そうさ。比ひ如对 dictionary 可か以做 $(a.b.c) 形式けいしき的てき member 访问。对于 array，理り论上应该支持しじ $(a[1]) 这种形式けいしき，不ふ过目前まえ我わが们用的てき是ぜ $(a.1)。表おもて达 a[2].b[3].c 可か以用 $(a.2.b.3.c) 表示ひょうじ。
• 变量智能ちのう marshal。在ざい不同ふどう的てき场景下か，变量的てき marshal 结果会かい有ゆう差さ异。所以ゆえん变量 marshal 需要じゅよう上下じょうげ文ぶん，而不是ぜ简单的てき字じ符ふ串くし替がえ换。比ひ如 http://rs.qiniu.com/delete/$(ekey) 和かず {"delete":$(ekey)} 这两个地方ちほう，$(ekey) 的てき marshal 结果有ゆう很大的てき差さ别。除じょ了りょう出で现在 json 里さと面めん的てき $(ekey) 需要じゅよう用よう "..." 括くく起おこり来らい，而 url 中ちゅう不ふ需要じゅよう这样的てき显著差さ别外，对于特殊とくしゅ字じ符ふ的てき escape 转义方法ほうほう也完全ぜん不同ふどう（但ただし是ぜ这个细节经常容易ようい被ひ忽ゆるがせ略りゃく）。

这几乎是这套 DSL 中ちゅう最さい核心かくしん的てき概念がいねん。作さく为一门语言ごと，有ゆう变量，自然しぜん会かい有ゆう赋值的てき概念がいねん。在ざい这里的てき确有实现赋值的てき能力のうりょく，但ただし它不叫さけべ赋值，而是叫さけべ匹ひき配はい。先さき看み例れい子こ：

match $(a.b) 1
match $(a.c) '"hello"'

这个例れい子こ的てき结果是ぜ，得とく到いた了りょう一いち个变量りょう a，其值为 {"b": 1, "c": "hello"}。

到いた现在为止，你看到いた的てき match 像ぞう赋值的てき一いち面めん。但ただし是ぜ你不能ふのう对已经绑定てい了りょう特定とくてい值的变量再さい次つぎ赋不同ふどう的てき值：

match $(a.b) 1
match $(a.b) 1		#可か以匹配はい，因いん为$(a.b)的てき值的确为1
match $(a.b) 2		#失しつ败，1和わ2不ふ相等そうとう

match 语句可か以很复杂，如：

match '{"c": {"d": $(d)}}' '{"c": {"d": "hello", "e": "world"}, "f": 1}'

一般いっぱん地ち，match 命令めいれい的てき文法ぶんぽう为：

match <ExpectedObject> <SourceObject>

其中 <SourceObject> 中ちゅう不能ふのう出で现未绑定的てき变量。<ExpectedObject> 中ちゅう则允许存在そんざい未み绑定的てき变量。<ExpectedObject> 和わ <SourceObject> 不ふ必完全ぜん一致いっち，但ただし是これ <ExpectedObject> 中出なかいで现的，在ざい <SourceObject> 中也ちゅうや必须出で现，也就是ぜ要求ようきゅう是ぜ子こ集しゅう关系（<ExpectedObject> 是これ <SourceObject> 的てき子こ集しゅう）。<ExpectedObject> 中ちゅう某ぼう个变量りょう如果还未绑定，则按照あきら对应的てき <SourceObject> 的てき值进行ぎょう绑定；如果变量已やめ经绑定じょう，则两边的值必须是匹ひき配はい的てき。

支ささえ撑我们整个 DSL 的てき基もと石せき，正せい是ぜ匹ひき配はい文法ぶんぽう。这里你可以把所有しょゆう支持しじ的てき命令めいれい都と看み成なり是ぜ bool 表ひょう达式，如果返かえし回かい true 则成功せいこう，返かえし回かい false 则失败。我わが们看下か一开始你看到的例子的片段：

ret 298
json '[{"code": $(code1)}, {"code": 612}]'

它表达的含义是ぜ，要求ようきゅう返かえし回かい包つつみ的てき StatusCode = 298，然しか后きさき返かえし回かい的てき Response Body 必须能のう够匹配はい '[{"code": $(code1)}, {"code": 612}]'，Content-Type 则必须为 application/json。它等价于：

ret		#不ふ带参数すう的てき ret 仅仅发起请求，并将返かえし回かい包つつみ存そん储在 $(resp) 变量中ちゅう，不ふ做任何なん匹ひき配はい
match 298 $(resp.code)
match '["application/json"]' $(resp.header.Content-Type)
match '[{"code": $(code1)}, {"code": 612}]' $(resp.body)

如同 linux shell 一いち样，我わが们可以在一いち条じょう命令めいれい中ちゅう，嵌入かんにゅう另一个命令めいれい，并把该命令めいれい的てき执行结果作さく为本命令めいれい输入的てき一いち部分ぶぶん。这种嵌入かんにゅう其他命令めいれい之の中なか的てき命令めいれい，我わが们称为子命令めいれい。样例如下：

host rs.qiniu.com `env QiniuRSHost`

match $(ekey1) |base64 Bucket:Key|
match $(ekey2) |base64 Bucket2:Key2|

和かず linux shell 相しょう比ひ，我わが们多了りょう一いち个子命令めいれい语法：|...|。这没有ゆう别的意い图，纯粹是ぜ为了 Go 语言的てき友好ゆうこう性せい（linux 风格的てき子こ命令めいれい在ざい Go 里さと面めん表ひょう达需要よう特とく别费劲）。

我わが们样例れい中ちゅう的てき两个子こ命令めいれい env 和わ base64 都みやこ是ただし返かえし回かい string 类型。但ただし作さく为我们 DSL 的てき一いち部分ぶぶん，子こ命令めいれい同どう样可以返回かい我わが们类型がた系けい统中的てき任意にんい类型。所以ゆえん，原はら则上我わが们的子こ命令めいれい如同变量一いち样，有ゆう着ぎ上下じょうげ文相ぶんしょう关的 marshal 需求，比ひ如：

post http://rs.qiniu.com/delete/`base64 Bucket:Key`
match $(foo) {"ekey":`base64 Bucket:Key`}

为了达到这样的てき效果こうか，我わが们可以想象ぞう一种子命令的实现手法：

match $(__auto_var_1) `base64 Bucket:Key`
post http://rs.qiniu.com/delete/$(__auto_var_1)

match $(__auto_var_2) `base64 Bucket:Key`
match $(foo) {"ekey":$(__auto_var_2)}

也就是ぜ为每个子命令めいれい背せ地ち里さと生成せいせい一个自动变量，这样就可以让上下じょうげ文相ぶんしょう关的 marshal 能力のうりょく，统一到いた由ゆかり “智能ちのう变量” 来らい支持しじ。

请求包つつみ：

req <Method> <Url>      #可か以简写うつし为 post <Url> 或ある get <Url> 或ある delete <Url>
auth <AuthInterface>
header <Key1> <Value1>
header <Key2> <Value2>
body <BodyType> <Body>  #可か以简写うつし为 form <FormBody> 或ある json <JsonBody>

返かえし回かい包つつみ测试：

ret <Code>              #参さん数すう可か不ふ指定してい。不ふ带参数すう的てき ret 仅仅发起请求，并将返かえし回かい包つつみ存そん储在 $(resp) 变量中ちゅう
header <Key1> <Value1>
header <Key2> <Value2>
body <BodyType> <Body>  #可か以简写うつし为 json <JsonBody>

一般测试案例框架都有选择性执行某个案例、多た个案例れい共ども享とおる setUp、tearDown 这样的てき启动和わ终止代だい码。我わが们 DSL 也支持しじ，如下：

#代だい码片段だん1
...

case testCase1
#代だい码片段だん2
...

case testCase2
#代だい码片段だん3
...

tearDown
#代だい码片段だん4
...

这段代だい码里面めん，“代だい码片段だん1” 将はた被ひ认为是ぜ setUp 代だい码，“代だい码片段だん4” 是ぜ tearDown 代だい码，所有しょゆう testCase 开始前ぜん都会とかい执行一いち遍へん“代だい码片段だん1”，退出たいしゅつ前ぜん执行一いち遍へん“代だい码片段だん4”。每まい个 case 不用ふよう写うつし end 语句，遇ぐう到いた下しも一いち个 case 或ある者もの遇ぐう到いた tearDown 就代表だいひょう该 case 结束。

目前もくぜん，这套 DSL 的てき运算能力のうりょく是ぜ比ひ较有限げん的てき。基本きほん上じょう只ただ能のう做字符ふ串くし拼接（concat）。如下：

match $(c) '"Hello $(a), $(b)!"'

如果我わが们希望きぼう做复杂运算さん，我わが设想未来みらい有ゆう可能かのう通どおり过支持しじ calc 这样的てき子こ命令めいれい。例れい如：

match $(g) `calc max($(a), $(b), $(c)) + sin($(d)) + $(e)`

实现一いち个 calc 并不复杂，在ざい C++ 中ちゅう用よう TPL 只ただ是ぜ几十じゅう分ふん钟的事情じじょう（但ただし在ざい Go 语言里さと面めん怎么做还没ぼつ有ゆう特とく别去研究けんきゅう）。

考こう虑尽可能かのう利用りよう现有资源的てき话，我わが们可以考虑内嵌はま lua 来らい实现 calc 支持しじ。比ひ如：

match $(g) `calc math.max($(a), $(b), $(c)) + math.sin($(d)) + $(e)`

参考さんこう：

• https://github.com/aarzilli/golua
• https://github.com/stevedonovan/luar (基もと于 golua 的てき进一いち步ほ包装ほうそう)

有ゆう了りょう calc 事情じじょう就更有ゆう意思いし了りょう，我わが们还可か以直接ちょくせつ用よう calc 命令めいれい做断言だんげん，比ひ如：

calc $(a) < $(b)

在ざい calc 外面がいめん不ふ套任何なん指令しれい，由ゆかり于 calc 返かえし回かい false 或ある true，而基于前面めん返かえし回かい true 表示ひょうじ成功せいこう，返かえし回かい false 表示ひょうじ失しつ败的原げん则，这个指令しれい直接ちょくせつ就是断言だんげん。当然とうぜん为了友好ゆうこう，我わが们可以搞个别的てき名字みょうじ：

assert $(a) < $(b)

等ひとし等ひとし，难道我わが们真要よう做一个图灵完备的语言？上面うわつら的てき运算能力のうりょく的てき讨论已やめ经有点てん脱だつ离需求もとめ了りょう（先さき实际使用しよう中ちゅう检验吧），我わが们就此打住じゅう吧。