-
Notifications
You must be signed in to change notification settings - Fork 65
Expand file tree
/
Copy pathcomponent_test.go
More file actions
995 lines (839 loc) · 25.7 KB
/
Copy pathcomponent_test.go
File metadata and controls
995 lines (839 loc) · 25.7 KB
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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
package nvlink
import (
"context"
"errors"
"sync/atomic"
"testing"
"time"
"github.com/NVIDIA/go-nvml/pkg/nvml"
"github.com/NVIDIA/go-nvml/pkg/nvml/mock"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
apiv1 "github.com/leptonai/gpud/api/v1"
"github.com/leptonai/gpud/components"
"github.com/leptonai/gpud/pkg/nvidia-query/nvml/device"
nvmllib "github.com/leptonai/gpud/pkg/nvidia-query/nvml/lib"
"github.com/leptonai/gpud/pkg/nvidia-query/nvml/testutil"
nvmlerrors "github.com/leptonai/gpud/pkg/nvidia/errors"
nvidiaproduct "github.com/leptonai/gpud/pkg/nvidia/product"
)
// mockNVMLInstance implements the nvml.InstanceV2 interface for testing
type mockNVMLInstance struct {
devicesFunc func() map[string]device.Device
}
func (m *mockNVMLInstance) Devices() map[string]device.Device {
if m.devicesFunc != nil {
return m.devicesFunc()
}
return nil
}
func (m *mockNVMLInstance) FabricManagerSupported() bool {
return true
}
func (m *mockNVMLInstance) FabricStateSupported() bool {
return false
}
func (m *mockNVMLInstance) GetMemoryErrorManagementCapabilities() nvidiaproduct.MemoryErrorManagementCapabilities {
return nvidiaproduct.MemoryErrorManagementCapabilities{}
}
func (m *mockNVMLInstance) ProductName() string {
return "NVIDIA Test GPU"
}
func (m *mockNVMLInstance) Architecture() string {
return ""
}
func (m *mockNVMLInstance) Brand() string {
return ""
}
func (m *mockNVMLInstance) DriverVersion() string {
return ""
}
func (m *mockNVMLInstance) DriverMajor() int {
return 0
}
func (m *mockNVMLInstance) CUDAVersion() string {
return ""
}
func (m *mockNVMLInstance) NVMLExists() bool {
return true
}
func (m *mockNVMLInstance) Library() nvmllib.Library {
return nil
}
func (m *mockNVMLInstance) Shutdown() error {
return nil
}
func (m *mockNVMLInstance) InitError() error {
return nil
}
// mockNVMLInstanceNVMLNotExists is a special mock for the case where NVMLExists returns false
type mockNVMLInstanceNVMLNotExists struct {
mockNVMLInstance
}
func (m *mockNVMLInstanceNVMLNotExists) NVMLExists() bool {
return false
}
// MockNVLinkComponent creates a component with mocked functions for testing
func MockNVLinkComponent(
ctx context.Context,
devicesFunc func() map[string]device.Device,
getNVLinkFunc func(uuid string, dev device.Device) (NVLink, error),
) components.Component {
cctx, cancel := context.WithCancel(ctx)
mockInstance := &mockNVMLInstance{
devicesFunc: devicesFunc,
}
return &component{
ctx: cctx,
cancel: cancel,
getTimeNowFunc: func() time.Time {
return time.Now().UTC()
},
nvmlInstance: mockInstance,
getNVLinkFunc: getNVLinkFunc,
getThresholdsFunc: GetDefaultExpectedLinkStates,
}
}
func TestNew(t *testing.T) {
ctx := context.Background()
mockInstance := &mockNVMLInstance{
devicesFunc: func() map[string]device.Device { return nil },
}
// Create a GPUdInstance for the New function
gpudInstance := &components.GPUdInstance{
RootCtx: ctx,
NVMLInstance: mockInstance,
}
c, err := New(gpudInstance)
assert.NotNil(t, c, "New should return a non-nil component")
assert.NoError(t, err, "New should not return an error")
assert.Equal(t, Name, c.Name(), "Component name should match")
// Type assertion to access internal fields
tc, ok := c.(*component)
require.True(t, ok, "Component should be of type *component")
assert.NotNil(t, tc.ctx, "Context should be set")
assert.NotNil(t, tc.cancel, "Cancel function should be set")
assert.NotNil(t, tc.nvmlInstance, "nvmlInstance should be set")
assert.NotNil(t, tc.getNVLinkFunc, "getNVLinkFunc should be set")
}
func TestName(t *testing.T) {
ctx := context.Background()
c := MockNVLinkComponent(ctx, nil, nil)
assert.Equal(t, Name, c.Name(), "Component name should match")
}
func TestTags(t *testing.T) {
ctx := context.Background()
c := MockNVLinkComponent(ctx, nil, nil)
expectedTags := []string{
"accelerator",
"gpu",
"nvidia",
Name,
}
tags := c.Tags()
assert.Equal(t, expectedTags, tags, "Component tags should match expected values")
assert.Len(t, tags, 4, "Component should return exactly 4 tags")
}
func TestCheckOnce_Success(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-123"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "test-arch", "test-brand", "test-cuda", "test-pci")
devs := map[string]device.Device{
uuid: mockDev,
}
getDevicesFunc := func() map[string]device.Device {
return devs
}
nvLinkState := NVLinkState{
Link: 0,
FeatureEnabled: true,
ReplayErrors: 5,
RecoveryErrors: 2,
CRCErrors: 1,
}
nvLink := NVLink{
UUID: uuid,
States: []NVLinkState{nvLinkState, nvLinkState},
}
getNVLinkFunc := func(uuid string, dev device.Device) (NVLink, error) {
return nvLink, nil
}
component := MockNVLinkComponent(ctx, getDevicesFunc, getNVLinkFunc).(*component)
_ = component.Check()
// Verify the data was collected
component.lastMu.RLock()
lastCheckResult := component.lastCheckResult
component.lastMu.RUnlock()
require.NotNil(t, lastCheckResult, "lastCheckResult should not be nil")
assert.Equal(t, apiv1.HealthStateTypeHealthy, lastCheckResult.health, "data should be marked healthy")
assert.Equal(t, "all 1 GPU(s) were checked, no nvlink issue found", lastCheckResult.reason)
assert.Len(t, lastCheckResult.NVLinks, 1)
assert.Equal(t, nvLink, lastCheckResult.NVLinks[0])
}
func TestCheckOnce_NVLinkError(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-123"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "test-arch", "test-brand", "test-cuda", "test-pci")
devs := map[string]device.Device{
uuid: mockDev,
}
getDevicesFunc := func() map[string]device.Device {
return devs
}
errExpected := errors.New("NVLink error")
getNVLinkFunc := func(uuid string, dev device.Device) (NVLink, error) {
return NVLink{}, errExpected
}
component := MockNVLinkComponent(ctx, getDevicesFunc, getNVLinkFunc).(*component)
_ = component.Check()
// Verify error handling
component.lastMu.RLock()
lastCheckResult := component.lastCheckResult
component.lastMu.RUnlock()
require.NotNil(t, lastCheckResult, "lastCheckResult should not be nil")
assert.Equal(t, apiv1.HealthStateTypeUnhealthy, lastCheckResult.health, "data should be marked unhealthy")
assert.Equal(t, errExpected, lastCheckResult.err)
assert.Equal(t, "error getting nvlink", lastCheckResult.reason)
}
func TestCheckOnce_NoDevices(t *testing.T) {
ctx := context.Background()
getDevicesFunc := func() map[string]device.Device {
return map[string]device.Device{} // Empty map
}
component := MockNVLinkComponent(ctx, getDevicesFunc, nil).(*component)
_ = component.Check()
// Verify handling of no devices
component.lastMu.RLock()
lastCheckResult := component.lastCheckResult
component.lastMu.RUnlock()
require.NotNil(t, lastCheckResult, "lastCheckResult should not be nil")
assert.Equal(t, apiv1.HealthStateTypeHealthy, lastCheckResult.health, "data should be marked healthy")
assert.Equal(t, "all 0 GPU(s) were checked, no nvlink issue found", lastCheckResult.reason)
assert.Empty(t, lastCheckResult.NVLinks)
}
func TestStates_WithData(t *testing.T) {
ctx := context.Background()
component := MockNVLinkComponent(ctx, nil, nil).(*component)
// Set test data
nvLinkState := NVLinkState{
Link: 0,
FeatureEnabled: true,
ReplayErrors: 0,
RecoveryErrors: 0,
CRCErrors: 0,
}
component.lastMu.Lock()
component.lastCheckResult = &checkResult{
NVLinks: []NVLink{
{
UUID: "gpu-uuid-123",
States: []NVLinkState{nvLinkState, nvLinkState},
},
},
health: apiv1.HealthStateTypeHealthy,
reason: "all 1 GPU(s) were checked, no nvlink issue found",
}
component.lastMu.Unlock()
// Get states
states := component.LastHealthStates()
assert.Len(t, states, 1)
state := states[0]
assert.Equal(t, Name, state.Name)
assert.Equal(t, apiv1.HealthStateTypeHealthy, state.Health)
assert.Equal(t, "all 1 GPU(s) were checked, no nvlink issue found", state.Reason)
assert.Contains(t, state.ExtraInfo["data"], "gpu-uuid-123")
}
func TestStates_WithError(t *testing.T) {
ctx := context.Background()
component := MockNVLinkComponent(ctx, nil, nil).(*component)
// Set test data with error
component.lastMu.Lock()
component.lastCheckResult = &checkResult{
err: errors.New("test NVLink error"),
health: apiv1.HealthStateTypeUnhealthy,
reason: "error getting nvlink",
}
component.lastMu.Unlock()
// Get states
states := component.LastHealthStates()
assert.Len(t, states, 1)
state := states[0]
assert.Equal(t, Name, state.Name)
assert.Equal(t, apiv1.HealthStateTypeUnhealthy, state.Health)
assert.Equal(t, "error getting nvlink", state.Reason)
assert.Equal(t, "test NVLink error", state.Error)
}
func TestStates_WithSuggestedActions(t *testing.T) {
ctx := context.Background()
component := MockNVLinkComponent(ctx, nil, nil).(*component)
component.lastMu.Lock()
component.lastCheckResult = &checkResult{
ts: time.Now().UTC(),
health: apiv1.HealthStateTypeUnhealthy,
reason: "nvlink threshold violated: require >=1 GPUs with all links active; got 0",
suggestedActions: &apiv1.SuggestedActions{
RepairActions: []apiv1.RepairActionType{apiv1.RepairActionTypeRebootSystem},
},
}
component.lastMu.Unlock()
states := component.LastHealthStates()
require.Len(t, states, 1)
state := states[0]
if assert.NotNil(t, state.SuggestedActions) {
assert.Equal(t, []apiv1.RepairActionType{apiv1.RepairActionTypeRebootSystem}, state.SuggestedActions.RepairActions)
}
}
func TestStates_NoData(t *testing.T) {
ctx := context.Background()
component := MockNVLinkComponent(ctx, nil, nil).(*component)
// Don't set any data
// Get states
states := component.LastHealthStates()
assert.Len(t, states, 1)
state := states[0]
assert.Equal(t, Name, state.Name)
assert.Equal(t, apiv1.HealthStateTypeHealthy, state.Health)
assert.Equal(t, "no data yet", state.Reason)
}
func TestEvents(t *testing.T) {
ctx := context.Background()
component := MockNVLinkComponent(ctx, nil, nil)
events, err := component.Events(ctx, time.Now())
assert.NoError(t, err)
assert.Empty(t, events)
}
func TestStart(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// Create mock functions that count calls
callCount := &atomic.Int32{}
getDevicesFunc := func() map[string]device.Device {
callCount.Add(1)
return map[string]device.Device{}
}
component := MockNVLinkComponent(ctx, getDevicesFunc, nil)
// Start should be non-blocking
err := component.Start()
assert.NoError(t, err)
// Give the goroutine time to execute CheckOnce at least once
time.Sleep(100 * time.Millisecond)
// Verify CheckOnce was called
assert.GreaterOrEqual(t, callCount.Load(), int32(1), "CheckOnce should have been called at least once")
}
func TestClose(t *testing.T) {
ctx := context.Background()
component := MockNVLinkComponent(ctx, nil, nil).(*component)
err := component.Close()
assert.NoError(t, err)
// Check that context is canceled
select {
case <-component.ctx.Done():
// Context is properly canceled
default:
t.Fatal("component context was not canceled on Close")
}
}
func TestData_GetError(t *testing.T) {
tests := []struct {
name string
data *checkResult
expected string
}{
{
name: "nil data",
data: nil,
expected: "",
},
{
name: "with error",
data: &checkResult{
err: errors.New("test error"),
},
expected: "test error",
},
{
name: "no error",
data: &checkResult{
health: apiv1.HealthStateTypeHealthy,
reason: "all good",
},
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := tt.data.getError()
assert.Equal(t, tt.expected, got)
})
}
}
func TestData_String(t *testing.T) {
tests := []struct {
name string
data *checkResult
expected string
contains string
}{
{
name: "nil data",
data: nil,
expected: "",
},
{
name: "empty nvlinks",
data: &checkResult{},
expected: "no data",
},
{
name: "with nvlink data",
data: &checkResult{
NVLinks: []NVLink{
{
UUID: "gpu-uuid-123",
BusID: "0000:01:00.0",
Supported: true,
States: []NVLinkState{
{
Link: 0,
FeatureEnabled: true,
},
},
},
},
},
contains: "gpu-uuid-123",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := tt.data.String()
if tt.expected != "" {
assert.Equal(t, tt.expected, got)
}
if tt.contains != "" {
assert.Contains(t, got, tt.contains)
}
})
}
}
func TestData_Summary(t *testing.T) {
tests := []struct {
name string
data *checkResult
expected string
}{
{
name: "nil data",
data: nil,
expected: "",
},
{
name: "with reason",
data: &checkResult{
reason: "test reason",
},
expected: "test reason",
},
{
name: "empty reason",
data: &checkResult{},
expected: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := tt.data.Summary()
assert.Equal(t, tt.expected, got)
})
}
}
func TestData_HealthState(t *testing.T) {
tests := []struct {
name string
data *checkResult
expected apiv1.HealthStateType
}{
{
name: "nil data",
data: nil,
expected: "",
},
{
name: "healthy state",
data: &checkResult{
health: apiv1.HealthStateTypeHealthy,
},
expected: apiv1.HealthStateTypeHealthy,
},
{
name: "unhealthy state",
data: &checkResult{
health: apiv1.HealthStateTypeUnhealthy,
},
expected: apiv1.HealthStateTypeUnhealthy,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := tt.data.HealthStateType()
assert.Equal(t, tt.expected, got)
})
}
}
func TestCheckOnce_NilNVMLInstance(t *testing.T) {
ctx := context.Background()
// Create component with nil nvmlInstance
component := &component{
ctx: ctx,
getTimeNowFunc: func() time.Time {
return time.Now().UTC()
},
nvmlInstance: nil,
}
result := component.Check()
data, ok := result.(*checkResult)
require.True(t, ok)
assert.Equal(t, apiv1.HealthStateTypeHealthy, data.health)
assert.Equal(t, "NVIDIA NVML instance is nil", data.reason)
}
func TestCheckOnce_NVMLNotLoaded(t *testing.T) {
ctx := context.Background()
// Use specialized mock instance where NVMLExists returns false
mockInstance := &mockNVMLInstanceNVMLNotExists{
mockNVMLInstance: mockNVMLInstance{
devicesFunc: func() map[string]device.Device { return nil },
},
}
component := &component{
ctx: ctx,
getTimeNowFunc: func() time.Time {
return time.Now().UTC()
},
nvmlInstance: mockInstance,
}
result := component.Check()
data, ok := result.(*checkResult)
require.True(t, ok)
assert.Equal(t, apiv1.HealthStateTypeHealthy, data.health)
assert.Equal(t, "NVIDIA NVML library is not loaded", data.reason)
}
func TestData_getLastHealthStates(t *testing.T) {
tests := []struct {
name string
data *checkResult
expectedHealth apiv1.HealthStateType
expectedReason string
expectedError string
}{
{
name: "nil data",
data: nil,
expectedHealth: apiv1.HealthStateTypeHealthy,
expectedReason: "no data yet",
},
{
name: "healthy data",
data: &checkResult{
NVLinks: []NVLink{
{
UUID: "gpu-uuid-123",
Supported: true,
States: []NVLinkState{},
},
},
health: apiv1.HealthStateTypeHealthy,
reason: "all good",
},
expectedHealth: apiv1.HealthStateTypeHealthy,
expectedReason: "all good",
},
{
name: "unhealthy data with error",
data: &checkResult{
NVLinks: []NVLink{
{
UUID: "gpu-uuid-123",
Supported: true,
States: []NVLinkState{},
},
},
health: apiv1.HealthStateTypeUnhealthy,
reason: "something wrong",
err: errors.New("test error"),
},
expectedHealth: apiv1.HealthStateTypeUnhealthy,
expectedReason: "something wrong",
expectedError: "test error",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
states := tt.data.HealthStates()
require.Len(t, states, 1)
state := states[0]
assert.Equal(t, Name, state.Name)
assert.Equal(t, tt.expectedHealth, state.Health)
assert.Equal(t, tt.expectedReason, state.Reason)
assert.Equal(t, tt.expectedError, state.Error)
// Check that extraInfo is properly populated for non-nil data
if tt.data != nil {
assert.NotEmpty(t, state.ExtraInfo["data"])
}
})
}
}
func TestCheck_MetricsGeneration(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-123"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "test-arch", "test-brand", "test-cuda", "test-pci")
devs := map[string]device.Device{
uuid: mockDev,
}
getDevicesFunc := func() map[string]device.Device {
return devs
}
// Create NVLink data with specific error counts to check metric values
nvLinkStates := []NVLinkState{
{
Link: 0,
FeatureEnabled: true,
ReplayErrors: 5,
RecoveryErrors: 3,
CRCErrors: 2,
},
{
Link: 1,
FeatureEnabled: false,
ReplayErrors: 1,
RecoveryErrors: 2,
CRCErrors: 3,
},
}
nvLink := NVLink{
UUID: uuid,
Supported: true,
States: nvLinkStates,
}
getNVLinkFunc := func(uuid string, dev device.Device) (NVLink, error) {
return nvLink, nil
}
// Create a component and run Check
component := MockNVLinkComponent(ctx, getDevicesFunc, getNVLinkFunc).(*component)
_ = component.Check()
// Verify the data was collected
component.lastMu.RLock()
lastCheckResult := component.lastCheckResult
component.lastMu.RUnlock()
require.NotNil(t, lastCheckResult, "lastCheckResult should not be nil")
assert.Equal(t, apiv1.HealthStateTypeHealthy, lastCheckResult.health, "data should be marked healthy")
assert.Len(t, lastCheckResult.NVLinks, 1)
// The actual metrics are set using prometheus counters which we can't directly test here
// without additional mocking, but we can at least ensure the right structure is in place
// and the feature enabled state is correctly determined
assert.False(t, lastCheckResult.NVLinks[0].States.AllFeatureEnabled(),
"AllFeatureEnabled should be false since not all links have FeatureEnabled=true")
assert.Equal(t, uint64(6), lastCheckResult.NVLinks[0].States.TotalReplayErrors(),
"TotalReplayErrors should match the sum")
assert.Equal(t, uint64(5), lastCheckResult.NVLinks[0].States.TotalRecoveryErrors(),
"TotalRecoveryErrors should match the sum")
assert.Equal(t, uint64(5), lastCheckResult.NVLinks[0].States.TotalCRCErrors(),
"TotalCRCErrors should match the sum")
}
func TestCheck_GPULostError(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-123"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "test-arch", "test-brand", "test-cuda", "test-pci")
devs := map[string]device.Device{
uuid: mockDev,
}
getDevicesFunc := func() map[string]device.Device {
return devs
}
// Use nvmlerrors.ErrGPULost for the error
getNVLinkFunc := func(uuid string, dev device.Device) (NVLink, error) {
return NVLink{}, nvmlerrors.ErrGPULost
}
component := MockNVLinkComponent(ctx, getDevicesFunc, getNVLinkFunc).(*component)
result := component.Check()
// Verify error handling for GPU lost case
data, ok := result.(*checkResult)
require.True(t, ok, "result should be of type *checkResult")
require.NotNil(t, data, "data should not be nil")
assert.Equal(t, apiv1.HealthStateTypeUnhealthy, data.health, "data should be marked unhealthy")
assert.True(t, errors.Is(data.err, nvmlerrors.ErrGPULost), "error should be nvmlerrors.ErrGPULost")
assert.Equal(t, nvmlerrors.ErrGPULost.Error(), data.reason)
// Verify suggested actions for GPU lost case
if assert.NotNil(t, data.suggestedActions) {
assert.Equal(t, nvmlerrors.ErrGPULost.Error(), data.suggestedActions.Description)
assert.Contains(t, data.suggestedActions.RepairActions, apiv1.RepairActionTypeRebootSystem)
}
// Verify suggested actions propagates to health state output
states := component.LastHealthStates()
require.Len(t, states, 1)
assert.NotNil(t, states[0].SuggestedActions)
assert.Contains(t, states[0].SuggestedActions.RepairActions, apiv1.RepairActionTypeRebootSystem)
}
func TestCheck_GPURequiresResetSuggestedActions(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-123"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) { return uuid, nvml.SUCCESS },
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "test-arch", "test-brand", "test-cuda", "test-pci")
devs := map[string]device.Device{
uuid: mockDev,
}
getDevicesFunc := func() map[string]device.Device { return devs }
// Simulate NVML returning a code whose string is "GPU requires reset"
originalErrorString := nvml.ErrorString
nvml.ErrorString = func(ret nvml.Return) string {
if ret == nvml.Return(5555) {
return "GPU requires reset"
}
return originalErrorString(ret)
}
defer func() { nvml.ErrorString = originalErrorString }()
// Return a Reset-like error via nvml.Return and mapping in GetNVLink
getNVLinkFunc := func(uuid string, dev device.Device) (NVLink, error) {
// Use any API that would surface this return in underlying helper; directly return the mapped error here
// because the nvlink component only checks errors.Is on ErrGPURequiresReset
return NVLink{}, nvmlerrors.ErrGPURequiresReset
}
component := MockNVLinkComponent(ctx, getDevicesFunc, getNVLinkFunc).(*component)
result := component.Check()
// Verify check result carries suggested actions
data, ok := result.(*checkResult)
require.True(t, ok, "result should be of type *checkResult")
require.NotNil(t, data)
assert.Equal(t, apiv1.HealthStateTypeUnhealthy, data.health)
assert.True(t, errors.Is(data.err, nvmlerrors.ErrGPURequiresReset))
assert.Equal(t, "GPU requires reset", data.reason)
if assert.NotNil(t, data.suggestedActions) {
assert.Equal(t, "GPU requires reset", data.suggestedActions.Description)
assert.Contains(t, data.suggestedActions.RepairActions, apiv1.RepairActionTypeRebootSystem)
}
// Verify suggested actions propagates to health state output
states := component.LastHealthStates()
require.Len(t, states, 1)
assert.NotNil(t, states[0].SuggestedActions)
}
func TestCheck_ThresholdViolationInactive(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-inactive"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "arch", "brand", "cuda", "pci")
devs := map[string]device.Device{uuid: mockDev}
getDevicesFunc := func() map[string]device.Device {
return devs
}
nvLink := NVLink{
UUID: uuid,
Supported: true,
States: []NVLinkState{
{FeatureEnabled: false},
},
}
component := MockNVLinkComponent(ctx, getDevicesFunc, func(string, device.Device) (NVLink, error) {
return nvLink, nil
}).(*component)
component.getThresholdsFunc = func() ExpectedLinkStates {
return ExpectedLinkStates{AtLeastGPUsWithAllLinksFeatureEnabled: 1}
}
result := component.Check()
cr, ok := result.(*checkResult)
require.True(t, ok)
assert.Equal(t, apiv1.HealthStateTypeUnhealthy, cr.health)
assert.Equal(t, []string{uuid}, cr.InactiveNVLinkUUIDs)
assert.Contains(t, cr.reason, "threshold violated")
assert.Contains(t, cr.reason, uuid)
}
func TestCheck_ThresholdViolationUnsupported(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-unsupported"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "arch", "brand", "cuda", "pci")
devs := map[string]device.Device{uuid: mockDev}
getDevicesFunc := func() map[string]device.Device {
return devs
}
nvLink := NVLink{
UUID: uuid,
Supported: false,
}
component := MockNVLinkComponent(ctx, getDevicesFunc, func(string, device.Device) (NVLink, error) {
return nvLink, nil
}).(*component)
component.getThresholdsFunc = func() ExpectedLinkStates {
return ExpectedLinkStates{AtLeastGPUsWithAllLinksFeatureEnabled: 1}
}
result := component.Check()
cr, ok := result.(*checkResult)
require.True(t, ok)
assert.Equal(t, apiv1.HealthStateTypeUnhealthy, cr.health)
assert.Equal(t, []string{uuid}, cr.UnsupportedNVLinkUUIDs)
assert.Contains(t, cr.reason, "threshold violated")
assert.Contains(t, cr.reason, uuid)
assert.Empty(t, cr.InactiveNVLinkUUIDs)
}
func TestCheck_ThresholdSatisfied(t *testing.T) {
ctx := context.Background()
uuid := "gpu-uuid-healthy"
mockDeviceObj := &mock.Device{
GetUUIDFunc: func() (string, nvml.Return) {
return uuid, nvml.SUCCESS
},
}
mockDev := testutil.NewMockDevice(mockDeviceObj, "arch", "brand", "cuda", "pci")
devs := map[string]device.Device{uuid: mockDev}
getDevicesFunc := func() map[string]device.Device {
return devs
}
nvLink := NVLink{
UUID: uuid,
Supported: true,
States: []NVLinkState{
{FeatureEnabled: true},
},
}
component := MockNVLinkComponent(ctx, getDevicesFunc, func(string, device.Device) (NVLink, error) {
return nvLink, nil
}).(*component)
component.getThresholdsFunc = func() ExpectedLinkStates {
return ExpectedLinkStates{AtLeastGPUsWithAllLinksFeatureEnabled: 1}
}
result := component.Check()
cr, ok := result.(*checkResult)
require.True(t, ok)
assert.Equal(t, apiv1.HealthStateTypeHealthy, cr.health)
assert.Contains(t, cr.reason, "threshold satisfied")
assert.Empty(t, cr.InactiveNVLinkUUIDs)
assert.Empty(t, cr.UnsupportedNVLinkUUIDs)
}