探討Golang中Mock的用法

Golang是一種開源的靜態類型程式語言，受到了越來越多開發者的歡迎和喜愛。在編寫測試程式碼時，經常需要進行Mock資料的處理。在本文中，我們將深入探討Golang中Mock的用法，以及針對不同場景下的Mock資料的處理方式。

一、為什麼需要Mocking?

在測試過程中，我們常常會遇到需要測試一些依賴第三方服務（例如API、資料庫、訊息佇列等）的程式碼。這就需要我們透過Mocking技術來模擬這些依賴服務的回應結果，以確保測試程式碼能夠獨立且快速地運行。

此外，Mocking還可以用於測試程式碼的邊界條件（例如異常情況，如輸入資料不符合要求等），以增強程式碼的健壯性和可靠性。

二、Golang中的Mocking工具

Golang中有許多Mocking工具可供選擇，其中一些比較流行的工具有：

1. testify：提供了Mocking和斷言功能，非常易於使用。可用於模擬資料庫、HTTP請求、其他服務等常見的資料來源以及輸出。
2. mockery：相對而言，該工具更加輕量級。它可以快速、準確地產生Mock程式碼，並支援運行時Mocking功能。此外，mockery在產生Mock程式碼時支援模板化輸出，可以為使用者提供更多的可自訂化的選項。
3. mockery/mockery：與上述的mockery相比，這個工具更專注於Go語言開發人員的需求。它提供了一種更為靈活的API，可以實現程式碼的可測性。 Mockery除了支援mock介面方法外，還可以mock無侵入式的外部依賴。

三、使用testify進行Mocking

下面我們將以testify作為Mocking工具，用一個範例來示範如何使用Mocking技術測試程式碼。

我們假設下面這個函數依賴一個外部HTTP API來取得資料：

func getOrderDetail(orderID int) (OrderDetail, error){
    resp, err := http.Get("https://api.example.com/order/"+strconv.Itoa(orderID))
    if err != nil {
        return nil, err
    }
    defer resp.Body.Close()
    
    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("getOrderDetail API returns error status code: %d", resp.StatusCode)
    }

    var orderDetail OrderDetail
    return orderDetail, json.NewDecoder(resp.Body).Decode(&orderDetail)
}

為了測試這個函數，我們將需要Mock掉HTTP請求。 testify提供MockHTTPServer和RoundTripper兩種方式來實作HTTP請求的Mock。

首先，我們來看看如何使用MockHTTPServer：

func TestGetOrderDetail(t *testing.T) {
    // 创建一个mock server
    server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // 按照需要返回数据
        if r.URL.Path == "/order/123" {
            fmt.Fprintln(w, "{\"orderID\":123,\"createDate\":\"2021-01-01\"}")
        } else {
            http.Error(w, "not found", http.StatusNotFound)
        }
    }))
    defer server.Close()

    // 将http client的请求地址指向mock server
    oldClient := http.DefaultClient
    http.DefaultClient = server.Client()
    defer func() { http.DefaultClient = oldClient }()

    // 调用 getOrderDetail() 函数
    orderDetail, err := getOrderDetail(123)

    // 对 getOrderDetail() 的返回结果进行断言
    assert.Nil(t, err)
    assert.Equal(t, 123, orderDetail.OrderID) // 假设OrderDetail中包含了字段 OrderID

    // 按照需要进行其他断言
}

在這個範例中，我們使用了httptest.NewServer()方法來建立mock server，然後在其handlerFunc()中模擬傳回HTTP請求的回應和狀態碼。

接著，我們將http.DefaultClient指向了mock server，以便在測試過程中呼叫getOrderDetail()時，可以讓其傳送請求到mock server。

最後，我們使用testify的斷言方法對傳回結果進行檢驗，以確保函數的正確性。

除了MockHTTPServer之外，testify還提供了RoundTripper方式來mock HTTP請求，這種方式提供了更靈活、可控的方式來模擬HTTP請求。使用者可以自訂RoundTripper的實現，以便隨時切換到mock資料來源，從而更好地控制測試過程。讀者可以參考testify官方文檔，來深入了解這個方法的使用。

四、使用mockery進行Mocking

除了testify之外，我們還可以使用mockery來進行Mocking。 mockery是基於語言內建的mock函式庫(http://golang.org/pkg/mock/)，並提供了程式碼產生工具，可以產生可重複使用Mock程式碼的框架。 Mockery支援產生介面、外部依賴兩種Mock程式碼，我們以下將以介面方式的Mocking為例進行介紹。

首先，我們需要安裝mockery生成工具：

go get github.com/vektra/mockery/v2/.../

接著，我們定義一個接口，並為其添加一個方法：

type OrderDetailFetcher interface {
    FetchOrderDetail(orderID int) (OrderDetail, error)
}

然後，在專案的根目錄下，執行以下命令以產生Mock程式碼：

mockery --name OrderDetailFetcher

這將自動產生一個名為「mock_orderdetailfetcher.go」的文件，其中已經包含了自動產生的Mock程式碼。我們可以將該Mock程式碼用於任何程式碼中，以實現介面的Mock數據，並完成測試任務。

最後，我們給出一個具體的範例，來示範如何使用mockery產生Mocking程式碼：

type OrderDetail struct {
    OrderID     int
    CreateDate  string
}

type OrderDetailFetcher interface {
    FetchOrderDetail(orderID int) (OrderDetail, error)
}

func GetOrderDetail(fetcher OrderDetailFetcher, orderID int) (OrderDetail, error) {
    orderDetail, err := fetcher.FetchOrderDetail(orderID)
    if err != nil {
        return OrderDetail{}, err
    }

    return orderDetail, nil
}

在這個範例中，我們定義了一個名為「OrderDetailFetcher」的接口，並實作了一個GetOrderDetail()函數，該函數要求使用OrderDetailFetcher介面中的FetchOrderDetail()方法來取得訂單詳情資料。我們可以使用mockery的指令自動產生FetchOrderDetail()方法的Mock程式碼：

mockery --name OrderDetailFetcher

這個指令將在目前目錄下產生一個名為「mock_orderdetailfetcher.go」的文件，其中包含了自動產生的Mock程式碼。我們只需要將Mock程式碼與我們的測試程式碼結合起來，就可以完成功能的測試任務。

func TestGetOrderDetail(t *testing.T) {
    orderDetail := OrderDetail{OrderID: 123, CreateDate: "2021-01-01"}

    // 创建一个mock对象
    mockOrderDetailFetcher := &mocks.OrderDetailFetcher{}

    // 设定mock对象的mock调用及对应的返回结果
    mockOrderDetailFetcher.On("FetchOrderDetail", 123).Return(orderDetail, nil)

    // 调用GetOrderDetail()函数
    result, err := GetOrderDetail(mockOrderDetailFetcher, 123)

    // 校验返回结果及错误码
    assert.Nil(t, err)
    assert.Equal(t, orderDetail, result)
}

在這個範例中，我們定義了一個mockOrderDetailFetcher對象，並使用Mock函式庫中的On()方法，為其FetchOrderDetail()方法指定了一個特定的呼叫規則以及對應的結果－在orderID為123的情況下傳回orderDetail物件。當取得mockOrderDetailFetcher的FetchOrderDetail(123)時，測試程式碼會直接傳回預先配置的orderDetail物件。最後，我們使用testify的斷言方法來對結果進行驗證。

總結

在這篇文章中，我們介紹了Golang中Mocking的相關知識和常見的Mocking工具，以及如何使用testify和mockery兩種工具進行Mocking操作，完成對目標函數的Mock測試。透過合理、正確的Mocking技術應用，我們可以提高程式碼的可讀性、健壯性、可靠性等面向。同時，Mocking也能夠幫助我們快速定位、解決各種程式碼可能存在的問題，並提高測試程式碼的覆蓋率和準確率。

以上是探討Golang中Mock的用法的詳細內容。更多資訊請關注PHP中文網其他相關文章！