1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
# type: ignore
import re
from unittest import mock
import pytest
import yaml
from django.conf.urls import include
from django.db import models
from django.urls import path, re_path
from rest_framework import generics, mixins, routers, serializers, viewsets
from rest_framework.test import APIClient, APIRequestFactory
from rest_framework.versioning import AcceptHeaderVersioning, NamespaceVersioning, URLPathVersioning
from drf_spectacular.generators import SchemaGenerator
from drf_spectacular.utils import extend_schema
from drf_spectacular.validation import validate_schema
from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
from tests import assert_schema
from tests.models import SimpleModel
class Xv1Serializer(serializers.Serializer):
id = serializers.IntegerField()
class Xv2Serializer(serializers.Serializer):
id = serializers.UUIDField()
class PathVersioningViewset(mixins.ListModelMixin, viewsets.GenericViewSet):
versioning_class = URLPathVersioning
queryset = SimpleModel.objects.all()
@extend_schema(responses=Xv1Serializer, versions=['v1'])
@extend_schema(responses=Xv2Serializer, versions=['v2'])
def list(self, request, *args, **kwargs):
pass # pragma: no cover
@extend_schema(responses=Xv1Serializer, versions=['v1'])
@extend_schema(responses=Xv2Serializer, versions=['v2'])
def retrieve(self, request, *args, **kwargs):
pass # pragma: no cover
class NamespaceVersioningViewset(PathVersioningViewset):
versioning_class = NamespaceVersioning
class AcceptHeaderVersioningViewset(PathVersioningViewset):
versioning_class = AcceptHeaderVersioning
class PathVersioningViewset2(mixins.ListModelMixin, viewsets.GenericViewSet):
versioning_class = URLPathVersioning
queryset = SimpleModel.objects.all()
def list(self, request, *args, **kwargs):
pass # pragma: no cover
def retrieve(self, request, *args, **kwargs):
pass # pragma: no cover
def get_serializer_class(self):
if self.request.version == 'v2':
return Xv2Serializer
return Xv1Serializer
class NamespaceVersioningViewset2(PathVersioningViewset2):
versioning_class = NamespaceVersioning
class AcceptHeaderVersioningViewset2(PathVersioningViewset2):
versioning_class = AcceptHeaderVersioning
@pytest.mark.parametrize('viewset_cls', [PathVersioningViewset, PathVersioningViewset2])
@pytest.mark.parametrize('version', ['v1', 'v2'])
def test_url_path_versioning(no_warnings, viewset_cls, version):
router = routers.SimpleRouter()
router.register('x', viewset_cls, basename='x')
generator = SchemaGenerator(
patterns=[re_path(r'^(?P<version>[v1|v2]+)/', include((router.urls, 'x')))],
api_version=version,
)
schema = generator.get_schema(request=None, public=True)
assert_schema(schema, f'tests/test_versioning_{version}.yml')
@pytest.mark.parametrize('viewset_cls', [NamespaceVersioningViewset, NamespaceVersioningViewset2])
@pytest.mark.parametrize('version', ['v1', 'v2'])
def test_namespace_versioning(no_warnings, viewset_cls, version):
router = routers.SimpleRouter()
router.register('x', viewset_cls, basename='x')
generator = SchemaGenerator(
patterns=[
path('v1/', include((router.urls, 'v1'))),
path('v2/', include((router.urls, 'v2'))),
],
api_version=version,
)
schema = generator.get_schema(request=None, public=True)
assert_schema(schema, f'tests/test_versioning_{version}.yml')
class LookupModel(models.Model):
""" test_namespace_versioning_urlpatterns_simplification """
field = models.IntegerField()
@pytest.mark.parametrize(['path_func', 'path_str', 'pattern', ], [
(path, '{id}/', '<int:pk>/'),
(path, '{id}/', '<pk>/'),
(re_path, '{id}/', r'(?P<pk>[0-9A-Fa-f-]+)/'),
(re_path, '{id}/', r'(?P<pk>[^/.]+)/$'),
(re_path, '{id}/', r'(?P<pk>[a-z]{2}(-[a-z]{2})?)/'),
(re_path, '{field}/t/{id}/', r'^(?P<field>[^/.]+)/t/(?P<pk>[^/.]+)/'),
(re_path, '{field}/t/{id}/', r'^(?P<field>[A-Z\(\)]+)/t/(?P<pk>[^/.]+)/'),
])
def test_namespace_versioning_urlpatterns_simplification(no_warnings, path_func, path_str, pattern):
class LookupSerializer(serializers.ModelSerializer):
class Meta:
model = LookupModel
fields = '__all__'
class NamespaceVersioningAPIView(generics.RetrieveUpdateDestroyAPIView):
versioning_class = NamespaceVersioning
serializer_class = LookupSerializer
queryset = LookupModel.objects.all()
# make sure regex are valid
if path_func == re_path:
re.compile(pattern)
patterns_v1 = [path_func(pattern, NamespaceVersioningAPIView.as_view())]
generator = SchemaGenerator(
patterns=[path('v1/<int:some_param>/', include((patterns_v1, 'v1')))],
api_version='v1',
)
schema = generator.get_schema(request=None, public=True)
assert ('/v1/{some_param}/' + path_str) in schema['paths']
@pytest.mark.parametrize('viewset_cls', [AcceptHeaderVersioningViewset, AcceptHeaderVersioningViewset2])
@pytest.mark.parametrize('version', ['v1', 'v2'])
@pytest.mark.parametrize('with_request', [True, False])
def test_accept_header_versioning(no_warnings, viewset_cls, version, with_request):
router = routers.SimpleRouter()
router.register('x', viewset_cls, basename='x')
generator = SchemaGenerator(
patterns=[
path('', include((router.urls, 'x'))),
],
api_version=version,
)
if with_request:
view = SpectacularAPIView(
versioning_class=AcceptHeaderVersioning,
)
factory = APIRequestFactory()
request = factory.get('x', content_type='application/vnd.oai.openapi+json')
request = view.initialize_request(request)
else:
request = None
schema = generator.get_schema(request=request, public=True)
assert_schema(schema, f'tests/test_versioning_accept_{version}.yml')
urlpatterns_namespace = [
path('x/', NamespaceVersioningViewset.as_view({'get': 'list'})),
path('schema/', SpectacularAPIView.as_view(
versioning_class=NamespaceVersioning
), name='schema-nv-versioned'),
path('schema/ui', SpectacularSwaggerView.as_view(
versioning_class=NamespaceVersioning, url_name='schema-nv-versioned'
)),
]
urlpatterns_path = [
path('x/', PathVersioningViewset2.as_view({'get': 'list'})),
path('schema/', SpectacularAPIView.as_view(
versioning_class=URLPathVersioning
), name='schema-pv-versioned'),
path('schema/ui', SpectacularSwaggerView.as_view(
versioning_class=URLPathVersioning, url_name='schema-pv-versioned'
)),
]
urlpatterns_accept_header = [
path('x/', AcceptHeaderVersioningViewset2.as_view({'get': 'list'})),
path('schema/', SpectacularAPIView.as_view(
versioning_class=AcceptHeaderVersioning
), name='schema-ahv-versioned'),
path('schema/ui', SpectacularSwaggerView.as_view(
versioning_class=AcceptHeaderVersioning, url_name='schema-ahv-versioned'
)),
]
urlpatterns = [
# path versioning
re_path(r'^api/pv/(?P<version>[v1|v2]+)/', include(urlpatterns_path)),
# namespace versioning
path('api/nv/v1/', include((urlpatterns_namespace, 'v1'))),
path('api/nv/v2/', include((urlpatterns_namespace, 'v2'))),
# accept header versioning
path('api/ahv/', include((urlpatterns_accept_header, 'x'))),
# all unversioned
path('api/schema/', SpectacularAPIView.as_view()),
# manually versioned schema view that is in itself unversioned
path('api/schema-v2/', SpectacularAPIView.as_view(api_version='v2')),
]
@pytest.mark.parametrize(['url', 'path_count'], [
('/api/nv/v2/schema/', 8), # v2 nv + v2 pv + v2 ahv + unversioned
('/api/pv/v1/schema/', 8), # v1 nv + v1 pv + v1 ahv + unversioned
('/api/schema-v2/', 8), # v2 nv + v2 pv + v2 ahv + unversioned
('/api/schema/', 2), # unversioned schema
('/api/schema/?version=v2', 8), # versioned with query param
])
@pytest.mark.urls(__name__)
def test_spectacular_view_versioning(no_warnings, url, path_count):
response = APIClient().get(url)
assert response.status_code == 200
schema = yaml.load(response.content, Loader=yaml.SafeLoader)
validate_schema(schema)
assert len(schema['paths']) == path_count
@pytest.mark.parametrize('version', ['v1', 'v2'])
@pytest.mark.urls(__name__)
def test_spectacular_view_accept_header_versioning(no_warnings, version):
response = APIClient().get(
'/api/ahv/schema/', HTTP_ACCEPT=f'application/json; version={version}'
)
assert response.status_code == 200, response.content
schema = yaml.load(response.content, Loader=yaml.SafeLoader)
validate_schema(schema)
assert schema['info']['version'] == f'0.0.0 ({version})'
assert len(schema['paths']) == 8
@pytest.mark.parametrize(['url', 'schema_url'], [
('/api/nv/v1/schema/ui', b'/api/nv/v1/schema/'),
('/api/nv/v2/schema/ui', b'/api/nv/v2/schema/'),
('/api/pv/v1/schema/ui', b'/api/pv/v1/schema/'),
('/api/pv/v2/schema/ui', b'/api/pv/v2/schema/'),
])
@pytest.mark.urls(__name__)
def test_spectacular_ui_view_versioning(no_warnings, url, schema_url):
response = APIClient().get(url)
assert schema_url in response.content
@pytest.mark.urls(__name__)
def test_spectacular_versioning_info_object_variations(no_warnings):
# with default VERSION 0.0.0
response = APIClient().get('/api/nv/v2/schema/')
assert b'version: 0.0.0 (v2)\n' in response.content
response = APIClient().get('/api/schema/')
assert b'version: 0.0.0\n' in response.content
with mock.patch('drf_spectacular.settings.spectacular_settings.VERSION', None):
response = APIClient().get('/api/nv/v2/schema/')
assert b'version: v2\n' in response.content
response = APIClient().get('/api/schema/')
assert b"version: ''\n" in response.content
|
