import falcon import falcon.testing as testing import six class TestQueryParams(testing.TestBase): def before(self): self.resource = testing.TestResource() self.api.add_route('/', self.resource) def test_none(self): query_string = '' self.simulate_request('/', query_string=query_string) req = self.resource.req store = {} self.assertIs(req.get_param('marker'), None) self.assertIs(req.get_param('limit', store), None) self.assertNotIn('limit', store) self.assertIs(req.get_param_as_int('limit'), None) self.assertIs(req.get_param_as_bool('limit'), None) self.assertIs(req.get_param_as_list('limit'), None) def test_blank(self): query_string = 'marker=' self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertIs(req.get_param('marker'), None) store = {} self.assertIs(req.get_param('marker', store=store), None) self.assertNotIn('marker', store) def test_simple(self): query_string = 'marker=deadbeef&limit=25' self.simulate_request('/', query_string=query_string) req = self.resource.req store = {} self.assertEqual(req.get_param('marker', store=store) or 'nada', 'deadbeef') self.assertEqual(req.get_param('limit', store=store) or '0', '25') self.assertEqual(store['marker'], 'deadbeef') self.assertEqual(store['limit'], '25') def test_percent_encoded(self): query_string = 'id=23%2c42&q=%e8%b1%86+%e7%93%a3' self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertEqual(req.get_param('id'), six.u('23,42')) self.assertEqual(req.get_param_as_list('id', int), [23, 42]) self.assertEqual(req.get_param('q'), six.u('\u8c46 \u74e3')) def test_allowed_names(self): query_string = ('p=0&p1=23&2p=foo&some-thing=that&blank=&some_thing=x&' '-bogus=foo&more.things=blah') self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertEqual(req.get_param('p'), '0') self.assertEqual(req.get_param('p1'), '23') self.assertIs(req.get_param('2p'), None) self.assertEqual(req.get_param('some-thing'), 'that') self.assertIs(req.get_param('blank'), None) self.assertEqual(req.get_param('some_thing'), 'x') self.assertIs(req.get_param('-bogus'), None) self.assertEqual(req.get_param('more.things'), 'blah') def test_required(self): query_string = '' self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertRaises(falcon.HTTPBadRequest, req.get_param, 'marker', required=True) self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_int, 'marker', required=True) self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_bool, 'marker', required=True) self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_list, 'marker', required=True) def test_int(self): query_string = 'marker=deadbeef&limit=25' self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_int, 'marker') self.assertEqual(req.get_param_as_int('limit'), 25) store = {} self.assertEqual(req.get_param_as_int('limit', store=store), 25) self.assertEqual(store['limit'], 25) self.assertEqual( req.get_param_as_int('limit', min=1, max=50), 25) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'limit', min=0, max=10) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'limit', min=0, max=24) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'limit', min=30, max=24) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'limit', min=30, max=50) self.assertEqual( req.get_param_as_int('limit', min=1), 25) self.assertEqual( req.get_param_as_int('limit', max=50), 25) self.assertEqual( req.get_param_as_int('limit', max=25), 25) self.assertEqual( req.get_param_as_int('limit', max=26), 25) self.assertEqual( req.get_param_as_int('limit', min=25), 25) self.assertEqual( req.get_param_as_int('limit', min=24), 25) self.assertEqual( req.get_param_as_int('limit', min=-24), 25) def test_int_neg(self): query_string = 'marker=deadbeef&pos=-7' self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertEqual(req.get_param_as_int('pos'), -7) self.assertEqual( req.get_param_as_int('pos', min=-10, max=10), -7) self.assertEqual( req.get_param_as_int('pos', max=10), -7) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'pos', min=-6, max=0) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'pos', min=-6) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'pos', min=0, max=10) self.assertRaises( falcon.HTTPBadRequest, req.get_param_as_int, 'pos', min=0, max=10) def test_boolean(self): query_string = ('echo=true&doit=false&bogus=0&bogus2=1&' 't1=True&f1=False&t2=yes&f2=no') self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_bool, 'bogus') self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_bool, 'bogus2') self.assertEqual(req.get_param_as_bool('echo'), True) self.assertEqual(req.get_param_as_bool('doit'), False) self.assertEqual(req.get_param_as_bool('t1'), True) self.assertEqual(req.get_param_as_bool('t2'), True) self.assertEqual(req.get_param_as_bool('f1'), False) self.assertEqual(req.get_param_as_bool('f2'), False) store = {} self.assertEqual(req.get_param_as_bool('echo', store=store), True) self.assertEqual(store['echo'], True) def test_list_type(self): query_string = ('colors=red,green,blue&limit=1' '&list-ish1=f,,x&list-ish2=,0&list-ish3=a,,,b' '&empty1=&empty2=,&empty3=,,') self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertEqual(req.get_param('colors'), 'red,green,blue') self.assertEqual(req.get_param_as_list('colors'), ['red', 'green', 'blue']) self.assertEqual(req.get_param_as_list('limit'), ['1']) self.assertIs(req.get_param_as_list('marker'), None) self.assertEqual(req.get_param_as_list('empty1'), None) self.assertEqual(req.get_param_as_list('empty2'), [None, None]) self.assertEqual(req.get_param_as_list('empty3'), [None, None, None]) self.assertEqual(req.get_param_as_list('list-ish1'), ['f', None, 'x']) # Ensure that '0' doesn't get translated to None self.assertEqual(req.get_param_as_list('list-ish2'), [None, '0']) # Ensure that '0' doesn't get translated to None self.assertEqual(req.get_param_as_list('list-ish3'), ['a', None, None, 'b']) store = {} self.assertEqual(req.get_param_as_list('limit', store=store), ['1']) self.assertEqual(store['limit'], ['1']) def test_list_transformer(self): query_string = 'coord=1.4,13,15.1&limit=100&things=4,,1' self.simulate_request('/', query_string=query_string) req = self.resource.req self.assertEqual(req.get_param('coord'), '1.4,13,15.1') expected = [1.4, 13.0, 15.1] actual = req.get_param_as_list('coord', transform=float) self.assertEqual(actual, expected) expected = ['4', None, '1'] actual = req.get_param_as_list('things', transform=str) self.assertEqual(actual, expected) expected = [4, None, 1] actual = req.get_param_as_list('things', transform=int) self.assertEqual(actual, expected) self.assertRaises(falcon.HTTPBadRequest, req.get_param_as_list, 'coord', transform=int)