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
|
package openapi3filter
import (
"io"
"net/http"
"strings"
"testing"
"github.com/stretchr/testify/require"
"github.com/getkin/kin-openapi/openapi3"
"github.com/getkin/kin-openapi/routers/gorillamux"
)
func TestIssue689(t *testing.T) {
loader := openapi3.NewLoader()
ctx := loader.Context
spec := `
openapi: 3.0.0
info:
version: 1.0.0
title: Sample API
paths:
/items:
put:
requestBody:
content:
application/json:
schema:
properties:
testWithReadOnly:
readOnly: true
type: boolean
testNoReadOnly:
type: boolean
type: object
responses:
'200':
description: OK
get:
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
testWithWriteOnly:
writeOnly: true
type: boolean
testNoWriteOnly:
type: boolean
`[1:]
doc, err := loader.LoadFromData([]byte(spec))
require.NoError(t, err)
err = doc.Validate(ctx)
require.NoError(t, err)
router, err := gorillamux.NewRouter(doc)
require.NoError(t, err)
tests := []struct {
name string
options *Options
body string
method string
checkErr require.ErrorAssertionFunc
}{
// read-only
{
name: "non read-only property is added to request when validation enabled",
body: `{"testNoReadOnly": true}`,
method: http.MethodPut,
checkErr: require.NoError,
},
{
name: "non read-only property is added to request when validation disabled",
body: `{"testNoReadOnly": true}`,
method: http.MethodPut,
options: &Options{
ExcludeReadOnlyValidations: true,
},
checkErr: require.NoError,
},
{
name: "read-only property is added to requests when validation enabled",
body: `{"testWithReadOnly": true}`,
method: http.MethodPut,
checkErr: require.Error,
},
{
name: "read-only property is added to requests when validation disabled",
body: `{"testWithReadOnly": true}`,
method: http.MethodPut,
options: &Options{
ExcludeReadOnlyValidations: true,
},
checkErr: require.NoError,
},
// write-only
{
name: "non write-only property is added to request when validation enabled",
body: `{"testNoWriteOnly": true}`,
method: http.MethodGet,
checkErr: require.NoError,
},
{
name: "non write-only property is added to request when validation disabled",
body: `{"testNoWriteOnly": true}`,
method: http.MethodGet,
options: &Options{
ExcludeWriteOnlyValidations: true,
},
checkErr: require.NoError,
},
{
name: "write-only property is added to requests when validation enabled",
body: `{"testWithWriteOnly": true}`,
method: http.MethodGet,
checkErr: require.Error,
},
{
name: "write-only property is added to requests when validation disabled",
body: `{"testWithWriteOnly": true}`,
method: http.MethodGet,
options: &Options{
ExcludeWriteOnlyValidations: true,
},
checkErr: require.NoError,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
httpReq, err := http.NewRequest(test.method, "/items", strings.NewReader(test.body))
require.NoError(t, err)
httpReq.Header.Set("Content-Type", "application/json")
require.NoError(t, err)
route, pathParams, err := router.FindRoute(httpReq)
require.NoError(t, err)
requestValidationInput := &RequestValidationInput{
Request: httpReq,
PathParams: pathParams,
Route: route,
Options: test.options,
}
if test.method == http.MethodGet {
responseValidationInput := &ResponseValidationInput{
RequestValidationInput: requestValidationInput,
Status: 200,
Header: httpReq.Header,
Body: io.NopCloser(strings.NewReader(test.body)),
Options: test.options,
}
err = ValidateResponse(ctx, responseValidationInput)
} else {
err = ValidateRequest(ctx, requestValidationInput)
}
test.checkErr(t, err)
})
}
}
|
