本文章转载于搜狗测试
被测试服务请求第三方服务,针对第三方服务的响应进行异常容错测试是后端服务典型的测试场景。测试环境直接搭建第三方服务,从被测服务发送请求给第三方服务模拟异常情况十分困难。因此,测试通常采用直接配置Json文件或PHP跳转到Json文件的方式模拟第三方服务返回异常数据;一方面,不同第三方服务需要配置不同的Json文件,管理多种Json文件路径十分麻烦;另一方面,部分场景下被测服务认为PHP跳转的方式为失败的情况与预期测试结果不符,需要通过其他方式解决。为了解决上述问题,本文引入WireMock工具模拟第三方服务响应。
WireMock有两种使用方法,即在测试代码中引用WireMock的库文件和Jar包的方式使用。Jar包的方式比较轻便,本文主要介绍WireMockjar包的使用方法。
一、 搭建wiremock环境
1.下载wiremock-1.57-standalone.jar
2.启动wiremock
执行命令 java -jar wiremock-1.57-standalone.jar -port 9999 –verbose
相关参数说明:
–port: 用来设置wiremock监听端口号,不指定端口的话默认是8080
-verbose: 打印日志用的
执行命令启动后,可以看到打印的日志,如下图。
启动后在同目录下会生成两个空的文件夹:files和mappings。mappings文件夹放匹配第三方服务的匹配规则,files文件夹放满足某个规则后具体第三方服务的返回数据。
注意mapping文件有改动后,都需要重启服务才能生效。
二、 wiremock使用实例
Wiremock支持的HTTP方法比较广泛,包括GET, POST, PUT, DELETE, HEAD, TRACE, OPTIONS等,自定义头、数据模板(bodyPatterns,如不符合,抛出404错误),URL Template,Query参数匹配,显示指定文件内容等。本文总结了几种实用的方法,具体如下:
1.mappings文件夹用法
Mappings文件夹下可以直接创建以.json结尾的文件,用来匹配第三方url并返回具体响应数据。mappings文件夹下json文件如下图:
mappings主要由2部分构成:request、response。request是要匹配的请求信息,根据需要一般包括url(请求url)、method(请求方式)和header(请求头)等。response是匹配后返回的响应信息,一般包括status(响应状态码)和body(响应内容)等。
Url匹配规则有url完全匹配和url不完全匹配。假设启动wiremock监听端口是9999。
1) url完全匹配:
{
"request": {
"url":"/gethomepagechannel_rec?mid=4f62f2ecb30f62f10ee61091fc2e35eabc0deac229ed",
"method":"POST"
},
"response": {
"status":200,
"body":""
}
}
会匹配url:http://host:9999/gethomepagechannel_rec?mid=4f62f2ecb30f62f10ee61091fc2e35
eabc0deac229ed的请求,对应响应就会返回response的body内容。
2) url不完全匹配:
案例1:
{
"request": {
"urlPattern":"/gethomepagechannel_rec\\?mid=.*",
"method":"POST"
},
"response": {
"status":200,
"body":""
}
}
会匹配url:http://host:9999/gethomepagechannel_rec?mid=任意值
案例2(url匹配范围更大):
{
"request": {
"urlPattern":"/gethomepagechannel_rec.*",
"method":"POST"
},
"response": {
"status":200,
"body":""
}
}
会匹配url:http://host:9999/gethomepagechannel_rec+任意值
比如:1:http://host:9999/gethomepagechannel_rec?e=ok
2:http://host:9999/gethomepagechannel_rec
3:http://host:9999/gethomepagechannel_rec/1?p=0
响应body的设置有2种方式:body直接匹配和body配置成文件。
1) body直接匹配:
{
"request": {
"url":"/gethomepagechannel_rec2?mid=4f62f2ecb30f62f10ee61091fc2e35eabc0deac229ed",
"method":"POST"
},
"response": {
"status":200,
"body":"{\"status\":1,\"msg\":\"\",\"result\":{\"ranks\":[{\"channel_id\":\"1\",\"appendix\":\"1 |0|9|9|android\"},{\"channel_id\":\"1\",\"appendix\":\"2|1|9|9|android\"}],\"more\":{\"channel_id\":\"1024\",\"appendix\":\"1024|更多|1024|9|9|android\"}}}"
}
}
当请求匹配上了url,就会返回body的内容作为响应。
用这种方法时需要注意,body的取值不是直接放上第三方响应内容,而是需要把其转成字符串并且转义(推荐使用这个工具http://www.bejson.com/zhuanyi/ ,进入后点击压缩并转义即可)。
2) body配置成文件:使用bodyFileName参数。
{
"request": {
"urlPattern":"/gethomepagechannel_rec\\?mid=.*",
"method":"POST"
},
"response": {
"status":200,
"bodyFileName":"homepagechannel_rec.json"
}
}
当请求匹配上了url,就会返回homepagechannel_rec.json的内容作为响应。
使用该参数的好处是,可以直接把第三方服务的响应拿过来用,不需要转成字符串并转义。
模拟服务超时:使用参数fixedDelayMilliseconds(单位毫秒)
{
"priority":1,
"request": {
"urlPattern":"/channel_rec\\?mid=2.*",
"method":"POST"
},
"response": {
"status":504,
"fixedDelayMilliseconds":400
}
}
模拟服务返回404:
{
"priority":1,
"request": {
"urlPattern":"/channel_rec\\?mid=1.*",
"method":"POST"
},
"response": {
"status":404,
"jsonBody": {"status":"Error","message":"Endpoint not found"},
"headers": {
"Content-Type":"application/json"
}
}
}
2.__files文件夹用法
files主要配合mappings使用,当mappings文件夹下配置bodyFileName参数时,其值即files文件夹下具体响应数据文件的相对路径。
比如mappings文件夹下某json文件:
{
"priority":1,
"request": {
"urlPattern":"/channel_rec\\?mid=8.*",
"method":"POST"
},
"response": {
"status":200,
"bodyFileName":"homepagechannelrec/homepagechannel_rec.json"
}
}
这时要把文件homepagechannel_rec.json放在__files/ homepagechannelrec目录下。