| 1 |
import copy |
| 2 |
import json |
| 3 |
import os |
| 4 |
from io import StringIO |
| 5 |
|
| 6 |
import pytest |
| 7 |
from datadiff.tools import assert_equal |
| 8 |
from django.contrib.auth.models import User |
| 9 |
from django.core.management import call_command |
| 10 |
from rest_framework.test import APIRequestFactory |
| 11 |
from rest_framework.views import APIView |
| 12 |
|
| 13 |
from drf_yasg import codecs, openapi |
| 14 |
from drf_yasg.codecs import yaml_dump, yaml_load |
| 15 |
from drf_yasg.generators import OpenAPISchemaGenerator |
| 16 |
|
| 17 |
|
| 18 |
@pytest.fixture |
| 19 |
def mock_schema_request(db): |
| 20 |
from rest_framework.test import force_authenticate |
| 21 |
|
| 22 |
factory = APIRequestFactory() |
| 23 |
user = User.objects.get(username="admin") |
| 24 |
request = factory.get("/swagger.json") |
| 25 |
force_authenticate(request, user=user) |
| 26 |
request = APIView().initialize_request(request) |
| 27 |
return request |
| 28 |
|
| 29 |
|
| 30 |
@pytest.fixture |
| 31 |
def codec_json(): |
| 32 |
return codecs.OpenAPICodecJson(["flex", "ssv"]) |
| 33 |
|
| 34 |
|
| 35 |
@pytest.fixture |
| 36 |
def codec_yaml(): |
| 37 |
return codecs.OpenAPICodecYaml(["ssv", "flex"]) |
| 38 |
|
| 39 |
|
| 40 |
@pytest.fixture |
| 41 |
def swagger(mock_schema_request): |
| 42 |
generator = OpenAPISchemaGenerator( |
| 43 |
info=openapi.Info(title="Test generator", default_version="v1"), |
| 44 |
version="v2", |
| 45 |
) |
| 46 |
return generator.get_schema(mock_schema_request, True) |
| 47 |
|
| 48 |
|
| 49 |
@pytest.fixture |
| 50 |
def swagger_dict(swagger, codec_json): |
| 51 |
return json.loads(codec_json.encode(swagger)) |
| 52 |
|
| 53 |
|
| 54 |
@pytest.fixture |
| 55 |
def validate_schema(): |
| 56 |
def validate_schema(swagger): |
| 57 |
try: |
| 58 |
from flex.core import parse as validate_flex |
| 59 |
|
| 60 |
validate_flex(copy.deepcopy(swagger)) |
| 61 |
except ImportError: |
| 62 |
pass |
| 63 |
|
| 64 |
from swagger_spec_validator.validator20 import validate_spec as validate_ssv |
| 65 |
|
| 66 |
validate_ssv(copy.deepcopy(swagger)) |
| 67 |
|
| 68 |
return validate_schema |
| 69 |
|
| 70 |
|
| 71 |
@pytest.fixture |
| 72 |
def call_generate_swagger(): |
| 73 |
def call_generate_swagger( |
| 74 |
output_file="-", |
| 75 |
overwrite=False, |
| 76 |
format="", |
| 77 |
api_url="", |
| 78 |
mock=False, |
| 79 |
user=None, |
| 80 |
private=False, |
| 81 |
generator_class_name="", |
| 82 |
**kwargs, |
| 83 |
): |
| 84 |
out = StringIO() |
| 85 |
call_command( |
| 86 |
"generate_swagger", |
| 87 |
stdout=out, |
| 88 |
output_file=output_file, |
| 89 |
overwrite=overwrite, |
| 90 |
format=format, |
| 91 |
api_url=api_url, |
| 92 |
mock=mock, |
| 93 |
user=user, |
| 94 |
private=private, |
| 95 |
generator_class_name=generator_class_name, |
| 96 |
**kwargs, |
| 97 |
) |
| 98 |
return out.getvalue() |
| 99 |
|
| 100 |
return call_generate_swagger |
| 101 |
|
| 102 |
|
| 103 |
@pytest.fixture |
| 104 |
def compare_schemas(): |
| 105 |
def compare_schemas(schema1, schema2): |
| 106 |
ignore = ["info", "host", "schemes", "basePath", "securityDefinitions"] |
| 107 |
for attr in ignore: |
| 108 |
schema1.pop(attr, None) |
| 109 |
schema2.pop(attr, None) |
| 110 |
|
| 111 |
# print diff between YAML strings because it's prettier |
| 112 |
assert_equal(yaml_dump(schema1, binary=False), yaml_dump(schema2, binary=False)) |
| 113 |
|
| 114 |
return compare_schemas |
| 115 |
|
| 116 |
|
| 117 |
@pytest.fixture |
| 118 |
def swagger_settings(settings): |
| 119 |
swagger_settings = copy.deepcopy(settings.SWAGGER_SETTINGS) |
| 120 |
settings.SWAGGER_SETTINGS = swagger_settings |
| 121 |
return swagger_settings |
| 122 |
|
| 123 |
|
| 124 |
@pytest.fixture |
| 125 |
def redoc_settings(settings): |
| 126 |
redoc_settings = copy.deepcopy(settings.REDOC_SETTINGS) |
| 127 |
settings.REDOC_SETTINGS = redoc_settings |
| 128 |
return redoc_settings |
| 129 |
|
| 130 |
|
| 131 |
@pytest.fixture |
| 132 |
def reference_schema(): |
| 133 |
with open(os.path.join(os.path.dirname(__file__), "reference.yaml")) as reference: |
| 134 |
return yaml_load(reference) |