| 1 |
import pytest |
| 2 |
|
| 3 |
from drf_yasg.codecs import yaml_load |
| 4 |
from drf_yasg.errors import SwaggerGenerationError |
| 5 |
|
| 6 |
|
| 7 |
def _get_versioned_schema(prefix, client, validate_schema, path="/snippets/"): |
| 8 |
response = client.get(prefix + "/swagger.yaml") |
| 9 |
assert response.status_code == 200 |
| 10 |
swagger = yaml_load(response.content) |
| 11 |
_check_base(swagger, prefix, validate_schema, path) |
| 12 |
return swagger |
| 13 |
|
| 14 |
|
| 15 |
def _get_versioned_schema_management( |
| 16 |
prefix, call_generate_swagger, validate_schema, kwargs, path="/snippets/" |
| 17 |
): |
| 18 |
output = call_generate_swagger( |
| 19 |
format="yaml", api_url="http://localhost" + prefix + "/swagger.yaml", **kwargs |
| 20 |
) |
| 21 |
swagger = yaml_load(output) |
| 22 |
_check_base(swagger, prefix, validate_schema, path) |
| 23 |
return swagger |
| 24 |
|
| 25 |
|
| 26 |
def _check_base(swagger, prefix, validate_schema, path): |
| 27 |
assert swagger["basePath"] == prefix |
| 28 |
validate_schema(swagger) |
| 29 |
assert path in swagger["paths"] |
| 30 |
return swagger |
| 31 |
|
| 32 |
|
| 33 |
def _check_v1(swagger, path="/snippets/"): |
| 34 |
assert swagger["info"]["version"] == "1.0" |
| 35 |
versioned_post = swagger["paths"][path]["post"] |
| 36 |
assert ( |
| 37 |
versioned_post["responses"]["201"]["schema"]["$ref"] == "#/definitions/Snippet" |
| 38 |
) |
| 39 |
assert "v2field" not in swagger["definitions"]["Snippet"]["properties"] |
| 40 |
assert "/snippets_excluded/" not in swagger["paths"] |
| 41 |
|
| 42 |
|
| 43 |
def _check_v2(swagger, path="/snippets/"): |
| 44 |
assert swagger["info"]["version"] == "2.0" |
| 45 |
versioned_post = swagger["paths"][path]["post"] |
| 46 |
assert ( |
| 47 |
versioned_post["responses"]["201"]["schema"]["$ref"] |
| 48 |
== "#/definitions/SnippetV2" |
| 49 |
) |
| 50 |
assert "v2field" in swagger["definitions"]["SnippetV2"]["properties"] |
| 51 |
v2field = swagger["definitions"]["SnippetV2"]["properties"]["v2field"] |
| 52 |
assert v2field["description"] == "version 2.0 field" |
| 53 |
assert "/snippets_excluded/" not in swagger["paths"] |
| 54 |
|
| 55 |
|
| 56 |
@pytest.mark.urls("urlconfs.url_versioning") |
| 57 |
def test_url_v2(client, validate_schema): |
| 58 |
swagger = _get_versioned_schema("/versioned/url/v2.0", client, validate_schema) |
| 59 |
_check_v2(swagger) |
| 60 |
|
| 61 |
|
| 62 |
@pytest.mark.urls("urlconfs.url_versioning_extra") |
| 63 |
def test_url_v2_extra(client, validate_schema): |
| 64 |
swagger = _get_versioned_schema( |
| 65 |
"/versioned/url/v2.0", client, validate_schema, path="/extra/snippets/" |
| 66 |
) |
| 67 |
_check_v2(swagger, path="/extra/snippets/") |
| 68 |
|
| 69 |
|
| 70 |
@pytest.mark.urls("urlconfs.overrided_serializer_name") |
| 71 |
def test_url_same_ref_names(client, validate_schema): |
| 72 |
for v in {"v1.0", "v2.0"}: |
| 73 |
try: |
| 74 |
client.get(f"/versioned/url/{v}/swagger.yaml") |
| 75 |
except SwaggerGenerationError: |
| 76 |
pass |
| 77 |
else: |
| 78 |
raise AssertionError("drf_yasg.errors.SwaggerGenerationError is not raised") |
| 79 |
|
| 80 |
|
| 81 |
@pytest.mark.urls("urlconfs.url_versioning") |
| 82 |
def test_url_v1(client, validate_schema): |
| 83 |
swagger = _get_versioned_schema("/versioned/url/v1.0", client, validate_schema) |
| 84 |
_check_v1(swagger) |
| 85 |
|
| 86 |
|
| 87 |
@pytest.mark.urls("urlconfs.ns_versioning") |
| 88 |
def test_ns_v1(client, validate_schema): |
| 89 |
swagger = _get_versioned_schema("/versioned/ns/v1.0", client, validate_schema) |
| 90 |
_check_v1(swagger) |
| 91 |
|
| 92 |
|
| 93 |
@pytest.mark.urls("urlconfs.ns_versioning") |
| 94 |
def test_ns_v2(client, validate_schema): |
| 95 |
swagger = _get_versioned_schema("/versioned/ns/v2.0", client, validate_schema) |
| 96 |
_check_v2(swagger) |
| 97 |
|
| 98 |
|
| 99 |
@pytest.mark.urls("urlconfs.url_versioning") |
| 100 |
def test_url_v2_management(call_generate_swagger, validate_schema): |
| 101 |
kwargs = {"api_version": "2.0"} |
| 102 |
swagger = _get_versioned_schema_management( |
| 103 |
"/versioned/url/v2.0", call_generate_swagger, validate_schema, kwargs |
| 104 |
) |
| 105 |
_check_v2(swagger) |
| 106 |
|
| 107 |
|
| 108 |
@pytest.mark.urls("urlconfs.url_versioning_extra") |
| 109 |
def test_url_v2_management_extra(call_generate_swagger, validate_schema): |
| 110 |
kwargs = {"api_version": "2.0"} |
| 111 |
swagger = _get_versioned_schema_management( |
| 112 |
"/versioned/url/v2.0", |
| 113 |
call_generate_swagger, |
| 114 |
validate_schema, |
| 115 |
kwargs, |
| 116 |
path="/extra/snippets/", |
| 117 |
) |
| 118 |
_check_v2(swagger, path="/extra/snippets/") |
| 119 |
|
| 120 |
|
| 121 |
@pytest.mark.urls("urlconfs.ns_versioning") |
| 122 |
def test_ns_v2_management(call_generate_swagger, validate_schema): |
| 123 |
kwargs = {"api_version": "2.0"} |
| 124 |
swagger = _get_versioned_schema_management( |
| 125 |
"/versioned/ns/v2.0", call_generate_swagger, validate_schema, kwargs |
| 126 |
) |
| 127 |
_check_v2(swagger) |