openapi-core/tests/integration/test_petstore.py

417 lines
12 KiB
Python
Raw Normal View History

2017-09-21 11:51:37 +00:00
import json
import pytest
from six import iteritems
from openapi_core.exceptions import (
2017-09-25 11:22:55 +00:00
MissingParameterError, InvalidContentTypeError, InvalidServerError,
2017-09-25 14:15:00 +00:00
InvalidValueType, UndefinedSchemaProperty, MissingPropertyError,
2017-09-21 11:51:37 +00:00
)
from openapi_core.media_types import MediaType
from openapi_core.operations import Operation
from openapi_core.paths import Path
from openapi_core.request_bodies import RequestBody
from openapi_core.schemas import Schema
2017-09-25 11:22:55 +00:00
from openapi_core.servers import Server, ServerVariable
2017-09-21 11:51:37 +00:00
from openapi_core.shortcuts import create_spec
from openapi_core.wrappers import BaseOpenAPIRequest
class RequestMock(BaseOpenAPIRequest):
def __init__(
2017-09-25 11:22:55 +00:00
self, host_url, method, path, path_pattern=None, args=None,
view_args=None, headers=None, cookies=None, data=None,
2017-10-09 14:57:07 +00:00
mimetype='application/json'):
2017-09-25 11:22:55 +00:00
self.host_url = host_url
2017-09-21 11:51:37 +00:00
self.path = path
self.path_pattern = path_pattern or path
self.method = method
self.args = args or {}
self.view_args = view_args or {}
self.headers = headers or {}
self.cookies = cookies or {}
self.data = data or ''
2017-10-09 14:57:07 +00:00
self.mimetype = mimetype
2017-09-21 11:51:37 +00:00
class TestPetstore(object):
@pytest.fixture
def spec_dict(self, factory):
return factory.spec_from_file("data/v3.0/petstore.yaml")
@pytest.fixture
def spec(self, spec_dict):
return create_spec(spec_dict)
def test_spec(self, spec, spec_dict):
2017-09-25 11:22:55 +00:00
url = 'http://petstore.swagger.io/v1'
assert spec.info.title == spec_dict['info']['title']
assert spec.info.version == spec_dict['info']['version']
2017-09-25 11:22:55 +00:00
assert spec.get_server_url() == url
for idx, server in enumerate(spec.servers):
assert type(server) == Server
server_spec = spec_dict['servers'][idx]
assert server.url == server_spec['url']
assert server.default_url == url
for variable_name, variable in iteritems(server.variables):
assert type(variable) == ServerVariable
assert variable.name == variable_name
variable_spec = server_spec['variables'][variable_name]
assert variable.default == variable_spec['default']
assert variable.enum == variable_spec.get('enum')
2017-09-21 11:51:37 +00:00
for path_name, path in iteritems(spec.paths):
assert type(path) == Path
assert path.name == path_name
for http_method, operation in iteritems(path.operations):
assert type(operation) == Operation
assert operation.path_name == path_name
assert operation.http_method == http_method
operation_spec = spec_dict['paths'][path_name][http_method]
request_body_spec = operation_spec.get('requestBody')
assert bool(request_body_spec) == bool(operation.request_body)
if not request_body_spec:
continue
assert type(operation.request_body) == RequestBody
assert bool(operation.request_body.required) ==\
request_body_spec.get('required', False)
2017-10-09 14:57:07 +00:00
for mimetype, media_type in iteritems(
2017-09-21 11:51:37 +00:00
operation.request_body.content):
assert type(media_type) == MediaType
2017-10-09 14:57:07 +00:00
assert media_type.mimetype == mimetype
2017-09-21 11:51:37 +00:00
2017-10-09 14:57:07 +00:00
content_spec = request_body_spec['content'][mimetype]
2017-09-21 11:51:37 +00:00
schema_spec = content_spec.get('schema')
assert bool(schema_spec) == bool(media_type.schema)
if not schema_spec:
continue
# @todo: test with defererence
if '$ref' in schema_spec:
continue
assert type(media_type.schema) == Schema
assert media_type.schema.type == schema_spec['type']
assert media_type.schema.required == schema_spec.get(
'required', False)
if not spec.components:
return
for schema_name, schema in iteritems(spec.components.schemas):
assert type(schema) == Schema
2017-09-21 11:51:37 +00:00
def test_get_pets(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
2017-09-21 11:51:37 +00:00
query_params = {
'limit': '20',
'ids': ['12', '13'],
}
2017-09-25 11:22:55 +00:00
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'GET', '/pets',
2017-09-25 11:22:55 +00:00
path_pattern=path_pattern, args=query_params,
)
2017-09-21 11:51:37 +00:00
parameters = request.get_parameters(spec)
2017-09-25 13:20:23 +00:00
body = request.get_body(spec)
2017-09-21 11:51:37 +00:00
assert parameters == {
'query': {
'limit': 20,
'ids': [12, 13],
}
}
2017-09-25 13:20:23 +00:00
assert body is None
2017-09-21 11:51:37 +00:00
2017-09-25 14:15:00 +00:00
def test_get_pets_wrong_parameter_type(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
2017-09-25 14:15:00 +00:00
query_params = {
'limit': 'twenty',
}
2017-09-25 11:22:55 +00:00
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'GET', '/pets',
2017-09-25 14:15:00 +00:00
path_pattern=path_pattern, args=query_params,
2017-09-25 11:22:55 +00:00
)
2017-09-21 11:51:37 +00:00
2017-09-25 14:15:00 +00:00
with pytest.raises(InvalidValueType):
2017-09-21 11:51:37 +00:00
request.get_parameters(spec)
2017-09-25 13:20:23 +00:00
body = request.get_body(spec)
assert body is None
2017-09-25 14:15:00 +00:00
def test_get_pets_raises_missing_required_param(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'GET', '/pets',
2017-09-25 14:15:00 +00:00
path_pattern=path_pattern,
2017-09-25 11:22:55 +00:00
)
2017-09-21 11:51:37 +00:00
2017-09-25 14:15:00 +00:00
with pytest.raises(MissingParameterError):
request.get_parameters(spec)
2017-09-25 13:20:23 +00:00
body = request.get_body(spec)
2017-09-21 11:51:37 +00:00
2017-09-25 13:20:23 +00:00
assert body is None
2017-09-21 11:51:37 +00:00
def test_get_pets_empty_value(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
2017-09-21 11:51:37 +00:00
query_params = {
'limit': '',
}
2017-09-25 11:22:55 +00:00
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'GET', '/pets',
2017-09-25 11:22:55 +00:00
path_pattern=path_pattern, args=query_params,
)
2017-09-21 11:51:37 +00:00
parameters = request.get_parameters(spec)
2017-09-25 13:20:23 +00:00
body = request.get_body(spec)
2017-09-21 11:51:37 +00:00
assert parameters == {
'query': {
'limit': None,
}
}
2017-09-25 13:20:23 +00:00
assert body is None
2017-09-21 11:51:37 +00:00
def test_get_pets_none_value(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
2017-09-21 11:51:37 +00:00
query_params = {
'limit': None,
}
2017-09-25 11:22:55 +00:00
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'GET', '/pets',
2017-09-25 11:22:55 +00:00
path_pattern=path_pattern, args=query_params,
)
2017-09-21 11:51:37 +00:00
parameters = request.get_parameters(spec)
assert parameters == {
'query': {
'limit': None,
}
}
2017-09-25 13:20:23 +00:00
body = request.get_body(spec)
assert body is None
def test_post_pets(self, spec, spec_dict):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
pet_name = 'Cat'
pet_tag = 'cats'
pet_street = 'Piekna'
pet_city = 'Warsaw'
2017-09-21 11:51:37 +00:00
data_json = {
'name': pet_name,
'tag': pet_tag,
'address': {
'street': pet_street,
'city': pet_city,
}
2017-09-21 11:51:37 +00:00
}
data = json.dumps(data_json)
2017-09-25 11:22:55 +00:00
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'POST', '/pets',
2017-09-25 11:22:55 +00:00
path_pattern=path_pattern, data=data,
)
2017-09-21 11:51:37 +00:00
2017-09-25 13:20:23 +00:00
parameters = request.get_parameters(spec)
assert parameters == {}
body = request.get_body(spec)
schemas = spec_dict['components']['schemas']
pet_model = schemas['PetCreate']['x-model']
address_model = schemas['Address']['x-model']
2017-09-25 13:20:23 +00:00
assert body.__class__.__name__ == pet_model
assert body.name == pet_name
assert body.tag == pet_tag
assert body.address.__class__.__name__ == address_model
assert body.address.street == pet_street
assert body.address.city == pet_city
2017-09-21 11:51:37 +00:00
2017-09-25 14:15:00 +00:00
def test_post_pets_empty_body(self, spec, spec_dict):
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
data_json = {}
data = json.dumps(data_json)
request = RequestMock(
host_url, 'POST', '/pets',
path_pattern=path_pattern, data=data,
)
parameters = request.get_parameters(spec)
assert parameters == {}
with pytest.raises(MissingPropertyError):
request.get_body(spec)
def test_post_pets_extra_body_properties(self, spec, spec_dict):
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
pet_name = 'Cat'
alias = 'kitty'
data_json = {
'name': pet_name,
'alias': alias,
}
data = json.dumps(data_json)
request = RequestMock(
host_url, 'POST', '/pets',
path_pattern=path_pattern, data=data,
)
parameters = request.get_parameters(spec)
assert parameters == {}
with pytest.raises(UndefinedSchemaProperty):
request.get_body(spec)
def test_post_pets_only_required_body(self, spec, spec_dict):
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
pet_name = 'Cat'
data_json = {
'name': pet_name,
}
data = json.dumps(data_json)
request = RequestMock(
host_url, 'POST', '/pets',
path_pattern=path_pattern, data=data,
)
parameters = request.get_parameters(spec)
assert parameters == {}
body = request.get_body(spec)
schemas = spec_dict['components']['schemas']
pet_model = schemas['PetCreate']['x-model']
assert body.__class__.__name__ == pet_model
assert body.name == pet_name
2017-10-17 13:02:21 +00:00
assert not hasattr(body, 'tag')
assert not hasattr(body, 'address')
2017-09-25 14:15:00 +00:00
def test_get_pets_wrong_body_type(self, spec):
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
pet_name = 'Cat'
pet_tag = 'cats'
pet_address = 'address text'
data_json = {
'name': pet_name,
'tag': pet_tag,
'address': pet_address,
}
data = json.dumps(data_json)
request = RequestMock(
host_url, 'POST', '/pets',
path_pattern=path_pattern, data=data,
)
parameters = request.get_parameters(spec)
assert parameters == {}
with pytest.raises(InvalidValueType):
request.get_body(spec)
2017-10-09 14:57:07 +00:00
def test_post_pets_raises_invalid_mimetype(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets'
2017-09-21 11:51:37 +00:00
data_json = {
'name': 'Cat',
'tag': 'cats',
}
data = json.dumps(data_json)
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'POST', '/pets',
2017-10-09 14:57:07 +00:00
path_pattern=path_pattern, data=data, mimetype='text/html',
2017-09-25 11:22:55 +00:00
)
2017-09-21 11:51:37 +00:00
2017-09-25 13:20:23 +00:00
parameters = request.get_parameters(spec)
assert parameters == {}
2017-09-21 11:51:37 +00:00
with pytest.raises(InvalidContentTypeError):
request.get_body(spec)
2017-09-25 11:22:55 +00:00
def test_post_pets_raises_invalid_server_error(self, spec):
host_url = 'http://flowerstore.swagger.io/v1'
path_pattern = '/v1/pets'
data_json = {
'name': 'Cat',
'tag': 'cats',
}
data = json.dumps(data_json)
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'POST', '/pets',
2017-10-09 14:57:07 +00:00
path_pattern=path_pattern, data=data, mimetype='text/html',
2017-09-25 11:22:55 +00:00
)
2017-09-25 13:20:23 +00:00
with pytest.raises(InvalidServerError):
request.get_parameters(spec)
2017-09-25 11:22:55 +00:00
with pytest.raises(InvalidServerError):
request.get_body(spec)
2017-09-21 11:51:37 +00:00
def test_get_pet(self, spec):
2017-09-25 11:22:55 +00:00
host_url = 'http://petstore.swagger.io/v1'
path_pattern = '/v1/pets/{petId}'
2017-09-21 11:51:37 +00:00
view_args = {
'petId': '1',
}
request = RequestMock(
2017-09-25 13:20:23 +00:00
host_url, 'GET', '/pets/1',
2017-09-25 11:22:55 +00:00
path_pattern=path_pattern, view_args=view_args,
2017-09-21 11:51:37 +00:00
)
parameters = request.get_parameters(spec)
assert parameters == {
'path': {
'petId': 1,
}
}
2017-09-25 13:20:23 +00:00
body = request.get_body(spec)
assert body is None