-
Notifications
You must be signed in to change notification settings - Fork 1
/
model.go
399 lines (339 loc) · 11.6 KB
/
model.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
package checker
import (
"errors"
"fmt"
"net/http"
"reflect"
"sort"
"strings"
"github.com/resonatehq/durable-promise-test-harness/pkg/openapi"
"github.com/resonatehq/durable-promise-test-harness/pkg/store"
"github.com/resonatehq/durable-promise-test-harness/pkg/utils"
)
// A Model is a sequential specification of the durable promise system.
type DurablePromiseModel struct {
SequentialSpec map[store.API]StepVerifier
}
func newDurablePromiseModel() *DurablePromiseModel {
return &DurablePromiseModel{
SequentialSpec: map[store.API]StepVerifier{
store.Search: newSearchPromiseVerifier(),
store.Get: newGetPromiseVerifier(),
store.Create: newCreatePromiseVerifier(),
store.Cancel: newCompletePromiseVerifier(),
store.Resolve: newCompletePromiseVerifier(),
store.Reject: newCompletePromiseVerifier(),
},
}
}
func (m *DurablePromiseModel) Init() State {
return make(State, 0)
}
func (m *DurablePromiseModel) Step(state State, input, output event) (State, error) {
verif, ok := m.SequentialSpec[input.API]
if !ok {
return state, fmt.Errorf("unexpected operation '%d'", input.API)
}
return verif.Verify(state, input, output)
}
type StepVerifier interface {
Verify(st State, in event, out event) (State, error)
}
type SearchPromiseVerifier struct{}
func newSearchPromiseVerifier() *SearchPromiseVerifier {
return &SearchPromiseVerifier{}
}
func (v *SearchPromiseVerifier) Verify(state State, req, resp event) (State, error) {
if !isValidResponse(resp.status) {
return state, fmt.Errorf("operation has unexpected status '%d'", resp.status)
}
reqObj, ok := req.value.(*openapi.SearchPromisesParams)
if !ok {
return state, errors.New("res.Value not of type *openapi.SearchPromisesParams")
}
respObj, ok := resp.value.(*openapi.SearchPromisesResponseObj)
if !ok {
return state, errors.New("res.Value not of type *openapi.SearchPromiseResponse")
}
if resp.status != store.Ok {
return state, fmt.Errorf("expected '%d', got '%d'", store.Ok, resp.status)
}
if resp.code != http.StatusOK {
return state, fmt.Errorf("expected '%d', got '%d'", http.StatusOK, resp.code)
}
localResults := state.Search(string(*reqObj.State))
serverResults := *respObj.Promises
sort.Slice(localResults, func(i, j int) bool {
return localResults[i].Id < localResults[j].Id
})
sort.Slice(serverResults, func(i, j int) bool {
return serverResults[i].Id < serverResults[j].Id
})
if err := deepEqualPromiseList(state, localResults, serverResults); err != nil {
return state, fmt.Errorf("got mistmatched promises search results: %v", err)
}
// state does not change with read operations
return state, nil
}
type GetPromiseVerifier struct{}
func newGetPromiseVerifier() *GetPromiseVerifier {
return &GetPromiseVerifier{}
}
func (v *GetPromiseVerifier) Verify(state State, req, resp event) (State, error) {
if !isValidResponse(resp.status) {
return state, fmt.Errorf("operation has unexpected status '%d'", resp.status)
}
reqObj, ok := req.value.(string)
if !ok {
return state, errors.New("res.Value not of type string")
}
respObj, ok := resp.value.(*openapi.Promise)
if !ok {
return state, errors.New("res.Value not of type *openapi.Promise")
}
local, err := state.Get(reqObj)
if err != nil {
if resp.status == store.Fail && resp.code == http.StatusNotFound {
return state, nil
}
return state, err
}
if resp.status != store.Ok {
return state, fmt.Errorf("expected '%d', got '%d'", store.Ok, resp.status)
}
if resp.code != http.StatusOK {
return state, fmt.Errorf("expected '%d', got '%d'", http.StatusOK, resp.code)
}
if err = deepEqualPromise(state, local, respObj); err != nil {
return state, fmt.Errorf("got incorrect promise result: %v", err)
}
// state does not change with read operations
return state, nil
}
type CreatePromiseVerifier struct{}
func newCreatePromiseVerifier() *CreatePromiseVerifier {
return &CreatePromiseVerifier{}
}
func (v *CreatePromiseVerifier) Verify(state State, req, resp event) (State, error) {
if !isValidResponse(resp.status) {
return state, fmt.Errorf("operation has unexpected status '%d'", resp.status)
}
reqObj, ok := req.value.(*openapi.CreatePromiseJSONRequestBody)
if !ok {
return state, errors.New("req.Value not of type *openapi.CreatePromiseRequest")
}
respObj, ok := resp.value.(*openapi.Promise)
if !ok {
return state, errors.New("resp.Value not of type *openapi.Promise")
}
if resp.status == store.Fail {
if resp.code == http.StatusConflict && state.Exists(reqObj.Id) {
return state, nil
}
return state, fmt.Errorf("got an unexpected failure status code '%d", resp.code)
}
if resp.status != store.Ok {
return state, fmt.Errorf("expected '%d', got '%d'", store.Ok, resp.status)
}
if resp.code != http.StatusCreated && resp.code != http.StatusOK {
return state, fmt.Errorf("expected '%d' or '%d', got '%d'", http.StatusCreated, http.StatusOK, resp.code)
}
if respObj.State != openapi.PromiseStatePENDING {
return state, fmt.Errorf("expected '%s', got '%s'", openapi.PromiseStatePENDING, respObj.State)
}
newState := utils.DeepCopy(state)
newState.Set(respObj.Id, respObj)
return newState, nil
}
type CompletePromiseVerifier struct{}
func newCompletePromiseVerifier() *CompletePromiseVerifier {
return &CompletePromiseVerifier{}
}
func (v *CompletePromiseVerifier) Verify(state State, req, resp event) (State, error) {
if !isValidResponse(resp.status) {
return state, fmt.Errorf("operation has unexpected status '%d'", resp.status)
}
reqObj, ok := req.value.(*openapi.CompletePromiseRequestWrapper)
if !ok {
return state, errors.New("req.Value not of type *simulator.CompletePromiseRequestWrapper")
}
respObj, ok := resp.value.(*openapi.Promise)
if !ok {
return state, errors.New("resp.Value not of type *openapi.Promise")
}
if resp.status == store.Fail {
switch resp.code {
case http.StatusForbidden:
if state.Completed(*reqObj.Id) || isErrorResponse(respObj) || isTimedOut(respObj.State) {
return state, nil
}
return state, fmt.Errorf("got an unexpected 403 status: promise not completed")
case http.StatusNotFound:
if !state.Exists(*reqObj.Id) {
return state, nil
}
return state, fmt.Errorf("got an unexpected 404 status code: promise exists")
default:
return state, fmt.Errorf("got an unexpected failure status code '%d", resp.code)
}
}
if resp.code != http.StatusCreated && resp.code != http.StatusOK && isCorrectCompleteState(resp.API, respObj.State) {
return state, fmt.Errorf("go an unexpected ok status code '%d", resp.code)
}
newState := utils.DeepCopy(state)
newState.Set(respObj.Id, respObj)
return newState, nil
}
// State holds the expectation of the client
type State map[string]*openapi.Promise
func (s State) Set(key string, val *openapi.Promise) {
s[key] = val
}
func (s State) Search(stateParam string) []openapi.Promise {
filter := make([]openapi.Promise, 0)
for _, promise := range s {
if promise == nil && promise.State == "" {
continue
}
if strings.EqualFold(stateParam, string(openapi.PromiseStateREJECTED)) && isRejectedState(promise.State) {
filter = append(filter, *promise)
continue
}
if strings.EqualFold(stateParam, string(promise.State)) {
filter = append(filter, *promise)
}
}
return filter
}
func (s State) Get(key string) (*openapi.Promise, error) {
val, ok := s[key]
if !ok {
return nil, errors.New("promise not found")
}
return val, nil
}
func (s State) Exists(key string) bool {
_, ok := s[key]
return ok
}
func (s State) Completed(key string) bool {
val, ok := s[key]
if !ok {
return false
}
switch val.State {
case openapi.PromiseStateRESOLVED, openapi.PromiseStateREJECTED, openapi.PromiseStateREJECTEDCANCELED, openapi.PromiseStateREJECTEDTIMEDOUT:
return true
default:
return false
}
}
func (s State) String() string {
// sorts key for consistent output
keys := make([]string, 0, len(s))
for k := range s {
keys = append(keys, k)
}
sort.Strings(keys)
build := strings.Builder{}
build.WriteString("STATE\n")
build.WriteString("-----\n")
for _, k := range keys {
promise := s[k]
build.WriteString(fmt.Sprintf(
"Promise(Id=%v, state=%v)\n",
promise.Id,
promise.State,
))
}
return build.String()
}
//
// utils
//
func isValidResponse(stat store.Status) bool {
return stat == store.Ok || stat == store.Fail
}
func isTimedOut(state openapi.PromiseState) bool {
return state == openapi.PromiseStateREJECTEDTIMEDOUT
}
func isCorrectCompleteState(api store.API, state openapi.PromiseState) bool {
switch api {
case store.Resolve:
return state == openapi.PromiseStateRESOLVED
case store.Reject:
return state == openapi.PromiseStateREJECTED
case store.Cancel:
return state == openapi.PromiseStateREJECTEDCANCELED
default:
return false
}
}
func isRejectedState(state openapi.PromiseState) bool {
switch state {
case openapi.PromiseStateREJECTED, openapi.PromiseStateREJECTEDCANCELED, openapi.PromiseStateREJECTEDTIMEDOUT:
return true
default:
return false
}
}
func deepEqualPromiseList(state State, local, external []openapi.Promise) error {
if len(local) != len(external) {
return fmt.Errorf("expected '%v' promises, got '%v'instead", len(local), len(external))
}
for i := range local {
err := deepEqualPromise(state, &local[i], &external[i])
if err != nil {
return err
}
}
return nil
}
func deepEqualPromise(state State, local, external *openapi.Promise) error {
// intentionally ignore createdOn and completedOn fields
if !reflect.DeepEqual(local.CreatedOn, external.CreatedOn) {
return fmt.Errorf("expected 'CreatedOn' %v, got %v", local.CreatedOn, external.CreatedOn)
}
if !reflect.DeepEqual(local.Id, external.Id) {
return fmt.Errorf("expected 'Id' %v, got %v", local.Id, external.Id)
}
if !reflect.DeepEqual(local.Param, external.Param) {
return fmt.Errorf("expected 'Param' %v, got %v", local.Param, external.Param)
}
if !reflect.DeepEqual(local.Tags, external.Tags) {
return fmt.Errorf("expected 'Tags' %v, got %v", local.Tags, external.Tags)
}
if !reflect.DeepEqual(local.Timeout, external.Timeout) {
return fmt.Errorf("expected 'Timeout' %v, got %v", local.Timeout, external.Timeout)
}
if !reflect.DeepEqual(local.Value, external.Value) {
return fmt.Errorf("expected 'Value' %v, got %v", local.Value, external.Value)
}
// A client and a server may have clocks that are out of sync with each other. The client's
// clock reflect its local time, while the severer's clock reflects the standard time for that
// system. When setting timeouts for requests between the client and the sever, the server's
// clock is the one that matters. This is because the server sets the deadline for a request
// based on its own clock. If the client's clock drifts, it may think a request timed out when
// it really still has time left according to the server. Or the client may think it still has
// time to send a request when the deadline has already passed on the server side. To avoid
// unpredictable behavior, the server's clock is the definitive source of time for any timeouts.
// This keeps the timing consistent from the perspective of the server, which helps ensure
// reliability in the system.
if external.State != openapi.PromiseStateREJECTEDTIMEDOUT {
if !reflect.DeepEqual(local.State, external.State) {
return fmt.Errorf("expected'State' %v, got %v", local.State, external.State)
}
} else {
// if external state is timeout, then local state should update to timedout
local.State = external.State
state.Set(local.Id, local)
}
return nil
}
// hack for now to check if received error response
func isErrorResponse(respObj *openapi.Promise) bool {
if respObj.Id == "" && respObj.State == "" {
return true
}
return false
}