add tests for find()
[tiramisu.git] / test / test_config_api.py
1 "configuration objects global API"
2 import autopath
3 from py.test import raises
4
5 from tiramisu.config import Config
6 from tiramisu.option import IntOption, FloatOption, StrOption, ChoiceOption, \
7     BoolOption, FilenameOption, OptionDescription
8
9
10 def make_description():
11     gcoption = ChoiceOption('name', 'GC name', ('ref', 'framework'), 'ref')
12     gcdummy = BoolOption('dummy', 'dummy', default=False)
13     objspaceoption = ChoiceOption('objspace', 'Object space',
14                                   ('std', 'thunk'), 'std')
15     booloption = BoolOption('bool', 'Test boolean option', default=True)
16     booloption2 = BoolOption('bool', 'Test boolean option', default=True)
17     intoption = IntOption('int', 'Test int option', default=0)
18     floatoption2 = FloatOption('float', 'Test float option', default=2.3)
19     floatoption = FloatOption('float', 'Test float option', default=2.3)
20     stroption = StrOption('str', 'Test string option', default="abc")
21     boolop = BoolOption('boolop', 'Test boolean option op', default=True)
22     wantref_option = BoolOption('wantref', 'Tests', default=False)
23     wantframework_option = BoolOption('wantframework', 'Test', default=False)
24     gcgroup2 = OptionDescription('gc2', '', [booloption2])
25     gcgroup = OptionDescription('gc', '', [gcgroup2, gcoption, gcdummy, floatoption])
26     descr = OptionDescription('tiramisu', '', [gcgroup, booloption, objspaceoption,
27                                                wantref_option, stroption,
28                                                wantframework_option,
29                                                intoption, boolop, floatoption2])
30     return descr
31
32
33 def test_compare_configs():
34     "config object comparison"
35     descr = make_description()
36     conf1 = Config(descr)
37     conf2 = Config(descr)
38     conf2.wantref = True
39     assert conf1 != conf2
40     assert hash(conf1) != hash(conf2)
41     #assert conf1.getkey() != conf2.getkey()
42     conf1.wantref = True
43     assert conf1 == conf2
44     assert hash(conf1) == hash(conf2)
45     #assert conf1.getkey() == conf2.getkey()
46     conf2.gc.dummy = True
47     assert conf1 != conf2
48     assert hash(conf1) != hash(conf2)
49     #assert conf1.getkey() != conf2.getkey()
50     conf1.gc.dummy = True
51     assert conf1 == conf2
52     assert hash(conf1) == hash(conf2)
53     assert not conf1 == 'conf2'
54     assert conf1 != 'conf2'
55 # ____________________________________________________________
56
57
58 def test_iter_config():
59     "iteration on config object"
60     s = StrOption("string", "", default="string")
61     s2 = StrOption("string2", "", default="string2")
62     descr = OptionDescription("options", "", [s, s2])
63     config = Config(descr)
64     assert [(name, value) for name, value in config] == \
65         [('string', 'string'), ('string2', 'string2')]
66
67
68 def test_iter_subconfig():
69     "iteration on config sub object"
70     descr = make_description()
71     conf = Config(descr)
72     for (name, value), (gname, gvalue) in \
73             zip(conf.gc, [("name", "ref"), ("dummy", False)]):
74         assert name == gname
75         assert value == gvalue
76
77
78 def test_str():
79     descr = make_description()
80     c = Config(descr)
81     c  # does not crash
82
83
84 def test_make_dict():
85     "serialization of the whole config to a dict"
86     descr = OptionDescription("opt", "", [
87         OptionDescription("s1", "", [
88             BoolOption("a", "", default=False)]),
89         IntOption("int", "", default=42)])
90     config = Config(descr)
91     d = config.make_dict()
92     assert d == {"s1.a": False, "int": 42}
93     config.int = 43
94     config.s1.a = True
95     d = config.make_dict()
96     assert d == {"s1.a": True, "int": 43}
97     d2 = config.make_dict(flatten=True)
98     assert d2 == {'a': True, 'int': 43}
99     raises(ValueError, 'd2 = config.make_dict(withvalue="3")')
100
101
102 def test_find_in_config():
103     "finds option in config"
104     descr = make_description()
105     conf = Config(descr)
106     assert conf.find(byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
107     assert conf.find(byname='float') == [conf.unwrap_from_path('gc.float'), conf.unwrap_from_path('float')]
108     assert conf.find_first(byname='bool') == conf.unwrap_from_path('gc.gc2.bool')
109     assert conf.find_first(byname='dummy') == conf.unwrap_from_path('gc.dummy')
110     assert conf.find_first(byname='float') == conf.unwrap_from_path('gc.float')
111     assert conf.find(bytype=ChoiceOption) == [conf.unwrap_from_path('gc.name'), conf.unwrap_from_path('objspace')]
112     assert conf.find_first(bytype=ChoiceOption) == conf.unwrap_from_path('gc.name')
113     assert conf.find(byvalue='ref') == [conf.unwrap_from_path('gc.name')]
114     assert conf.find_first(byvalue='ref') == conf.unwrap_from_path('gc.name')
115     # combinaison of filters
116     assert conf.find(bytype=BoolOption, byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
117     assert conf.find_first(bytype=BoolOption, byname='dummy') == conf.unwrap_from_path('gc.dummy')
118     assert conf.find(byvalue=False, byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
119     assert conf.find_first(byvalue=False, byname='dummy') == conf.unwrap_from_path('gc.dummy')
120     #subconfig
121     assert conf.gc.find(byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
122     assert conf.gc.find(byname='float') == [conf.unwrap_from_path('gc.float')]
123     assert conf.gc.find(byname='bool') == [conf.unwrap_from_path('gc.gc2.bool')]
124     raises(AttributeError, "conf.gc.find(byname='wantref').first()")
125     # not OptionDescription
126     raises(AttributeError, "conf.find_first(byname='gc')")
127     raises(AttributeError, "conf.gc.find_first(byname='gc2')")
128
129
130 def test_find_multi():
131     b = BoolOption('bool', '', multi=True)
132     o = OptionDescription('od', '', [b])
133     conf = Config(o)
134     raises(AttributeError, "conf.find(byvalue=True)")
135     raises(AttributeError, "conf.find_first(byvalue=True)")
136     conf.bool.append(False)
137     raises(AttributeError, "conf.find(byvalue=True)")
138     raises(AttributeError, "conf.find_first(byvalue=True)")
139     conf.bool.append(False)
140     raises(AttributeError, "conf.find(byvalue=True)")
141     raises(AttributeError, "conf.find_first(byvalue=True)")
142     conf.bool.append(True)
143     assert conf.find(byvalue=True) == [b]
144     assert conf.find_first(byvalue=True) == b
145
146
147 def test_does_not_find_in_config():
148     descr = make_description()
149     conf = Config(descr)
150     raises(AttributeError, "conf.find(byname='IDontExist')")
151
152
153 def test_filename():
154     a = FilenameOption('a', '')
155     o = OptionDescription('o', '', [a])
156     c = Config(o)
157     c.a = u'/'
158     c.a = u'/tmp'
159     c.a = u'/tmp/'
160     c.a = u'/tmp/text.txt'
161     c.a = u'tmp'
162     c.a = u'tmp/'
163     c.a = u'tmp/text.txt'
164     raises(ValueError, "c.a = u'/tmp/with space.txt'")
165     raises(ValueError, "c.a = u'/tmp/with$.txt'")