drf-yasg/tests/test_versioning.py

80 lines
2.9 KiB
Python

import pytest
from drf_yasg.codecs import yaml_sane_load
def _get_versioned_schema(prefix, client, validate_schema):
response = client.get(prefix + '/swagger.yaml')
assert response.status_code == 200
swagger = yaml_sane_load(response.content.decode('utf-8'))
_check_base(swagger, prefix, validate_schema)
return swagger
def _get_versioned_schema_management(prefix, call_generate_swagger, validate_schema, kwargs):
output = call_generate_swagger(format='yaml', api_url='http://localhost' + prefix + '/swagger.yaml', **kwargs)
swagger = yaml_sane_load(output)
_check_base(swagger, prefix, validate_schema)
return swagger
def _check_base(swagger, prefix, validate_schema):
assert swagger['basePath'] == prefix
validate_schema(swagger)
assert '/snippets/' in swagger['paths']
return swagger
def _check_v1(swagger):
assert swagger['info']['version'] == '1.0'
versioned_post = swagger['paths']['/snippets/']['post']
assert versioned_post['responses']['201']['schema']['$ref'] == '#/definitions/Snippet'
assert 'v2field' not in swagger['definitions']['Snippet']['properties']
def _check_v2(swagger):
assert swagger['info']['version'] == '2.0'
versioned_post = swagger['paths']['/snippets/']['post']
assert versioned_post['responses']['201']['schema']['$ref'] == '#/definitions/SnippetV2'
assert 'v2field' in swagger['definitions']['SnippetV2']['properties']
v2field = swagger['definitions']['SnippetV2']['properties']['v2field']
assert v2field['description'] == 'version 2.0 field'
@pytest.mark.urls('urlconfs.url_versioning')
def test_url_v1(client, validate_schema):
swagger = _get_versioned_schema('/versioned/url/v1.0', client, validate_schema)
_check_v1(swagger)
@pytest.mark.urls('urlconfs.url_versioning')
def test_url_v2(client, validate_schema):
swagger = _get_versioned_schema('/versioned/url/v2.0', client, validate_schema)
_check_v2(swagger)
@pytest.mark.urls('urlconfs.ns_versioning')
def test_ns_v1(client, validate_schema):
swagger = _get_versioned_schema('/versioned/ns/v1.0', client, validate_schema)
_check_v1(swagger)
@pytest.mark.urls('urlconfs.ns_versioning')
def test_ns_v2(client, validate_schema):
swagger = _get_versioned_schema('/versioned/ns/v2.0', client, validate_schema)
_check_v2(swagger)
@pytest.mark.urls('urlconfs.url_versioning')
def test_url_v2_management(call_generate_swagger, validate_schema):
kwargs = {'api_version': '2.0'}
swagger = _get_versioned_schema_management('/versioned/url/v2.0', call_generate_swagger, validate_schema, kwargs)
_check_v2(swagger)
@pytest.mark.urls('urlconfs.ns_versioning')
def test_ns_v2_management(call_generate_swagger, validate_schema):
kwargs = {'api_version': '2.0'}
swagger = _get_versioned_schema_management('/versioned/ns/v2.0', call_generate_swagger, validate_schema, kwargs)
_check_v2(swagger)