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
|
package health
import (
"context"
"fmt"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"testing"
"time"
)
func TestStatusUnknownBeforeStatusUp(t *testing.T) {
// Arrange
testData := map[string]CheckState{"check1": {Status: StatusUp}, "check2": {Status: StatusUnknown}}
// Act
result := aggregateStatus(testData)
// Assert
assert.Equal(t, result, StatusUnknown)
}
func TestStatusDownBeforeStatusUnknown(t *testing.T) {
// Arrange
testData := map[string]CheckState{"check1": {Status: StatusDown}, "check2": {Status: StatusUnknown}}
// Act
result := aggregateStatus(testData)
// Assert
assert.Equal(t, result, StatusDown)
}
func doTestEvaluateAvailabilityStatus(
t *testing.T,
expectedStatus AvailabilityStatus,
maxTimeInError time.Duration,
maxFails uint,
state CheckState,
) {
// Act
result := evaluateCheckStatus(&state, maxTimeInError, maxFails)
// Assert
assert.Equal(t, expectedStatus, result)
}
func TestWhenNoChecksMadeYetThenStatusUnknown(t *testing.T) {
doTestEvaluateAvailabilityStatus(t, StatusUnknown, 0, 0, CheckState{
LastCheckedAt: &time.Time{},
})
}
func TestWhenNoErrorThenStatusUp(t *testing.T) {
now := time.Now()
doTestEvaluateAvailabilityStatus(t, StatusUp, 0, 0, CheckState{
LastCheckedAt: &now,
})
}
func TestWhenErrorThenStatusDown(t *testing.T) {
now := time.Now()
doTestEvaluateAvailabilityStatus(t, StatusDown, 0, 0, CheckState{
LastCheckedAt: &now,
Result: fmt.Errorf("example error"),
})
}
func TestWhenErrorAndMaxFailuresThresholdNotCrossedThenStatusWarn(t *testing.T) {
now := time.Now()
lastSuccessAt := now.Add(-3 * time.Minute)
doTestEvaluateAvailabilityStatus(t, StatusUp, 1*time.Second, uint(10), CheckState{
LastCheckedAt: &now,
Result: fmt.Errorf("example error"),
FirstCheckStartedAt: now.Add(-2 * time.Minute),
LastSuccessAt: &lastSuccessAt,
ContiguousFails: 1,
})
}
func TestWhenErrorAndMaxTimeInErrorThresholdNotCrossedThenStatusWarn(t *testing.T) {
now := time.Now()
lastSuccessAt := now.Add(-2 * time.Minute)
doTestEvaluateAvailabilityStatus(t, StatusUp, 1*time.Hour, uint(1), CheckState{
LastCheckedAt: &now,
Result: fmt.Errorf("example error"),
FirstCheckStartedAt: time.Now().Add(-3 * time.Minute),
LastSuccessAt: &lastSuccessAt,
ContiguousFails: 100,
})
}
func TestWhenErrorAndAllThresholdsCrossedThenStatusDown(t *testing.T) {
now := time.Now()
lastSuccessAt := now.Add(-2 * time.Minute)
doTestEvaluateAvailabilityStatus(t, StatusDown, 1*time.Second, uint(1), CheckState{
LastCheckedAt: &now,
Result: fmt.Errorf("example error"),
FirstCheckStartedAt: time.Now().Add(-3 * time.Minute),
LastSuccessAt: &lastSuccessAt,
ContiguousFails: 5,
})
}
func TestStartStopManualPeriodicChecks(t *testing.T) {
ckr := NewChecker(
WithDisabledAutostart(),
WithPeriodicCheck(50*time.Minute, 0, Check{
Name: "check",
Check: func(ctx context.Context) error {
return nil
},
}))
assert.Equal(t, 0, ckr.GetRunningPeriodicCheckCount())
ckr.Start()
assert.Equal(t, 1, ckr.GetRunningPeriodicCheckCount())
ckr.Stop()
assert.Equal(t, 0, ckr.GetRunningPeriodicCheckCount())
}
func doTestCheckerCheckFunc(t *testing.T, updateInterval time.Duration, err error, expectedStatus AvailabilityStatus) {
// Arrange
ckr := NewChecker(
WithTimeout(10*time.Second),
WithCheck(Check{
Name: "check1",
Check: func(ctx context.Context) error {
return nil
},
}),
WithPeriodicCheck(updateInterval, 0, Check{
Name: "check2",
Check: func(ctx context.Context) error {
return err
},
}),
)
// Act
res := ckr.Check(context.Background())
// Assert
require.NotNil(t, res.Details)
assert.Equal(t, expectedStatus, res.Status)
for _, checkName := range []string{"check1", "check2"} {
_, checkResultExists := (*res.Details)[checkName]
assert.True(t, checkResultExists)
}
}
func TestWhenChecksExecutedThenAggregatedResultUp(t *testing.T) {
doTestCheckerCheckFunc(t, 0, nil, StatusUp)
}
func TestWhenOneCheckFailedThenAggregatedResultDown(t *testing.T) {
doTestCheckerCheckFunc(t, 0, fmt.Errorf("this is a check error"), StatusDown)
}
func TestCheckSuccessNotAllChecksExecutedYet(t *testing.T) {
doTestCheckerCheckFunc(t, 5*time.Hour, nil, StatusUnknown)
}
|
