玩转单元测试之WireMock -- Web服务模拟器

WireMock 是一个灵活的库用于 Web 服务测试，和其他测试工具不同的是，WireMock 创建一个实际的 HTTP服务器来运行你的 Web 服务以方便测试。

它支持 HTTP 响应存根、请求验证、代理/拦截、记录和回放，并且可以在单元测试下使用或者部署到测试环境。

它可以用在哪些场景下：

测试移动应用依赖于第三方REST APIs
创建快速原型的APIs
注入否则难于模拟第三方服务中的错误
任何单元测试的代码依赖于web服务的

目录

   前提条件

   Maven配置

   准备工作

   Examples

   Troubleshooting

   参考

前提条件

JDK 1.7

Maven 3

Maven配置

pom里添加以下的dependencies

<dependency>

      <groupId>com.github.tomakehurst</groupId>

      <artifactId>wiremock</artifactId>

      <version>1.53</version>

      <classifier>standalone</classifier>

</dependency>

<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>6.8</version>
</dependency>

如果有依赖冲突，可以exclued 掉冲突的依赖，配置如下

<dependency>

    <groupId>com.github.tomakehurst</groupId>

    <artifactId>wiremock</artifactId>

    <version>1.53</version>

    <!-- Include everything below here if you have dependency conflicts -->

    <classifier>standalone</classifier>

    <exclusions>

        <exclusion>

          <groupId>org.mortbay.jetty</groupId>

          <artifactId>jetty</artifactId>

        </exclusion>

        <exclusion>

          <groupId>com.google.guava</groupId>

          <artifactId>guava</artifactId>

        </exclusion>

        <exclusion>

          <groupId>com.fasterxml.jackson.core</groupId>

          <artifactId>jackson-core</artifactId>

        </exclusion>

        <exclusion>

          <groupId>com.fasterxml.jackson.core</groupId>

          <artifactId>jackson-annotations</artifactId>

        </exclusion>

        <exclusion>

          <groupId>com.fasterxml.jackson.core</groupId>

          <artifactId>jackson-databind</artifactId>

        </exclusion>

        <exclusion>

          <groupId>org.apache.httpcomponents</groupId>

          <artifactId>httpclient</artifactId>

        </exclusion>

        <exclusion>

          <groupId>org.skyscreamer</groupId>

          <artifactId>jsonassert</artifactId>

        </exclusion>

        <exclusion>

          <groupId>xmlunit</groupId>

          <artifactId>xmlunit</artifactId>

        </exclusion>

        <exclusion>

          <groupId>com.jayway.jsonpath</groupId>

          <artifactId>json-path</artifactId>

        </exclusion>

        <exclusion>

          <groupId>net.sf.jopt-simple</groupId>

          <artifactId>jopt-simple</artifactId>

        </exclusion>

     </exclusions>

</dependency>

exclusions

准备工作

首先我写了一个类HTTPRequestor用来执行Http request访问Rest服务的，然后我需要一个Rest服务来测试我写的类是否ok, 但我手上没有一个真实的Rest web service, 所以WireMock就可以出场了，模拟一个Rest web serivce来测试我这个类。

HTTPRequestor如下：

 package com.demo.HttpRequestor;

 import static com.jayway.restassured.RestAssured.given;

 import java.util.HashMap;

 import java.util.Map;

 import org.slf4j.Logger;

 import org.slf4j.LoggerFactory;

 import com.jayway.restassured.response.Response;

 import com.jayway.restassured.specification.RequestSpecification;

 /**

  * Wrapper for RestAssured. Perform an HTTP requests.

  *

  * @author wadexu

  *

  */

 public class HTTPRequestor {

         protected static final Logger logger = LoggerFactory.getLogger(HTTPRequestor.class);

     private RequestSpecification reqSpec;

     /**

      * Constructor. Initializes the RequestSpecification (relaxedHTTPSValidation

      * avoids certificate errors).

      *

      */

     public HTTPRequestor() {

         reqSpec = given().relaxedHTTPSValidation();

     }

     public HTTPRequestor(String proxy) {

         reqSpec = given().relaxedHTTPSValidation().proxy(proxy);

     }

     /**

      * Performs the request using the stored request data and then returns the response

      *

      * @param url

      * @param method

      * @param headers

      * @param body

      * @return response Response, will contain entire response (response string and status code).

      * @throws Exception

      */

     public Response perform_request(String url, String method, HashMap<String, String> headers, String body) throws Exception {

         Response response = null;

         try {

           for(Map.Entry<String, String> entry: headers.entrySet()) {

             reqSpec.header(entry.getKey(), entry.getValue());

           }

           switch(method) {

             case "GET": {

               response = reqSpec.get(url);

               break;

             }

             case "POST": {

               response = reqSpec.body(body).post(url);

               break;

             }

             case "PUT": {

               response = reqSpec.body(body).put(url);

               break;

             }

             case "DELETE": {

               response = reqSpec.delete(url);

               break;

             }

             default: {

               logger.error("Unknown call type: [" + method + "]");

             }

           }

         } catch (Exception e) {

           logger.error("Problem performing request: ", e);

         }

         return response;

       }

 }

这个类是需要依赖 jayway 的 rest-assured包的

        <dependency>

            <groupId>com.jayway.restassured</groupId>

            <artifactId>rest-assured</artifactId>

            <version>2.3.3</version>

            <scope>test</scope>

        </dependency>

Examples

新建一个测试类HTTPRequestorMockTest

new 一个 WireMockService 配置一下然后启动

        wireMockServer = new WireMockServer(wireMockConfig().port(8090));

        WireMock.configureFor("localhost", 8090);

        wireMockServer.start();

在测试方法之前

创建存根, 指明是GET方法，URL路径, Header的内容，会返回什么样的Response

    @BeforeTest

    public void stubRequests() {

      stubFor(get(urlEqualTo("/cars/Chevy"))

              .withHeader("Accept", equalTo("application/json"))

              .withHeader("User-Agent", equalTo("Jakarta Commons-HttpClient/3.1"))

                      .willReturn(aResponse()

                                  .withHeader("content-type", "application/json")

                                  .withStatus(200)

                                  .withBody("{\"message\":\"Chevy car response body\"}")

                                 )

             );

    }

##转载注明出处： http://www.cnblogs.com/wade-xu/p/4299710.html

一切都模拟好了，接下来开始测试了，测试方法如下

@Test

    public void test_Get_Method() {

        String url = "http://localhost:8090/cars/Chevy";

        String method = "GET";

        String body = "";

        HashMap<String, String> headers = new HashMap<String, String>();

        headers.put("Accept", "application/json");

        headers.put("User-Agent", "Jakarta Commons-HttpClient/3.1");

        HTTPRequestor httpRequestor = new HTTPRequestor();

        Response response = null;

        try {

                response = httpRequestor.perform_request(url, method, headers, body);

        } catch (Exception e) {

                fail("Problem using HTTPRequestor to generate response: " + e.getMessage());

        }

        assertEquals(200, response.getStatusCode());

        assertEquals("Chevy car response body", response.jsonPath().get("message"));

    }

上面的例子是GET，没有请求体，下面我们来看POST的例子

同理创建存根

RequestBody假设为"Mini Cooper"

 stubFor(post(urlEqualTo("/cars/Mini"))

              .withHeader("Authorization", equalTo("Basic d8d74jf82o929d"))

              .withHeader("Accept", equalTo("application/json"))

              .withHeader("User-Agent", equalTo("Jakarta Commons-HttpClient/3.1"))

              .withRequestBody(equalTo("Mini Cooper"))

                      .willReturn(aResponse()

                                  .withHeader("content-type", "application/json")

                                  .withStatus(200)

                                  .withBody("{\"message\":\"Mini Cooper car response body\", \"success\":true}")

                                 )

             );

测试方法如下：

 @Test

    public void test_Post_Method() {

        String url = "http://localhost:8090/cars/Mini";

        String method = "POST";

        String body = "Mini Cooper";

        HashMap<String, String> headers = new HashMap<String, String>();

        headers.put("Authorization", "Basic d8d74jf82o929d");

        headers.put("Accept", "application/json");

        headers.put("User-Agent", "Jakarta Commons-HttpClient/3.1");

        HTTPRequestor httpRequestor = new HTTPRequestor();

        Response response = null;

        try {

                response = httpRequestor.perform_request(url, method, headers, body);

        } catch (Exception e) {

                fail("Problem using HTTPRequestor to generate response: " + e.getMessage());

        }

        assertEquals(200, response.getStatusCode());

        assertEquals("Mini Cooper car response body", response.jsonPath().get("message"));

        assertEquals(true, response.jsonPath().get("success"));

    }

PUT 和 DELETE 都是一样的道理，有兴趣的读者可以自行练习。

测试结束之后不要忘记tear down，停掉WireMockServer

@AfterTest(alwaysRun=true)

    public void tearDown() {

      wireMockServer.stop();

      wireMockServer.shutdown();

    }

贴出我的整个测试类 (两个测试方法都需要同样的参数，所以可以用@DataProvider的方式来改进，我这里就不详细阐述了)

 package com.demo.mocktest;

 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;

 import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;

 import static com.github.tomakehurst.wiremock.client.WireMock.get;

 import static com.github.tomakehurst.wiremock.client.WireMock.post;

 import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;

 import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;

 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;

 import static org.testng.Assert.assertEquals;

 import static org.testng.Assert.fail;

 import java.util.HashMap;

 import org.testng.ITest;

 import org.testng.annotations.AfterTest;

 import org.testng.annotations.BeforeTest;

 import org.testng.annotations.Test;

 import com.demo.HttpRequestor.HTTPRequestor;

 import com.github.tomakehurst.wiremock.WireMockServer;

 import com.github.tomakehurst.wiremock.client.WireMock;

 import com.jayway.restassured.response.Response;

 public class HTTPRequestorMockTest implements ITest{

     private WireMockServer wireMockServer;

     @Override

     public String getTestName() {

       return "Mock Test";

     }

     public HTTPRequestorMockTest() {

         wireMockServer = new WireMockServer(wireMockConfig().port(8090));

         WireMock.configureFor("localhost", 8090);

         wireMockServer.start();

     }

     @BeforeTest

     public void stubRequests() {

       stubFor(get(urlEqualTo("/cars/Chevy"))

               .withHeader("Accept", equalTo("application/json"))

               .withHeader("User-Agent", equalTo("Jakarta Commons-HttpClient/3.1"))

                       .willReturn(aResponse()

                                   .withHeader("content-type", "application/json")

                                   .withStatus(200)

                                   .withBody("{\"message\":\"Chevy car response body\"}")

                                  )

              );

       stubFor(post(urlEqualTo("/cars/Mini"))

               .withHeader("Authorization", equalTo("Basic d8d74jf82o929d"))

               .withHeader("Accept", equalTo("application/json"))

               .withHeader("User-Agent", equalTo("Jakarta Commons-HttpClient/3.1"))

               .withRequestBody(equalTo("Mini Cooper"))

                       .willReturn(aResponse()

                                   .withHeader("content-type", "application/json")

                                   .withStatus(200)

                                   .withBody("{\"message\":\"Mini Cooper car response body\", \"success\":true}")

                                  )

              );

     }

     @Test

     public void test_Get_Method() {

         String url = "http://localhost:8090/cars/Chevy";

         String method = "GET";

         String body = "";

         HashMap<String, String> headers = new HashMap<String, String>();

         headers.put("Accept", "application/json");

         headers.put("User-Agent", "Jakarta Commons-HttpClient/3.1");

         HTTPRequestor httpRequestor = new HTTPRequestor();

         Response response = null;

         try {

                 response = httpRequestor.perform_request(url, method, headers, body);

         } catch (Exception e) {

                 fail("Problem using HTTPRequestor to generate response: " + e.getMessage());

         }

         assertEquals(200, response.getStatusCode());

         assertEquals("Chevy car response body", response.jsonPath().get("message"));

     }

     @Test

     public void test_Post_Method() {

         String url = "http://localhost:8090/cars/Mini";

         String method = "POST";

         String body = "Mini Cooper";

         HashMap<String, String> headers = new HashMap<String, String>();

         headers.put("Authorization", "Basic d8d74jf82o929d");

         headers.put("Accept", "application/json");

         headers.put("User-Agent", "Jakarta Commons-HttpClient/3.1");

         HTTPRequestor httpRequestor = new HTTPRequestor();

         Response response = null;

         try {

                 response = httpRequestor.perform_request(url, method, headers, body);

         } catch (Exception e) {

                 fail("Problem using HTTPRequestor to generate response: " + e.getMessage());

         }

         assertEquals(200, response.getStatusCode());

         assertEquals("Mini Cooper car response body", response.jsonPath().get("message"));

         assertEquals(true, response.jsonPath().get("success"));

     }

     @AfterTest(alwaysRun=true)

     public void tearDown() {

       wireMockServer.stop();

       wireMockServer.shutdown();

     }

 }

HTTPRequestorMockTest

##转载注明出处： http://www.cnblogs.com/wade-xu/p/4299710.html

Run as TestNG

测试结果如下：

PASSED: Mock Test

PASSED: Mock Test

===============================================

    Default test

    Tests run: 2, Failures: 0, Skips: 0

===============================================

[TestNG] Time taken by org.testng.reporters.JUnitReportReporter@26b923ee: 7 ms

[TestNG] Time taken by [TestListenerAdapter] Passed:0 Failed:0 Skipped:0]: 1 ms

[TestNG] Time taken by org.testng.reporters.EmailableReporter@512f0124: 5 ms

[TestNG] Time taken by org.testng.reporters.XMLReporter@5a4ec51c: 7 ms

[TestNG] Time taken by org.testng.reporters.SuiteHTMLReporter@5706937e: 31 ms

Troubleshooting

HTTPRequestor类第59行报错Cannot switch on a value of type String for source level below 1.7. Only convertible int values or enum constants are permitted

--- Java Build Path 设置 JRE System library 1.7 以上

Static import 如下：

import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;

import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;

import static com.github.tomakehurst.wiremock.client.WireMock.get;

import static com.github.tomakehurst.wiremock.client.WireMock.post;

import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;

import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;

import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;

参考

官方文档：http://wiremock.org/

感谢阅读，如果您觉得本文的内容对您的学习有所帮助，您可以点击右下方的推荐按钮，您的鼓励是我创作的动力。

##转载注明出处： http://www.cnblogs.com/wade-xu/p/4299710.html