-
Notifications
You must be signed in to change notification settings - Fork 1
/
status_test.go
633 lines (578 loc) · 16.6 KB
/
status_test.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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
package ctrl
import (
"context"
"encoding/json"
"io"
"os"
"testing"
"time"
"github.com/google/uuid"
"github.com/nats-io/nats-server/v2/server"
srvtest "github.com/nats-io/nats-server/v2/test"
"github.com/nats-io/nats.go"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
orc "github.com/metal-toolbox/conditionorc/pkg/api/v1/orchestrator/client"
orctypes "github.com/metal-toolbox/conditionorc/pkg/api/v1/orchestrator/types"
"github.com/metal-toolbox/rivets/condition"
"github.com/metal-toolbox/rivets/events"
"github.com/metal-toolbox/rivets/events/registry"
)
func startJetStreamServer(t *testing.T) *server.Server {
t.Helper()
opts := srvtest.DefaultTestOptions
opts.Port = -1
opts.JetStream = true
return srvtest.RunServer(&opts)
}
func jetStreamContext(t *testing.T, s *server.Server) (*nats.Conn, nats.JetStreamContext) {
t.Helper()
nc, err := nats.Connect(s.ClientURL())
if err != nil {
t.Fatalf("connect => %v", err)
}
js, err := nc.JetStream(nats.MaxWait(10 * time.Second))
if err != nil {
t.Fatalf("JetStream => %v", err)
}
return nc, js
}
func shutdownJetStream(t *testing.T, s *server.Server) {
t.Helper()
var sd string
if config := s.JetStreamConfig(); config != nil {
sd = config.StoreDir
}
s.Shutdown()
if sd != "" {
if err := os.RemoveAll(sd); err != nil {
t.Fatalf("Unable to remove storage %q: %v", sd, err)
}
}
s.WaitForShutdown()
}
func TestNewNatsConditionStatusPublisher(t *testing.T) {
srv := startJetStreamServer(t)
defer shutdownJetStream(t, srv)
natsConn, _ := jetStreamContext(t, srv) // nc is closed on evJS.Close(), js needs no cleanup
evJS := events.NewJetstreamFromConn(natsConn)
defer evJS.Close()
cond := &condition.Condition{
Kind: condition.FirmwareInstall,
ID: uuid.New(),
}
const facilityCode = "fac13"
controllerID := registry.GetID("test")
controller := &NatsController{
stream: evJS,
facilityCode: facilityCode,
conditionKind: cond.Kind,
logger: logrus.New(),
}
// test happy case
p, err := NewNatsConditionStatusPublisher(
"test",
cond.ID.String(),
facilityCode,
cond.Kind,
controllerID,
0,
evJS,
controller.logger,
)
publisher, ok := p.(*NatsConditionStatusPublisher)
assert.True(t, ok)
require.Nil(t, err)
require.NotNil(t, publisher, "publisher constructor")
assert.Equal(t, controller.facilityCode, publisher.facilityCode)
assert.Equal(t, cond.ID.String(), publisher.conditionID)
assert.Equal(t, controller.logger, publisher.log)
// Test re-initialized publisher will set lastRev to KV revision and subsequent publishes work
serverID := uuid.New()
require.NotPanics(t,
func() {
errP := publisher.Publish(
context.Background(),
serverID.String(),
condition.Pending,
[]byte(`{"pending...": "true"}`),
false,
)
require.NoError(t, errP)
},
"publish 1",
)
require.Equal(t, uint64(1), publisher.lastRev)
p, err = NewNatsConditionStatusPublisher(
"test",
cond.ID.String(),
facilityCode,
cond.Kind,
controllerID,
0,
evJS,
controller.logger,
)
publisher, ok = p.(*NatsConditionStatusPublisher)
assert.True(t, ok)
require.Nil(t, err)
require.NotNil(t, publisher, "publisher constructor")
require.Equal(t, uint64(1), publisher.lastRev)
require.NotPanics(t,
func() {
errP := publisher.Publish(
context.Background(),
serverID.String(),
condition.Active,
[]byte(`{"some work...": "true"}`),
false,
)
require.NoError(t, errP)
},
"publish 2",
)
require.Equal(t, uint64(2), publisher.lastRev)
}
func TestPublish(t *testing.T) {
srv := startJetStreamServer(t)
defer shutdownJetStream(t, srv)
natsConn, jsCtx := jetStreamContext(t, srv) // nc is closed on evJS.Close(), js needs no cleanup
evJS := events.NewJetstreamFromConn(natsConn)
defer evJS.Close()
cond := &condition.Condition{
Kind: condition.FirmwareInstall,
ID: uuid.New(),
}
const facilityCode = "fac13"
controllerID := registry.GetID("test")
controller := &NatsController{
stream: evJS,
facilityCode: facilityCode,
conditionKind: cond.Kind,
logger: logrus.New(),
}
p, err := NewNatsConditionStatusPublisher(
"test",
cond.ID.String(),
facilityCode,
cond.Kind,
controllerID,
0,
evJS,
controller.logger,
)
publisher, ok := p.(*NatsConditionStatusPublisher)
assert.True(t, ok)
require.Nil(t, err)
require.NotNil(t, publisher, "publisher constructor")
kv, err := jsCtx.KeyValue(string(cond.Kind))
require.NoError(t, err, "kv read handle")
serverID := uuid.New()
// publish pending status
require.NotPanics(t,
func() {
errP := publisher.Publish(
context.Background(), serverID.String(),
condition.Pending,
[]byte(`{"pending...": "true"}`),
false,
)
require.NoError(t, errP)
},
"publish pending",
)
require.NotEqual(t, 0, publisher.lastRev, "last rev - 1")
entry, err := kv.Get(facilityCode + "." + cond.ID.String())
require.Nil(t, err)
require.Equal(t, entry.Revision(), publisher.lastRev, "last rev - 2")
sv := &condition.StatusValue{}
err = json.Unmarshal(entry.Value(), sv)
require.NoError(t, err, "unmarshal")
require.Equal(t, condition.StatusValueVersion, sv.MsgVersion, "version check")
require.Equal(t, serverID.String(), sv.Target, "sv Target")
require.Contains(t, string(sv.Status), condition.Pending, "sv Status")
// publish active status
require.NotPanics(t,
func() {
errP := publisher.Publish(
context.Background(),
serverID.String(),
condition.Active,
[]byte(`{"active...": "true"}`),
false,
)
require.NoError(t, errP)
},
"publish active",
)
entry, err = kv.Get(facilityCode + "." + cond.ID.String())
require.Nil(t, err)
require.Equal(t, entry.Revision(), publisher.lastRev, "last rev - 3")
}
func TestConditionState(t *testing.T) {
srv := startJetStreamServer(t)
defer shutdownJetStream(t, srv)
natsConn, jsCtx := jetStreamContext(t, srv) // nc is closed on evJS.Close(), js needs no cleanup
evJS := events.NewJetstreamFromConn(natsConn)
defer evJS.Close()
kvName := "testKV"
_, err := jsCtx.CreateKeyValue(&nats.KeyValueConfig{Bucket: kvName})
require.NoError(t, err)
kvStore, err := jsCtx.KeyValue(kvName)
require.NoError(t, err)
tests := []struct {
name string
setup func(string, nats.KeyValue)
conditionID string
expected *condition.StatusValue
}{
{
name: "Condition not started",
// nolint:revive // function param names I'd like to keep around, k thx revive
setup: func(conditionID string, kv nats.KeyValue) {
// No setup needed as no KV entry will exist
},
},
{
name: "Condition complete",
setup: func(conditionID string, kv nats.KeyValue) {
statusValue := &condition.StatusValue{
State: string(condition.Succeeded),
// Populate other required fields
}
data, _ := json.Marshal(statusValue)
if _, err := kv.Put("testFacility."+conditionID, data); err != nil {
t.Fatal(err)
}
},
},
{
name: "Condition indeterminate (unreadable status)",
setup: func(conditionID string, kv nats.KeyValue) {
// Put unreadable data
if _, err := kv.Put("testFacility."+conditionID, []byte("not json")); err != nil {
t.Fatal(err)
}
},
},
{
name: "Condition orphaned (missing worker data)",
setup: func(conditionID string, kv nats.KeyValue) {
statusValue := &condition.StatusValue{
State: string(condition.Pending),
WorkerID: "missingWorker",
// Populate other required fields
}
data, _ := json.Marshal(statusValue)
if _, err := kv.Put("testFacility."+conditionID, data); err != nil {
t.Fatal(err)
}
},
},
}
for _, tt := range tests {
tt.conditionID = uuid.New().String()
t.Run(tt.name, func(t *testing.T) {
tt.setup(tt.conditionID, kvStore)
entry, err := kvStore.Get("testFacility." + tt.conditionID)
if errors.Is(err, nats.ErrKeyNotFound) && tt.name == "Condition not started" {
// Expected path for not started condition
return
}
require.NoError(t, err, "Expect no error fetching entry")
var sv condition.StatusValue
err = json.Unmarshal(entry.Value(), &sv)
if tt.name == "Condition indeterminate (unreadable status)" {
require.Error(t, err, "Expect error on unmarshal for indeterminate condition")
} else {
require.NoError(t, err, "Expect successful unmarshal for condition status")
}
})
}
}
func TestStatusValueUpdate(t *testing.T) {
tests := []struct {
name string
curSV *condition.StatusValue
newSV *condition.StatusValue
expectedSV *condition.StatusValue
expectedErrContains string
}{
{
name: "Successful status update with different states",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Pending),
Status: json.RawMessage(`{"msg":"status1"}`),
},
newSV: &condition.StatusValue{
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status2"}`),
},
expectedSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status2"}`),
UpdatedAt: time.Now(),
},
},
{
name: "Error returned when update on a finalized condition",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Succeeded),
Status: json.RawMessage(`{"msg":"status1"}`),
},
newSV: &condition.StatusValue{
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status2"}`),
},
expectedSV: nil,
expectedErrContains: "invalid update, condition state already finalized",
},
{
name: "Error returned for invalid current Status JSON",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status1}`),
},
newSV: &condition.StatusValue{
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status2"}`),
},
expectedSV: nil,
expectedErrContains: "current StatusValue unmarshal error",
},
{
name: "Error returned for invalid new Status JSON",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status1"}`),
},
newSV: &condition.StatusValue{
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"status2}`),
},
expectedSV: nil,
expectedErrContains: "new StatusValue unmarshal error",
},
{
name: "Empty status update does not overwrite current",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"hello"}`),
},
newSV: &condition.StatusValue{
State: string(condition.Active),
Status: json.RawMessage(`{}`),
},
expectedSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"hello"}`),
UpdatedAt: time.Now(),
},
},
{
name: "Empty new State does not overwrite current",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"hello"}`),
},
newSV: &condition.StatusValue{
Status: json.RawMessage(`{"msg": "hello 2"}`),
},
expectedSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"hello 2"}`),
UpdatedAt: time.Now(),
},
},
{
name: "No update when status is equal",
curSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"same"}`),
},
newSV: &condition.StatusValue{
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"same"}`),
},
expectedSV: &condition.StatusValue{
WorkerID: "worker1",
Target: "target1",
TraceID: "trace1",
SpanID: "span1",
State: string(condition.Active),
Status: json.RawMessage(`{"msg":"same"}`),
UpdatedAt: time.Now(),
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotSV, err := statusValueUpdate(tt.curSV, tt.newSV)
if tt.expectedErrContains != "" {
require.Error(t, err)
assert.Contains(t, err.Error(), tt.expectedErrContains)
} else {
require.NoError(t, err)
assert.Equal(t, tt.expectedSV.WorkerID, gotSV.WorkerID)
assert.Equal(t, tt.expectedSV.Target, gotSV.Target)
assert.Equal(t, tt.expectedSV.TraceID, gotSV.TraceID)
assert.Equal(t, tt.expectedSV.SpanID, gotSV.SpanID)
assert.Equal(t, tt.expectedSV.State, gotSV.State)
assert.JSONEq(t, string(tt.expectedSV.Status), string(gotSV.Status))
assert.WithinDuration(t, tt.expectedSV.UpdatedAt, gotSV.UpdatedAt, time.Second)
}
})
}
}
func TestHTTPConditionStatusPublisher_Publish(t *testing.T) {
logger := logrus.New()
logger.SetOutput(io.Discard)
serverID := uuid.New()
conditionID := uuid.New()
conditionKind := condition.FirmwareInstall
publisher := &HTTPConditionStatusPublisher{
controllerID: registry.GetIDWithUUID("test", serverID),
conditionID: conditionID,
conditionKind: conditionKind,
serverID: serverID,
logger: logger,
}
tests := []struct {
name string
state condition.State
status json.RawMessage
tsUpdateOnly bool
mockSetup func(m *orc.MockQueryor)
expectedError string
}{
{
name: "Successful publish",
state: condition.Active,
status: json.RawMessage(`{"message":"In progress"}`),
tsUpdateOnly: false,
mockSetup: func(m *orc.MockQueryor) {
m.On("ConditionStatusUpdate",
mock.Anything,
conditionKind,
serverID,
conditionID,
mock.MatchedBy(func(sv *condition.StatusValue) bool {
assert.Equal(t, sv.State, string(condition.Active))
assert.Equal(t, sv.Target, serverID.String())
assert.WithinDuration(t, time.Now(), sv.UpdatedAt, time.Second)
return true
}),
false,
).Return(&orctypes.ServerResponse{StatusCode: 200}, nil)
},
},
{
name: "Successful timestamp-only update",
state: condition.Active,
status: json.RawMessage(`{"message":"In progress"}`),
tsUpdateOnly: true,
mockSetup: func(m *orc.MockQueryor) {
m.On("ConditionStatusUpdate",
mock.Anything,
conditionKind,
serverID,
conditionID,
mock.IsType(&condition.StatusValue{}),
true,
).Return(&orctypes.ServerResponse{StatusCode: 200}, nil)
},
},
{
name: "Publish error",
state: condition.Failed,
status: json.RawMessage(`{"error":"Something went wrong"}`),
tsUpdateOnly: false,
mockSetup: func(m *orc.MockQueryor) {
m.On("ConditionStatusUpdate",
mock.Anything,
conditionKind,
serverID,
conditionID,
mock.IsType(&condition.StatusValue{}),
false,
).Return(nil, errors.New("Publish error"))
},
expectedError: "Publish error",
},
{
name: "Non-200 status code",
state: condition.Succeeded,
status: json.RawMessage(`{"message":"Completed successfully"}`),
tsUpdateOnly: false,
mockSetup: func(m *orc.MockQueryor) {
m.On("ConditionStatusUpdate",
mock.Anything,
conditionKind,
serverID,
conditionID,
mock.IsType(&condition.StatusValue{}),
false,
).Return(&orctypes.ServerResponse{StatusCode: 400}, nil)
},
expectedError: "API Query returned error, status code: 400: condition status publish error",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
mockQueryor := new(orc.MockQueryor)
tt.mockSetup(mockQueryor)
publisher.orcQueryor = mockQueryor
ctx := context.Background()
err := publisher.Publish(ctx, serverID.String(), tt.state, tt.status, tt.tsUpdateOnly)
if tt.expectedError != "" {
assert.Error(t, err)
assert.Contains(t, err.Error(), tt.expectedError)
} else {
assert.NoError(t, err)
}
})
}
}