{{ message }}
Repository navigation
Expand file tree
/
Copy pathmessages_test.go
More file actions
437 lines (389 loc) · 13.5 KB
/
Copy pathmessages_test.go
File metadata and controls
437 lines (389 loc) · 13.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
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
// SPDX-FileCopyrightText: Copyright 2015-2025 go-swagger maintainers
// SPDX-License-Identifier: Apache-2.0
package validate
import (
"fmt"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
"testing"
loads "github.com/allons-y/openapi-loads"
"github.com/go-openapi/strfmt"
"github.com/go-openapi/testify/v2/assert"
"github.com/go-openapi/testify/v2/require"
yaml "go.yaml.in/yaml/v3"
)
var (
// This debug environment variable allows to report and capture actual validation messages
// during testing. It should be disabled (undefined) during CI tests.
DebugTest = os.Getenv("SWAGGER_DEBUG_TEST") != ""
)
type ExpectedMessage struct {
Message string `yaml:"message"`
WithContinueOnErrors bool `yaml:"withContinueOnErrors"` // should be expected only when SetContinueOnErrors(true)
IsRegexp bool `yaml:"isRegexp"` // expected message is interpreted as regexp (with regexp.MatchString())
}
type ExpectedFixture struct {
Comment string `yaml:"comment,omitempty"`
Todo string `yaml:"todo,omitempty"`
ExpectedLoadError bool `yaml:"expectedLoadError"` // expect error on load: skip validate step
ExpectedValid bool `yaml:"expectedValid"` // expect valid spec
ExpectedMessages []ExpectedMessage `yaml:"expectedMessages"`
ExpectedWarnings []ExpectedMessage `yaml:"expectedWarnings"`
Tested bool `yaml:"-"`
Failed bool `yaml:"-"`
}
type ExpectedMap map[string]*ExpectedFixture
func (m ExpectedMap) Get(key string) (*ExpectedFixture, bool) {
v, ok := m[key] // no need to lock this map for now
return v, ok
}
// Test message improvements, issue #44 and some more
// ContinueOnErrors mode on
// WARNING: this test is very demanding and constructed with varied scenarios,
// which are not necessarily "unitary". Expect multiple changes in messages whenever
// altering the validator.
func Test_MessageQualityContinueOnErrors_Issue44(t *testing.T) {
if !enableLongTests {
skipNotify(t)
t.SkipNow()
}
errs := testMessageQuality(t, true, true) /* set haltOnErrors=true to iterate spec by spec */
assert.Zero(t, errs, "Message testing didn't match expectations")
}
// ContinueOnErrors mode off
func Test_MessageQualityStopOnErrors_Issue44(t *testing.T) {
if !enableLongTests {
skipNotify(t)
t.SkipNow()
}
errs := testMessageQuality(t, true, false) /* set haltOnErrors=true to iterate spec by spec */
assert.Zero(t, errs, "Message testing didn't match expectations")
}
func loadTestConfig(t *testing.T, fp string) ExpectedMap {
expectedConfig, err := os.ReadFile(fp)
require.NoErrorf(t, err, "cannot read expected messages config file: %v", err)
tested := make(ExpectedMap, 200)
err = yaml.Unmarshal(expectedConfig, &tested)
require.NoErrorf(t, err, "cannot unmarshall expected messages from config file : %v", err)
// Check config
for fixture, expected := range tested {
require.Nil(t, UniqueItems("", "", expected.ExpectedMessages), "duplicate error messages configured for %s", fixture)
require.Nil(t, UniqueItems("", "", expected.ExpectedWarnings), "duplicate warning messages configured for %s", fixture)
}
return tested
}
func testMessageQuality(t *testing.T, haltOnErrors bool, continueOnErrors bool) int {
// Verifies the production of validation error messages in multiple
// spec scenarios.
//
// The objective is to demonstrate that:
// - messages are stable
// - validation continues as much as possible, even in presence of many errors
//
// haltOnErrors is used in dev mode to study and fix testcases step by step (output is pretty verbose)
//
// set SWAGGER_DEBUG_TEST=1 env to get a report of messages at the end of each test.
// expectedMessage{"", false, false},
//
// expected messages and warnings are configured in ./fixtures/validation/expected_messages.yaml
//
var errs int // error count
tested := loadTestConfig(t, filepath.Join("fixtures", "validation", "expected_messages.yaml"))
if err := filepath.Walk(filepath.Join("fixtures", "validation"), testWalkSpecs(t, tested, haltOnErrors, continueOnErrors)); err != nil {
t.Logf("%v", err)
errs++
}
recapTest(t, tested)
return errs
}
func testDebugLog(t *testing.T, thisTest *ExpectedFixture) {
if DebugTest {
if thisTest.Comment != "" {
t.Logf("\tDEVMODE: Comment: %s", thisTest.Comment)
}
if thisTest.Todo != "" {
t.Logf("\tDEVMODE: Todo: %s", thisTest.Todo)
}
}
}
func expectInvalid(t *testing.T, path string, thisTest *ExpectedFixture, continueOnErrors bool) {
// Checking invalid specs
t.Logf("Testing messages for invalid spec: %s", path)
testDebugLog(t, thisTest)
doc, err := loads.Spec(path)
// Check specs with load errors (error is located in pkg loads or spec)
if thisTest.ExpectedLoadError {
// Expect a load error: no further validation may possibly be conducted.
require.Error(t, err, "expected this spec to return a load error")
assert.Equal(t, 0, verifyLoadErrors(t, err, thisTest.ExpectedMessages))
return
}
require.NoError(t, err, "expected this spec to load properly")
// Validate the spec document
validator := NewSpecValidator(doc.Schema(), strfmt.Default)
validator.SetContinueOnErrors(continueOnErrors)
res, warn := validator.Validate(doc)
// Check specs with load errors (error is located in pkg loads or spec)
require.False(t, res.IsValid(), "expected this spec to be invalid")
errs := verifyErrorsVsWarnings(t, res, warn)
errs += verifyErrors(t, res, thisTest.ExpectedMessages, "error", continueOnErrors)
errs += verifyErrors(t, warn, thisTest.ExpectedWarnings, "warning", continueOnErrors)
assert.Equal(t, 0, errs)
if errs > 0 {
t.Logf("Message qualification on spec validation failed for %s", path)
// DEVMODE allows developers to experiment and tune expected results
if DebugTest {
reportTest(t, path, res, thisTest.ExpectedMessages, "error", continueOnErrors)
reportTest(t, path, warn, thisTest.ExpectedWarnings, "warning", continueOnErrors)
}
}
}
func expectValid(t *testing.T, path string, thisTest *ExpectedFixture, continueOnErrors bool) {
// Expecting no message (e.g.valid spec): 0 message expected
t.Logf("Testing valid spec: %s", path)
testDebugLog(t, thisTest)
doc, err := loads.Spec(path)
require.NoError(t, err, "expected this spec to load without error")
validator := NewSpecValidator(doc.Schema(), strfmt.Default)
validator.SetContinueOnErrors(continueOnErrors)
res, warn := validator.Validate(doc)
assert.True(t, res.IsValid(), "expected this spec to be valid")
assert.Emptyf(t, res.Errors, "expected no returned errors")
// check warnings
errs := verifyErrors(t, warn, thisTest.ExpectedWarnings, "warning", continueOnErrors)
assert.Equal(t, 0, errs)
if DebugTest && errs > 0 {
reportTest(t, path, res, thisTest.ExpectedMessages, "error", continueOnErrors)
reportTest(t, path, warn, thisTest.ExpectedWarnings, "warning", continueOnErrors)
}
}
func checkMustHalt(t *testing.T, haltOnErrors bool) {
if t.Failed() && haltOnErrors {
assert.FailNow(t, "test halted: stop testing on message checking error mode")
return
}
}
func testWalkSpecs(t *testing.T, tested ExpectedMap, haltOnErrors, continueOnErrors bool) filepath.WalkFunc {
return func(path string, info os.FileInfo, _ error) error {
thisTest, found := tested.Get(info.Name())
if info.IsDir() || !found { // skip
return nil
}
t.Run(path, func(t *testing.T) {
if !DebugTest { // when running in dev mode, run serially
t.Parallel()
}
defer func() {
thisTest.Tested = true
thisTest.Failed = t.Failed()
}()
if !thisTest.ExpectedValid {
expectInvalid(t, path, thisTest, continueOnErrors)
checkMustHalt(t, haltOnErrors)
} else {
expectValid(t, path, thisTest, continueOnErrors)
checkMustHalt(t, haltOnErrors)
}
})
return nil
}
}
func recapTest(t *testing.T, config ExpectedMap) {
recapFailed := false
for k, v := range config {
if !v.Tested {
t.Logf("WARNING: %s configured but not tested (fixture not found)", k)
recapFailed = true
} else if v.Failed {
t.Logf("ERROR: %s failed passing messages verification", k)
recapFailed = true
}
}
if !recapFailed {
t.Log("INFO:We are good")
}
}
func reportTest(t *testing.T, path string, res *Result, expectedMessages []ExpectedMessage, msgtype string, continueOnErrors bool) {
const expected = "Expected "
// Prints out a recap of error messages. To be enabled during development / test iterations
verifiedErrors := make([]string, 0, 50)
lines := make([]string, 0, 50)
for _, e := range res.Errors {
verifiedErrors = append(verifiedErrors, e.Error())
}
t.Logf("DEVMODE:Recap of returned %s messages while validating %s ", msgtype, path)
for _, v := range verifiedErrors {
status := "Unexpected " + msgtype
for _, s := range expectedMessages {
if (s.WithContinueOnErrors && continueOnErrors) || !s.WithContinueOnErrors {
if s.IsRegexp {
if matched, _ := regexp.MatchString(s.Message, v); matched {
status = expected + msgtype
break
}
} else {
if strings.Contains(v, s.Message) {
status = expected + msgtype
break
}
}
}
}
lines = append(lines, fmt.Sprintf("[%s]%s", status, v))
}
for _, s := range expectedMessages {
if (s.WithContinueOnErrors && continueOnErrors) || !s.WithContinueOnErrors {
status := "Missing " + msgtype
for _, v := range verifiedErrors {
if s.IsRegexp {
if matched, _ := regexp.MatchString(s.Message, v); matched {
status = expected + msgtype
break
}
} else {
if strings.Contains(v, s.Message) {
status = expected + msgtype
break
}
}
}
if status != expected+msgtype {
lines = append(lines, fmt.Sprintf("[%s]%s", status, s.Message))
}
}
}
if len(lines) > 0 {
sort.Strings(lines)
for _, line := range lines {
t.Log(line)
}
}
}
func verifyErrorsVsWarnings(t *testing.T, res, warn *Result) int {
// First verification of result conventions: results are redundant, just a matter of presentation
w := len(warn.Errors)
if !assert.Len(t, res.Warnings, w) ||
!assert.Empty(t, warn.Warnings) ||
!assert.Subset(t, res.Warnings, warn.Errors) ||
!assert.Subset(t, warn.Errors, res.Warnings) {
t.Log("Result equivalence errors vs warnings not verified")
return 1
}
return 0
}
func verifyErrors(t *testing.T, res *Result, expectedMessages []ExpectedMessage, msgtype string, continueOnErrors bool) int {
var numExpected, errs int
verifiedErrors := make([]string, 0, 50)
for _, e := range res.Errors {
verifiedErrors = append(verifiedErrors, e.Error())
}
for _, s := range expectedMessages {
if (s.WithContinueOnErrors == true && continueOnErrors == true) || s.WithContinueOnErrors == false {
numExpected++
}
}
// We got the expected number of messages (e.g. no duplicates, no uncontrolled side-effect, ...)
if !assert.Len(t, verifiedErrors, numExpected, "unexpected number of %s messages returned. Wanted %d, got %d", msgtype, numExpected, len(verifiedErrors)) {
errs++
}
// Check that all expected messages are here
for _, s := range expectedMessages {
found := false
if (s.WithContinueOnErrors == true && continueOnErrors == true) || s.WithContinueOnErrors == false {
for _, v := range verifiedErrors {
if s.IsRegexp {
if matched, _ := regexp.MatchString(s.Message, v); matched {
found = true
break
}
} else {
if strings.Contains(v, s.Message) {
found = true
break
}
}
}
if !assert.True(t, found, "Missing expected %s message: %s", msgtype, s.Message) {
errs++
}
}
}
// Check for no unexpected message
for _, v := range verifiedErrors {
found := false
for _, s := range expectedMessages {
if (s.WithContinueOnErrors == true && continueOnErrors == true) || s.WithContinueOnErrors == false {
if s.IsRegexp {
if matched, _ := regexp.MatchString(s.Message, v); matched {
found = true
break
}
} else {
if strings.Contains(v, s.Message) {
found = true
break
}
}
}
}
if !assert.True(t, found, "unexpected %s message: %s", msgtype, v) {
errs++
}
}
return errs
}
func verifyLoadErrors(t *testing.T, err error, expectedMessages []ExpectedMessage) int {
var errs int
// Perform several matches on single error message
// Process here error messages from loads (normally unit tested in the load package:
// we just want to figure out how all this is captured at the validate package level.
v := err.Error()
for _, s := range expectedMessages {
var found bool
if s.IsRegexp {
if found, _ = regexp.MatchString(s.Message, v); found {
break
}
} else {
if found = strings.Contains(v, s.Message); found {
break
}
}
if !assert.True(t, found, "unexpected load error: %s", v) {
t.Logf("Expecting one of the following:")
for _, s := range expectedMessages {
smode := "Contains"
if s.IsRegexp {
smode = "MatchString"
}
t.Logf("[%s]:%s", smode, s.Message)
}
errs++
}
}
return errs
}
func testIssue(t *testing.T, path string, expectedNumErrors, expectedNumWarnings int) {
res, _ := loadAndValidate(t, path)
if expectedNumErrors > -1 && !assert.Len(t, res.Errors, expectedNumErrors) {
t.Log("Returned errors:")
for _, e := range res.Errors {
t.Logf("%v", e)
}
}
if expectedNumWarnings > -1 && !assert.Len(t, res.Warnings, expectedNumWarnings) {
t.Log("Returned warnings:")
for _, e := range res.Warnings {
t.Logf("%v", e)
}
}
}
// Test unitary fixture for dev and bug fixing
func Test_SingleFixture(t *testing.T) {
t.SkipNow()
path := filepath.Join("fixtures", "validation", "fixture-1231.yaml")
testIssue(t, path, -1, -1)
}
You can’t perform that action at this time.