Goでinterfaceを使ってモックオブジェクトを実装したい

Question

私がしたいことは以下のようです。

• HTTPリクエストを送るメソッドがあるが、testでは時間がかかってしまうためモックオブジェクトを使いたい。
• その際にinterface型でうまくできるようなのですが、どのようにしたらいいのでしょうか？

以下のようなメソッドをテストにしたいのです。

type client struct {}

func (c *client) Send() bool{
   //HTTPリクエストで処理
   // 真偽値を返す
}

どのようにしたらいいのでしょうか？

type client interface{
     Send() bool
}

func New() client {
    return &fakeClient
}

func (f *fakeClient) Send() bool {
      // モックなのでただ真偽値を返す
}

このようにしてあたかも本物みたいに

client := NewFake()
client.Send()

ぐらいしかないですか？僕としてはあたかも本番コードと同じようにテストを書きたいです。
また、このモックオブジェクトの作り方が正しいとしても

func New() client {
    return &fakeClient
}

でinterfaceとして本番コードと同じように書けるくらいのメリットしかありませんよね？
たとえば本番コードが更に複雑なメソッドがあったら、モックオブジェクトも同じように実装できるか不安で「使うメリットがあるのか」と思ってしまいます。

どのようにすればいいテストがかけるでしょうか？
HTTPリクエストだけでなく、もっと処理に時間がかかるテストがモックオブジェクトで書きたいのです。

Answer 1

以下は一例です。client に動作が変えられる物をフィールドとして持たせておき、テストの場合だけそれを差し替える事でテスト出来ます。例えば以下はサーバからの応答が OK である事を期待するコードです。

package main

import (
	"io/ioutil"
	"net/http"
)

type client struct {
	uri string
}

func NewClient() *client {
	return &client{
		uri: "http://mock.example.com/api",
	}
}

func (c *client) Send() bool {
	resp, err := http.Get(c.uri)
	if err != nil {
		return false
	}
	defer resp.Body.Close()
	b, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		return false
	}
	return string(b) == "OK"
}

func DoSend(c *client) bool {
	return c.Send()
}

func main() {
	client := NewClient()
	DoSend(client)
}

この DoSend() がテストしたいとします。

package main

import (
	"net/http"
	"net/http/httptest"
	"testing"
)

func TestMock(t *testing.T) {
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		if r.URL.Path == "/ok" {
			w.Write([]byte("OK"))
			return
		}
		if r.URL.Path == "/ng" {
			w.Write([]byte("NG"))
			return
		}
	}))

	c := NewClient()

	c.uri = ts.URL + "/ok"
	want := true
	got := DoSend(c)
	if got != want {
		t.Fatalf("want %v but got %v", want, got)
	}

	c.uri = ts.URL + "/ng"
	want = false
	got = DoSend(c)
	if got != want {
		t.Fatalf("want %v but got %v", want, got)
	}
}

この様に client がアクセスするターゲットを差し替える事で本番コードを変更せずにテスト出来ます。

Comments

[退会済みユーザー]

すみません、もう少し説明していただけませんか、、、初心者でテストを頑張ろうとしていて、、、すみません、、

[mattn]

どのあたりが分からないか書いてもらえると説明しやすそうです。

今回の質問者さんのコードだと、テストしたいのは client の動きであって、クライアントの作成部分 New ではないはずです。であれば client interface を実装した FakeClient を作って渡すまでがテストの範囲になりますよね。

逆に client の作成部分 New も含めてテストしたいという事であれば、FakeClient を渡す事が出来ないので、代わりに本物の client を使いつつ動きを変えられる様な仕組みを入れる必要があります。

今回の僕のコードだと本番の URL をテストコードから差し替える事で、テスト時だけ異なる動作をさせています。

要はテストしやすい様に処理毎に関数分けされていれば、モックであったり、僕の例の様な方法であったり、色んな方法でインジェクト出来るはずという事です。