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
|
from functools import wraps
import pytest
import falcon
import falcon.constants
import falcon.testing as testing
# RFC 7231, 5789 methods
HTTP_METHODS = [
'CONNECT',
'DELETE',
'GET',
'HEAD',
'OPTIONS',
'PATCH',
'POST',
'PUT',
'TRACE',
]
# RFC 2518 and 4918 methods
WEBDAV_METHODS = [
'CHECKIN',
'CHECKOUT',
'COPY',
'LOCK',
'MKCOL',
'MOVE',
'PROPFIND',
'PROPPATCH',
'REPORT',
'UNCHECKIN',
'UNLOCK',
'UPDATE',
'VERSION-CONTROL',
]
@pytest.fixture
def stonewall():
return Stonewall()
@pytest.fixture
def resource_things():
return ThingsResource()
@pytest.fixture
def resource_misc():
return MiscResource()
@pytest.fixture
def resource_get_with_faulty_put():
return GetWithFaultyPutResource()
@pytest.fixture
def client(asgi, util):
app = util.create_app(asgi)
app.add_route('/stonewall', Stonewall())
resource_things = ThingsResource()
app.add_route('/things', resource_things)
app.add_route('/things/{id}/stuff/{sid}', resource_things)
resource_misc = MiscResource()
app.add_route('/misc', resource_misc)
resource_get_with_faulty_put = GetWithFaultyPutResource()
app.add_route('/get_with_param/{param}', resource_get_with_faulty_put)
return testing.TestClient(app)
class ThingsResource:
def __init__(self):
self.called = False
# Test non-callable attribute
self.on_patch = {}
# Field names ordered differently than in uri template
def on_get(self, req, resp, sid, id):
self.called = True
self.req, self.resp = req, resp
resp.status = falcon.HTTP_204
# Field names ordered the same as in uri template
def on_head(self, req, resp, id, sid):
self.called = True
self.req, self.resp = req, resp
resp.status = falcon.HTTP_204
def on_put(self, req, resp, id, sid):
self.called = True
self.req, self.resp = req, resp
resp.status = falcon.HTTP_201
def on_report(self, req, resp, id, sid):
self.called = True
self.req, self.resp = req, resp
resp.status = falcon.HTTP_204
def on_websocket(self, req, resp, id, sid):
self.called = True
class Stonewall:
pass
def capture(func):
@wraps(func)
def with_capture(*args, **kwargs):
self = args[0]
self.called = True
self.req, self.resp = args[1:]
func(*args, **kwargs)
return with_capture
def selfless_decorator(func):
def faulty(req, resp, foo, bar):
pass
return faulty
class MiscResource:
def __init__(self):
self.called = False
@capture
def on_get(self, req, resp):
resp.status = falcon.HTTP_204
@capture
def on_head(self, req, resp):
resp.status = falcon.HTTP_204
@capture
def on_put(self, req, resp):
resp.status = falcon.HTTP_400
@capture
def on_patch(self, req, resp):
pass
def on_options(self, req, resp):
# NOTE(kgriffs): The default responder returns 200
resp.status = falcon.HTTP_204
# NOTE(kgriffs): This is incorrect, but only return GET so
# that we can verify that the default OPTIONS responder has
# been overridden.
resp.set_header('allow', 'GET')
class GetWithFaultyPutResource:
def __init__(self):
self.called = False
@capture
def on_get(self, req, resp):
resp.status = falcon.HTTP_204
def on_put(self, req, resp, param):
raise TypeError()
class FaultyDecoratedResource:
@selfless_decorator
def on_get(self, req, resp):
pass
class TestHttpMethodRouting:
def test_get(self, client, resource_things):
client.app.add_route('/things', resource_things)
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
response = client.simulate_request(path='/things/42/stuff/57')
assert response.status == falcon.HTTP_204
assert resource_things.called
def test_put(self, client, resource_things):
client.app.add_route('/things', resource_things)
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
response = client.simulate_request(path='/things/42/stuff/1337', method='PUT')
assert response.status == falcon.HTTP_201
assert resource_things.called
def test_post_not_allowed(self, client, resource_things):
client.app.add_route('/things', resource_things)
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
response = client.simulate_request(path='/things/42/stuff/1337', method='POST')
assert response.status == falcon.HTTP_405
assert not resource_things.called
def test_report(self, client, resource_things):
client.app.add_route('/things', resource_things)
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
response = client.simulate_request(
path='/things/42/stuff/1337', method='REPORT'
)
assert response.status == falcon.HTTP_204
assert resource_things.called
def test_misc(self, client, resource_misc):
client.app.add_route('/misc', resource_misc)
for method in ['GET', 'HEAD', 'PUT', 'PATCH']:
resource_misc.called = False
client.simulate_request(path='/misc', method=method)
assert resource_misc.called
assert resource_misc.req.method == method
def test_methods_not_allowed_simple(self, client, stonewall):
client.app.add_route('/stonewall', stonewall)
for method in ['GET', 'HEAD', 'PUT', 'PATCH']:
response = client.simulate_request(path='/stonewall', method=method)
assert response.status == falcon.HTTP_405
def test_methods_not_allowed_complex(self, client, resource_things):
client.app.add_route('/things', resource_things)
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
for method in HTTP_METHODS + WEBDAV_METHODS:
if method in ('GET', 'PUT', 'HEAD', 'OPTIONS', 'REPORT'):
continue
resource_things.called = False
response = client.simulate_request(
path='/things/84/stuff/65', method=method
)
assert not resource_things.called
assert response.status == falcon.HTTP_405
headers = response.headers
assert headers['allow'] == 'GET, HEAD, PUT, REPORT, OPTIONS'
def test_method_not_allowed_with_param(self, client, resource_get_with_faulty_put):
client.app.add_route('/get_with_param/{param}', resource_get_with_faulty_put)
for method in HTTP_METHODS + WEBDAV_METHODS:
if method in ('GET', 'PUT', 'OPTIONS'):
continue
resource_get_with_faulty_put.called = False
response = client.simulate_request(
method=method,
path='/get_with_param/bogus_param',
)
assert not resource_get_with_faulty_put.called
assert response.status == falcon.HTTP_405
headers = response.headers
assert headers['allow'] == 'GET, PUT, OPTIONS'
def test_default_on_options(self, client, resource_things):
client.app.add_route('/things', resource_things)
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
response = client.simulate_request(path='/things/84/stuff/65', method='OPTIONS')
assert response.status == falcon.HTTP_200
headers = response.headers
assert headers['allow'] == 'GET, HEAD, PUT, REPORT'
def test_on_options(self, client):
response = client.simulate_request(path='/misc', method='OPTIONS')
assert response.status == falcon.HTTP_204
headers = response.headers
assert headers['allow'] == 'GET'
@pytest.mark.parametrize(
'method', falcon.constants._META_METHODS + ['SETECASTRONOMY']
)
@pytest.mark.filterwarnings('ignore:Unknown REQUEST_METHOD')
def test_meta_and_others_disallowed(self, client, resource_things, method):
client.app.add_route('/things/{id}/stuff/{sid}', resource_things)
response = client.simulate_request(
path='/things/42/stuff/1337', method='WEBSOCKET'
)
assert response.status == falcon.HTTP_400
assert not resource_things.called
|
