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
|
import json
from base64 import b64encode
import pytest
from openapi_core import V30RequestUnmarshaller
from openapi_core.datatypes import Parameters
from openapi_core.templating.media_types.exceptions import MediaTypeNotFound
from openapi_core.templating.paths.exceptions import OperationNotFound
from openapi_core.templating.paths.exceptions import PathNotFound
from openapi_core.templating.security.exceptions import SecurityNotFound
from openapi_core.testing import MockRequest
from openapi_core.validation.request.exceptions import InvalidParameter
from openapi_core.validation.request.exceptions import MissingRequiredParameter
from openapi_core.validation.request.exceptions import (
MissingRequiredRequestBody,
)
from openapi_core.validation.request.exceptions import (
RequestBodyValidationError,
)
from openapi_core.validation.request.exceptions import SecurityValidationError
class TestRequestUnmarshaller:
host_url = "http://petstore.swagger.io"
api_key = "12345"
@property
def api_key_encoded(self):
api_key_bytes = self.api_key.encode("utf8")
api_key_bytes_enc = b64encode(api_key_bytes)
return str(api_key_bytes_enc, "utf8")
@pytest.fixture(scope="session")
def spec_dict(self, v30_petstore_content):
return v30_petstore_content
@pytest.fixture(scope="session")
def spec(self, v30_petstore_spec):
return v30_petstore_spec
@pytest.fixture(scope="session")
def request_unmarshaller(self, spec):
return V30RequestUnmarshaller(spec)
def test_request_server_error(self, request_unmarshaller):
request = MockRequest("http://petstore.invalid.net/v1", "get", "/")
result = request_unmarshaller.unmarshal(request)
assert len(result.errors) == 1
assert type(result.errors[0]) == PathNotFound
assert result.body is None
assert result.parameters == Parameters()
def test_invalid_path(self, request_unmarshaller):
request = MockRequest(self.host_url, "get", "/v1")
result = request_unmarshaller.unmarshal(request)
assert len(result.errors) == 1
assert type(result.errors[0]) == PathNotFound
assert result.body is None
assert result.parameters == Parameters()
def test_invalid_operation(self, request_unmarshaller):
request = MockRequest(self.host_url, "patch", "/v1/pets")
result = request_unmarshaller.unmarshal(request)
assert len(result.errors) == 1
assert type(result.errors[0]) == OperationNotFound
assert result.body is None
assert result.parameters == Parameters()
def test_missing_parameter(self, request_unmarshaller):
request = MockRequest(self.host_url, "get", "/v1/pets")
with pytest.warns(DeprecationWarning):
result = request_unmarshaller.unmarshal(request)
assert type(result.errors[0]) == MissingRequiredParameter
assert result.body is None
assert result.parameters == Parameters(
query={
"page": 1,
"search": "",
},
)
def test_get_pets(self, request_unmarshaller):
args = {"limit": "10", "ids": ["1", "2"], "api_key": self.api_key}
request = MockRequest(
self.host_url,
"get",
"/v1/pets",
path_pattern="/v1/pets",
args=args,
)
with pytest.warns(DeprecationWarning):
result = request_unmarshaller.unmarshal(request)
assert result.errors == []
assert result.body is None
assert result.parameters == Parameters(
query={
"limit": 10,
"page": 1,
"search": "",
"ids": [1, 2],
},
)
assert result.security == {
"api_key": self.api_key,
}
def test_get_pets_multidict(self, request_unmarshaller):
from multidict import MultiDict
request = MockRequest(
self.host_url,
"get",
"/v1/pets",
path_pattern="/v1/pets",
)
request.parameters.query = MultiDict(
[("limit", "5"), ("ids", "1"), ("ids", "2")],
)
with pytest.warns(DeprecationWarning):
result = request_unmarshaller.unmarshal(request)
assert result.errors == []
assert result.body is None
assert result.parameters == Parameters(
query={
"limit": 5,
"page": 1,
"search": "",
"ids": [1, 2],
},
)
def test_missing_body(self, request_unmarshaller):
headers = {
"api-key": self.api_key_encoded,
}
cookies = {
"user": "123",
}
request = MockRequest(
"https://development.gigantic-server.com",
"post",
"/v1/pets",
path_pattern="/v1/pets",
headers=headers,
cookies=cookies,
)
result = request_unmarshaller.unmarshal(request)
assert len(result.errors) == 1
assert type(result.errors[0]) == MissingRequiredRequestBody
assert result.body is None
assert result.parameters == Parameters(
header={
"api-key": self.api_key,
},
cookie={
"user": 123,
},
)
def test_invalid_content_type(self, request_unmarshaller):
data = b"csv,data"
headers = {
"api-key": self.api_key_encoded,
}
cookies = {
"user": "123",
}
request = MockRequest(
"https://development.gigantic-server.com",
"post",
"/v1/pets",
path_pattern="/v1/pets",
content_type="text/csv",
data=data,
headers=headers,
cookies=cookies,
)
result = request_unmarshaller.unmarshal(request)
assert len(result.errors) == 1
assert type(result.errors[0]) == RequestBodyValidationError
assert result.errors[0].__cause__ == MediaTypeNotFound(
mimetype="text/csv",
availableMimetypes=[
"application/json",
"application/x-www-form-urlencoded",
"text/plain",
],
)
assert result.body is None
assert result.parameters == Parameters(
header={
"api-key": self.api_key,
},
cookie={
"user": 123,
},
)
def test_invalid_complex_parameter(self, request_unmarshaller, spec_dict):
pet_name = "Cat"
pet_tag = "cats"
pet_street = "Piekna"
pet_city = "Warsaw"
data_json = {
"name": pet_name,
"tag": pet_tag,
"position": 2,
"address": {
"street": pet_street,
"city": pet_city,
},
"ears": {
"healthy": True,
},
}
data = json.dumps(data_json).encode()
headers = {
"api-key": self.api_key_encoded,
}
userdata = {
"name": 1,
}
userdata_json = json.dumps(userdata)
cookies = {
"user": "123",
"userdata": userdata_json,
}
request = MockRequest(
"https://development.gigantic-server.com",
"post",
"/v1/pets",
path_pattern="/v1/pets",
data=data,
headers=headers,
cookies=cookies,
)
result = request_unmarshaller.unmarshal(request)
assert result.errors == [
InvalidParameter(name="userdata", location="cookie")
]
assert result.parameters == Parameters(
header={
"api-key": self.api_key,
},
cookie={
"user": 123,
},
)
assert result.security == {}
schemas = spec_dict["components"]["schemas"]
pet_model = schemas["PetCreate"]["x-model"]
address_model = schemas["Address"]["x-model"]
assert result.body.__class__.__name__ == pet_model
assert result.body.name == pet_name
assert result.body.tag == pet_tag
assert result.body.position == 2
assert result.body.address.__class__.__name__ == address_model
assert result.body.address.street == pet_street
assert result.body.address.city == pet_city
def test_post_pets(self, request_unmarshaller, spec_dict):
pet_name = "Cat"
pet_tag = "cats"
pet_street = "Piekna"
pet_city = "Warsaw"
data_json = {
"name": pet_name,
"tag": pet_tag,
"position": 2,
"address": {
"street": pet_street,
"city": pet_city,
},
"ears": {
"healthy": True,
},
}
data = json.dumps(data_json).encode()
headers = {
"api-key": self.api_key_encoded,
}
cookies = {
"user": "123",
}
request = MockRequest(
"https://development.gigantic-server.com",
"post",
"/v1/pets",
path_pattern="/v1/pets",
data=data,
headers=headers,
cookies=cookies,
)
result = request_unmarshaller.unmarshal(request)
assert result.errors == []
assert result.parameters == Parameters(
header={
"api-key": self.api_key,
},
cookie={
"user": 123,
},
)
assert result.security == {}
schemas = spec_dict["components"]["schemas"]
pet_model = schemas["PetCreate"]["x-model"]
address_model = schemas["Address"]["x-model"]
assert result.body.__class__.__name__ == pet_model
assert result.body.name == pet_name
assert result.body.tag == pet_tag
assert result.body.position == 2
assert result.body.address.__class__.__name__ == address_model
assert result.body.address.street == pet_street
assert result.body.address.city == pet_city
def test_post_pets_plain_no_schema(self, request_unmarshaller):
data = b"plain text"
headers = {
"api-key": self.api_key_encoded,
}
cookies = {
"user": "123",
}
request = MockRequest(
"https://development.gigantic-server.com",
"post",
"/v1/pets",
path_pattern="/v1/pets",
data=data,
headers=headers,
cookies=cookies,
content_type="text/plain",
)
result = request_unmarshaller.unmarshal(request)
assert result.errors == []
assert result.parameters == Parameters(
header={
"api-key": self.api_key,
},
cookie={
"user": 123,
},
)
assert result.security == {}
assert result.body == data.decode()
def test_get_pet_unauthorized(self, request_unmarshaller):
request = MockRequest(
self.host_url,
"get",
"/v1/pets/1",
path_pattern="/v1/pets/{petId}",
view_args={"petId": "1"},
)
result = request_unmarshaller.unmarshal(request)
assert len(result.errors) == 1
assert type(result.errors[0]) is SecurityValidationError
assert result.errors[0].__cause__ == SecurityNotFound(
[["petstore_auth"]]
)
assert result.body is None
assert result.parameters == Parameters()
assert result.security is None
def test_get_pet(self, request_unmarshaller):
authorization = "Basic " + self.api_key_encoded
headers = {
"Authorization": authorization,
}
request = MockRequest(
self.host_url,
"get",
"/v1/pets/1",
path_pattern="/v1/pets/{petId}",
view_args={"petId": "1"},
headers=headers,
)
result = request_unmarshaller.unmarshal(request)
assert result.errors == []
assert result.body is None
assert result.parameters == Parameters(
path={
"petId": 1,
},
)
assert result.security == {
"petstore_auth": self.api_key_encoded,
}
|
