def test_not_instantiated(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
"""
Ice cream service
"""
# Use GetRequestSchema and ResponseSchemas classes instead of objects
@service.get(validators=(colander_validator, ),
schema=GetRequestSchema)
def view_get(self, request):
"""Serve icecream"""
return self.request.validated
@service.put(validators=(colander_validator, ),
schema=PutRequestSchema())
def view_put(self, request):
"""Add flavour"""
return self.request.validated
self.service = service
self.swagger = CorniceSwagger([self.service])
self.spec = self.swagger.generate()
validate(self.spec)
def test_ignore_multiple_views_by_ctype(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
def view_put(self, request):
return "red"
service.add_view(
"put",
IceCream.view_put,
validators=(colander_validator, ),
schema=PutRequestSchema(),
content_type='application/json',
)
service.add_view(
"put",
IceCream.view_put,
validators=(colander_validator, ),
schema=PutRequestSchema(),
content_type='text/xml',
)
swagger = CorniceSwagger([service])
swagger.ignore_ctypes = ['text/xml']
spec = swagger.generate()
self.assertEquals(
spec['paths']['/icecream/{flavour}']['put']['consumes'],
['application/json'])
def test_swagger_field_overrides_extracted_paths(self):
swagger = CorniceSwagger([self.service], param_ref=True)
swagger.swagger = {'parameters': {'BodySchema': {'required': False}}}
spec = swagger.generate()
validate(self.spec)
expected = {'name': 'BodySchema', 'required': False}
self.assertDictContainsSubset(expected,
spec['parameters']['BodySchema'])
def test_colander_body_validator_to_full_schema(self):
swagger = CorniceSwagger([self.service])
service_args = dict(schema=BodySchema(),
validators=(colander_body_validator, ))
full_schema = swagger._extract_transform_colander_schema(service_args)
# ensure schema is cloned
self.assertNotEqual(service_args['schema'], full_schema['body'])
# ensure schema is transformed
self.assertEqual(service_args['schema'].typ, full_schema['body'].typ)
self.assertEqual(len(service_args['schema'].children),
len(full_schema['body'].children))
def test_invalid_default_opid_raises_exception(self):
service = Service("IceCream", "/icecream/{flavour}")
@service.get()
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
swagger.default_op_ids = "foo"
self.assertRaises(CorniceSwaggerException, swagger.generate)
def test_no_ctype_no_list_with_none(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.put()
def view_put(self, request):
return self.request.validated
swagger = CorniceSwagger([service])
spec = swagger.generate()
self.assertNotIn('consumes',
spec['paths']['/icecream/{flavour}']['put'])
def test_unkown_renderer(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get(renderer='')
def view_get(self, request):
return self.request.validated
swagger = CorniceSwagger([service])
spec = swagger.generate()
self.assertNotIn('produces',
spec['paths']['/icecream/{flavour}']['get'])
def test_view_defined_operation_id(self):
service = Service("IceCream", "/icecream/{flavour}")
@service.get(operation_id='serve_icecream')
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
spec = swagger.generate()
validate(spec)
op_id = spec['paths']['/icecream/{flavour}']['get']['operationId']
self.assertEquals(op_id, 'serve_icecream')
def test_default_renderer(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get()
def view_get(self, request):
return self.request.validated
swagger = CorniceSwagger([service])
spec = swagger.generate()
self.assertEquals(
spec['paths']['/icecream/{flavour}']['get']['produces'],
['application/json'])
def test_multiple_ctypes(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.put(content_type=('application/json', 'text/xml'))
def view_put(self, request):
return self.request.validated
swagger = CorniceSwagger([service])
spec = swagger.generate()
self.assertEquals(
spec['paths']['/icecream/{flavour}']['put']['consumes'],
['application/json', 'text/xml'])
def test_schema_transform(self):
swagger = CorniceSwagger([self.service])
header_schema = HeaderSchema()
service_args = dict(schema=GetRequestSchema())
def add_headers_transform(schema, args):
schema['header'] = header_schema
return schema
swagger.schema_transformers.append(add_headers_transform)
full_schema = swagger._extract_transform_colander_schema(service_args)
self.assertEqual(header_schema, full_schema['header'])
# ensure service schema is left untouched
self.assertNotIn('header', service_args['schema'])
def test_view_defined_tags(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get(tags=['cold', 'foo'])
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
spec = swagger.generate()
validate(spec)
tags = spec['paths']['/icecream/{flavour}']['get']['tags']
self.assertEquals(tags, ['cold', 'foo'])
def test_summary_docstrings_with_klass(self):
class TemperatureCooler(object):
def put_view(self):
"""Put it."""
pass
service = Service("TemperatureCooler",
"/freshair",
klass=TemperatureCooler)
service.add_view("put", "put_view")
CorniceSwagger.services = [service]
self.swagger = CorniceSwagger()
self.spec = self.swagger.generate()
validate(self.spec)
def test_multiple_views_with_different_ctypes_raises_exception(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
def view_put(self, request):
return "red"
service.add_view(
"put",
IceCream.view_put,
validators=(colander_validator, ),
schema=PutRequestSchema(),
content_type='application/json',
)
service.add_view(
"put",
IceCream.view_put,
validators=(colander_validator, ),
schema=PutRequestSchema(),
content_type='text/xml',
)
swagger = CorniceSwagger([service])
self.assertRaises(CorniceSwaggerException, swagger.generate)
def test_single_ctype_callable(self):
service = Service("IceCream", "/icecream/{flavour}")
def my_ctype_callable(request):
return 'application/octet-stream'
class IceCream(object):
@service.put(content_type=my_ctype_callable)
def view_put(self, request):
return self.request.validated
swagger = CorniceSwagger([service])
spec = swagger.generate()
self.assertEquals(
spec['paths']['/icecream/{flavour}']['put']['consumes'], [])
def test_callable_default_tags(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get()
def view_get(self, request):
return service
def default_tag_callable(service, method):
return ['cold']
swagger = CorniceSwagger([service])
swagger.default_tags = default_tag_callable
spec = swagger.generate()
validate(spec)
tags = spec['paths']['/icecream/{flavour}']['get']['tags']
self.assertEquals(tags, ['cold'])
def test_handles_subpaths_as_parameters(self):
service = Service("IceCream", "/icecream/*subpath")
class IceCream(object):
@service.get()
def view_get(self, request):
return self.request
swagger = CorniceSwagger([service])
spec = swagger.generate()
expected = {
'name': 'subpath',
'required': True,
'type': 'string',
'in': 'path'
}
self.assertDictEqual(
spec['paths']['/icecream/{subpath}']['parameters'][0], expected)
def test_view_defined_security(self):
service = Service("IceCream", "/icecream/{flavour}")
@service.get(api_security=[{'basicAuth': []}])
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
swagger.swagger = {
'securityDefinitions': {
'basicAuth': {
'type': 'basic'
}
}
}
spec = swagger.generate()
validate(spec)
security = spec['paths']['/icecream/{flavour}']['get']['security']
self.assertEquals(security, [{'basicAuth': []}])
def test_invalid_security_raises_exception(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get(api_security='basicAuth')
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
self.assertRaises(CorniceSwaggerException, swagger.generate)
def test_provided_tags_override_sorting(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get(tags=['cold', 'foo'])
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
tags = [{'name': 'foo', 'description': 'bar'}]
swagger.swagger = {'tags': tags}
spec = swagger.generate()
validate(spec)
self.assertListEqual([{
'name': 'foo',
'description': 'bar'
}, {
'name': 'cold'
}], spec['tags'])
def test_invalid_service_tag_raises_exception(self):
service = Service("IceCream", "/icecream/{flavour}", tags='cold')
class IceCream(object):
@service.get()
def view_get(self, request):
return service
swagger = CorniceSwagger([service])
self.assertRaises(CorniceSwaggerException, swagger.generate)
def test_mixed_ctype_string_and_callable(self):
service = Service("IceCream", "/icecream/{flavour}")
def my_ctype_callable(request):
return 'application/octet-stream'
def my_ctype_callable_2(request):
return 'image/png'
class IceCream(object):
@service.put(content_type=(my_ctype_callable, 'application/json',
my_ctype_callable_2, 'image/jpeg'))
def view_put(self, request):
return self.request.validated
swagger = CorniceSwagger([service])
spec = swagger.generate()
self.assertEquals(
spec['paths']['/icecream/{flavour}']['put']['consumes'],
['application/json', 'image/jpeg'])
def test_callable_default_security(self):
def get_security(service, method):
definitions = service.definitions
for definition in definitions:
met, view, args = definition
if met == method:
break
if 'security' in args:
return [{'basicAuth': []}]
else:
return []
service = Service("IceCream", "/icecream/{flavour}")
@service.get()
def view_get(self, request):
return service
@service.post(security='foo')
def view_post(self, request):
return service
swagger = CorniceSwagger([service])
swagger.swagger = {
'securityDefinitions': {
'basicAuth': {
'type': 'basic'
}
}
}
swagger.default_security = get_security
spec = swagger.generate()
validate(spec)
security = spec['paths']['/icecream/{flavour}']['post']['security']
self.assertEquals(security, [{'basicAuth': []}])
security = spec['paths']['/icecream/{flavour}']['get']['security']
self.assertEquals(security, [])
def test_default_operation_ids(self):
service = Service("IceCream", "/icecream/{flavour}")
@service.get()
def view_get(self, request):
return service
@service.put()
def view_put(self, request):
return service
def op_id_generator(service, method):
return '%s_%s' % (method.lower(), service.path.split('/')[-2])
swagger = CorniceSwagger([service])
swagger.default_op_ids = op_id_generator
spec = swagger.generate()
validate(spec)
op_id = spec['paths']['/icecream/{flavour}']['get']['operationId']
self.assertEquals(op_id, 'get_icecream')
op_id = spec['paths']['/icecream/{flavour}']['put']['operationId']
self.assertEquals(op_id, 'put_icecream')
def setUp(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get(validators=(colander_validator, ),
schema=GetRequestSchema(),
response_schemas=response_schemas)
def view_get(self, request):
"""Serve ice cream"""
return self.request.validated
@service.put(validators=(colander_validator, ),
schema=PutRequestSchema())
def view_put(self, request):
"""Add flavour"""
return self.request.validated
self.service = service
CorniceSwagger.services = [self.service]
CorniceSwagger.api_title = 'IceCreamAPI'
CorniceSwagger.api_version = '4.2'
self.swagger = CorniceSwagger()
self.spec = self.swagger.generate()
validate(self.spec)
def generate_api_schema(swagger_base_spec):
# type: (Dict[str, Union[str, List[str]]]) -> JSON
"""
Return JSON Swagger specifications of Cowbird REST API.
Uses Cornice Services and Schemas to return swagger specification.
:param swagger_base_spec: dictionary that specifies the 'host' and list of HTTP 'schemes' to employ.
"""
generator = CorniceSwagger(get_services())
# function docstrings are used to create the route's summary in Swagger-UI
generator.summary_docstrings = True
generator.default_security = get_security
swagger_base_spec.update(SecurityDefinitionsAPI)
generator.swagger = swagger_base_spec
json_api_spec = generator.generate(title=TitleAPI,
version=__meta__.__version__,
info=InfoAPI)
for tag in json_api_spec["tags"]:
tag["description"] = TAG_DESCRIPTIONS[tag["name"]]
return json_api_spec
def test_with_resp_ref(self):
swagger = CorniceSwagger([self.service], resp_ref=True)
spec = swagger.generate()
validate(spec)
self.assertIn('responses', spec)
def test_with_param_ref(self):
swagger = CorniceSwagger([self.service], param_ref=True)
spec = swagger.generate()
validate(spec)
self.assertIn('parameters', spec)
def test_with_schema_ref(self):
swagger = CorniceSwagger([self.service], def_ref_depth=1)
spec = swagger.generate()
validate(spec)
self.assertIn('definitions', spec)
class CorniceSwaggerGeneratorTest(unittest.TestCase):
def setUp(self):
service = Service("IceCream", "/icecream/{flavour}")
class IceCream(object):
@service.get(validators=(colander_validator, ),
schema=GetRequestSchema(),
response_schemas=response_schemas)
def view_get(self, request):
"""Serve ice cream"""
return self.request.validated
@service.put(validators=(colander_validator, ),
schema=PutRequestSchema())
def view_put(self, request):
"""Add flavour"""
return self.request.validated
self.service = service
CorniceSwagger.services = [self.service]
CorniceSwagger.api_title = 'IceCreamAPI'
CorniceSwagger.api_version = '4.2'
self.swagger = CorniceSwagger()
self.spec = self.swagger.generate()
validate(self.spec)
def test_path(self):
self.assertIn('/icecream/{flavour}', self.spec['paths'])
def test_path_methods(self):
path = self.spec['paths']['/icecream/{flavour}']
self.assertIn('get', path)
self.assertIn('put', path)
def test_path_parameters(self):
parameters = self.spec['paths']['/icecream/{flavour}']['parameters']
self.assertEquals(len(parameters), 1)
self.assertEquals(parameters[0]['name'], 'flavour')
def test_summary_docstrings(self):
self.swagger.summary_docstrings = True
self.spec = self.swagger.generate()
validate(self.spec)
summary = self.spec['paths']['/icecream/{flavour}']['get']['summary']
self.assertEquals(summary, 'Serve ice cream')
def test_summary_docstrings_with_klass(self):
class TemperatureCooler(object):
def put_view(self):
"""Put it."""
pass
service = Service("TemperatureCooler",
"/freshair",
klass=TemperatureCooler)
service.add_view("put", "put_view")
CorniceSwagger.services = [service]
self.swagger = CorniceSwagger()
self.spec = self.swagger.generate()
validate(self.spec)
def test_with_schema_ref(self):
swagger = CorniceSwagger([self.service], def_ref_depth=1)
spec = swagger.generate()
validate(spec)
self.assertIn('definitions', spec)
def test_with_param_ref(self):
swagger = CorniceSwagger([self.service], param_ref=True)
spec = swagger.generate()
validate(spec)
self.assertIn('parameters', spec)
def test_with_resp_ref(self):
swagger = CorniceSwagger([self.service], resp_ref=True)
spec = swagger.generate()
validate(spec)
self.assertIn('responses', spec)
def test_swagger_field_updates_extracted_paths(self):
self.swagger.swagger = {
'definitions': {
'OtherDef': {
'additionalProperties': {}
}
}
}
spec = self.swagger.generate()
validate(spec)
self.assertEquals(spec['definitions'],
self.swagger.swagger['definitions'])
def test_swagger_field_overrides_extracted_paths(self):
swagger = CorniceSwagger([self.service], param_ref=True)
swagger.swagger = {'parameters': {'BodySchema': {'required': False}}}
spec = swagger.generate()
validate(self.spec)
expected = {'name': 'BodySchema', 'required': False}
self.assertDictContainsSubset(expected,
spec['parameters']['BodySchema'])
@mock.patch('cornice_swagger.swagger.warnings.warn')
def test_swagger_call_is_deprecated(self, mocked):
self.swagger()
msg = "Calling `CorniceSwagger is deprecated, call `generate` instead"
mocked.assert_called_with(msg, DeprecationWarning)
