WireMock是一个HTTP模拟服务器,其核心是Web服务器,可以准备好为特定请求(存根)提供预设响应,并捕获传入的请求,以便以后检查它们(验证)。当在开发接口时,我们的接口依赖于第三方接口的返回,但第三方接口未开发完成时,我们可以用WireMock来模拟真实的接口服务进行数据返回。又例如, 前端与后端分开开发时,前端依赖于后端接口,后端接口未开发完时,可以自己mock一个接口来进行页面开发。
面来说说基于Junit的REST Assured测试来验证模拟的行为,首先需要在工程里面添加wiremock的jar包。如果下载的java是8.0以上的版本,添加依赖方式如下:
maven:
gradle:
testCompile "com.github.tomakehurst:wiremock-jre8:2.23.2"
其他版本可以参阅官网 http://wiremock.org/docs/download-and-installation/
下面我们创建一个TestCase类
Rule里定义一个WireMockRule 的对象,不传值时默认在8080端口上启动
@Rule public WireMockRule wireMockRule = new WireMockRule();
在8089端口上启动
@Rule
public WireMockRule wireMockRule = new WireMockRule(8089);
定义一个setupStub方法,用来mock一个接口,模拟接口地址为http://localhost:8089/pingpong,body为PING,返回状态为200,返回的header是Content-Type=application/xml,返回body为
public void setupStub() {
stubFor(post(urlEqualTo("/pingpong"))
.withRequestBody(matching("PING"))
.willReturn(aResponse()
.withStatus(200)
.withHeader("Content-Type", "application/xml")
.withBody("")));
}
其实转换过来就是这样的json格式
{
"request": {
"method": "POST",
"urlPath": "/pingpong",
"body": "PING"
},
"response": {
"status": 200,
"body": "",
"headers": {
"Content-Type": "application/xml"
}
}
}
然后编写测试案例,调用此方法生成一个模拟api,使用REST Assured的given when then方式,请求http://localhost:8089/pingpong地址,断言响应里的output的内容是否是PONG
@Test
public void testPingPongPositive() {
setupStub();
given().
body("PING").
when().
post("http://localhost:8089/pingpong").
then().
assertThat().
statusCode(200).
and().
assertThat().body("output", org.hamcrest.Matchers.equalTo("PONG"));
}
当我们不依赖于JUnit时,我们可以通过这种方式启动wiremock
WireMockServer wireMockServer = new WireMockServer(options().port(8089)); //No-args constructor will start on port 8080, no HTTPS wireMockServer.start(); // Sometime later wireMockServer.stop();
如果是手动测试,我们仍然可以使用wiremock模拟api服务,这时我们可以单独下wiremock的jar包,
http://wiremock.org/docs/running-standalone/,下载后进入安装jar包的路径启动wiremock
java -jar wiremock-standalone-2.1.10.jar(注意版本)
启动后会生成2个文件夹,__files和mappings。mappings文件夹里的内容可以理解为定义请求的地方,__files主要配合mappings使用,可以理解成存放response请求body的地方,在request中设置响应体文件名称,服务会对应找到__files下的这个文件作为response返回。
如这就是mappings下的一个json文件
{
"request": {
"method": "Get",
"urlPath": "/pingpong"
},
"response": {
"status": 200,
"bodyFileName": "abc.json",
"headers": {
"Content-Type": "application/xml"
}
}
}
在__files下创建abc.json文件
{
"equalToJson" : "{ "name": "qq" }",
"jsonCompareMode": "LENIENT"
}
在浏览器里打开http://localhost:8080/pingpong(8080是默认端口),可以看到返回如下内容:
{
"status": 200,
"bodyFileName": {
{
"equalToJson" : "{ "name": "qq" }",
"jsonCompareMode": "LENIENT"
}
}
"headers": {
"Content-Type": "application/xml"
}
}
注:每次修改为mapping里的文件后需重启wiremock,__files里的修改不需要