Q. gomockでフィールドの部分一致を検証したい

前提：gomock.Eq について#

gomock では、主にgomock.Eq()matcher を利用して値の検証を行える。

次のように直接値を指定したケースでも、内部的にはgomock.Eq()が利用されている。

1
repo.EXPECT().someMethod(2).Return(nil)

このgomock.Eq()では、値の完全一致が求められるため、複雑な構造体を受け取るような場合に全てを列挙するか、gomock.Any()を利用してスタブと化すかのどちらかになってしまう。

1
// throw error if there are missing or incorrect fields
2
repo.EXPECT().someMethod(chaosObject{
3
    SecondaryField: "value",
4
})

gomock.Any()を利用すると値の検証は行われない。

1
repo.EXPECT().someMethod(gomock.Any())

Q. 部分一致で検証したい#

ID やタイムスタンプなど動的な値が含まれる場合や、関心事が特定のフィールドのみの場合、部分一致で検証したいことがある。

動的な値に関しては、それを生成する関数をモック化するという手段でも対応できると思われる。

A. Custom matcher を利用する#

gomock が提供しているgomock.Matcherを利用して、任意の matcher を作成することができる。

例えば、次のようにcmpを利用して部分一致を検証する matcher を作成することができる。

1
import (
2
    "github.com/golang/mock/gomock"
3
    "github.com/google/go-cmp/cmp"
4
  "github.com/google/go-cmp/cmp/cmpopts"
5
)
6

7
type someObjMatcher struct {
8
    expected someObj
9
}
10

11
func (m *someObjMatcher) Matches(x interface{}) bool {
12
    actual, ok := x.(someObj)
13
    if !ok {
14
        return false
15
    }
16

17
    return cmp.Equal(actual, m.expected, cmpopts.IgnoreFields(someObj{}, "Field1"))
18
}

次のように利用できる。

1
repo.EXPECT().someMethod(someObjMatcher{
2
    expected: someObj{
3
        Field1: "value",
4
    },
5
})

次の記事にあるように汎用的な matcher を作成することもできる。

https://cloudandbuild.jp/blog/article-5#カスタム matcher を作る

A. Do メソッド内で検証する#

gomock.Matcherを利用する方法は、matcher を作成するためのコードが必要になるため、煩雑になることがある。

gomock.Do()内で assetion を行うことでシンプルに記述できる。

1
repo.EXPECT().someMethod(gomock.Any()).Do(func(arg someObj) {
2
    assert.Equal(t, "value", arg.Field1)
3
})

ただし、特定のオブジェクトに対する検証が複数箇所で必要になるようなケースでは、Custom matcher の方が適していると思われる。