-
-
Notifications
You must be signed in to change notification settings - Fork 146
/
test_checks.py
343 lines (295 loc) · 11.6 KB
/
test_checks.py
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
import json
from typing import Any, Dict
import pytest
import requests
from hypothesis import given, settings
import schemathesis
from schemathesis import models
from schemathesis.checks import (
content_type_conformance,
not_a_server_error,
response_schema_conformance,
status_code_conformance,
)
from schemathesis.exceptions import InvalidSchema
from schemathesis.models import EndpointDefinition
from schemathesis.schemas import BaseSchema
def make_case(schema: BaseSchema, definition: Dict[str, Any]) -> models.Case:
endpoint = models.Endpoint("/path", "GET", definition=EndpointDefinition(definition, None), schema=schema)
return models.Case(endpoint)
def make_response(content=b"{}", content_type="application/json") -> requests.Response:
response = requests.Response()
response._content = content
response.status_code = 200
response.headers["Content-Type"] = content_type
return response
@pytest.fixture()
def spec(request):
param = getattr(request, "param", None)
if param == "swagger":
return request.getfixturevalue("swagger_20")
elif param == "openapi":
return request.getfixturevalue("openapi_30")
return request.getfixturevalue("swagger_20")
@pytest.fixture()
def response(request):
return make_response(content_type=request.param)
@pytest.fixture()
def case(request, spec) -> models.Case:
if "swagger" in spec.raw_schema:
data = {"produces": request.param}
else:
data = {
"responses": {
"200": {
"content": {
# There should be a content type in OAS3. But in test below it is omitted
# For simplicity a default value is implemented here
key: {"schema": {"type": "string"}}
for key in request.param or ["application/json"]
}
}
}
}
return make_case(spec, data)
@pytest.mark.parametrize("spec", ("swagger", "openapi"), indirect=["spec"])
@pytest.mark.parametrize(
"response, case",
(
("application/json", []),
("application/json", ["application/json"]),
("application/json;charset=utf-8", ["application/json"]),
),
indirect=["response", "case"],
)
def test_content_type_conformance_valid(spec, response, case):
assert content_type_conformance(response, case) is None
@pytest.mark.parametrize(
"raw_schema",
(
{
"swagger": "2.0",
"info": {"title": "Sample API", "description": "API description in Markdown.", "version": "1.0.0"},
"host": "api.example.com",
"basePath": "/",
"schemes": ["https"],
"produces": ["application/xml"],
"paths": {
"/users": {
"get": {
"summary": "Returns a list of users.",
"description": "Optional extended description in Markdown.",
"produces": ["application/json"],
"responses": {"200": {"description": "OK"}},
}
}
},
},
{
"openapi": "3.0.2",
"info": {"title": "Test", "description": "Test", "version": "0.1.0"},
"paths": {
"/users": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {"application/json": {"schema": {"type": "object"}}},
}
},
}
}
},
},
),
)
@pytest.mark.parametrize("content_type, is_error", (("application/json", False), ("application/xml", True)))
def test_content_type_conformance_integration(raw_schema, content_type, is_error):
schema = schemathesis.from_dict(raw_schema)
endpoint = schema.endpoints["/users"]["get"]
case = models.Case(endpoint)
response = make_response(content_type=content_type)
if not is_error:
assert content_type_conformance(response, case) is None
else:
with pytest.raises(AssertionError):
content_type_conformance(response, case)
@pytest.mark.parametrize("value", (500, 502))
def test_not_a_server_error(value, swagger_20):
response = make_response()
response.status_code = value
case = make_case(swagger_20, {})
with pytest.raises(AssertionError) as exc_info:
not_a_server_error(response, case)
assert exc_info.type.__name__ == f"StatusCodeError{value}"
@pytest.mark.parametrize("value", (400, 405))
def test_status_code_conformance_valid(value, swagger_20):
response = make_response()
response.status_code = value
case = make_case(swagger_20, {"responses": {"4XX"}})
status_code_conformance(response, case)
@pytest.mark.parametrize("value", (400, 405))
def test_status_code_conformance_invalid(value, swagger_20):
response = make_response()
response.status_code = value
case = make_case(swagger_20, {"responses": {"5XX"}})
with pytest.raises(AssertionError) as exc_info:
status_code_conformance(response, case)
assert exc_info.type.__name__ == f"StatusCodeError{value}"
@pytest.mark.parametrize("spec", ("swagger", "openapi"), indirect=["spec"])
@pytest.mark.parametrize(
"response, case",
(("plain/text", ["application/json"]), ("plain/text;charset=utf-8", ["application/json"])),
indirect=["response", "case"],
)
def test_content_type_conformance_invalid(spec, response, case):
message = (
f"^Received a response with '{response.headers['Content-Type']}' Content-Type, "
"but it is not declared in the schema.\n\nDefined content types: application/json$"
)
with pytest.raises(AssertionError, match=message) as exc_info:
content_type_conformance(response, case)
assert "SchemaValidationError" in exc_info.type.__name__
def test_invalid_schema_on_content_type_check():
# When schema validation is disabled and it doesn't contain "responses" key
schema = schemathesis.from_dict(
{
"openapi": "3.0.2",
"info": {"title": "Test", "description": "Test", "version": "0.1.0"},
"paths": {"/users": {"get": {}}},
},
validate_schema=False,
)
endpoint = schema.endpoints["/users"]["get"]
case = models.Case(endpoint)
response = make_response(content_type="application/json")
# Then an error should be risen
with pytest.raises(InvalidSchema):
content_type_conformance(response, case)
SUCCESS_SCHEMA = {"type": "object", "properties": {"success": {"type": "boolean"}}, "required": ["success"]}
@pytest.mark.parametrize(
"content, definition",
(
(b'{"success": true}', {}),
(b'{"success": true}', {"responses": {"200": {"description": "text"}}}),
(b'{"random": "text"}', {"responses": {"200": {"description": "text"}}}),
(b'{"success": true}', {"responses": {"200": {"description": "text", "schema": SUCCESS_SCHEMA}}}),
(b'{"success": true}', {"responses": {"default": {"description": "text", "schema": SUCCESS_SCHEMA}}}),
),
)
def test_response_schema_conformance_swagger(swagger_20, content, definition):
response = make_response(content)
case = make_case(swagger_20, definition)
assert response_schema_conformance(response, case) is None
def test_response_schema_conformance_swagger_no_content_header(swagger_20):
"""Regression: response_schema_conformance does not raise KeyError when response does not have a "Content-Type"."""
response = requests.Response()
response.status_code = 418
case = make_case(swagger_20, {})
result = response_schema_conformance(response, case)
assert result is None
@pytest.mark.parametrize(
"content, definition",
(
(b'{"success": true}', {}),
(b'{"success": true}', {"responses": {"200": {"description": "text"}}}),
(b'{"random": "text"}', {"responses": {"200": {"description": "text"}}}),
(
b'{"success": null}',
{
"responses": {
"200": {
"description": "text",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"success": {"type": "boolean", "nullable": True}},
"required": ["success"],
}
}
},
}
}
},
),
(
b'{"success": true}',
{
"responses": {
"200": {"description": "text", "content": {"application/json": {"schema": SUCCESS_SCHEMA}}}
}
},
),
(
b'{"success": true}',
{
"responses": {
"default": {"description": "text", "content": {"application/json": {"schema": SUCCESS_SCHEMA}}}
}
},
),
),
)
def test_response_schema_conformance_openapi(openapi_30, content, definition):
response = make_response(content)
case = make_case(openapi_30, definition)
assert response_schema_conformance(response, case) is None
@pytest.mark.parametrize(
"content, definition",
(
(b'{"random": "text"}', {"responses": {"200": {"description": "text", "schema": SUCCESS_SCHEMA}}}),
(b'{"random": "text"}', {"responses": {"default": {"description": "text", "schema": SUCCESS_SCHEMA}}}),
),
)
def test_response_schema_conformance_invalid_swagger(swagger_20, content, definition):
response = make_response(content)
case = make_case(swagger_20, definition)
with pytest.raises(AssertionError) as exc_info:
response_schema_conformance(response, case)
assert "SchemaValidationError" in exc_info.type.__name__
@pytest.mark.parametrize(
"content, definition",
(
(
b'{"random": "text"}',
{
"responses": {
"200": {"description": "text", "content": {"application/json": {"schema": SUCCESS_SCHEMA}}}
}
},
),
(
b'{"random": "text"}',
{
"responses": {
"default": {"description": "text", "content": {"application/json": {"schema": SUCCESS_SCHEMA}}}
}
},
),
),
)
def test_response_schema_conformance_invalid_openapi(openapi_30, content, definition):
response = make_response(content)
case = make_case(openapi_30, definition)
with pytest.raises(AssertionError):
response_schema_conformance(response, case)
@pytest.mark.hypothesis_nested
def test_response_schema_conformance_references_invalid(complex_schema):
schema = schemathesis.from_path(complex_schema)
@given(case=schema.endpoints["/teapot"]["POST"].as_strategy())
@settings(max_examples=3)
def test(case):
response = make_response(json.dumps({"foo": 1}).encode())
with pytest.raises(AssertionError):
case.validate_response(response)
test()
@pytest.mark.hypothesis_nested
def test_response_schema_conformance_references_valid(complex_schema):
schema = schemathesis.from_path(complex_schema)
@given(case=schema.endpoints["/teapot"]["POST"].as_strategy())
@settings(max_examples=3)
def test(case):
response = make_response(json.dumps({"key": "foo"}).encode())
case.validate_response(response)
test()