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
|
from base64 import b64encode
import pytest
from jsonschema_path import SchemaPath
from openapi_core.schema.servers import get_server_url
from openapi_core.schema.specs import get_spec_url
class TestPetstore:
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
def base_uri(self):
return "file://tests/integration/data/v3.0/petstore.yaml"
@pytest.fixture
def spec_dict(self, content_factory):
content, _ = content_factory.from_file("data/v3.0/petstore.yaml")
return content
@pytest.fixture
def schema_path(self, spec_dict, base_uri):
return SchemaPath.from_dict(spec_dict, base_uri=base_uri)
def test_spec(self, schema_path, spec_dict):
url = "http://petstore.swagger.io/v1"
info = schema_path / "info"
info_spec = spec_dict["info"]
assert info["title"] == info_spec["title"]
assert info["description"] == info_spec["description"]
assert info["termsOfService"] == info_spec["termsOfService"]
assert info["version"] == info_spec["version"]
contact = info / "contact"
contact_spec = info_spec["contact"]
assert contact["name"] == contact_spec["name"]
assert contact["url"] == contact_spec["url"]
assert contact["email"] == contact_spec["email"]
license = info / "license"
license_spec = info_spec["license"]
assert license["name"] == license_spec["name"]
assert license["url"] == license_spec["url"]
security = schema_path / "security"
security_spec = spec_dict.get("security", [])
for idx, security_reqs in enumerate(security):
security_reqs_spec = security_spec[idx]
for scheme_name, security_req in security_reqs.items():
security_req == security_reqs_spec[scheme_name]
assert get_spec_url(schema_path) == url
servers = schema_path / "servers"
for idx, server in enumerate(servers):
server_spec = spec_dict["servers"][idx]
assert server["url"] == server_spec["url"]
assert get_server_url(server) == url
variables = server / "variables"
for variable_name, variable in variables.items():
variable_spec = server_spec["variables"][variable_name]
assert variable["default"] == variable_spec["default"]
assert variable["enum"] == variable_spec.get("enum")
paths = schema_path / "paths"
for path_name, path in paths.items():
path_spec = spec_dict["paths"][path_name]
assert path.getkey("summary") == path_spec.get("summary")
assert path.getkey("description") == path_spec.get("description")
servers = path.get("servers", [])
servers_spec = path_spec.get("servers", [])
for idx, server in enumerate(servers):
server_spec = servers_spec[idx]
assert server.url == server_spec["url"]
assert server.default_url == server_spec["url"]
assert server.description == server_spec.get("description")
variables = server.get("variables", {})
for variable_name, variable in variables.items():
variable_spec = server_spec["variables"][variable_name]
assert variable["default"] == variable_spec["default"]
assert variable.getkey("enum") == variable_spec.get("enum")
operations = [
"get",
"put",
"post",
"delete",
"options",
"head",
"patch",
"trace",
]
for http_method in operations:
if http_method not in path:
continue
operation = path / http_method
operation_spec = path_spec[http_method]
assert operation["operationId"] is not None
assert operation["tags"] == operation_spec["tags"]
assert operation["summary"] == operation_spec.get("summary")
assert operation.getkey("description") == operation_spec.get(
"description"
)
ext_docs = operation.get("externalDocs")
ext_docs_spec = operation_spec.get("externalDocs")
assert bool(ext_docs_spec) == bool(ext_docs)
if ext_docs_spec:
assert ext_docs["url"] == ext_docs_spec["url"]
assert ext_docs.getkey("description") == ext_docs_spec.get(
"description"
)
servers = operation.get("servers", [])
servers_spec = operation_spec.get("servers", [])
for idx, server in enumerate(servers):
server_spec = servers_spec[idx]
assert server["url"] == server_spec["url"]
assert get_server_url(server) == server_spec["url"]
assert server["description"] == server_spec.get(
"description"
)
variables = server.get("variables", {})
for variable_name, variable in variables.items():
variable_spec = server_spec["variables"][variable_name]
assert variable["default"] == variable_spec["default"]
assert variable.getkey("enum") == variable_spec.get(
"enum"
)
security = operation.get("security", [])
security_spec = operation_spec.get("security")
if security_spec is not None:
for idx, security_reqs in enumerate(security):
security_reqs_spec = security_spec[idx]
for scheme_name, security_req in security_reqs.items():
security_req == security_reqs_spec[scheme_name]
responses = operation / "responses"
responses_spec = operation_spec.get("responses")
for http_status, response in responses.items():
response_spec = responses_spec[http_status]
if not response_spec:
continue
# @todo: test with defererence
if "$ref" in response_spec:
continue
description_spec = response_spec["description"]
assert response.getkey("description") == description_spec
headers = response.get("headers", {})
for parameter_name, parameter in headers.items():
headers_spec = response_spec["headers"]
parameter_spec = headers_spec[parameter_name]
schema = parameter.get("schema")
schema_spec = parameter_spec.get("schema")
assert bool(schema_spec) == bool(schema)
if not schema_spec:
continue
# @todo: test with defererence
if "$ref" in schema_spec:
continue
assert schema["type"] == schema_spec["type"]
assert schema.getkey("format") == schema_spec.get(
"format"
)
assert schema.getkey("required") == schema_spec.get(
"required"
)
content = parameter.get("content", {})
content_spec = parameter_spec.get("content")
assert bool(content_spec) == bool(content)
if not content_spec:
continue
for mimetype, media_type in content.items():
media_spec = parameter_spec["content"][mimetype]
schema = media_type.get("schema")
schema_spec = media_spec.get("schema")
assert bool(schema_spec) == bool(schema)
if not schema_spec:
continue
# @todo: test with defererence
if "$ref" in schema_spec:
continue
assert schema["type"] == schema_spec["type"]
assert schema.getkey("format") == schema_spec.get(
"format"
)
assert schema.getkey(
"required"
) == schema_spec.get("required")
content_spec = response_spec.get("content")
if not content_spec:
continue
content = response.get("content", {})
for mimetype, media_type in content.items():
content_spec = response_spec["content"][mimetype]
example_spec = content_spec.get("example")
assert media_type.getkey("example") == example_spec
schema = media_type.get("schema")
schema_spec = content_spec.get("schema")
assert bool(schema_spec) == bool(schema)
if not schema_spec:
continue
# @todo: test with defererence
if "$ref" in schema_spec:
continue
assert schema["type"] == schema_spec["type"]
assert schema.getkey("required") == schema_spec.get(
"required"
)
request_body = operation.get("requestBody")
request_body_spec = operation_spec.get("requestBody")
assert bool(request_body_spec) == bool(request_body)
if not request_body_spec:
continue
assert bool(
request_body.getkey("required")
) == request_body_spec.get("required")
content = request_body / "content"
for mimetype, media_type in content.items():
content_spec = request_body_spec["content"][mimetype]
schema_spec = content_spec.get("schema")
if not schema_spec:
continue
# @todo: test with defererence
if "$ref" in schema_spec:
continue
schema = media_type.get("schema")
assert bool(schema_spec) == bool(schema)
assert schema["type"] == schema_spec["type"]
assert schema.getkey("format") == schema_spec.get("format")
assert schema.getkey("required") == schema_spec.get(
"required"
)
components = schema_path.get("components")
if not components:
return
schemas = components.get("schemas", {})
for schema_name, schema in schemas.items():
schema_spec = spec_dict["components"]["schemas"][schema_name]
assert schema.getkey("readOnly") == schema_spec.get("readOnly")
assert schema.getkey("writeOnly") == schema_spec.get("writeOnly")
class TestWebhook:
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
def base_uri(self):
return "file://tests/integration/data/v3.1/webhook-example.yaml"
@pytest.fixture
def spec_dict(self, content_factory):
content, _ = content_factory.from_file(
"data/v3.1/webhook-example.yaml"
)
return content
@pytest.fixture
def schema_path(self, spec_dict, base_uri):
return SchemaPath.from_dict(
spec_dict,
base_uri=base_uri,
)
def test_spec(self, schema_path, spec_dict):
info = schema_path / "info"
info_spec = spec_dict["info"]
assert info["title"] == info_spec["title"]
assert info["version"] == info_spec["version"]
webhooks = schema_path / "webhooks"
webhooks_spec = spec_dict["webhooks"]
assert webhooks["newPet"] == webhooks_spec["newPet"]
components = schema_path.get("components")
if not components:
return
schemas = components.get("schemas", {})
for schema_name, schema in schemas.items():
assert spec_dict["components"]["schemas"][schema_name] is not None
|
