模擬對象

一般都叫 Mock 或 Stub, 兩者差不多, 都是模擬被測組件對外依賴的模擬, 存根 stub 就在那里, 不需要檢查它和被測組件的交互, Mock 則可以用來檢查于被測對象的交互

Mock

Mock 是測試驅(qū)動開發(fā)必備之利器, 只要有狀態(tài), 有依賴, 做單元測試就不能沒有 Mock
在 API 或 集成測試的時候, 如果依賴于第三方的 API, 也時常使用 mock server 或 mock proxy

Mock 的原則

Mockito 是廣泛使用的 Java Mock library, 它的 wiki 上有篇文章 - 如何寫出好的測試代碼, 其中提出了幾條使用 mock 的原則:

• 不要 mock 非你所有的類型

• 不要 mock 值對象

• 不要 mock 所有的東西

后兩點很好理解, 第一點有些語焉不詳, 什么叫非你所有的類型, 我的理解就是如果一個類型不是你與第三方約定的接口, 它屬于別人定義的, 你只是拿過來使用, 那么你最好不要去mock 它, 你可以寫一個中間層或適配器, 然后mock 這個中間層和適配器, 原因是第三方可以隨時更改它的定義和行為, 你把它mock掉了, 你也就不會發(fā)現(xiàn)由于別人更改了定義或行為導(dǎo)致的異常. 而你自己寫的中間層由你掌控，不必有此擔(dān)心。

與第三方或其它服務(wù)集成測試屬于Consumer Test 消費者測試和End to End 端到端的測試的范圍

Mock 使用步驟

• 1.模擬外部依賴并將mock插入到測試代碼中

• 2.定義指定的行為及響應(yīng)

• 
  

1. 執(zhí)行測試下的代碼

• 4.驗證代碼是否正確執(zhí)行

驗證什么呢, 除了你的程序的應(yīng)用邏輯, 還有對于所mock的對象的交互驗證

• 對于mock 的對象的調(diào)用次數(shù)驗證

• 對于mock 的對象的調(diào)用參數(shù)驗證

• 對于mock 的對象所給出的不同輸出結(jié)果的反應(yīng)

Mock 的問題

mock的時候最煩人的是兩個問題

1.無法mock

就我熟悉的, 也是應(yīng)用最廣的兩門語言 C 和 Java 來看

gmock 和 mockito 在大多數(shù)情況下都夠用了，一般情況下不需要也不應(yīng)該 mock 私有方法，靜態(tài)方法和全局方法，當然如果你的代碼可測試性及依賴反轉(zhuǎn)做得得沒那么好, 實在繞不過去，也有權(quán)變之法, C 可以直接改掉其在內(nèi)存中的函數(shù)地址, Java 可以利用反射或修改字節(jié)碼來搞定.

2. 需要mock的太多了

舉例來說, 我曾經(jīng)做過一個網(wǎng)絡(luò)電話控制系統(tǒng), 它會對呼入呼出的電話會做一些語音交互應(yīng)答(IVR), 并控制后續(xù)的電話會議流程, 系統(tǒng)比較復(fù)雜, 單元測試也很難做, 因為它用的是自己定義的一門領(lǐng)域特定語言 - Call Control XML, 并由自己的 Call Flow 引擎進行解析執(zhí)行, 端到端的測試由于環(huán)境及配置的復(fù)雜性做起來很麻煩, 我的一位同事提出把系統(tǒng)的網(wǎng)絡(luò)消息發(fā)送接收模塊 mock 掉, 也就是把對外交互的消息全部 mock 起來, 但是mock的消息數(shù)量巨大, 工作量驚人.

我也寫了一個類似于 hub 的類, 所有消息會回調(diào)到一個 MessageReceiver, MessageReceiver 會直接調(diào)用注冊上來的各個 MessageHandler, 每個 Handler 只關(guān)注自己關(guān)心的消息, 具體來說, 每個 Handler 都可以設(shè)置一個正則表達式, 當消息頭或消息體匹配這個正則表達式, 則由這個 Handler 來處理回應(yīng)事先 mock好的消息, 回應(yīng)你自己指定的消息, 從而把這個系統(tǒng)對外的依賴全部 mock 掉, 并測試了所有的交互

mock 的粒度

根據(jù)你測試的對象大小，粒度自然有區(qū)別，根據(jù)測試三角形，小而美，越大越麻煩, 從小到大可以分為如下三個粒度

1. mock一個函數(shù)

與這個函數(shù)的交互全部mock 掉

2. mock整個類或接口

與這個類或接口的交互全部mock 掉，接口也可指某個API

3. mock 整個系統(tǒng)

與系統(tǒng)外部的交互全部mock 掉

總之，模擬外部依賴要區(qū)分內(nèi)外的邊界，找到合適的切入點

Mock 類庫和工具

僅就我所熟悉的 Java 和 C 舉例如下, python, ruby, JavaScript 之類的腳本語言就更簡單了

Mockito for Java

http://site./

Powermock for Java

https://github.com/powermock/powermock 它通過自定義類加載器和修改字節(jié)碼來mock static methods, constructors, final classes and methods, private methods, removal of static initializers 等等

GoogleMock for C

https://github.com/google/googletest/tree/master/googlemock

Mock Server

MockServer 用來 mock 整個web service
https://github.com/jamesdbloom/mockserver

wiremock

WireMock 和上面的 mock server差不多, 是一個 HTTP-based APIs的模擬器.

http:///

典型示例

接下來, 讓我們寫幾個例子來說明 mock 和相關(guān)類庫的用法...

Mock 依賴的類和方法

基本步驟:

1. mock 設(shè)置模擬行為

2. call 調(diào)用被測試代碼

3. verify 檢驗期望行為

這里以 Guava Loading Cache 類為例, 測試它的基本行為是否符合預(yù)期

Mock 靜態(tài)方法

這里使用 Powermock 和 testng , 如果有 junit 的話, 用法稍有不同
testng 需要從 PowerMockTestCase 繼承
junit4 需要加上一個注解 @RunWith(PowerMockRunner.class)

• 靜態(tài)類和方法

package com.github.walterfan.hellotest;import lombok.extern.slf4j.Slf4j;import org.apache.commons.io.IOUtils;import java.io.File;import java.io.FileFilter;import java.io.FilenameFilter;import java.io.IOException;import java.io.InputStream;import java.nio.charset.Charset;import java.util.ArrayList;import java.util.List;@Slf4jpublic class FileUtils {    public static final FileFilter javaFileFilter = new FileFilter() {        @Override
        public boolean accept(File file) {            if(file.isDirectory()) {                return true;
            }            if(file.getName().endsWith('.java')) {                return true;
            }            return false;
        }
    };    public static List<String> listFiles(File folder, FileFilter filter) {
        List<String> files = new ArrayList<>();
        listDir(new File('.'), files, filter);        return files;
    }    public static void listDir(File folder, List<String> fileNames, FileFilter filter) {
        File[] files = folder.listFiles(filter);        for (File file: files) {            if(file.isFile()) {
                fileNames.add(file.getName());
            } else if (file.isDirectory()) {
                listDir(file, fileNames, filter);
            }
        }
    }
}

• 測試類

在 pom.xml 中加上

<dependency>
            <groupId>org.powermock</groupId>
            <artifactId>powermock-core</artifactId>
            <version>1.7.1</version>
            <scope>test</scope>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.powermock</groupId>
            <artifactId>powermock-api-mockito</artifactId>
            <version>1.7.1</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.powermock</groupId>
            <artifactId>powermock-module-junit4</artifactId>
            <version>1.7.1</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.powermock</groupId>
            <artifactId>powermock-module-testng</artifactId>
            <version>1.7.1</version>
            <scope>test</scope>
        </dependency>

Mock 第三方服務(wù)

假設(shè)我們在服務(wù)啟動時需要調(diào)用第三方的服務(wù)來獲取訪問口令

GET $third_service_url/oauth2/api/v1/access_token?client_id=$clientId&client_secret=$clientPass

返回值是 json :

{ 'token': '$token'}

我們在本地做測試時并沒有部署這個第三方服務(wù), 我們可以用如下方法 mock 掉整個第三方服務(wù)的所有 API 調(diào)用, 例子代碼如下, 這里用到了以上所說的 http://www. 庫

輸出如下

22:09:05.000 [main] DEBUG org.mockserver.client.netty.NettyHttpClient - Sending to: localhost/127.0.0.1:10086 request: {  'method' : 'PUT',  'path' : '/expectation',  'headers' : {    'host' : [ 'localhost:10086' ]
  },  'body' : {    'type' : 'STRING',    'string' : '{\n  \'httpRequest\' : {\n    \'method\' : \'GET\',\n    \'path\' : \'/oauth2/api/v1/access_token\'\n  },\n  \'httpResponse\' : {\n    \'statusCode\' : 200,\n    \'headers\' : {\n      \'Content-Type\' : [ \'application/json;charset=UTF-8\' ]\n    },\n    \'body\' : \'{ \\\'token\\\': \\\'abcd1234\\\'}\'\n  },\n  \'times\' : {\n    \'remainingTimes\' : 1,\n    \'unlimited\' : false\n  },\n  \'timeToLive\' : {\n    \'unlimited\' : true\n  }\n}',    'contentType' : 'text/plain; charset=utf-8'
  }
}22:09:05.059 [nioEventLoopGroup-4-1] DEBUG io.netty.buffer.AbstractByteBuf - -Dio.netty.buffer.bytebuf.checkAccessible: true22:09:05.060 [nioEventLoopGroup-4-1] DEBUG io.netty.util.ResourceLeakDetectorFactory - Loaded default ResourceLeakDetector: io.netty.util.ResourceLeakDetector@6fc3e61922:09:05.106 [nioEventLoopGroup-4-1] DEBUG io.netty.util.Recycler - -Dio.netty.recycler.maxCapacityPerThread: 3276822:09:05.106 [nioEventLoopGroup-4-1] DEBUG io.netty.util.Recycler - -Dio.netty.recycler.maxSharedCapacityFactor: 222:09:05.106 [nioEventLoopGroup-4-1] DEBUG io.netty.util.Recycler - -Dio.netty.recycler.linkCapacity: 1622:09:05.106 [nioEventLoopGroup-4-1] DEBUG io.netty.util.Recycler - -Dio.netty.recycler.ratio: 822:09:06.003 [nioEventLoopGroup-3-1] INFO org.mockserver.mock.HttpStateHandler - creating expectation:

    {      'httpRequest' : {        'method' : 'GET',        'path' : '/oauth2/api/v1/access_token'
      },      'times' : {        'remainingTimes' : 1,        'unlimited' : false
      },      'timeToLive' : {        'unlimited' : true
      },      'httpResponse' : {        'statusCode' : 200,        'headers' : {          'Content-Type' : [ 'application/json;charset=UTF-8' ]
        },        'body' : '{ \'token\': \'abcd1234\'}'
      }
    }22:09:06.035 [nioEventLoopGroup-4-1] DEBUG io.netty.buffer.PoolThreadCache - Freed 3 thread-local buffer(s) from thread: nioEventLoopGroup-4-1
22:09:06.106 [nioEventLoopGroup-3-2] INFO org.mockserver.mock.HttpStateHandler - request:    {      'method' : 'GET',      'path' : '/oauth2/api/v1/access_token',      'queryStringParameters' : {        'client_secret' : [ 'pass' ],        'client_id' : [ 'test' ]
      },      'headers' : {        'content-length' : [ '0' ],        'Connection' : [ 'Keep-Alive' ],        'User-Agent' : [ 'okhttp/3.8.0' ],        'Host' : [ 'localhost:10086' ],        'Accept-Encoding' : [ 'gzip' ]
      },      'keepAlive' : true,      'secure' : false
    }

 matched expectation:

    {      'method' : 'GET',      'path' : '/oauth2/api/v1/access_token'
    }22:09:06.114 [nioEventLoopGroup-3-2] INFO org.mockserver.mock.HttpStateHandler - returning response:

    {      'statusCode' : 200,      'headers' : {        'Content-Type' : [ 'application/json;charset=UTF-8' ],        'connection' : [ 'keep-alive' ]
      },      'body' : '{ \'token\': \'abcd1234\'}'
    } for request:

    {      'method' : 'GET',      'path' : '/oauth2/api/v1/access_token',      'queryStringParameters' : {        'client_secret' : [ 'pass' ],        'client_id' : [ 'test' ]
      },      'headers' : {        'content-length' : [ '0' ],        'Connection' : [ 'Keep-Alive' ],        'User-Agent' : [ 'okhttp/3.8.0' ],        'Host' : [ 'localhost:10086' ],        'Accept-Encoding' : [ 'gzip' ]
      },      'keepAlive' : true,      'secure' : false
    } for response action:

    {      'statusCode' : 200,      'headers' : {        'Content-Type' : [ 'application/json;charset=UTF-8' ]
      },      'body' : '{ \'token\': \'abcd1234\'}'
    }22:09:06.122 [main] INFO com.github.walterfan.hellotest.MockServerTest - Content-Type: application/json;charset=UTF-822:09:06.123 [main] INFO com.github.walterfan.hellotest.MockServerTest - connection: keep-alive22:09:06.123 [main] INFO com.github.walterfan.hellotest.MockServerTest - content-length: 2222:09:06.124 [main] INFO com.github.walterfan.hellotest.MockServerTest -  strResult: { 'token': 'abcd1234'}

pom.xml 如下

參考資料

• https://github.com/google/googletest/blob/master/googlemock/docs/ForDummies.md

• https://github.com/google/googletest/blob/master/googlemock/docs/CheatSheet.md

• https://github.com/google/googletest/blob/master/googlemock/docs/CookBook.md

• Mockito 官方文檔

• Mockito Refcard

• 如何寫出好測試