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
|
// Copyright 2015 go-swagger maintainers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package analysis
import (
"path/filepath"
"strconv"
"testing"
"github.com/go-openapi/analysis/internal/antest"
"github.com/go-openapi/spec"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestFixer_EmptyResponseDescriptions(t *testing.T) {
t.Parallel()
bp := filepath.Join("fixtures", "fixer", "fixer.yaml")
sp := antest.LoadOrFail(t, bp)
FixEmptyResponseDescriptions(sp)
for path, pathItem := range sp.Paths.Paths {
require.NotNil(t, pathItem, "expected a fixture with all path items provided in: %s", path)
if path == "/noDesc" {
// scope for fixed descriptions
assertAllVerbs(t, pathItem, true)
} else {
// scope for unchanged descriptions
assertAllVerbs(t, pathItem, false)
}
}
for r, toPin := range sp.Responses {
resp := toPin
assert.Truef(t, assertResponse(t, "/responses/"+r, &resp, true),
"expected a fixed empty description in response %s", r)
}
}
func assertAllVerbs(t testing.TB, pathItem spec.PathItem, isEmpty bool) {
msg := "expected %s description for %s"
var mode string
if isEmpty {
mode = "a fixed empty"
} else {
mode = "an unmodified"
}
assert.Truef(t, assertResponseInOperation(t, pathItem.Get, isEmpty), msg, mode, "GET")
assert.Truef(t, assertResponseInOperation(t, pathItem.Put, isEmpty), msg, mode, "PUT")
assert.Truef(t, assertResponseInOperation(t, pathItem.Post, isEmpty), msg, mode, "POST")
assert.Truef(t, assertResponseInOperation(t, pathItem.Delete, isEmpty), msg, mode, "DELETE")
assert.Truef(t, assertResponseInOperation(t, pathItem.Options, isEmpty), msg, mode, "OPTIONS")
assert.Truef(t, assertResponseInOperation(t, pathItem.Patch, isEmpty), msg, mode, "PATCH")
assert.Truef(t, assertResponseInOperation(t, pathItem.Head, isEmpty), msg, mode, "HEAD")
}
func assertResponseInOperation(t testing.TB, op *spec.Operation, isEmpty bool) bool {
require.NotNilf(t, op, "expected a fixture with all REST verbs set")
if op.Responses == nil {
return true
}
if op.Responses.Default != nil {
return assert.Truef(t, assertResponse(t, "default", op.Responses.Default, isEmpty),
"unexpected description in response %s for operation", "default")
}
for code, resp := range op.Responses.StatusCodeResponses {
pin := resp
return assert.Truef(t, assertResponse(t, strconv.Itoa(code), &pin, isEmpty),
"unexpected description in response %d for operation", code)
}
return true
}
func assertResponse(t testing.TB, path string, resp *spec.Response, isEmpty bool) bool {
var expected string
if isEmpty {
expected = "(empty)"
} else {
expected = "my description"
}
if resp.Ref.String() != "" {
expected = ""
}
if !assert.Equalf(t, expected, resp.Description, "unexpected description for resp. %s", path) {
return false
}
return true
}
|
