1
# vim: tabstop=4 shiftwidth=4 softtabstop=4
7
from cinder import exception
8
from cinder import test
9
from cinder import utils
10
from cinder.api.openstack import wsgi
11
from cinder.tests.api.openstack import fakes
15
class RequestTest(test.TestCase):
16
def test_content_type_missing(self):
17
request = wsgi.Request.blank('/tests/123', method='POST')
18
request.body = "<body />"
19
self.assertEqual(None, request.get_content_type())
21
def test_content_type_unsupported(self):
22
request = wsgi.Request.blank('/tests/123', method='POST')
23
request.headers["Content-Type"] = "text/html"
24
request.body = "asdf<br />"
25
self.assertRaises(exception.InvalidContentType,
26
request.get_content_type)
28
def test_content_type_with_charset(self):
29
request = wsgi.Request.blank('/tests/123')
30
request.headers["Content-Type"] = "application/json; charset=UTF-8"
31
result = request.get_content_type()
32
self.assertEqual(result, "application/json")
34
def test_content_type_from_accept(self):
35
for content_type in ('application/xml',
36
'application/vnd.openstack.volume+xml',
38
'application/vnd.openstack.volume+json'):
39
request = wsgi.Request.blank('/tests/123')
40
request.headers["Accept"] = content_type
41
result = request.best_match_content_type()
42
self.assertEqual(result, content_type)
44
def test_content_type_from_accept_best(self):
45
request = wsgi.Request.blank('/tests/123')
46
request.headers["Accept"] = "application/xml, application/json"
47
result = request.best_match_content_type()
48
self.assertEqual(result, "application/json")
50
request = wsgi.Request.blank('/tests/123')
51
request.headers["Accept"] = ("application/json; q=0.3, "
52
"application/xml; q=0.9")
53
result = request.best_match_content_type()
54
self.assertEqual(result, "application/xml")
56
def test_content_type_from_query_extension(self):
57
request = wsgi.Request.blank('/tests/123.xml')
58
result = request.best_match_content_type()
59
self.assertEqual(result, "application/xml")
61
request = wsgi.Request.blank('/tests/123.json')
62
result = request.best_match_content_type()
63
self.assertEqual(result, "application/json")
65
request = wsgi.Request.blank('/tests/123.invalid')
66
result = request.best_match_content_type()
67
self.assertEqual(result, "application/json")
69
def test_content_type_accept_and_query_extension(self):
70
request = wsgi.Request.blank('/tests/123.xml')
71
request.headers["Accept"] = "application/json"
72
result = request.best_match_content_type()
73
self.assertEqual(result, "application/xml")
75
def test_content_type_accept_default(self):
76
request = wsgi.Request.blank('/tests/123.unsupported')
77
request.headers["Accept"] = "application/unsupported1"
78
result = request.best_match_content_type()
79
self.assertEqual(result, "application/json")
82
class ActionDispatcherTest(test.TestCase):
83
def test_dispatch(self):
84
serializer = wsgi.ActionDispatcher()
85
serializer.create = lambda x: 'pants'
86
self.assertEqual(serializer.dispatch({}, action='create'), 'pants')
88
def test_dispatch_action_None(self):
89
serializer = wsgi.ActionDispatcher()
90
serializer.create = lambda x: 'pants'
91
serializer.default = lambda x: 'trousers'
92
self.assertEqual(serializer.dispatch({}, action=None), 'trousers')
94
def test_dispatch_default(self):
95
serializer = wsgi.ActionDispatcher()
96
serializer.create = lambda x: 'pants'
97
serializer.default = lambda x: 'trousers'
98
self.assertEqual(serializer.dispatch({}, action='update'), 'trousers')
101
class DictSerializerTest(test.TestCase):
102
def test_dispatch_default(self):
103
serializer = wsgi.DictSerializer()
104
self.assertEqual(serializer.serialize({}, 'update'), '')
107
class XMLDictSerializerTest(test.TestCase):
109
input_dict = dict(servers=dict(a=(2, 3)))
110
expected_xml = '<serversxmlns="asdf"><a>(2,3)</a></servers>'
111
serializer = wsgi.XMLDictSerializer(xmlns="asdf")
112
result = serializer.serialize(input_dict)
113
result = result.replace('\n', '').replace(' ', '')
114
self.assertEqual(result, expected_xml)
117
class JSONDictSerializerTest(test.TestCase):
119
input_dict = dict(servers=dict(a=(2, 3)))
120
expected_json = '{"servers":{"a":[2,3]}}'
121
serializer = wsgi.JSONDictSerializer()
122
result = serializer.serialize(input_dict)
123
result = result.replace('\n', '').replace(' ', '')
124
self.assertEqual(result, expected_json)
127
class TextDeserializerTest(test.TestCase):
128
def test_dispatch_default(self):
129
deserializer = wsgi.TextDeserializer()
130
self.assertEqual(deserializer.deserialize({}, 'update'), {})
133
class JSONDeserializerTest(test.TestCase):
138
"bs": ["1", "2", "3", {"c": {"c1": "1"}}],
146
'bs': ['1', '2', '3', {'c': {'c1': '1'}}],
152
deserializer = wsgi.JSONDeserializer()
153
self.assertEqual(deserializer.deserialize(data), as_dict)
156
class XMLDeserializerTest(test.TestCase):
160
<bs><b>1</b><b>2</b><b>3</b><b><c c1="1"/></b></bs>
170
'bs': ['1', '2', '3', {'c': {'c1': '1'}}],
176
metadata = {'plurals': {'bs': 'b', 'ts': 't'}}
177
deserializer = wsgi.XMLDeserializer(metadata=metadata)
178
self.assertEqual(deserializer.deserialize(xml), as_dict)
180
def test_xml_empty(self):
182
as_dict = {"body": {"a": {}}}
183
deserializer = wsgi.XMLDeserializer()
184
self.assertEqual(deserializer.deserialize(xml), as_dict)
187
class ResourceTest(test.TestCase):
188
def test_resource_call(self):
189
class Controller(object):
190
def index(self, req):
193
req = webob.Request.blank('/tests')
194
app = fakes.TestRouter(Controller())
195
response = req.get_response(app)
196
self.assertEqual(response.body, 'off')
197
self.assertEqual(response.status_int, 200)
199
def test_resource_not_authorized(self):
200
class Controller(object):
201
def index(self, req):
202
raise exception.NotAuthorized()
204
req = webob.Request.blank('/tests')
205
app = fakes.TestRouter(Controller())
206
response = req.get_response(app)
207
self.assertEqual(response.status_int, 403)
209
def test_dispatch(self):
210
class Controller(object):
211
def index(self, req, pants=None):
214
controller = Controller()
215
resource = wsgi.Resource(controller)
216
method, extensions = resource.get_method(None, 'index', None, '')
217
actual = resource.dispatch(method, None, {'pants': 'off'})
219
self.assertEqual(actual, expected)
221
def test_get_method_unknown_controller_action(self):
222
class Controller(object):
223
def index(self, req, pants=None):
226
controller = Controller()
227
resource = wsgi.Resource(controller)
228
self.assertRaises(AttributeError, resource.get_method,
229
None, 'create', None, '')
231
def test_get_method_action_json(self):
232
class Controller(wsgi.Controller):
233
@wsgi.action('fooAction')
234
def _action_foo(self, req, id, body):
237
controller = Controller()
238
resource = wsgi.Resource(controller)
239
method, extensions = resource.get_method(None, 'action',
241
'{"fooAction": true}')
242
self.assertEqual(controller._action_foo, method)
244
def test_get_method_action_xml(self):
245
class Controller(wsgi.Controller):
246
@wsgi.action('fooAction')
247
def _action_foo(self, req, id, body):
250
controller = Controller()
251
resource = wsgi.Resource(controller)
252
method, extensions = resource.get_method(None, 'action',
254
'<fooAction>true</fooAction>')
255
self.assertEqual(controller._action_foo, method)
257
def test_get_method_action_bad_body(self):
258
class Controller(wsgi.Controller):
259
@wsgi.action('fooAction')
260
def _action_foo(self, req, id, body):
263
controller = Controller()
264
resource = wsgi.Resource(controller)
265
self.assertRaises(exception.MalformedRequestBody, resource.get_method,
266
None, 'action', 'application/json', '{}')
268
def test_get_method_unknown_controller_action(self):
269
class Controller(wsgi.Controller):
270
@wsgi.action('fooAction')
271
def _action_foo(self, req, id, body):
274
controller = Controller()
275
resource = wsgi.Resource(controller)
276
self.assertRaises(KeyError, resource.get_method,
277
None, 'action', 'application/json',
278
'{"barAction": true}')
280
def test_get_method_action_method(self):
282
def action(self, req, pants=None):
285
controller = Controller()
286
resource = wsgi.Resource(controller)
287
method, extensions = resource.get_method(None, 'action',
289
'<fooAction>true</fooAction')
290
self.assertEqual(controller.action, method)
292
def test_get_action_args(self):
293
class Controller(object):
294
def index(self, req, pants=None):
297
controller = Controller()
298
resource = wsgi.Resource(controller)
301
'wsgiorg.routing_args': [None, {
309
expected = {'action': 'update', 'id': 12}
311
self.assertEqual(resource.get_action_args(env), expected)
313
def test_get_body_bad_content(self):
314
class Controller(object):
315
def index(self, req, pants=None):
318
controller = Controller()
319
resource = wsgi.Resource(controller)
321
request = wsgi.Request.blank('/', method='POST')
322
request.headers['Content-Type'] = 'application/none'
325
content_type, body = resource.get_body(request)
326
self.assertEqual(content_type, None)
327
self.assertEqual(body, '')
329
def test_get_body_no_content_type(self):
330
class Controller(object):
331
def index(self, req, pants=None):
334
controller = Controller()
335
resource = wsgi.Resource(controller)
337
request = wsgi.Request.blank('/', method='POST')
340
content_type, body = resource.get_body(request)
341
self.assertEqual(content_type, None)
342
self.assertEqual(body, '')
344
def test_get_body_no_content_body(self):
345
class Controller(object):
346
def index(self, req, pants=None):
349
controller = Controller()
350
resource = wsgi.Resource(controller)
352
request = wsgi.Request.blank('/', method='POST')
353
request.headers['Content-Type'] = 'application/json'
356
content_type, body = resource.get_body(request)
357
self.assertEqual(content_type, None)
358
self.assertEqual(body, '')
360
def test_get_body(self):
361
class Controller(object):
362
def index(self, req, pants=None):
365
controller = Controller()
366
resource = wsgi.Resource(controller)
368
request = wsgi.Request.blank('/', method='POST')
369
request.headers['Content-Type'] = 'application/json'
372
content_type, body = resource.get_body(request)
373
self.assertEqual(content_type, 'application/json')
374
self.assertEqual(body, 'foo')
376
def test_deserialize_badtype(self):
377
class Controller(object):
378
def index(self, req, pants=None):
381
controller = Controller()
382
resource = wsgi.Resource(controller)
383
self.assertRaises(exception.InvalidContentType,
384
resource.deserialize,
385
controller.index, 'application/none', 'foo')
387
def test_deserialize_default(self):
388
class JSONDeserializer(object):
389
def deserialize(self, body):
392
class XMLDeserializer(object):
393
def deserialize(self, body):
396
class Controller(object):
397
@wsgi.deserializers(xml=XMLDeserializer)
398
def index(self, req, pants=None):
401
controller = Controller()
402
resource = wsgi.Resource(controller, json=JSONDeserializer)
404
obj = resource.deserialize(controller.index, 'application/json', 'foo')
405
self.assertEqual(obj, 'json')
407
def test_deserialize_decorator(self):
408
class JSONDeserializer(object):
409
def deserialize(self, body):
412
class XMLDeserializer(object):
413
def deserialize(self, body):
416
class Controller(object):
417
@wsgi.deserializers(xml=XMLDeserializer)
418
def index(self, req, pants=None):
421
controller = Controller()
422
resource = wsgi.Resource(controller, json=JSONDeserializer)
424
obj = resource.deserialize(controller.index, 'application/xml', 'foo')
425
self.assertEqual(obj, 'xml')
427
def test_register_actions(self):
428
class Controller(object):
429
def index(self, req, pants=None):
432
class ControllerExtended(wsgi.Controller):
433
@wsgi.action('fooAction')
434
def _action_foo(self, req, id, body):
437
@wsgi.action('barAction')
438
def _action_bar(self, req, id, body):
441
controller = Controller()
442
resource = wsgi.Resource(controller)
443
self.assertEqual({}, resource.wsgi_actions)
445
extended = ControllerExtended()
446
resource.register_actions(extended)
448
'fooAction': extended._action_foo,
449
'barAction': extended._action_bar,
450
}, resource.wsgi_actions)
452
def test_register_extensions(self):
453
class Controller(object):
454
def index(self, req, pants=None):
457
class ControllerExtended(wsgi.Controller):
459
def index(self, req, resp_obj, pants=None):
462
@wsgi.extends(action='fooAction')
463
def _action_foo(self, req, resp, id, body):
466
controller = Controller()
467
resource = wsgi.Resource(controller)
468
self.assertEqual({}, resource.wsgi_extensions)
469
self.assertEqual({}, resource.wsgi_action_extensions)
471
extended = ControllerExtended()
472
resource.register_extensions(extended)
473
self.assertEqual({'index': [extended.index]}, resource.wsgi_extensions)
474
self.assertEqual({'fooAction': [extended._action_foo]},
475
resource.wsgi_action_extensions)
477
def test_get_method_extensions(self):
478
class Controller(object):
479
def index(self, req, pants=None):
482
class ControllerExtended(wsgi.Controller):
484
def index(self, req, resp_obj, pants=None):
487
controller = Controller()
488
extended = ControllerExtended()
489
resource = wsgi.Resource(controller)
490
resource.register_extensions(extended)
491
method, extensions = resource.get_method(None, 'index', None, '')
492
self.assertEqual(method, controller.index)
493
self.assertEqual(extensions, [extended.index])
495
def test_get_method_action_extensions(self):
496
class Controller(wsgi.Controller):
497
def index(self, req, pants=None):
500
@wsgi.action('fooAction')
501
def _action_foo(self, req, id, body):
504
class ControllerExtended(wsgi.Controller):
505
@wsgi.extends(action='fooAction')
506
def _action_foo(self, req, resp_obj, id, body):
509
controller = Controller()
510
extended = ControllerExtended()
511
resource = wsgi.Resource(controller)
512
resource.register_extensions(extended)
513
method, extensions = resource.get_method(None, 'action',
515
'{"fooAction": true}')
516
self.assertEqual(method, controller._action_foo)
517
self.assertEqual(extensions, [extended._action_foo])
519
def test_get_method_action_whitelist_extensions(self):
520
class Controller(wsgi.Controller):
521
def index(self, req, pants=None):
524
class ControllerExtended(wsgi.Controller):
525
@wsgi.action('create')
526
def _create(self, req, body):
529
@wsgi.action('delete')
530
def _delete(self, req, id):
533
controller = Controller()
534
extended = ControllerExtended()
535
resource = wsgi.Resource(controller)
536
resource.register_actions(extended)
538
method, extensions = resource.get_method(None, 'create',
541
self.assertEqual(method, extended._create)
542
self.assertEqual(extensions, [])
544
method, extensions = resource.get_method(None, 'delete', None, None)
545
self.assertEqual(method, extended._delete)
546
self.assertEqual(extensions, [])
548
def test_pre_process_extensions_regular(self):
549
class Controller(object):
550
def index(self, req, pants=None):
553
controller = Controller()
554
resource = wsgi.Resource(controller)
558
def extension1(req, resp_obj):
562
def extension2(req, resp_obj):
566
extensions = [extension1, extension2]
567
response, post = resource.pre_process_extensions(extensions, None, {})
568
self.assertEqual(called, [])
569
self.assertEqual(response, None)
570
self.assertEqual(list(post), [extension2, extension1])
572
def test_pre_process_extensions_generator(self):
573
class Controller(object):
574
def index(self, req, pants=None):
577
controller = Controller()
578
resource = wsgi.Resource(controller)
583
called.append('pre1')
585
called.append('post1')
588
called.append('pre2')
590
called.append('post2')
592
extensions = [extension1, extension2]
593
response, post = resource.pre_process_extensions(extensions, None, {})
595
self.assertEqual(called, ['pre1', 'pre2'])
596
self.assertEqual(response, None)
597
self.assertEqual(len(post), 2)
598
self.assertTrue(inspect.isgenerator(post[0]))
599
self.assertTrue(inspect.isgenerator(post[1]))
604
except StopIteration:
607
self.assertEqual(called, ['pre1', 'pre2', 'post2', 'post1'])
609
def test_pre_process_extensions_generator_response(self):
610
class Controller(object):
611
def index(self, req, pants=None):
614
controller = Controller()
615
resource = wsgi.Resource(controller)
620
called.append('pre1')
624
called.append('pre2')
626
extensions = [extension1, extension2]
627
response, post = resource.pre_process_extensions(extensions, None, {})
628
self.assertEqual(called, ['pre1'])
629
self.assertEqual(response, 'foo')
630
self.assertEqual(post, [])
632
def test_post_process_extensions_regular(self):
633
class Controller(object):
634
def index(self, req, pants=None):
637
controller = Controller()
638
resource = wsgi.Resource(controller)
642
def extension1(req, resp_obj):
646
def extension2(req, resp_obj):
650
response = resource.post_process_extensions([extension2, extension1],
652
self.assertEqual(called, [2, 1])
653
self.assertEqual(response, None)
655
def test_post_process_extensions_regular_response(self):
656
class Controller(object):
657
def index(self, req, pants=None):
660
controller = Controller()
661
resource = wsgi.Resource(controller)
665
def extension1(req, resp_obj):
669
def extension2(req, resp_obj):
673
response = resource.post_process_extensions([extension2, extension1],
675
self.assertEqual(called, [2])
676
self.assertEqual(response, 'foo')
678
def test_post_process_extensions_generator(self):
679
class Controller(object):
680
def index(self, req, pants=None):
683
controller = Controller()
684
resource = wsgi.Resource(controller)
696
ext1 = extension1(None)
698
ext2 = extension2(None)
701
response = resource.post_process_extensions([ext2, ext1],
704
self.assertEqual(called, [2, 1])
705
self.assertEqual(response, None)
707
def test_post_process_extensions_generator_response(self):
708
class Controller(object):
709
def index(self, req, pants=None):
712
controller = Controller()
713
resource = wsgi.Resource(controller)
726
ext1 = extension1(None)
728
ext2 = extension2(None)
731
response = resource.post_process_extensions([ext2, ext1],
734
self.assertEqual(called, [2])
735
self.assertEqual(response, 'foo')
738
class ResponseObjectTest(test.TestCase):
739
def test_default_code(self):
740
robj = wsgi.ResponseObject({})
741
self.assertEqual(robj.code, 200)
743
def test_modified_code(self):
744
robj = wsgi.ResponseObject({})
745
robj._default_code = 202
746
self.assertEqual(robj.code, 202)
748
def test_override_default_code(self):
749
robj = wsgi.ResponseObject({}, code=404)
750
self.assertEqual(robj.code, 404)
752
def test_override_modified_code(self):
753
robj = wsgi.ResponseObject({}, code=404)
754
robj._default_code = 202
755
self.assertEqual(robj.code, 404)
757
def test_set_header(self):
758
robj = wsgi.ResponseObject({})
759
robj['Header'] = 'foo'
760
self.assertEqual(robj.headers, {'header': 'foo'})
762
def test_get_header(self):
763
robj = wsgi.ResponseObject({})
764
robj['Header'] = 'foo'
765
self.assertEqual(robj['hEADER'], 'foo')
767
def test_del_header(self):
768
robj = wsgi.ResponseObject({})
769
robj['Header'] = 'foo'
771
self.assertFalse('header' in robj.headers)
773
def test_header_isolation(self):
774
robj = wsgi.ResponseObject({})
775
robj['Header'] = 'foo'
777
hdrs['hEADER'] = 'bar'
778
self.assertEqual(robj['hEADER'], 'foo')
780
def test_default_serializers(self):
781
robj = wsgi.ResponseObject({})
782
self.assertEqual(robj.serializers, {})
784
def test_bind_serializers(self):
785
robj = wsgi.ResponseObject({}, json='foo')
786
robj._bind_method_serializers(dict(xml='bar', json='baz'))
787
self.assertEqual(robj.serializers, dict(xml='bar', json='foo'))
789
def test_get_serializer(self):
790
robj = wsgi.ResponseObject({}, json='json', xml='xml', atom='atom')
791
for content_type, mtype in wsgi._MEDIA_TYPE_MAP.items():
792
_mtype, serializer = robj.get_serializer(content_type)
793
self.assertEqual(serializer, mtype)
795
def test_get_serializer_defaults(self):
796
robj = wsgi.ResponseObject({})
797
default_serializers = dict(json='json', xml='xml', atom='atom')
798
for content_type, mtype in wsgi._MEDIA_TYPE_MAP.items():
799
self.assertRaises(exception.InvalidContentType,
800
robj.get_serializer, content_type)
801
_mtype, serializer = robj.get_serializer(content_type,
803
self.assertEqual(serializer, mtype)
805
def test_serialize(self):
806
class JSONSerializer(object):
807
def serialize(self, obj):
810
class XMLSerializer(object):
811
def serialize(self, obj):
814
class AtomSerializer(object):
815
def serialize(self, obj):
818
robj = wsgi.ResponseObject({}, code=202,
822
robj['X-header1'] = 'header1'
823
robj['X-header2'] = 'header2'
825
for content_type, mtype in wsgi._MEDIA_TYPE_MAP.items():
826
request = wsgi.Request.blank('/tests/123')
827
response = robj.serialize(request, content_type)
829
self.assertEqual(response.headers['Content-Type'], content_type)
830
self.assertEqual(response.headers['X-header1'], 'header1')
831
self.assertEqual(response.headers['X-header2'], 'header2')
832
self.assertEqual(response.status_int, 202)
833
self.assertEqual(response.body, mtype)