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 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
|
import functools
import io
import json
import pytest
import falcon
import falcon.testing as testing
def validate(req, resp, resource, params):
assert resource
raise falcon.HTTPBadRequest(
title='Invalid thing', description='Your thing was not formatted correctly.'
)
def validate_param(req, resp, resource, params, param_name, maxval=100):
assert resource
limit = req.get_param_as_int(param_name)
if limit and int(limit) > maxval:
msg = '{0} must be <= {1}'.format(param_name, maxval)
raise falcon.HTTPBadRequest(title='Out of Range', description=msg)
async def validate_param_async(*args, **kwargs):
validate_param(*args, **kwargs)
class ResourceAwareValidateParam:
def __call__(self, req, resp, resource, params):
assert resource
validate_param(req, resp, resource, params, 'limit')
def validate_field(req, resp, resource, params, field_name='test'):
assert resource
try:
params[field_name] = int(params[field_name])
except ValueError:
raise falcon.HTTPBadRequest()
def parse_body(req, resp, resource, params):
assert resource
length = req.content_length
if length:
params['doc'] = json.load(io.TextIOWrapper(req.bounded_stream, 'utf-8'))
async def parse_body_async(req, resp, resource, params):
assert resource
length = req.content_length
if length:
data = await req.bounded_stream.read()
params['doc'] = json.loads(data.decode('utf-8'))
def bunnies(req, resp, resource, params):
assert resource
params['bunnies'] = 'fuzzy'
def frogs(req, resp, resource, params):
assert resource
if 'bunnies' in params:
params['bunnies'] = 'fluffy'
params['frogs'] = 'not fluffy'
class Fish:
def __call__(self, req, resp, resource, params):
assert resource
params['fish'] = 'slippery'
def hook(self, req, resp, resource, params):
assert resource
params['fish'] = 'wet'
# NOTE(kgriffs): Use partial methods for these next two in order
# to make sure we handle that correctly.
def things_in_the_head(header, value, req, resp, resource, params):
resp.set_header(header, value)
bunnies_in_the_head = functools.partial(things_in_the_head, 'X-Bunnies', 'fluffy')
frogs_in_the_head = functools.partial(things_in_the_head, 'X-Frogs', 'not fluffy')
class WrappedRespondersResource:
@falcon.before(validate_param, 'limit', 100)
def on_get(self, req, resp):
self.req = req
self.resp = resp
@falcon.before(validate)
def on_put(self, req, resp):
self.req = req
self.resp = resp
class WrappedRespondersResourceChild(WrappedRespondersResource):
@falcon.before(validate_param, 'x', maxval=1000)
def on_get(self, req, resp):
pass
def on_put(self, req, resp):
# Test passing no extra args
super(WrappedRespondersResourceChild, self).on_put(req, resp)
class WrappedRespondersBodyParserResource:
@falcon.before(validate_param, 'limit', 100)
@falcon.before(parse_body)
def on_get(self, req, resp, doc=None):
self.req = req
self.resp = resp
self.doc = doc
@falcon.before(bunnies)
class WrappedClassResource:
_some_fish = Fish()
# Test non-callable should be skipped by decorator
on_patch = {} # type: ignore
@falcon.before(validate_param, 'limit')
def on_get(self, req, resp, bunnies):
self._capture(req, resp, bunnies)
@falcon.before(validate_param, 'limit')
def on_head(self, req, resp, bunnies):
self._capture(req, resp, bunnies)
@falcon.before(_some_fish)
def on_post(self, req, resp, fish, bunnies):
self._capture(req, resp, bunnies)
self.fish = fish
@falcon.before(_some_fish.hook)
def on_put(self, req, resp, fish, bunnies):
self._capture(req, resp, bunnies)
self.fish = fish
def _capture(self, req, resp, bunnies):
self.req = req
self.resp = resp
self.bunnies = bunnies
# NOTE(swistakm): we use both type of hooks (class and method)
# at once for the sake of simplicity
@falcon.before(bunnies)
class ClassResourceWithAwareHooks:
hook_as_class = ResourceAwareValidateParam()
@falcon.before(validate_param, 'limit', 10)
def on_get(self, req, resp, bunnies):
self._capture(req, resp, bunnies)
@falcon.before(validate_param, 'limit')
def on_head(self, req, resp, bunnies):
self._capture(req, resp, bunnies)
@falcon.before(hook_as_class)
def on_put(self, req, resp, bunnies):
self._capture(req, resp, bunnies)
@falcon.before(hook_as_class.__call__)
def on_post(self, req, resp, bunnies):
self._capture(req, resp, bunnies)
def _capture(self, req, resp, bunnies):
self.req = req
self.resp = resp
self.bunnies = bunnies
class TestFieldResource:
@falcon.before(validate_field, field_name='id')
def on_get(self, req, resp, id):
self.id = id
class TestFieldResourceChild(TestFieldResource):
def on_get(self, req, resp, id):
# Test passing a single extra arg
super(TestFieldResourceChild, self).on_get(req, resp, id)
class TestFieldResourceChildToo(TestFieldResource):
def on_get(self, req, resp, id):
# Test passing a single kwarg, but no extra args
super(TestFieldResourceChildToo, self).on_get(req, resp, id=id)
@falcon.before(bunnies)
@falcon.before(frogs)
@falcon.before(Fish())
@falcon.before(bunnies_in_the_head)
@falcon.before(frogs_in_the_head)
class ZooResource:
def on_get(self, req, resp, bunnies, frogs, fish):
self.bunnies = bunnies
self.frogs = frogs
self.fish = fish
class ZooResourceChild(ZooResource):
def on_get(self, req, resp):
super(ZooResourceChild, self).on_get(
req,
resp,
# Test passing a mixture of args and kwargs
'fluffy',
'not fluffy',
fish='slippery',
)
@pytest.fixture
def wrapped_aware_resource():
return ClassResourceWithAwareHooks()
@pytest.fixture
def wrapped_resource():
return WrappedClassResource()
@pytest.fixture
def resource():
return WrappedRespondersResource()
@pytest.fixture
def client(asgi, util, request, resource):
app = util.create_app(asgi)
app.add_route('/', resource)
return testing.TestClient(app)
@pytest.mark.parametrize('resource', [ZooResource(), ZooResourceChild()])
def test_multiple_resource_hooks(client, resource):
client.app.add_route('/', resource)
result = client.simulate_get('/')
assert 'not fluffy' == result.headers['X-Frogs']
assert 'fluffy' == result.headers['X-Bunnies']
assert 'fluffy' == resource.bunnies
assert 'not fluffy' == resource.frogs
assert 'slippery' == resource.fish
def test_input_validator(client):
result = client.simulate_put('/')
assert result.status_code == 400
def test_input_validator_inherited(client):
client.app.add_route('/', WrappedRespondersResourceChild())
result = client.simulate_put('/')
assert result.status_code == 400
result = client.simulate_get('/', query_string='x=1000')
assert result.status_code == 200
result = client.simulate_get('/', query_string='x=1001')
assert result.status_code == 400
def test_param_validator(client):
result = client.simulate_get('/', query_string='limit=10', body='{}')
assert result.status_code == 200
result = client.simulate_get('/', query_string='limit=101')
assert result.status_code == 400
@pytest.mark.parametrize(
'resource',
[
TestFieldResource(),
TestFieldResourceChild(),
TestFieldResourceChildToo(),
],
)
def test_field_validator(client, resource):
client.app.add_route('/queue/{id}/messages', resource)
result = client.simulate_get('/queue/10/messages')
assert result.status_code == 200
assert resource.id == 10
result = client.simulate_get('/queue/bogus/messages')
assert result.status_code == 400
@pytest.mark.parametrize(
'body,doc',
[
(json.dumps({'animal': 'falcon'}), {'animal': 'falcon'}),
('{}', {}),
('', None),
(None, None),
],
)
def test_parser_sync(body, doc):
app = falcon.App()
resource = WrappedRespondersBodyParserResource()
app.add_route('/', resource)
testing.simulate_get(app, '/', body=body)
assert resource.doc == doc
@pytest.mark.parametrize(
'body,doc',
[
(json.dumps({'animal': 'falcon'}), {'animal': 'falcon'}),
('{}', {}),
('', None),
(None, None),
],
)
def test_parser_async(body, doc, util):
with util.disable_asgi_non_coroutine_wrapping():
class WrappedRespondersBodyParserAsyncResource:
@falcon.before(validate_param_async, 'limit', 100)
@falcon.before(parse_body_async)
async def on_get(self, req, resp, doc=None):
self.doc = doc
@falcon.before(parse_body_async)
async def on_put(self, req, resp, doc=None):
self.doc = doc
app = util.create_app(asgi=True)
resource = WrappedRespondersBodyParserAsyncResource()
app.add_route('/', resource)
testing.simulate_get(app, '/', body=body)
assert resource.doc == doc
testing.simulate_put(app, '/', body=body)
assert resource.doc == doc
async def test_direct():
resource = WrappedRespondersBodyParserAsyncResource()
req = testing.create_asgi_req()
resp = util.create_resp(True)
await resource.on_get(req, resp, doc)
assert resource.doc == doc
falcon.async_to_sync(test_direct)
def test_wrapped_resource(client, wrapped_resource):
client.app.add_route('/wrapped', wrapped_resource)
result = client.simulate_patch('/wrapped')
assert result.status_code == 405
result = client.simulate_get('/wrapped', query_string='limit=10')
assert result.status_code == 200
assert 'fuzzy' == wrapped_resource.bunnies
result = client.simulate_head('/wrapped')
assert result.status_code == 200
assert 'fuzzy' == wrapped_resource.bunnies
result = client.simulate_post('/wrapped')
assert result.status_code == 200
assert 'slippery' == wrapped_resource.fish
result = client.simulate_get('/wrapped', query_string='limit=101')
assert result.status_code == 400
assert wrapped_resource.bunnies == 'fuzzy'
def test_wrapped_resource_with_hooks_aware_of_resource(client, wrapped_aware_resource):
client.app.add_route('/wrapped_aware', wrapped_aware_resource)
result = client.simulate_patch('/wrapped_aware')
assert result.status_code == 405
result = client.simulate_get('/wrapped_aware', query_string='limit=10')
assert result.status_code == 200
assert wrapped_aware_resource.bunnies == 'fuzzy'
for method in ('HEAD', 'PUT', 'POST'):
result = client.simulate_request(method, '/wrapped_aware')
assert result.status_code == 200
assert wrapped_aware_resource.bunnies == 'fuzzy'
result = client.simulate_get('/wrapped_aware', query_string='limit=11')
assert result.status_code == 400
assert wrapped_aware_resource.bunnies == 'fuzzy'
_another_fish = Fish()
def header_hook(req, resp, resource, params):
value = resp.get_header('X-Hook-Applied') or '0'
resp.set_header('X-Hook-Applied', str(int(value) + 1))
@falcon.before(header_hook)
class PiggybackingCollection:
def __init__(self):
self._items = {}
self._sequence = 0
@falcon.before(_another_fish.hook)
def on_delete(self, req, resp, fish, itemid):
del self._items[itemid]
resp.set_header('X-Fish-Trait', fish)
resp.status = falcon.HTTP_NO_CONTENT
@falcon.before(header_hook)
@falcon.before(_another_fish.hook)
@falcon.before(header_hook)
def on_delete_collection(self, req, resp, fish):
if fish != 'wet':
raise falcon.HTTPUnavailableForLegalReasons(title='fish must be wet')
self._items = {}
resp.status = falcon.HTTP_NO_CONTENT
@falcon.before(_another_fish)
def on_get(self, req, resp, fish, itemid):
resp.set_header('X-Fish-Trait', fish)
resp.media = self._items[itemid]
def on_get_collection(self, req, resp):
resp.media = sorted(self._items.values(), key=lambda item: item['itemid'])
def on_head_(self):
return 'I shall not be decorated.'
def on_header(self):
return 'I shall not be decorated.'
def on_post_collection(self, req, resp):
self._sequence += 1
itemid = self._sequence
self._items[itemid] = dict(req.media, itemid=itemid)
resp.location = '/items/{}'.format(itemid)
resp.status = falcon.HTTP_CREATED
class PiggybackingCollectionAsync(PiggybackingCollection):
@falcon.before(header_hook)
async def on_post_collection(self, req, resp):
self._sequence += 1
itemid = self._sequence
doc = await req.get_media()
self._items[itemid] = dict(doc, itemid=itemid)
resp.location = '/items/{}'.format(itemid)
resp.status = falcon.HTTP_CREATED
@pytest.fixture()
def app_client(asgi, util):
items = PiggybackingCollectionAsync() if asgi else PiggybackingCollection()
app = util.create_app(asgi)
app.add_route('/items', items, suffix='collection')
app.add_route('/items/{itemid:int}', items)
return testing.TestClient(app)
def test_piggybacking_resource_post_item(app_client):
resp1 = app_client.simulate_post('/items', json={'color': 'green'})
assert resp1.status_code == 201
assert 'X-Fish-Trait' not in resp1.headers
assert resp1.headers['Location'] == '/items/1'
assert resp1.headers['X-Hook-Applied'] == '1'
resp2 = app_client.simulate_get(resp1.headers['Location'])
assert resp2.status_code == 200
assert resp2.headers['X-Fish-Trait'] == 'slippery'
assert resp2.headers['X-Hook-Applied'] == '1'
assert resp2.json == {'color': 'green', 'itemid': 1}
resp3 = app_client.simulate_get('/items')
assert resp3.status_code == 200
assert 'X-Fish-Trait' not in resp3.headers
assert resp3.headers['X-Hook-Applied'] == '1'
assert resp3.json == [{'color': 'green', 'itemid': 1}]
def test_piggybacking_resource_post_and_delete(app_client):
for number in range(1, 8):
resp = app_client.simulate_post('/items', json={'number': number})
assert resp.status_code == 201
assert resp.headers['X-Hook-Applied'] == '1'
assert len(app_client.simulate_get('/items').json) == number
resp = app_client.simulate_delete('/items/{}'.format(number))
assert resp.status_code == 204
assert resp.headers['X-Fish-Trait'] == 'wet'
assert resp.headers['X-Hook-Applied'] == '1'
assert len(app_client.simulate_get('/items').json) == 6
resp = app_client.simulate_delete('/items')
assert resp.status_code == 204
assert resp.headers['X-Hook-Applied'] == '3'
assert app_client.simulate_get('/items').json == []
def test_decorable_name_pattern():
resource = PiggybackingCollection()
assert resource.on_head_() == 'I shall not be decorated.'
assert resource.on_header() == 'I shall not be decorated.'
|