-
Notifications
You must be signed in to change notification settings - Fork 507
/
Copy pathtest_api.py
339 lines (257 loc) · 10.7 KB
/
test_api.py
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
import copy
from flask import url_for, Blueprint
import flask_restplus as restplus
class APITest(object):
def test_root_endpoint(self, app):
api = restplus.Api(app, version='1.0')
with app.test_request_context():
url = url_for('root')
assert url == '/'
assert api.base_url == 'http://localhost/'
def test_root_endpoint_lazy(self, app):
api = restplus.Api(version='1.0')
api.init_app(app)
with app.test_request_context():
url = url_for('root')
assert url == '/'
assert api.base_url == 'http://localhost/'
def test_root_endpoint_with_blueprint(self, app):
blueprint = Blueprint('api', __name__, url_prefix='/api')
api = restplus.Api(blueprint, version='1.0')
app.register_blueprint(blueprint)
with app.test_request_context():
url = url_for('api.root')
assert url == '/api/'
assert api.base_url == 'http://localhost/api/'
def test_root_endpoint_with_blueprint_with_subdomain(self, app):
blueprint = Blueprint('api', __name__, subdomain='api', url_prefix='/api')
api = restplus.Api(blueprint, version='1.0')
app.register_blueprint(blueprint)
with app.test_request_context():
url = url_for('api.root')
assert url == 'http://api.localhost/api/'
assert api.base_url == 'http://api.localhost/api/'
def test_parser(self):
api = restplus.Api()
assert isinstance(api.parser(), restplus.reqparse.RequestParser)
def test_doc_decorator(self, app):
api = restplus.Api(app, prefix='/api', version='1.0')
params = {'q': {'description': 'some description'}}
@api.doc(params=params)
class TestResource(restplus.Resource):
pass
assert hasattr(TestResource, '__apidoc__')
assert TestResource.__apidoc__ == {'params': params}
def test_doc_with_inheritance(self, app):
api = restplus.Api(app, prefix='/api', version='1.0')
base_params = {'q': {'description': 'some description', 'type': 'string', 'paramType': 'query'}}
child_params = {'q': {'description': 'some new description'}, 'other': {'description': 'another param'}}
@api.doc(params=base_params)
class BaseResource(restplus.Resource):
pass
@api.doc(params=child_params)
class TestResource(BaseResource):
pass
assert TestResource.__apidoc__ == {'params': {
'q': {
'description': 'some new description',
'type': 'string',
'paramType': 'query'
},
'other': {'description': 'another param'},
}}
def test_specs_endpoint_not_added(self, app):
api = restplus.Api()
api.init_app(app, add_specs=False)
assert 'specs' not in api.endpoints
assert 'specs' not in app.view_functions
def test_specs_endpoint_not_found_if_not_added(self, app, client):
api = restplus.Api()
api.init_app(app, add_specs=False)
resp = client.get('/swagger.json')
assert resp.status_code == 404
def test_default_endpoint(self, app):
api = restplus.Api(app)
@api.route('/test/')
class TestResource(restplus.Resource):
pass
with app.test_request_context():
assert url_for('test_resource') == '/test/'
def test_default_endpoint_lazy(self, app):
api = restplus.Api()
@api.route('/test/')
class TestResource(restplus.Resource):
pass
api.init_app(app)
with app.test_request_context():
assert url_for('test_resource') == '/test/'
def test_default_endpoint_with_blueprint(self, app):
blueprint = Blueprint('api', __name__, url_prefix='/api')
api = restplus.Api(blueprint)
app.register_blueprint(blueprint)
@api.route('/test/')
class TestResource(restplus.Resource):
pass
with app.test_request_context():
assert url_for('api.test_resource') == '/api/test/'
def test_default_endpoint_with_blueprint_with_subdomain(self, app):
blueprint = Blueprint('api', __name__, subdomain='api', url_prefix='/api')
api = restplus.Api(blueprint)
app.register_blueprint(blueprint)
@api.route('/test/')
class TestResource(restplus.Resource):
pass
with app.test_request_context():
assert url_for('api.test_resource') == 'http://api.localhost/api/test/'
def test_default_endpoint_for_namespace(self, app):
api = restplus.Api(app)
ns = api.namespace('ns', 'Test namespace')
@ns.route('/test/')
class TestResource(restplus.Resource):
pass
with app.test_request_context():
assert url_for('ns_test_resource') == '/ns/test/'
def test_default_endpoint_lazy_for_namespace(self, app):
api = restplus.Api()
ns = api.namespace('ns', 'Test namespace')
@ns.route('/test/')
class TestResource(restplus.Resource):
pass
api.init_app(app)
with app.test_request_context():
assert url_for('ns_test_resource') == '/ns/test/'
def test_default_endpoint_for_namespace_with_blueprint(self, app):
blueprint = Blueprint('api', __name__, url_prefix='/api')
api = restplus.Api(blueprint)
ns = api.namespace('ns', 'Test namespace')
@ns.route('/test/')
class TestResource(restplus.Resource):
pass
app.register_blueprint(blueprint)
with app.test_request_context():
assert url_for('api.ns_test_resource') == '/api/ns/test/'
def test_multiple_default_endpoint(self, app):
api = restplus.Api(app)
@api.route('/test2/')
@api.route('/test/')
class TestResource(restplus.Resource):
pass
with app.test_request_context():
assert url_for('test_resource') == '/test/'
assert url_for('test_resource_2') == '/test2/'
def test_multiple_default_endpoint_lazy(self, app):
api = restplus.Api()
@api.route('/test2/')
@api.route('/test/')
class TestResource(restplus.Resource):
pass
api.init_app(app)
with app.test_request_context():
assert url_for('test_resource') == '/test/'
assert url_for('test_resource_2') == '/test2/'
def test_multiple_default_endpoint_for_namespace(self, app):
api = restplus.Api(app)
ns = api.namespace('ns', 'Test namespace')
@ns.route('/test2/')
@ns.route('/test/')
class TestResource(restplus.Resource):
pass
with app.test_request_context():
assert url_for('ns_test_resource') == '/ns/test/'
assert url_for('ns_test_resource_2') == '/ns/test2/'
def test_multiple_default_endpoint_lazy_for_namespace(self, app):
api = restplus.Api()
ns = api.namespace('ns', 'Test namespace')
@ns.route('/test2/')
@ns.route('/test/')
class TestResource(restplus.Resource):
pass
api.init_app(app)
with app.test_request_context():
assert url_for('ns_test_resource') == '/ns/test/'
assert url_for('ns_test_resource_2') == '/ns/test2/'
def test_multiple_default_endpoint_for_namespace_with_blueprint(self, app):
blueprint = Blueprint('api', __name__, url_prefix='/api')
api = restplus.Api(blueprint)
ns = api.namespace('ns', 'Test namespace')
@ns.route('/test2/')
@ns.route('/test/')
class TestResource(restplus.Resource):
pass
app.register_blueprint(blueprint)
with app.test_request_context():
assert url_for('api.ns_test_resource') == '/api/ns/test/'
assert url_for('api.ns_test_resource_2') == '/api/ns/test2/'
def test_ns_path_prefixes(self, app):
api = restplus.Api()
ns = restplus.Namespace('test_ns', description='Test namespace')
@ns.route('/test/', endpoint='test_resource')
class TestResource(restplus.Resource):
pass
api.add_namespace(ns, '/api_test')
api.init_app(app)
with app.test_request_context():
assert url_for('test_resource') == '/api_test/test/'
def test_multiple_ns_with_authorizations(self, app):
api = restplus.Api()
a1 = {
'apikey': {
'type': 'apiKey',
'in': 'header',
'name': 'X-API'
}
}
a2 = {
'oauth2': {
'type': 'oauth2',
'flow': 'accessCode',
'tokenUrl': 'https://somewhere.com/token',
'scopes': {
'read': 'Grant read-only access',
'write': 'Grant read-write access',
}
}
}
ns1 = restplus.Namespace('ns1', authorizations=a1)
ns2 = restplus.Namespace('ns2', authorizations=a2)
@ns1.route('/')
class Ns1(restplus.Resource):
@ns1.doc(security='apikey')
def get(self):
pass
@ns2.route('/')
class Ns2(restplus.Resource):
@ns1.doc(security='oauth2')
def post(self):
pass
api.add_namespace(ns1, path='/ns1')
api.add_namespace(ns2, path='/ns2')
api.init_app(app)
assert {"apikey": []} in api.__schema__["paths"]["/ns1/"]["get"]["security"]
assert {"oauth2": []} in api.__schema__["paths"]["/ns2/"]["post"]["security"]
unified_auth = copy.copy(a1)
unified_auth.update(a2)
assert api.__schema__["securityDefinitions"] == unified_auth
def test_non_ordered_namespace(self, app):
api = restplus.Api(app)
ns = api.namespace('ns', 'Test namespace')
assert not ns.ordered
def test_ordered_namespace(self, app):
api = restplus.Api(app, ordered=True)
ns = api.namespace('ns', 'Test namespace')
assert ns.ordered
def test_decorators(self, app, mocker):
decorator1 = mocker.Mock(return_value=lambda x: x)
decorator2 = mocker.Mock(return_value=lambda x: x)
decorator3 = mocker.Mock(return_value=lambda x: x)
class TestResource(restplus.Resource):
method_decorators = []
api = restplus.Api(decorators=[decorator1])
ns = api.namespace('test_ns', decorators=[decorator2, decorator3])
ns.add_resource(TestResource, '/test', endpoint='test')
api.init_app(app)
assert decorator1.called is True
assert decorator2.called is True
assert decorator3.called is True