-
-
Notifications
You must be signed in to change notification settings - Fork 405
/
mock.go
420 lines (381 loc) · 11.6 KB
/
mock.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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
package mock
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
"sync"
"github.com/go-test/deep"
"github.com/google/uuid"
grpcMock "go.keploy.io/server/grpc/mock"
proto "go.keploy.io/server/grpc/regression"
"go.keploy.io/server/grpc/utils"
"go.keploy.io/server/pkg"
"go.keploy.io/server/pkg/models"
"go.uber.org/zap"
)
func NewMockService(mockFS models.MockFS, log *zap.Logger) *Mock {
return &Mock{
log: log,
mockFS: mockFS,
}
}
// Mock is a service to read-write mocks during record and replay in unit-tests only.
type Mock struct {
log *zap.Logger
mocks sync.Map
mockFS models.MockFS
}
func (m *Mock) FileExists(ctx context.Context, path string, overWrite bool) (bool, error) {
exists := m.mockFS.Exists(ctx, path)
if exists {
if !overWrite {
m.log.Error(fmt.Sprint("❌ Yaml file already exists with mock name: ", filepath.Base(path)))
} else {
path := strings.Split(path, "/")
fileName := strings.Split(path[len(path)-1], ".")[0]
mocks, err := m.GetAll(ctx, strings.Join(path[0:len(path)-1], "/"), fileName)
if err != nil {
return false, err
}
res, err := grpcMock.Decode(mocks)
if err != nil {
return false, err
}
if _, ok := m.mocks.Load(fileName); ok {
m.mocks.Delete(fileName)
}
m.mocks.Store(fileName, res)
}
}
return exists, nil
}
func replaceHttpFields(doc *proto.Mock, replace map[string]string) {
if doc.Kind == string(models.HTTP) {
for k, v := range replace {
fieldType := strings.Split(k, ".")[0] //req, resp, all
fieldValue := strings.Split(k, ".")[1] //header, body, proto_major, proto_minor, method, url
if fieldType == "req" || fieldType == "all" {
switch fieldValue {
case "header":
newHeader := strings.Split(v, "|") //The value of the header is a string of the form "value1|value2"
doc.Spec.Req.Header[strings.Split(k, ".")[2]] = utils.ToStrArr(newHeader)
case "domain":
url, err := url.Parse(doc.Spec.Req.URL)
if err != nil {
fmt.Println("Error while parsing url", err)
}
url.Host = v
doc.Spec.Req.URL = "something"
case "method":
doc.Spec.Req.Method = v
case "proto_major":
protomajor, err := strconv.Atoi(v)
if err != nil {
fmt.Println("Error while converting proto_major to int", err)
}
doc.Spec.Req.ProtoMajor = int64(protomajor)
case "proto_minor":
protominor, err := strconv.Atoi(v)
if err != nil {
fmt.Println("Error while converting proto_minor to int", err)
}
doc.Spec.Req.ProtoMinor = int64(protominor)
}
}
if fieldType == "meta" || fieldType == "all" {
switch fieldValue {
case "header":
newHeader := strings.Split(v, "|") //The value of the header is a string of the form "value1|value2"
doc.Spec.Req.Header[strings.Split(k, ".")[2]] = utils.ToStrArr(newHeader)
case "domain":
url, err := url.Parse(doc.Spec.Req.URL)
if err != nil {
fmt.Println("Error while parsing url", err)
}
url.Host = v
doc.Spec.Req.URL = "something"
case "method":
doc.Spec.Req.Method = v
case "proto_major":
protomajor, err := strconv.Atoi(v)
if err != nil {
fmt.Println("Error while converting proto_major to int", err)
}
doc.Spec.Req.ProtoMajor = int64(protomajor)
case "proto_minor":
protominor, err := strconv.Atoi(v)
if err != nil {
fmt.Println("Error while converting proto_minor to int", err)
}
doc.Spec.Req.ProtoMinor = int64(protominor)
}
}
}
}
}
func (m *Mock) Put(ctx context.Context, path string, doc *proto.Mock, meta interface{}, remove []string, replace map[string]string) error {
doc.Spec = pkg.FilterFields(doc.Spec, remove, m.log).(*proto.Mock_SpecSchema)
// replaceHttpFields(doc, replace)
doc.Spec = pkg.ReplaceFields(doc.Spec, replace, m.log).(*proto.Mock_SpecSchema)
newMock, err := grpcMock.Encode(doc)
if err != nil {
m.log.Error("failed to encode the mock to yaml document", zap.Error(err))
return err
}
mocksFromMap, ok := m.mocks.Load(newMock.Name)
var mocks = []*proto.Mock{}
if ok {
mocks = mocksFromMap.([]*proto.Mock)
}
if len(mocks) > 0 {
err := m.isEqual(ctx, mocks[0], doc, path, doc.Name, len(mocks))
if err == nil {
mocks = mocks[1:]
if len(mocks) > 0 {
m.mocks.Store(doc.Name, mocks)
} else {
m.mocks.Delete(doc.Name)
}
} else if err != nil && err.Error() == ERR_DEP_REQ_UNEQUAL_REMOVE {
for i := 1; i < len(mocks); i++ {
if mocks[i].Kind == doc.Kind || deep.Equal(mocks[i].Spec.Metadata, doc.Spec.Metadata) == nil && m.compareMockResponses(mocks[i], doc) {
mocks = mocks[i+1:]
if len(mocks) > 0 {
m.mocks.Store(doc.Name, mocks)
} else {
m.mocks.Delete(doc.Name)
}
break
}
}
} else if err != nil && err.Error() != ERR_DEP_REQ_UNEQUAL_INSERT {
return err
}
} else {
err = m.put(ctx, path, newMock, doc.Spec.Metadata)
if err != nil {
return err
}
}
return nil
}
func (m *Mock) put(ctx context.Context, path string, doc models.Mock, meta interface{}) error {
isGenerated := false
if doc.Name == "" {
doc.Name = uuid.New().String()
isGenerated = true
}
err := m.mockFS.Write(ctx, path, doc)
if err != nil {
m.log.Error(err.Error())
}
MockPathStr := fmt.Sprint("\n✅ Mocks are successfully written in yaml file at path: ", path, "/", doc.Name, ".yaml", "\n")
if isGenerated {
MockConfigStr := fmt.Sprint("\n\n🚨 Note: Please set the mock.Config.Name to auto generated name in your unit test. Ex: \n mock.Config{\n Name: ", doc.Name, "\n }\n")
MockNameStr := fmt.Sprint("\n💡 Auto generated name for your mock: ", doc.Name, " for ", doc.Kind, " with meta: {\n", mapToStrLog(meta.(map[string]string)), " }")
m.log.Info(fmt.Sprint(MockNameStr, MockConfigStr, MockPathStr))
} else {
m.log.Info(MockPathStr)
}
return nil
}
// GetAll returns an array of mocks which are captured in unit-tests
func (m *Mock) GetAll(ctx context.Context, path string, name string) ([]models.Mock, error) {
arr, err := m.mockFS.Read(ctx, path, name, true)
if err != nil {
m.log.Error("failed to read then yaml file", zap.Any("error", err))
return nil, err
}
MockPathStr := fmt.Sprint("\n✅ Mocks are read successfully from yaml file at path: ", path, "/", name, ".yaml", "\n")
m.log.Info(MockPathStr)
return arr, nil
}
func (m *Mock) upsert(ctx context.Context, mock *proto.Mock, path, name string, updateCount int) error {
mocks, err := m.mockFS.Read(ctx, path, name, true)
if err != nil {
m.log.Error(err.Error())
return err
}
newMock, err := grpcMock.Encode(mock)
if err != nil {
m.log.Error(err.Error())
return err
}
err = os.Remove(filepath.Join(path, name+".yaml"))
if err != nil {
m.log.Error("failed to remove mocks from", zap.String("file", name), zap.Error(err))
return err
}
mocks[len(mocks)-updateCount] = newMock
err = m.mockFS.WriteAll(ctx, path, name, mocks)
if err != nil {
m.log.Error("failed to write updated mocks", zap.Error(err))
return err
}
// for i := 0; i < len(arr)-updateCount; i++ {
// err := m.mockFS.Write(ctx, path, arr[i])
// if err != nil {
// m.log.Error(err.Error())
// return err
// }
// }
return nil
}
func (m *Mock) insertAt(ctx context.Context, mock *proto.Mock, path, name string, updateCount int) error {
mocks, err := m.mockFS.Read(ctx, path, name, true)
if err != nil {
m.log.Error(err.Error())
return err
}
newMock, err := grpcMock.Encode(mock)
if err != nil {
m.log.Error(err.Error())
return err
}
i := len(mocks) - updateCount
//insert the new mock at index i
mocks = append(mocks, newMock)
copy(mocks[i+1:], mocks[i:])
mocks[i] = newMock
// update the yaml file
err = os.Remove(filepath.Join(path, name+".yaml"))
if err != nil {
m.log.Error("failed to remove mocks from", zap.String("file", name), zap.Error(err))
return err
}
err = m.mockFS.WriteAll(ctx, path, name, mocks)
if err != nil {
m.log.Error("failed to write updated mocks", zap.Error(err))
return err
}
return nil
}
func (m *Mock) compareMockResponses(old, new *proto.Mock) bool {
matched := true
if old.Version != new.Version || old.Name != new.Name {
matched = false
}
switch old.Kind {
case string(models.GENERIC):
if deep.Equal(old.Spec.Objects, new.Spec.Objects) != nil {
matched = false
}
case string(models.HTTP):
// old.Spec.Res.ProtoMinor = 0
// if deep.Equal(old.Spec.Assertions, new.Spec.Assertions) != nil ||
if old.Spec.Res.StatusCode != new.Spec.Res.StatusCode {
matched = false
}
var (
bodyNoise []string
headerNoise = map[string]string{}
)
assertions := utils.GetStringMap(old.Spec.Assertions)
for _, n := range assertions["noise"] {
a := strings.Split(n, ".")
if len(a) > 1 && a[0] == "body" {
x := strings.Join(a[1:], ".")
bodyNoise = append(bodyNoise, x)
} else if a[0] == "header" {
// if len(a) == 2 {
// headerNoise[a[1]] = a[1]
// continue
// }
headerNoise[a[len(a)-1]] = a[len(a)-1]
// headerNoise[a[0]] = a[0]
}
}
if !pkg.Contains(assertions["noise"], "body") {
bodyType := models.BodyTypePlain
if json.Valid([]byte(new.Spec.Res.Body)) != json.Valid([]byte(old.Spec.Res.Body)) {
matched = false
}
if json.Valid([]byte(old.Spec.Res.Body)) {
bodyType = models.BodyTypeJSON
}
if bodyType == models.BodyTypeJSON {
_, _, pass, err := pkg.Match(old.Spec.Res.Body, new.Spec.Res.Body, bodyNoise, m.log)
if err != nil || !pass {
matched = false
}
} else {
if old.Spec.Res.Body != new.Spec.Res.Body {
matched = false
}
}
}
hRes := &[]models.HeaderResult{}
if !pkg.CompareHeaders(utils.GetHttpHeader(old.Spec.Res.Header), utils.GetHttpHeader(new.Spec.Res.Header), hRes, headerNoise) {
matched = false
}
case string(models.SQL):
if deep.Equal(old.Spec, new.Spec) != nil {
matched = false
}
}
return matched
}
func (m *Mock) trimMocks(ctx context.Context, mocks []models.Mock, path, name string, fromIndex, toIndex int) error {
mocks = append(mocks[0:fromIndex], mocks[toIndex:]...)
err := os.Remove(filepath.Join(path, name+".yaml"))
if err != nil {
m.log.Error("failed to remove mocks from", zap.String("file", name), zap.Error(err))
return err
}
err = m.mockFS.WriteAll(ctx, path, name, mocks)
if err != nil {
m.log.Error("failed to write updated mocks", zap.Error(err))
return err
}
return nil
}
func (m *Mock) isEqual(ctx context.Context, old, new *proto.Mock, path, name string, updateCount int) error {
if old.Kind != new.Kind || deep.Equal(old.Spec.Metadata, new.Spec.Metadata) != nil {
mArr, err := m.mockFS.Read(ctx, path, name, true)
if err != nil {
m.log.Error(err.Error())
return err
}
mocks, err := grpcMock.Decode(mArr)
if err != nil {
m.log.Error(err.Error())
return err
}
for i := len(mocks) - updateCount + 1; i < len(mocks); i++ {
if mocks[i].Kind == new.Kind && deep.Equal(mocks[i].Spec.Metadata, new.Spec.Metadata) == nil && m.compareMockResponses(mocks[i], new) {
err := m.trimMocks(ctx, mArr, path, name, len(mocks)-updateCount, i)
if err != nil {
return err
}
return errors.New(ERR_DEP_REQ_UNEQUAL_REMOVE)
}
}
err = m.insertAt(ctx, new, path, name, updateCount)
if err != nil {
return err
}
m.log.Info("Request of dmocks not matches: ", zap.Any("", old.Kind), zap.Any("", new.Kind))
return errors.New(ERR_DEP_REQ_UNEQUAL_INSERT)
}
matched := m.compareMockResponses(old, new)
if !matched {
err := m.upsert(ctx, new, path, name, updateCount)
if err != nil {
return err
}
}
return nil
}
func mapToStrLog(meta map[string]string) string {
res := ""
for k, v := range meta {
res += " " + k + ": " + v + "\n"
}
return res
}