Files
deb-python-falcon/tests/test_query_params.py
kgriffs d85cfc0b59 feat(Request): Add optional min, max arguments to req.get_param_as_int
This patch makes it easy to validate integer parameters.

Closes #103
2013-04-04 00:19:06 -04:00

190 lines
6.6 KiB
Python

import falcon
import falcon.testing as testing
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
self.assertIs(req.get_param('marker'), None)
self.assertIs(req.get_param('limit'), None)
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)
def test_simple(self):
query_string = 'marker=deadbeef&limit=25'
self.simulate_request('/', query_string=query_string)
req = self.resource.req
self.assertEquals(req.get_param('marker') or 'deadbeef', 'deadbeef')
self.assertEquals(req.get_param('limit') or '25', '25')
def test_allowed_names(self):
query_string = ('p=0&p1=23&2p=foo&some-thing=that&blank=&some_thing=x&'
'-bogus=foo')
self.simulate_request('/', query_string=query_string)
req = self.resource.req
self.assertEquals(req.get_param('p'), '0')
self.assertEquals(req.get_param('p1'), '23')
self.assertIs(req.get_param('2p'), None)
self.assertEquals(req.get_param('some-thing'), 'that')
self.assertIs(req.get_param('blank'), None)
self.assertEquals(req.get_param('some_thing'), 'x')
self.assertIs(req.get_param('-bogus'), None)
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.assertEquals(req.get_param_as_int('limit'), 25)
self.assertEquals(
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.assertEquals(
req.get_param_as_int('limit', min=1), 25)
self.assertEquals(
req.get_param_as_int('limit', max=50), 25)
self.assertEquals(
req.get_param_as_int('limit', max=25), 25)
self.assertEquals(
req.get_param_as_int('limit', max=26), 25)
self.assertEquals(
req.get_param_as_int('limit', min=25), 25)
self.assertEquals(
req.get_param_as_int('limit', min=24), 25)
self.assertEquals(
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.assertEquals(req.get_param_as_int('pos'), -7)
self.assertEquals(
req.get_param_as_int('pos', min=-10, max=10), -7)
self.assertEquals(
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'
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.assertEquals(req.get_param_as_bool('echo'), True)
self.assertEquals(req.get_param_as_bool('doit'), False)
def test_list_type(self):
query_string = 'colors=red,green,blue&limit=1'
self.simulate_request('/', query_string=query_string)
req = self.resource.req
self.assertEquals(req.get_param('colors'), 'red,green,blue')
self.assertEquals(req.get_param_as_list('colors'),
['red', 'green', 'blue'])
self.assertEquals(req.get_param_as_list('limit'), ['1'])
self.assertIs(req.get_param_as_list('marker'), None)
def test_list_transformer(self):
query_string = 'coord=1.4,13,15.1&limit=100'
self.simulate_request('/', query_string=query_string)
req = self.resource.req
self.assertEquals(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.assertEquals(actual, expected)
self.assertRaises(falcon.HTTPBadRequest,
req.get_param_as_list, 'coord', transform=int)
def test_bogus_input(self):
query_string = 'colors=red,green,&limit=1&pickle'
self.simulate_request('/', query_string=query_string)
req = self.resource.req
self.assertEquals(req.get_param_as_list('colors'),
['red', 'green', ''])
self.assertEquals(req.get_param('limit'), '1')
self.assertIs(req.get_param('pickle'), None)