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
|
# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright 2011 OpenStack LLC.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import routes
import webob
import webob.exc
import webtest
from melange.common import wsgi
from melange import tests
class StubApp(object):
def __init__(self):
self.called = False
def __call__(self, environ, start_response):
self.environ = environ
self.start_response = start_response
self.called = True
class StubUrlMap(StubApp, dict):
def __init__(self, dictionary):
self.update(dictionary)
super(StubUrlMap, self).__init__()
class VersionedURLMapTest(tests.BaseTest):
def setUp(self):
self.v1_app = StubApp()
self.v2_app = StubApp()
self.root_app = StubApp()
self.urlmap = StubUrlMap({'/v2.0': self.v2_app,
'/v1.0': self.v1_app,
'/': self.root_app})
self.versioned_urlmap = wsgi.VersionedURLMap(self.urlmap)
super(VersionedURLMapTest, self).setUp()
def test_chooses_app_based_on_accept_version(self):
environ = {'HTTP_ACCEPT': "application/vnd.openstack.melange+xml;"
"version=1.0",
'PATH_INFO': "/resource"}
self.versioned_urlmap(environ=environ, start_response=None)
self.assertTrue(self.v1_app.called)
def test_delegates_to_urlmapper_when_accept_header_is_absent(self):
self.versioned_urlmap(environ={'PATH_INFO': "/resource"},
start_response=None)
self.assertTrue(self.urlmap.called)
def test_delegates_to_urlmapper_for_std_accept_headers_with_version(self):
environ = {
'HTTP_ACCEPT': "application/json;version=1.0",
'PATH_INFO': "/resource",
}
self.versioned_urlmap(environ=environ, start_response=None)
self.assertTrue(self.urlmap.called)
def test_delegates_to_urlmapper_for_nonexistant_version_of_app(self):
environ = {
'HTTP_ACCEPT': "application/vnd.openstack.melange+xml;"
"version=9.0", 'REQUEST_METHOD': "GET",
'PATH_INFO': "/resource.xml",
}
def assert_status(status, *args):
self.assertEqual(status, "406 Not Acceptable")
self.versioned_urlmap(environ=environ, start_response=assert_status)
def test_delegates_to_urlmapper_when_url_versioned(self):
environ = {
'HTTP_ACCEPT': "application/vnd.openstack.melange+xml;"
"version=2.0",
'PATH_INFO': "/v1.0/resource",
}
self.versioned_urlmap(environ=environ, start_response=None)
self.assertTrue(self.urlmap.called)
class RequestTest(tests.BaseTest):
def test_content_type_missing_defaults_to_json(self):
request = wsgi.Request.blank('/tests/123')
self.assertEqual(request.get_content_type(), "application/json")
def test_content_type_unsupported(self):
request = wsgi.Request.blank('/tests/123')
request.headers["Content-Type"] = "text/html"
self.assertRaises(webob.exc.HTTPUnsupportedMediaType,
request.get_content_type)
def test_content_type_with_charset(self):
request = wsgi.Request.blank('/tests/123')
request.headers["Content-Type"] = "application/json; charset=UTF-8"
result = request.get_content_type()
self.assertEqual(result, "application/json")
def test_content_type_from_accept_header(self):
request = wsgi.Request.blank('/tests/123')
request.headers["Accept"] = "application/xml"
result = request.best_match_content_type()
self.assertEqual(result, "application/xml")
request = wsgi.Request.blank('/tests/123')
request.headers["Accept"] = "application/json"
result = request.best_match_content_type()
self.assertEqual(result, "application/json")
request = wsgi.Request.blank('/tests/123')
request.headers["Accept"] = "application/xml, application/json"
result = request.best_match_content_type()
self.assertEqual(result, "application/json")
request = wsgi.Request.blank('/tests/123')
request.headers["Accept"] = \
"application/json; q=0.3, application/xml; q=0.9"
result = request.best_match_content_type()
self.assertEqual(result, "application/xml")
def test_content_type_from_accept_header_with_versioned_mimetype(self):
request = wsgi.Request.blank('/tests/123')
request.headers["Accept"] = \
"application/vnd.openstack.melange+xml;version=66.0"
result = request.best_match_content_type()
self.assertEqual(result, "application/xml")
request = wsgi.Request.blank('/tests/123')
request.headers["Accept"] = \
"application/vnd.openstack.melange+json;version=96.0"
result = request.best_match_content_type()
self.assertEqual(result, "application/json")
def test_content_type_from_query_extension(self):
request = wsgi.Request.blank('/tests/123.xml')
result = request.best_match_content_type()
self.assertEqual(result, "application/xml")
request = wsgi.Request.blank('/tests/123.json')
result = request.best_match_content_type()
self.assertEqual(result, "application/json")
request = wsgi.Request.blank('/tests/123.invalid')
result = request.best_match_content_type()
self.assertEqual(result, "application/json")
def test_content_type_accept_and_query_extension(self):
request = wsgi.Request.blank('/tests/123.xml')
request.headers["Accept"] = "application/json"
result = request.best_match_content_type()
self.assertEqual(result, "application/xml")
def test_content_type_accept_default(self):
request = wsgi.Request.blank('/tests/123.unsupported')
request.headers["Accept"] = "application/unsupported1"
result = request.best_match_content_type()
self.assertEqual(result, "application/json")
def test_accept_version_for_custom_mime_type(self):
environ = {'HTTP_ACCEPT': "application/vnd.openstack.melange+xml;"
"version=1.0"}
request = wsgi.Request(environ=environ)
self.assertEqual(request.accept_version, "1.0")
def test_accept_version_from_first_custom_mime_type(self):
environ = {'HTTP_ACCEPT': "application/json;version=2.0, "
"application/vnd.openstack.melange+xml;version=1.0, "
"application/vnd.openstack.melange+json;version=4.0"}
request = wsgi.Request(environ=environ)
self.assertEqual(request.accept_version, "1.0")
def test_accept_version_is_none_for_standard_mime_type(self):
environ = {'HTTP_ACCEPT': "application/json;"
"version=1.0"}
request = wsgi.Request(environ=environ)
self.assertIsNone(request.accept_version)
def test_accept_version_is_none_for_invalid_mime_type(self):
environ = {'HTTP_ACCEPT': "glibberish;"
"version=1.0"}
request = wsgi.Request(environ=environ)
self.assertIsNone(request.accept_version)
def test_accept_version_none_when_mime_type_doesnt_specify_version(self):
environ = {'HTTP_ACCEPT': "application/vnd.openstack.melange+xml"}
request = wsgi.Request(environ=environ)
self.assertIsNone(request.accept_version)
def test_accept_version_is_none_when_accept_header_is_absent(self):
request = wsgi.Request(environ={})
self.assertIsNone(request.accept_version)
def test_accept_version_is_none_for_mime_type_with_invalid_version(self):
environ = {'HTTP_ACCEPT': "application/vnd.openstack.melange+xml;"
"version=foo.bar"}
request = wsgi.Request(environ=environ)
self.assertIsNone(request.accept_version)
def test_url_version_for_versioned_url(self):
request = wsgi.Request.blank("/v1.0/resource")
self.assertEqual(request.url_version, "1.0")
def test_url_version_for_non_versioned_url_is_none(self):
request = wsgi.Request.blank("/resource")
self.assertIsNone(request.url_version)
class DummyApp(wsgi.Router):
def __init__(self):
mapper = routes.Mapper()
controller = StubController()
mapper.resource("resource", "/resources",
controller=controller.create_resource())
super(DummyApp, self).__init__(mapper)
class StubController(wsgi.Controller):
def index(self, request, format=None):
return {'fort': 'knox'}
def show(self, request, id, format=None):
return {'fort': 'knox'}
class TestController(tests.BaseTest):
def test_response_content_type_matches_accept_header(self):
app = webtest.TestApp(DummyApp())
response = app.get("/resources", headers={'Accept': "application/xml"})
self.assertEqual(response.content_type, "application/xml")
self.assertEqual(response.xml.tag, "fort")
self.assertEqual(response.xml.text.strip(), "knox")
def test_response_content_type_matches_url_format_over_accept_header(self):
app = webtest.TestApp(DummyApp())
response = app.get("/resources.json",
headers={'Accept': "application/xml"})
self.assertEqual(response.content_type, "application/json")
self.assertEqual(response.json, {'fort': 'knox'})
def test_returns_404_if_action_not_implemented(self):
app = webtest.TestApp(DummyApp())
response = app.get("/resources/new", status='*')
self.assertEqual(response.status_int, 404)
class TestFault(tests.BaseTest):
def test_fault_wraps_webob_exception(self):
app = webtest.TestApp(wsgi.Fault(webob.exc.HTTPNotFound("some error")))
response = app.get("/", status="*")
self.assertEqual(response.status_int, 404)
self.assertEqual(response.content_type, "application/json")
self.assertEqual(response.json['NotFound'],
dict(code=404,
message="The resource could not be found.",
detail="some error"))
def test_fault_gives_back_xml(self):
app = webtest.TestApp(wsgi.Fault(
webob.exc.HTTPBadRequest("some error")))
response = app.get("/x.xml", status="*")
self.assertEqual(response.content_type, "application/xml")
self.assertEqual(response.xml.tag, 'BadRequest')
self.assertEqual(response.xml.attrib['code'], '400')
self.assertEqual(response.xml.find('detail').text.strip(),
'some error')
class TestResult(tests.BaseTest):
class TestData(object):
def data_for_json(self):
return {'foo': "bar", 'foo2': "bar2"}
def data_for_xml(self):
return {'foos': [{'foo': "bar"}, {'foo2': "bar2"}]}
def test_data_returns_back_input_data(self):
self.assertEqual(wsgi.Result("blah").data("application/json"), "blah")
self.assertEqual(wsgi.Result({'x': "blah"}).data("application/json"),
{'x': "blah"})
self.assertEqual(wsgi.Result(["x", "blah"]).data("application/xml"),
["x", "blah"])
def test_data_returns_json_specific_input_data(self):
self.assertEqual(wsgi.Result(self.TestData()).data("application/json"),
{'foo': "bar", 'foo2': "bar2"})
def test_data_returns_xml_specific_input_data(self):
self.assertEqual(wsgi.Result(self.TestData()).data("application/xml"),
{'foos': [{'foo': "bar"}, {'foo2': "bar2"}]})
|