| 1 |
import enum |
| 2 |
import json |
| 3 |
|
| 4 |
from drf_yasg import openapi |
| 5 |
from drf_yasg.generators import OpenAPISchemaGenerator |
| 6 |
from drf_yasg.inspectors import ( |
| 7 |
FieldInspector, |
| 8 |
FilterInspector, |
| 9 |
PaginatorInspector, |
| 10 |
SerializerInspector, |
| 11 |
) |
| 12 |
|
| 13 |
|
| 14 |
def test_reference_schema(swagger_dict, reference_schema, compare_schemas): |
| 15 |
compare_schemas(swagger_dict, reference_schema) |
| 16 |
|
| 17 |
|
| 18 |
class VerisonEnum(enum.Enum): |
| 19 |
V1 = "v1" |
| 20 |
V2 = "v2" |
| 21 |
|
| 22 |
|
| 23 |
class NoOpFieldInspector(FieldInspector): |
| 24 |
pass |
| 25 |
|
| 26 |
|
| 27 |
class NoOpSerializerInspector(SerializerInspector): |
| 28 |
pass |
| 29 |
|
| 30 |
|
| 31 |
class NoOpFilterInspector(FilterInspector): |
| 32 |
pass |
| 33 |
|
| 34 |
|
| 35 |
class NoOpPaginatorInspector(PaginatorInspector): |
| 36 |
pass |
| 37 |
|
| 38 |
|
| 39 |
def test_noop_inspectors( |
| 40 |
swagger_settings, mock_schema_request, codec_json, reference_schema, compare_schemas |
| 41 |
): |
| 42 |
from drf_yasg import app_settings |
| 43 |
|
| 44 |
def set_inspectors(inspectors, setting_name): |
| 45 |
inspectors = [__name__ + "." + inspector.__name__ for inspector in inspectors] |
| 46 |
swagger_settings[setting_name] = ( |
| 47 |
inspectors + app_settings.SWAGGER_DEFAULTS[setting_name] |
| 48 |
) |
| 49 |
|
| 50 |
set_inspectors( |
| 51 |
[NoOpFieldInspector, NoOpSerializerInspector], "DEFAULT_FIELD_INSPECTORS" |
| 52 |
) |
| 53 |
set_inspectors([NoOpFilterInspector], "DEFAULT_FILTER_INSPECTORS") |
| 54 |
set_inspectors([NoOpPaginatorInspector], "DEFAULT_PAGINATOR_INSPECTORS") |
| 55 |
|
| 56 |
generator = OpenAPISchemaGenerator( |
| 57 |
info=openapi.Info(title="Test generator", default_version=VerisonEnum.V1), |
| 58 |
version=VerisonEnum.V2, |
| 59 |
) |
| 60 |
swagger = generator.get_schema(mock_schema_request, True) |
| 61 |
|
| 62 |
swagger_dict = json.loads(codec_json.encode(swagger)) |
| 63 |
compare_schemas(swagger_dict, reference_schema) |
| 64 |
|
| 65 |
|
| 66 |
def test_no_nested_model(swagger_dict): |
| 67 |
# ForeignKey models in deep ModelViewSets might wrongly be labeled as 'Nested' in |
| 68 |
# the definitions section see https://github.com/axnsan12/drf-yasg/issues/59 |
| 69 |
assert "Nested" not in swagger_dict["definitions"] |