tests/test_urltree.py
author Tero Marttila <terom@fixme.fi>
Mon, 16 Feb 2009 20:56:05 +0200
changeset 82 d636dfcbd519
parent 81 847da3c265b5
child 83 69312afad653
permissions -rw-r--r--
more TestURL up to execute()
# :set encoding=utf8
"""
    Unit tests for qmsk.web.urltree
"""

import unittest
import urltree

class TestLabelValue (unittest.TestCase) :
    class dummylabel :
        key = 'foo'

    def test_str_default (self) :
        self.assertEqual(str(urltree.LabelValue(self.dummylabel, 'bar', True)), "foo")

    def test_str_value (self) :
        self.assertEqual(str(urltree.LabelValue(self.dummylabel, 'bar', False)), "foo='bar'")

class TestLabel (unittest.TestCase) :
    def setUp (self) :
        self.config = urltree.URLConfig()

    def _test_parse (self, mask, _type, defaults={}, **attrs) :
        label = urltree.Label.parse(mask, defaults, self.config)

        self.assertTrue(isinstance(label, _type))
        
        for k, v in attrs.iteritems() :
            self.assertEqual(getattr(label, k), v)

    def test_parse_empty (self) :
        self._test_parse("", urltree.EmptyLabel)

    def test_parse_static (self) :
        self._test_parse("foo", urltree.StaticLabel, name="foo")

    def test_parse_static_valid (self) :
        self._test_parse("foo_bar", urltree.StaticLabel, name="foo_bar")
        self._test_parse("foo2", urltree.StaticLabel, name="foo2")
        self._test_parse("2foo.q", urltree.StaticLabel, name="2foo.q")
    
    def test_parse_static_invalid (self) :
        self.assertRaises(urltree.URLError, urltree.Label.parse, "foo/bar", {}, self.config)

    def test_parse_value_plain (self) :
        self._test_parse("{foo}", urltree.SimpleValueLabel, key="foo", default=None, type_name=None, type=urltree.URLConfig.BUILTIN_TYPES[None])

    def test_parse_value_default1 (self) :
        self._test_parse("{foo=bar1}", urltree.SimpleValueLabel, key="foo", default="bar1", type_name=None)

    def test_parse_value_default2 (self) :
        self._test_parse("{foo}", urltree.SimpleValueLabel, dict(foo="bar2"), key="foo", default="bar2", type_name=None)

    def test_parse_value_default3 (self) :
        self._test_parse("{foo=bar1}", urltree.SimpleValueLabel, dict(foo="bar3"), key="foo", default="bar3", type_name=None)

    def test_parse_value_type_str (self) :
        self._test_parse("{foo:str}", urltree.SimpleValueLabel, key="foo", type_name="str", type=urltree.URLConfig.BUILTIN_TYPES['str'])

    def test_parse_value_type_int (self) :
        self._test_parse("{foo:int}", urltree.SimpleValueLabel, key="foo", type_name="int", type=urltree.URLConfig.BUILTIN_TYPES['int'])
    
    def test_parse_invalid_type (self) :
        self.assertRaises(KeyError, self._test_parse, "{foo:bar}", None)

class TestEmptyLabel (unittest.TestCase) :
    def setUp (self) :
        self.label = urltree.EmptyLabel()

    def test_eq (self) :
        self.assertTrue(self.label == urltree.EmptyLabel())
        self.assertFalse(self.label == urltree.StaticLabel("foo"))

    def test_match (self) :
        self.assertFalse(self.label.match())
        self.assertFalse(self.label.match("foo"))
        self.assertTrue(self.label.match(""))

    def test_build (self) :
        self.assertEqual(self.label.build({}), "")

    def test_build_default (self) :
        self.assertEqual(self.label.build_default({}), (False, ""))

    def test_str (self) :
        self.assertEqual(str(self.label), "")

class TestStaticLabel (unittest.TestCase) :
    def setUp (self) :
        self.label = urltree.StaticLabel("test")

    def test_eq (self) :
        self.assertTrue(self.label == urltree.StaticLabel("test"))
        self.assertFalse(self.label == urltree.StaticLabel("Test"))
        self.assertFalse(self.label == urltree.EmptyLabel())

    def test_match (self) :
        self.assertFalse(self.label.match())
        self.assertFalse(self.label.match("foo"))
        self.assertTrue(self.label.match("test"))

    def test_build (self) :
        self.assertEqual(self.label.build({}), "test")

    def test_build_default (self) :
        self.assertEqual(self.label.build_default({}), (False, "test"))

    def test_str (self) :
        self.assertEqual(str(self.label), "test")

class TestSimpleValueLabel (unittest.TestCase) :
    def setUp (self) :
        self.label = urltree.SimpleValueLabel("test", 'int', urltree.URLConfig.BUILTIN_TYPES['int'], None)
        self.label_default_0 = urltree.SimpleValueLabel("test", 'int', urltree.URLConfig.BUILTIN_TYPES['int'], 0)
        self.label_default_1 = urltree.SimpleValueLabel("test", 'int', urltree.URLConfig.BUILTIN_TYPES['int'], 1)
        self.label_str = urltree.SimpleValueLabel("test", None, urltree.URLConfig.BUILTIN_TYPES[None], None)
        self.label_str_default = urltree.SimpleValueLabel("test", None, urltree.URLConfig.BUILTIN_TYPES[None], 'def')

    def test_eq (self) :
        self.assertTrue(self.label == urltree.SimpleValueLabel("test", 'str', None, 1))
        self.assertFalse(self.label == urltree.StaticLabel("Test"))
        self.assertFalse(self.label == urltree.EmptyLabel())
    
    def _check_value (self, label, label_value, value, is_default) :
        self.assertTrue(isinstance(label_value, urltree.LabelValue))
        self.assertEqual(label_value.label, label)
        self.assertEqual(label_value.value, value)
        self.assertEqual(label_value.is_default, is_default)

    def test_match_default_none (self) :
        self.assertEquals(self.label.match(), None)

    def test_match_default_value (self) :
        self._check_value(self.label_default_0, self.label_default_0.match(), 0, True)
        self._check_value(self.label_default_1, self.label_default_1.match(), 1, True)
    
    def test_match_invalid (self) :
        self.assertEquals(self.label.match("foo"), False)
        self.assertEquals(self.label_default_0.match("foo"), False)
        self.assertEquals(self.label_default_1.match("foo"), False)

    def test_match_valid (self) :
        self._check_value(self.label, self.label.match("0"), 0, False)
        self._check_value(self.label, self.label.match("1"), 1, False)
        self._check_value(self.label_default_0, self.label_default_0.match("1"), 1, False)
        self._check_value(self.label_default_1, self.label_default_1.match("0"), 0, False)

    def test_build (self) :
        self.assertEqual(self.label.build(dict(test=1)), "1")
    
    def test_build_nodefault (self) :
        self.assertRaises(urltree.URLError, self.label.build, {})

    def test_build_none (self) :
        self.assertRaises(urltree.URLError, self.label.build, dict(test=None))
    
    def test_build_default (self) :
        self.assertEqual(self.label_default_0.build_default({}), (True, "0"))
        self.assertEqual(self.label_default_1.build_default({}), (True, "1"))
    
    def test_build_nonedefault (self) :
        self.assertEqual(self.label_default_1.build_default(dict(test=None)), (True, "1"))

    def test_build_value (self) :
        self.assertEqual(self.label.build_default(dict(test=0)), (False, "0"))
        self.assertEqual(self.label.build_default(dict(test=1)), (False, "1"))
        self.assertEqual(self.label_default_0.build_default(dict(test=1)), (False, "1"))
        self.assertEqual(self.label_default_0.build_default(dict(test=0)), (False, "0"))

    def test_str (self) :
        self.assertEqual(str(self.label), "{test:int}")
        self.assertEqual(str(self.label_default_0), "{test:int=0}")
        self.assertEqual(str(self.label_default_1), "{test:int=1}")
        self.assertEqual(str(self.label_str), "{test}")
        self.assertEqual(str(self.label_str_default), "{test=def}")

class TestStringType (unittest.TestCase) :
    def setUp (self) :
        self.type = urltree.URLStringType()

    def test_test (self) :
        self.assertTrue(self.type.test(""))
        self.assertTrue(self.type.test("xxx"))
    
    def test_parse (self) :
        self.assertEqual(self.type.parse(""), "")
        self.assertEqual(self.type.parse("xxx"), "xxx")
    
    def test_build (self) :
        self.assertEqual(self.type.build(""), "")
        self.assertEqual(self.type.build("xxx"), "xxx")
        self.assertEqual(self.type.build("äää"), "äää")

class TestIntegerType (unittest.TestCase) :
    def setUp (self) :
        self.type = urltree.URLIntegerType()
        self.type_positive = urltree.URLIntegerType(allow_negative=False)
        self.type_nonzero = urltree.URLIntegerType(allow_zero=False)
        self.type_max_5 = urltree.URLIntegerType(max=5)

    def test_test (self) :
        self.assertTrue(self.type.test("1"))
        self.assertFalse(self.type.test("xx"))
        self.assertTrue(self.type_positive.test("1"))
        self.assertFalse(self.type_positive.test("-1"))
        self.assertTrue(self.type_nonzero.test("1"))
        self.assertFalse(self.type_nonzero.test("0"))
        self.assertTrue(self.type_max_5.test("5"))
        self.assertFalse(self.type_max_5.test("6"))
    
    def test_parse_invalid (self) :
        self.assertRaises(ValueError, self.type.parse, "xx")
        self.assertRaises(ValueError, self.type_nonzero.parse, "0")

    def test_parse_valid (self) :
        self.assertEqual(self.type.parse("0"), 0)
        self.assertEqual(self.type.parse("2"), 2)
        self.assertEqual(self.type_nonzero.parse("3"), 3)
    
    def test_append (self) :
        self.assertRaises(urltree.URLError, self.type.append, 0, 1)

    def test_build (self) :
        self.assertEqual(self.type.build(0), "0")
        self.assertEqual(self.type.build(5), "5")
        self.assertEqual(self.type_positive.build(1), "1")
        self.assertEqual(self.type_nonzero.build(1), "1")
        self.assertEqual(self.type_max_5.build(5), "5")
    
    def test_build_invalid (self) :
        self.assertRaises(ValueError, self.type_positive.build, -1)
        self.assertRaises(ValueError, self.type_nonzero.build, 0)
        self.assertRaises(ValueError, self.type_max_5.build, 6)

    def test_build_multi (self) :
        self.assertEqual(self.type.build_multi(0), ["0"])
   
class TestListType (unittest.TestCase) :
    def setUp (self) :
        self.type = urltree.URLListType()

    def test_parse (self) :
        self.assertEqual(self.type.parse("x"), ["x"])
        self.assertEqual(self.type.parse(""), [""])
    
    def test_append (self) :
        self.assertEqual(self.type.append(["x"], ["y"]), ["x", "y"])

    def test_build_multi (self) :
        self.assertEqual(self.type.build_multi(["x", "y"]), ["x", "y"])

class TestConfig (unittest.TestCase) :
    def test_init (self) :
        urltree.URLConfig(type_dict=dict(foo=None), ignore_extra_args=True)

    def test_get_type (self) :
        self.assertEquals(urltree.URLConfig(dict(foo='xxx')).get_type('foo'), 'xxx')
    
    def test_get_type_invalid (self) :
        self.assertRaises(KeyError, urltree.URLConfig(dict(foo='xxx')).get_type, 'xxx')

    def test_call (self) :
        config = urltree.URLConfig()
        url = config("foo", None)

        self.assertTrue(isinstance(url, urltree.URL))
        self.assertTrue(url in config.urls)
    
    def test_iter (self) :
        config = urltree.URLConfig()
        url1 = config("foo1", None)
        url2 = config("foo2", None)

        urls = list(config)

        self.assertTrue(urls[0].url_mask == "foo1")
        self.assertTrue(urls[1].url_mask == "foo2")

class TestURL (unittest.TestCase) :
    def setUp (self) :
        self.config = urltree.URLConfig(ignore_extra_args=True)
        self.config_strict = urltree.URLConfig(ignore_extra_args=False)
    
    def _test_label_path (self, mask, *path, **qargs) :
        url = self.config(mask, None)
        
        # right label path
        self.assertEquals(url.label_path, list(path))
        
        # right qargs keys
        self.assertEquals(set(url.query_args), set(qargs))
        
        # right qargs values
        for key, value in qargs.iteritems() :
            self.assertEquals(url.query_args[key], value)

    def test_label_path_empty (self) :
        self._test_label_path("", urltree.EmptyLabel())
    
    def test_label_path_root (self) :
        self._test_label_path("/", urltree.EmptyLabel())

    def test_label_path_static (self) :
        self._test_label_path("/foo", urltree.StaticLabel("foo"))

    def test_label_path_static2 (self) :
        self._test_label_path("/foo/bar/", urltree.StaticLabel("foo"), urltree.StaticLabel("bar"), urltree.EmptyLabel())
    
    def test_label_path_mix (self) :
        self._test_label_path("/foo/{bar}", urltree.StaticLabel("foo"), urltree.SimpleValueLabel("bar", None, None, None))
    
#    def test_query_args_root_empty (self) :
#        self._test_label_path("/?", urltree.EmptyLabel())

    def test_query_args_simple (self) :
        self._test_label_path("/x/?foo", urltree.StaticLabel("x"), foo=(self.config.get_type(None), None))

    def test_query_args_multi (self) :
        self._test_label_path("/x/?foo=0&bar&tee:int=&eee:int", urltree.StaticLabel("x"), 
            foo = (self.config.get_type(None), "0"),
            bar = (self.config.get_type(None), None),
            tee = (self.config.get_type('int'), ''),
            eee = (self.config.get_type('int'), None),
        )
    
    def test_label_path_mutate (self) :
        l = self.config("xxx", None)

        lp = l.get_label_path()

        lp.pop(0)

        self.assertTrue(len(l.label_path) > len(lp))
    
    def _setup_handler (self) :
        def _handler (req, **kwargs) :
            return kwargs

        return _handler
    
    def _setup_execute (self, mask, config) :
        _handler = self._setup_handler()

        url = config(mask, _handler)

        return url
    
    class dummyrequest :
        def __init__ (self, qargs) : self.qargs = qargs
        def get_args (self) : return self.qargs
    
    class dummy_label :
        def __init__ (self, key, type) :
            self.key = key
            self.type = type

    class dummy_labelvalue :
        def __init__ (self, key, value, is_default, type) : 
            self.label = TestURL.dummy_label(key, type)
            self.value = value
            self.is_default = is_default

    def _test_execute (self, mask, values={}, qargs={}, qlist=[], config=None) :
        if not config :
            config = self.config

        # setup
        url = self._setup_execute(mask, config)
        req = self.dummyrequest(qargs.items() + qlist)
        values = [self.dummy_labelvalue(k, v, d, config.get_type()) for k, (v, d) in values.iteritems()]

        # exec
        out_args = url.execute(req, values)
        
        return out_args
        
    def test_execute_empty (self) :
        self.assertEquals(set(self._test_execute("/")), set())

    def test_execute_plain (self) :
        self.assertEquals(set(self._test_execute("/foo")), set())

    def test_execute_simple (self) :
        self.assertEquals(self._test_execute("/foo/{bar}", dict(bar=(0, False))), dict(bar=0))

    def test_execute_multi (self) :
        self.assertEquals(self._test_execute("/foo/{bar}/{quux}", dict(bar=(1, False), quux=(2, False))), dict(bar=1, quux=2))

    def test_execute_default (self) :
        self.assertEquals(self._test_execute("/foo/{bar=0}", dict(bar=("0", True))), dict(bar="0"))
    
    def test_execute_qargs_default (self) :
        self.assertEquals(self._test_execute("/{foo}/?bar=0", dict(foo=("x", False))), dict(foo="x", bar="0"))
    
    def test_execute_qargs_default_type (self) :
        self.assertEquals(self._test_execute("/{foo}/?bar:int=0", dict(foo=("x", False))), dict(foo="x", bar=0))

    def test_execute_qargs_default_none (self) :
        self.assertEquals(self._test_execute("/{foo}/?bar=", dict(foo=("x", False))), dict(foo="x"))

    def test_execute_qargs_missing (self) :
        self.assertRaises(urltree.URLError, self._test_execute, "/{foo}/?bar", dict(foo=("x", False)))

    def test_execute_qargs_invalid (self) :
        self.assertRaises(ValueError, self._test_execute, "/{foo}/?bar:int", dict(foo=("x", False)), dict(bar="x"))

    def test_execute_qargs_simple (self) :
        self.assertEquals(self._test_execute("/{foo}/?bar", dict(foo=("x", False)), dict(bar="y")), dict(foo="x", bar="y"))

    def test_execute_qargs_novalue (self) :
        self.assertRaises(urltree.URLError, self._test_execute, "/{foo}/?bar", dict(foo=("x", False)), dict(bar=''))

    def test_execute_qargs_multi_invalid (self) :
        self.assertRaises(urltree.URLError, self._test_execute, "/{foo}/?bar", dict(foo=("x", False)), qlist=[('bar', 'a'), ('bar', 'b')])

    def test_execute_qargs_multi_list (self) :
        self.assertEqual(self._test_execute("/{foo}/?bar:list", dict(foo=("x", False)), qlist=[('bar', 'a'), ('bar', 'b')]), dict(foo='x', bar=['a', 'b']))

    def test_execute_qarg_override_strict (self) :
        self.assertRaises(urltree.URLError, self._test_execute, "/{foo}", dict(foo=("x1", False)), dict(foo="x2"), config=self.config_strict)

    def test_execute_qarg_override_ignore (self) :
        self.assertEqual(self._test_execute("/{foo}", dict(foo=("x1", False)), dict(foo="x2")), dict(foo="x1"))
        
    def test_execute_qarg_override_ok (self) :
        self.assertEqual(self._test_execute("/{foo=x1}", dict(foo=("x1", True)), dict(foo="x2")), dict(foo="x2"))