1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
package matcher
import (
"context"
"errors"
"fmt"
"testing"
"github.com/golang/mock/gomock"
"github.com/google/go-cmp/cmp"
"google.golang.org/grpc/metadata"
"google.golang.org/protobuf/testing/protocmp"
)
var (
_ gomock.Matcher = &cmpMatcher{}
_ gomock.Matcher = &errorEqMatcher{}
_ gomock.Matcher = &grpcOutgoingCtx{}
)
// ProtoEq is a better gomock.Eq() that works correctly for protobuf messages.
// Use this matcher when checking equality of structs that:
// - are v1 protobuf messages (i.e. implement "github.com/golang/protobuf/proto".Message).
// - are v2 protobuf messages (i.e. implement "google.golang.org/protobuf/proto".Message).
// - have fields of the above types.
// See https://blog.golang.org/protobuf-apiv2 for v1 vs v2 details.
func ProtoEq(t *testing.T, msg interface{}, opts ...cmp.Option) gomock.Matcher {
o := []cmp.Option{protocmp.Transform()}
o = append(o, opts...)
return Cmp(t, msg, o...)
}
func ErrorEq(expectedError string) gomock.Matcher {
return &errorEqMatcher{
expectedError: expectedError,
}
}
func ErrorIs(expectedError error) gomock.Matcher {
return &errorIsMatcher{
expectedError: expectedError,
}
}
//func K8sObjectEq(t *testing.T, obj interface{}, opts ...cmp.Option) gomock.Matcher {
// o := []cmp.Option{kube_testing.TransformToUnstructured(), cmpopts.EquateEmpty()}
// o = append(o, opts...)
// return Cmp(t, obj, o...)
//}
func Cmp(t *testing.T, expected interface{}, opts ...cmp.Option) gomock.Matcher {
return &cmpMatcher{
t: t,
expected: expected,
options: opts,
}
}
type cmpMatcher struct {
t *testing.T
expected interface{}
options []cmp.Option
}
func (e cmpMatcher) Matches(x interface{}) bool {
equal := cmp.Equal(e.expected, x, e.options...)
if !equal && e.t != nil {
e.t.Log(cmp.Diff(e.expected, x, e.options...))
}
return equal
}
func (e cmpMatcher) String() string {
return fmt.Sprintf("equals %s with %d option(s)", e.expected, len(e.options))
}
type errorEqMatcher struct {
expectedError string
}
func (e *errorEqMatcher) Matches(x interface{}) bool {
if err, ok := x.(error); ok {
return err.Error() == e.expectedError
}
return false
}
func (e *errorEqMatcher) String() string {
return fmt.Sprintf("error with message %q", e.expectedError)
}
type errorIsMatcher struct {
expectedError error
}
func (e *errorIsMatcher) Matches(x interface{}) bool {
if err, ok := x.(error); ok {
return errors.Is(err, e.expectedError)
}
return false
}
func (e *errorIsMatcher) String() string {
return fmt.Sprintf("error Is(%v)", e.expectedError)
}
type grpcOutgoingCtx struct {
kv map[string]string
}
// GrpcOutgoingCtx returns a matcher for context.Context that must contain gRPC outgoing metadata
// with certain key-value pairs.
func GrpcOutgoingCtx(kv map[string]string) gomock.Matcher {
return grpcOutgoingCtx{kv: kv}
}
func (c grpcOutgoingCtx) Matches(x interface{}) bool {
ctx, ok := x.(context.Context)
if !ok {
return false
}
md, ok := metadata.FromOutgoingContext(ctx)
if !ok {
return false
}
for k, v := range c.kv {
vals := md[k]
if len(vals) != 1 || vals[0] != v {
return false
}
}
return true
}
func (c grpcOutgoingCtx) String() string {
return fmt.Sprintf("context %v", c.kv)
}
// From: https://github.com/golang/mock/issues/43#issuecomment-1292042897
// doMatch keeps state of the custom lambda matcher.
// match is a lambda function that asserts actual value matching.
// x keeps actual value.
type doMatch[V any] struct {
match func(v V) bool
x any
}
// DoMatch creates lambda matcher instance equipped with
// lambda function to detect if actual value matches
// some arbitrary criteria.
// Lambda matcher implements gomock customer matcher
// interface https://github.com/golang/mock/blob/5b455625bd2c8ffbcc0de6a0873f864ba3820904/gomock/matchers.go#L25.
// Sample of usage:
//
// mock.EXPECT().Foo(gomock.All(
//
// DoMatch(func(v Bar) bool {
// v.Greeting == "Hello world"
// }),
//
// ))
func DoMatch[V any](m func(v V) bool) gomock.Matcher {
return &doMatch[V]{
match: m,
}
}
// Matches receives actual value x casts it to specific type defined as a type parameter V
// and calls lambda function 'match' to resolve if x matches or not.
func (o *doMatch[V]) Matches(x any) bool {
o.x = x
v, ok := x.(V)
if !ok {
return false
}
return o.match(v)
}
// String describes what matcher matches.
func (o *doMatch[V]) String() string {
return fmt.Sprintf("is matched to %v", o.x)
}
|
