/
mockclient.go
381 lines (350 loc) · 10.9 KB
/
mockclient.go
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
/*
Copyright 2017 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package testutil
import (
"context"
"errors"
"fmt"
"sync"
"testing"
"time"
"github.com/golang/protobuf/proto"
"github.com/golang/protobuf/ptypes/empty"
proto3 "github.com/golang/protobuf/ptypes/struct"
pbt "github.com/golang/protobuf/ptypes/timestamp"
sppb "google.golang.org/genproto/googleapis/spanner/v1"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// Action is a mocked RPC activity that MockCloudSpannerClient will take.
type Action struct {
Method string
Err error
}
// MockCloudSpannerClient is a mock implementation of sppb.SpannerClient.
type MockCloudSpannerClient struct {
sppb.SpannerClient
mu sync.Mutex
t *testing.T
// Live sessions on the client.
sessions map[string]bool
// Expected set of actions that will be executed by the client.
actions []Action
// Session ping history.
pings []string
// Injected error, will be returned by all APIs.
injErr map[string]error
// Client will not fail on any request.
nice bool
// Client will stall on any requests.
freezed chan struct{}
}
// NewMockCloudSpannerClient creates new MockCloudSpannerClient instance.
func NewMockCloudSpannerClient(t *testing.T, acts ...Action) *MockCloudSpannerClient {
mc := &MockCloudSpannerClient{t: t, sessions: map[string]bool{}, injErr: map[string]error{}}
mc.SetActions(acts...)
// Produce a closed channel, so the default action of ready is to not block.
mc.Freeze()
mc.Unfreeze()
return mc
}
// MakeNice makes this a nice mock which will not fail on any request.
func (m *MockCloudSpannerClient) MakeNice() {
m.mu.Lock()
defer m.mu.Unlock()
m.nice = true
}
// MakeStrict makes this a strict mock which will fail on any unexpected request.
func (m *MockCloudSpannerClient) MakeStrict() {
m.mu.Lock()
defer m.mu.Unlock()
m.nice = false
}
// InjectError injects a global error that will be returned by all calls to method
// regardless of the actions array.
func (m *MockCloudSpannerClient) InjectError(method string, err error) {
m.mu.Lock()
defer m.mu.Unlock()
m.injErr[method] = err
}
// SetActions sets the new set of expected actions to MockCloudSpannerClient.
func (m *MockCloudSpannerClient) SetActions(acts ...Action) {
m.mu.Lock()
defer m.mu.Unlock()
m.actions = nil
for _, act := range acts {
m.actions = append(m.actions, act)
}
}
// DumpPings dumps the ping history.
func (m *MockCloudSpannerClient) DumpPings() []string {
m.mu.Lock()
defer m.mu.Unlock()
return append([]string(nil), m.pings...)
}
// DumpSessions dumps the internal session table.
func (m *MockCloudSpannerClient) DumpSessions() map[string]bool {
m.mu.Lock()
defer m.mu.Unlock()
st := map[string]bool{}
for s, v := range m.sessions {
st[s] = v
}
return st
}
// CreateSession is a placeholder for SpannerClient.CreateSession.
func (m *MockCloudSpannerClient) CreateSession(c context.Context, r *sppb.CreateSessionRequest, opts ...grpc.CallOption) (*sppb.Session, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
if err := m.injErr["CreateSession"]; err != nil {
return nil, err
}
s := &sppb.Session{}
if r.Database != "mockdb" {
// Reject other databases
return s, status.Errorf(codes.NotFound, fmt.Sprintf("database not found: %v", r.Database))
}
// Generate & record session name.
s.Name = fmt.Sprintf("mockdb-%v", time.Now().UnixNano())
m.sessions[s.Name] = true
return s, nil
}
// GetSession is a placeholder for SpannerClient.GetSession.
func (m *MockCloudSpannerClient) GetSession(c context.Context, r *sppb.GetSessionRequest, opts ...grpc.CallOption) (*sppb.Session, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
if err := m.injErr["GetSession"]; err != nil {
return nil, err
}
m.pings = append(m.pings, r.Name)
if _, ok := m.sessions[r.Name]; !ok {
return nil, status.Errorf(codes.NotFound, fmt.Sprintf("Session not found: %v", r.Name))
}
return &sppb.Session{Name: r.Name}, nil
}
// DeleteSession is a placeholder for SpannerClient.DeleteSession.
func (m *MockCloudSpannerClient) DeleteSession(c context.Context, r *sppb.DeleteSessionRequest, opts ...grpc.CallOption) (*empty.Empty, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
if err := m.injErr["DeleteSession"]; err != nil {
return nil, err
}
if _, ok := m.sessions[r.Name]; !ok {
// Session not found.
return &empty.Empty{}, status.Errorf(codes.NotFound, fmt.Sprintf("Session not found: %v", r.Name))
}
// Delete session from in-memory table.
delete(m.sessions, r.Name)
return &empty.Empty{}, nil
}
// ExecuteStreamingSql is a mock implementation of SpannerClient.ExecuteStreamingSql.
func (m *MockCloudSpannerClient) ExecuteStreamingSql(c context.Context, r *sppb.ExecuteSqlRequest, opts ...grpc.CallOption) (sppb.Spanner_ExecuteStreamingSqlClient, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
act, err := m.expectAction("ExecuteStreamingSql")
if err != nil {
return nil, err
}
wantReq := &sppb.ExecuteSqlRequest{
Session: "mocksession",
Transaction: &sppb.TransactionSelector{
Selector: &sppb.TransactionSelector_SingleUse{
SingleUse: &sppb.TransactionOptions{
Mode: &sppb.TransactionOptions_ReadOnly_{
ReadOnly: &sppb.TransactionOptions_ReadOnly{
TimestampBound: &sppb.TransactionOptions_ReadOnly_Strong{
Strong: true,
},
ReturnReadTimestamp: false,
},
},
},
},
},
Sql: "mockquery",
Params: &proto3.Struct{
Fields: map[string]*proto3.Value{"var1": {Kind: &proto3.Value_StringValue{StringValue: "abc"}}},
},
ParamTypes: map[string]*sppb.Type{"var1": {Code: sppb.TypeCode_STRING}},
}
if !proto.Equal(r, wantReq) {
return nil, fmt.Errorf("got query request: %v, want: %v", r, wantReq)
}
if act.Err != nil {
return nil, act.Err
}
return nil, errors.New("query never succeeds on mock client")
}
// StreamingRead is a placeholder for SpannerClient.StreamingRead.
func (m *MockCloudSpannerClient) StreamingRead(c context.Context, r *sppb.ReadRequest, opts ...grpc.CallOption) (sppb.Spanner_StreamingReadClient, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
act, err := m.expectAction("StreamingRead", "StreamingReadIndex")
if err != nil {
return nil, err
}
wantReq := &sppb.ReadRequest{
Session: "mocksession",
Transaction: &sppb.TransactionSelector{
Selector: &sppb.TransactionSelector_SingleUse{
SingleUse: &sppb.TransactionOptions{
Mode: &sppb.TransactionOptions_ReadOnly_{
ReadOnly: &sppb.TransactionOptions_ReadOnly{
TimestampBound: &sppb.TransactionOptions_ReadOnly_Strong{
Strong: true,
},
ReturnReadTimestamp: false,
},
},
},
},
},
Table: "t_mock",
Columns: []string{"col1", "col2"},
KeySet: &sppb.KeySet{
Keys: []*proto3.ListValue{
{
Values: []*proto3.Value{
{Kind: &proto3.Value_StringValue{StringValue: "foo"}},
},
},
},
Ranges: []*sppb.KeyRange{},
All: false,
},
}
if act.Method == "StreamingIndexRead" {
wantReq.Index = "idx1"
}
if !proto.Equal(r, wantReq) {
return nil, fmt.Errorf("got query request: %v, want: %v", r, wantReq)
}
if act.Err != nil {
return nil, act.Err
}
return nil, errors.New("read never succeeds on mock client")
}
// BeginTransaction is a placeholder for SpannerClient.BeginTransaction.
func (m *MockCloudSpannerClient) BeginTransaction(c context.Context, r *sppb.BeginTransactionRequest, opts ...grpc.CallOption) (*sppb.Transaction, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
if !m.nice {
act, err := m.expectAction("BeginTransaction")
if err != nil {
return nil, err
}
if act.Err != nil {
return nil, act.Err
}
}
resp := &sppb.Transaction{Id: []byte("transaction-1")}
if _, ok := r.Options.Mode.(*sppb.TransactionOptions_ReadOnly_); ok {
resp.ReadTimestamp = &pbt.Timestamp{Seconds: 3, Nanos: 4}
}
return resp, nil
}
// Commit is a placeholder for SpannerClient.Commit.
func (m *MockCloudSpannerClient) Commit(c context.Context, r *sppb.CommitRequest, opts ...grpc.CallOption) (*sppb.CommitResponse, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
if !m.nice {
act, err := m.expectAction("Commit")
if err != nil {
return nil, err
}
if act.Err != nil {
return nil, act.Err
}
}
return &sppb.CommitResponse{CommitTimestamp: &pbt.Timestamp{Seconds: 1, Nanos: 2}}, nil
}
// Rollback is a placeholder for SpannerClient.Rollback.
func (m *MockCloudSpannerClient) Rollback(c context.Context, r *sppb.RollbackRequest, opts ...grpc.CallOption) (*empty.Empty, error) {
m.ready()
m.mu.Lock()
defer m.mu.Unlock()
if !m.nice {
act, err := m.expectAction("Rollback")
if err != nil {
return nil, err
}
if act.Err != nil {
return nil, act.Err
}
}
return nil, nil
}
// PartitionQuery is a placeholder for SpannerServer.PartitionQuery.
func (m *MockCloudSpannerClient) PartitionQuery(ctx context.Context, r *sppb.PartitionQueryRequest, opts ...grpc.CallOption) (*sppb.PartitionResponse, error) {
m.ready()
return nil, errors.New("Unimplemented")
}
// PartitionRead is a placeholder for SpannerServer.PartitionRead.
func (m *MockCloudSpannerClient) PartitionRead(ctx context.Context, r *sppb.PartitionReadRequest, opts ...grpc.CallOption) (*sppb.PartitionResponse, error) {
m.ready()
return nil, errors.New("Unimplemented")
}
func (m *MockCloudSpannerClient) expectAction(methods ...string) (Action, error) {
for _, me := range methods {
if err := m.injErr[me]; err != nil {
return Action{}, err
}
}
if len(m.actions) == 0 {
m.t.Fatalf("unexpected %v executed", methods)
}
act := m.actions[0]
m.actions = m.actions[1:]
for _, me := range methods {
if me == act.Method {
return act, nil
}
}
m.t.Fatalf("unexpected call of one of %v, want method %s", methods, act.Method)
return Action{}, nil
}
// Freeze stalls all requests.
func (m *MockCloudSpannerClient) Freeze() {
m.mu.Lock()
defer m.mu.Unlock()
m.freezed = make(chan struct{})
}
// Unfreeze restores processing requests.
func (m *MockCloudSpannerClient) Unfreeze() {
m.mu.Lock()
defer m.mu.Unlock()
close(m.freezed)
}
// CheckActionsConsumed checks that all actions have been consumed.
func (m *MockCloudSpannerClient) CheckActionsConsumed() {
if len(m.actions) != 0 {
m.t.Fatalf("unconsumed mock client actions: %v", m.actions)
}
}
// ready checks conditions before executing requests
// TODO: add checks for injected errors, actions
func (m *MockCloudSpannerClient) ready() {
m.mu.Lock()
freezed := m.freezed
m.mu.Unlock()
// check if client should be freezed
<-freezed
}