95194a4f5c
This patch allows a wider variety of characters to be used in query string params, while also slightly improving the performance of parsing the same.
311 lines
10 KiB
Python
311 lines
10 KiB
Python
import json
|
|
import io
|
|
|
|
import falcon
|
|
import falcon.testing as testing
|
|
|
|
|
|
def validate(req, resp, params):
|
|
raise falcon.HTTPBadRequest('Invalid thing', 'Your thing was not '
|
|
'formatted correctly.')
|
|
|
|
|
|
def validate_param(req, resp, params):
|
|
limit = req.get_param_as_int('limit')
|
|
if limit and int(limit) > 100:
|
|
raise falcon.HTTPBadRequest('Out of range', 'limit must be <= 100')
|
|
|
|
|
|
def resource_aware_validate_param(req, resp, resource, params):
|
|
assert resource
|
|
validate_param(req, resp, params)
|
|
|
|
|
|
class ResourceAwareValidateParam(object):
|
|
def __call__(self, req, resp, resource, params):
|
|
assert resource
|
|
validate_param(req, resp, params)
|
|
|
|
|
|
def validate_field(req, resp, params):
|
|
try:
|
|
params['id'] = int(params['id'])
|
|
except ValueError:
|
|
raise falcon.HTTPBadRequest('Invalid ID', 'ID was not valid.')
|
|
|
|
|
|
def parse_body(req, resp, params):
|
|
length = req.content_length or 0
|
|
if length != 0:
|
|
params['doc'] = json.load(io.TextIOWrapper(req.stream, 'utf-8'))
|
|
|
|
|
|
def bunnies(req, resp, params):
|
|
params['bunnies'] = 'fuzzy'
|
|
|
|
|
|
def resource_aware_bunnies(req, resp, resource, params):
|
|
assert resource
|
|
bunnies(req, resp, params)
|
|
|
|
|
|
def frogs(req, resp, params):
|
|
if 'bunnies' in params:
|
|
params['bunnies'] = 'fluffy'
|
|
|
|
params['frogs'] = 'not fluffy'
|
|
|
|
|
|
class Fish(object):
|
|
def __call__(self, req, resp, params):
|
|
params['fish'] = 'slippery'
|
|
|
|
|
|
def bunnies_in_the_head(req, resp, params):
|
|
resp.set_header('X-Bunnies', 'fluffy')
|
|
|
|
|
|
def frogs_in_the_head(req, resp, params):
|
|
resp.set_header('X-Frogs', 'not fluffy')
|
|
|
|
|
|
class WrappedRespondersResource(object):
|
|
|
|
@falcon.before(validate_param)
|
|
@falcon.before(parse_body)
|
|
def on_get(self, req, resp, doc):
|
|
self.req = req
|
|
self.resp = resp
|
|
self.doc = doc
|
|
|
|
@falcon.before(validate)
|
|
def on_put(self, req, resp):
|
|
self.req = req
|
|
self.resp = resp
|
|
|
|
|
|
@falcon.before(bunnies)
|
|
class WrappedClassResource(object):
|
|
|
|
# Test non-callable should be skipped by decorator
|
|
on_patch = {}
|
|
|
|
@falcon.before(validate_param)
|
|
def on_get(self, req, resp, bunnies):
|
|
self._capture(req, resp, bunnies)
|
|
|
|
@falcon.before(validate_param)
|
|
def on_head(self, req, resp, bunnies):
|
|
self._capture(req, resp, bunnies)
|
|
|
|
@falcon.before(Fish())
|
|
def on_post(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 both both type of hooks (class and method)
|
|
# at once for the sake of simplicity
|
|
@falcon.before(resource_aware_bunnies)
|
|
class ClassResourceWithAwareHooks(object):
|
|
hook_as_class = ResourceAwareValidateParam()
|
|
|
|
@falcon.before(resource_aware_validate_param)
|
|
def on_get(self, req, resp, bunnies):
|
|
self._capture(req, resp, bunnies)
|
|
|
|
@falcon.before(resource_aware_validate_param)
|
|
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(object):
|
|
|
|
@falcon.before(validate_field)
|
|
def on_get(self, req, resp, id):
|
|
self.id = id
|
|
|
|
|
|
class BunnyResource(object):
|
|
|
|
def on_get(self, req, resp, bunnies):
|
|
self.bunnies = bunnies
|
|
|
|
|
|
class ZooResource(object):
|
|
|
|
def on_get(self, req, resp, bunnies, frogs, fish):
|
|
self.bunnies = bunnies
|
|
self.frogs = frogs
|
|
self.fish = fish
|
|
|
|
|
|
class TestHooks(testing.TestBase):
|
|
|
|
def before(self):
|
|
self.resource = WrappedRespondersResource()
|
|
self.api.add_route(self.test_route, self.resource)
|
|
|
|
self.field_resource = TestFieldResource()
|
|
self.api.add_route('/queue/{id}/messages', self.field_resource)
|
|
|
|
self.wrapped_resource = WrappedClassResource()
|
|
self.api.add_route('/wrapped', self.wrapped_resource)
|
|
|
|
self.wrapped_aware_resource = ClassResourceWithAwareHooks()
|
|
self.api.add_route('/wrapped_aware', self.wrapped_aware_resource)
|
|
|
|
def test_global_hook(self):
|
|
self.assertRaises(TypeError, falcon.API, None, 0)
|
|
self.assertRaises(TypeError, falcon.API, None, {})
|
|
|
|
self.api = falcon.API(before=bunnies)
|
|
zoo_resource = BunnyResource()
|
|
|
|
self.api.add_route(self.test_route, zoo_resource)
|
|
|
|
self.simulate_request(self.test_route)
|
|
self.assertEqual('fuzzy', zoo_resource.bunnies)
|
|
|
|
def test_global_hook_is_resource_aware(self):
|
|
self.api = falcon.API(before=resource_aware_bunnies)
|
|
zoo_resource = BunnyResource()
|
|
|
|
self.api.add_route(self.test_route, zoo_resource)
|
|
self.simulate_request(self.test_route)
|
|
self.assertEqual('fuzzy', zoo_resource.bunnies)
|
|
|
|
def test_multiple_global_hook(self):
|
|
self.api = falcon.API(before=[bunnies, frogs, Fish()])
|
|
zoo_resource = ZooResource()
|
|
|
|
self.api.add_route(self.test_route, zoo_resource)
|
|
|
|
self.simulate_request(self.test_route)
|
|
self.assertEqual('fluffy', zoo_resource.bunnies)
|
|
self.assertEqual('not fluffy', zoo_resource.frogs)
|
|
self.assertEqual('slippery', zoo_resource.fish)
|
|
|
|
def test_global_hook_wrap_default_on_options(self):
|
|
self.api = falcon.API(before=frogs_in_the_head)
|
|
bunny_resource = BunnyResource()
|
|
|
|
self.api.add_route(self.test_route, bunny_resource)
|
|
|
|
self.simulate_request(self.test_route, method='OPTIONS')
|
|
self.assertEqual(falcon.HTTP_204, self.srmock.status)
|
|
self.assertEqual('not fluffy', self.srmock.headers_dict['X-Frogs'])
|
|
|
|
def test_global_hook_wrap_default_405(self):
|
|
self.api = falcon.API(before=[frogs_in_the_head])
|
|
bunny_resource = BunnyResource()
|
|
|
|
self.api.add_route(self.test_route, bunny_resource)
|
|
|
|
# on_post is not defined in ZooResource
|
|
self.simulate_request(self.test_route, method='POST')
|
|
self.assertEqual(falcon.HTTP_405, self.srmock.status)
|
|
self.assertEqual('not fluffy', self.srmock.headers_dict['X-Frogs'])
|
|
|
|
def test_multiple_global_hooks_wrap_default_on_options(self):
|
|
self.api = falcon.API(before=[frogs_in_the_head, bunnies_in_the_head])
|
|
bunny_resource = BunnyResource()
|
|
|
|
self.api.add_route(self.test_route, bunny_resource)
|
|
|
|
self.simulate_request(self.test_route, method='OPTIONS')
|
|
self.assertEqual('not fluffy', self.srmock.headers_dict['X-Frogs'])
|
|
self.assertEqual('fluffy', self.srmock.headers_dict['X-Bunnies'])
|
|
|
|
def test_multiple_global_hooks_wrap_default_405(self):
|
|
self.api = falcon.API(before=[frogs_in_the_head, bunnies_in_the_head])
|
|
bunny_resource = BunnyResource()
|
|
|
|
self.api.add_route(self.test_route, bunny_resource)
|
|
|
|
# on_post is not defined in ZooResource
|
|
self.simulate_request(self.test_route, method='POST')
|
|
self.assertEqual('not fluffy', self.srmock.headers_dict['X-Frogs'])
|
|
self.assertEqual('fluffy', self.srmock.headers_dict['X-Bunnies'])
|
|
|
|
def test_input_validator(self):
|
|
self.simulate_request(self.test_route, method='PUT')
|
|
self.assertEqual(falcon.HTTP_400, self.srmock.status)
|
|
|
|
def test_param_validator(self):
|
|
self.simulate_request(self.test_route, query_string='limit=10',
|
|
body='{}')
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
|
|
self.simulate_request(self.test_route, query_string='limit=101')
|
|
self.assertEqual(falcon.HTTP_400, self.srmock.status)
|
|
|
|
def test_field_validator(self):
|
|
self.simulate_request('/queue/10/messages')
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
self.assertEqual(self.field_resource.id, 10)
|
|
|
|
self.simulate_request('/queue/bogus/messages')
|
|
self.assertEqual(falcon.HTTP_400, self.srmock.status)
|
|
|
|
def test_parser(self):
|
|
self.simulate_request(self.test_route,
|
|
body=json.dumps({'animal': 'falcon'}))
|
|
|
|
self.assertEqual(self.resource.doc, {'animal': 'falcon'})
|
|
|
|
def test_wrapped_resource(self):
|
|
self.simulate_request('/wrapped', method='PATCH')
|
|
self.assertEqual(falcon.HTTP_405, self.srmock.status)
|
|
|
|
self.simulate_request('/wrapped', query_string='limit=10')
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
self.assertEqual('fuzzy', self.wrapped_resource.bunnies)
|
|
|
|
self.simulate_request('/wrapped', method='HEAD')
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
self.assertEqual('fuzzy', self.wrapped_resource.bunnies)
|
|
|
|
self.simulate_request('/wrapped', method='POST')
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
self.assertEqual('slippery', self.wrapped_resource.fish)
|
|
|
|
self.simulate_request('/wrapped', query_string='limit=101')
|
|
self.assertEqual(falcon.HTTP_400, self.srmock.status)
|
|
self.assertEqual('fuzzy', self.wrapped_resource.bunnies)
|
|
|
|
def test_wrapped_resource_with_hooks_aware_of_resource(self):
|
|
self.simulate_request('/wrapped_aware', method='PATCH')
|
|
self.assertEqual(falcon.HTTP_405, self.srmock.status)
|
|
|
|
self.simulate_request('/wrapped_aware', query_string='limit=10')
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
self.assertEqual('fuzzy', self.wrapped_aware_resource.bunnies)
|
|
|
|
for method in ('HEAD', 'PUT', 'POST'):
|
|
self.simulate_request('/wrapped_aware', method=method)
|
|
self.assertEqual(falcon.HTTP_200, self.srmock.status)
|
|
self.assertEqual('fuzzy', self.wrapped_aware_resource.bunnies)
|
|
|
|
self.simulate_request('/wrapped_aware', query_string='limit=101')
|
|
self.assertEqual(falcon.HTTP_400, self.srmock.status)
|
|
self.assertEqual('fuzzy', self.wrapped_aware_resource.bunnies)
|