-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontract_verifier_test.go
More file actions
240 lines (202 loc) · 6.5 KB
/
contract_verifier_test.go
File metadata and controls
240 lines (202 loc) · 6.5 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
package modular
import (
"context"
"errors"
"testing"
"time"
)
// --- Mock Reloadable modules for contract tests ---
// wellBehavedReloadable satisfies all reload contract rules.
type wellBehavedReloadable struct{}
func (w *wellBehavedReloadable) Reload(ctx context.Context, _ []ConfigChange) error {
if err := ctx.Err(); err != nil {
return err
}
return nil
}
func (w *wellBehavedReloadable) CanReload() bool { return true }
func (w *wellBehavedReloadable) ReloadTimeout() time.Duration { return 5 * time.Second }
// zeroTimeoutReloadable returns a zero timeout.
type zeroTimeoutReloadable struct{ wellBehavedReloadable }
func (z *zeroTimeoutReloadable) ReloadTimeout() time.Duration { return 0 }
// panickyReloadable panics when CanReload is called.
type panickyReloadable struct{ wellBehavedReloadable }
func (p *panickyReloadable) CanReload() bool { panic("boom") }
type reloadPanicReloadable struct{ wellBehavedReloadable }
func (p *reloadPanicReloadable) Reload(ctx context.Context, _ []ConfigChange) error {
if err := ctx.Err(); err != nil {
return err
}
panic("reload boom")
}
// --- Mock HealthProviders for contract tests ---
// wellBehavedHealthProvider returns a proper report and respects cancellation.
type wellBehavedHealthProvider struct{}
func (w *wellBehavedHealthProvider) HealthCheck(ctx context.Context) ([]HealthReport, error) {
if err := ctx.Err(); err != nil {
return nil, err
}
return []HealthReport{
{
Module: "test-module",
Component: "test-component",
Status: StatusHealthy,
Message: "ok",
CheckedAt: time.Now(),
},
}, nil
}
// emptyModuleHealthProvider returns a report with empty Module field.
type emptyModuleHealthProvider struct{}
func (e *emptyModuleHealthProvider) HealthCheck(ctx context.Context) ([]HealthReport, error) {
if err := ctx.Err(); err != nil {
return nil, err
}
return []HealthReport{
{
Module: "",
Component: "comp",
Status: StatusHealthy,
CheckedAt: time.Now(),
},
}, nil
}
// cancelIgnoringHealthProvider ignores context cancellation.
type cancelIgnoringHealthProvider struct{}
func (c *cancelIgnoringHealthProvider) HealthCheck(_ context.Context) ([]HealthReport, error) {
return []HealthReport{
{
Module: "mod",
Component: "comp",
Status: StatusHealthy,
CheckedAt: time.Now(),
},
}, nil
}
type panicOnActiveHealthProvider struct{}
func (p *panicOnActiveHealthProvider) HealthCheck(ctx context.Context) ([]HealthReport, error) {
if err := ctx.Err(); err != nil {
return nil, err
}
panic("health boom")
}
// --- Tests ---
func TestContractVerifier_ReloadWellBehaved(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyReloadContract(&wellBehavedReloadable{})
if len(violations) != 0 {
t.Fatalf("expected 0 violations for well-behaved reloadable, got %d: %+v", len(violations), violations)
}
}
func TestContractVerifier_ReloadZeroTimeout(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyReloadContract(&zeroTimeoutReloadable{})
found := false
for _, v := range violations {
if v.Rule == "must-return-positive-timeout" && v.Severity == "error" {
found = true
break
}
}
if !found {
t.Fatalf("expected violation for zero timeout, got: %+v", violations)
}
}
func TestContractVerifier_ReloadPanicsOnCanReload(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyReloadContract(&panickyReloadable{})
found := false
for _, v := range violations {
if v.Rule == "can-reload-must-not-panic" && v.Severity == "warning" {
found = true
break
}
}
if !found {
t.Fatalf("expected violation for panicky CanReload, got: %+v", violations)
}
}
func TestContractVerifier_ReloadPanicUsesSentinelError(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyReloadContract(&reloadPanicReloadable{})
found := false
for _, v := range violations {
if v.Rule == "reload-must-not-panic" && errors.Is(v.Err, ErrReloadPanic) {
found = true
break
}
}
if !found {
t.Fatalf("expected reload panic sentinel in violations, got: %+v", violations)
}
}
func TestContractVerifier_HealthWellBehaved(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyHealthContract(&wellBehavedHealthProvider{})
if len(violations) != 0 {
t.Fatalf("expected 0 violations for well-behaved health provider, got %d: %+v", len(violations), violations)
}
}
func TestContractVerifier_HealthEmptyModule(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyHealthContract(&emptyModuleHealthProvider{})
found := false
for _, v := range violations {
if v.Rule == "must-have-module-field" && v.Severity == "error" {
found = true
break
}
}
if !found {
t.Fatalf("expected violation for empty Module field, got: %+v", violations)
}
}
func TestContractVerifier_HealthIgnoresCancellation(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyHealthContract(&cancelIgnoringHealthProvider{})
found := false
for _, v := range violations {
if v.Rule == "must-respect-context-cancellation" && v.Severity == "warning" {
found = true
break
}
}
if !found {
t.Fatalf("expected violation for ignoring cancellation, got: %+v", violations)
}
}
func TestContractVerifier_HealthPanicIsGuarded(t *testing.T) {
verifier := NewStandardContractVerifier()
// The first HealthCheck call panics and is recovered by the verifier. The
// cancellation check returns ctx.Err, so the test only fails if the guard is
// not active.
_ = verifier.VerifyHealthContract(&panicOnActiveHealthProvider{})
}
func TestContractVerifier_ReloadPanicWrapsErrReloadPanic(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyReloadContract(&reloadPanicReloadable{})
found := false
for _, v := range violations {
if v.Rule == "reload-must-not-panic" && errors.Is(v.Err, ErrReloadPanic) {
found = true
break
}
}
if !found {
t.Fatalf("expected violation with ErrReloadPanic, got: %+v", violations)
}
}
func TestContractVerifier_HealthPanicWrapsErrHealthCheckPanic(t *testing.T) {
verifier := NewStandardContractVerifier()
violations := verifier.VerifyHealthContract(&panicOnActiveHealthProvider{})
found := false
for _, v := range violations {
if v.Rule == "health-check-must-not-panic" && errors.Is(v.Err, ErrHealthCheckPanic) {
found = true
break
}
}
if !found {
t.Fatalf("expected violation with ErrHealthCheckPanic, got: %+v", violations)
}
}