review exception
[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 *
6 from tiramisu.option import *
7
8 def make_description():
9     gcoption = ChoiceOption('name', 'GC name', ('ref', 'framework'), 'ref')
10     gcdummy = BoolOption('dummy', 'dummy', default=False)
11     objspaceoption = ChoiceOption('objspace', 'Object space',
12                                 ('std', 'thunk'), 'std')
13     booloption = BoolOption('bool', 'Test boolean option', default=True)
14     intoption = IntOption('int', 'Test int option', default=0)
15     floatoption = FloatOption('float', 'Test float option', default=2.3)
16     stroption = StrOption('str', 'Test string option', default="abc")
17     boolop = BoolOption('boolop', 'Test boolean option op', default=True)
18     wantref_option = BoolOption('wantref', 'Tests', default=False)
19     wantframework_option = BoolOption('wantframework', 'Test', default=False)
20
21     gcgroup = OptionDescription('gc', '', [gcoption, gcdummy, floatoption])
22     descr = OptionDescription('tiramisu', '', [gcgroup, booloption, objspaceoption,
23                                            wantref_option, stroption,
24                                            wantframework_option,
25                                            intoption, boolop])
26     return descr
27
28
29 def test_compare_configs():
30     "config object comparison"
31     descr = make_description()
32     conf1 = Config(descr)
33     conf2 = Config(descr)
34     conf2.wantref = True
35     assert conf1 != conf2
36     assert hash(conf1) != hash(conf2)
37     assert conf1.getkey() != conf2.getkey()
38     conf1.wantref = True
39     assert conf1 == conf2
40     assert hash(conf1) == hash(conf2)
41     assert conf1.getkey() == conf2.getkey()
42 # ____________________________________________________________
43
44 def test_iter_config():
45     "iteration on config object"
46     s = StrOption("string", "", default="string")
47     s2 = StrOption("string2", "", default="string2")
48     descr = OptionDescription("options", "", [s,s2])
49     config = Config(descr)
50     assert [(name, value) for name, value in config] == \
51     [('string', 'string'), ('string2', 'string2')]
52
53 def test_iter_subconfig():
54     "iteration on config sub object"
55     descr = make_description()
56     conf = Config(descr)
57     for (name, value), (gname, gvalue) in \
58         zip(conf.gc, [("name", "ref"), ("dummy", False)]):
59         assert name == gname
60         assert value == gvalue
61
62 def test_cfgimpl_get_value():
63     "same as getattr."
64     descr = make_description()
65     conf = Config(descr)
66     #FIXME
67     #assert conf.cfgimpl_get_value(('gc', 'dummy')) == False
68
69 #____________________________________________________________
70 def test_getpaths():
71     descr = make_description()
72     config = Config(descr)
73
74     assert config.getpaths() == ['gc.name', 'gc.dummy', 'gc.float', 'bool',
75                                  'objspace', 'wantref', 'str', 'wantframework',
76                                  'int', 'boolop']
77     assert config.getpaths() == descr.getpaths()
78     assert config.gc.getpaths() == ['name', 'dummy', 'float']
79     assert config.gc.getpaths() == descr.gc.getpaths()
80     assert config.getpaths(include_groups=True) == [
81         'gc', 'gc.name', 'gc.dummy', 'gc.float',
82         'bool', 'objspace', 'wantref', 'str', 'wantframework', 'int', 'boolop']
83
84     assert config.getpaths(True) == descr.getpaths(True)
85
86 def test_getpaths_with_hidden():
87     objspaceoption = ChoiceOption('objspace', 'Object space',
88                                 ('std', 'thunk'), 'std')
89     booloption = BoolOption('bool', 'Test boolean option', default=True, properties=('hidden',))
90     intoption = IntOption('int', 'Test int option', default=0)
91     stroption = StrOption('str', 'Test string option', default="abc")
92     boolop = BoolOption('boolop', 'Test boolean option op', default=True)
93     wantref_option = BoolOption('wantref', 'Test requires', default=False)
94     wantframework_option = BoolOption('wantframework', 'Test requires',
95                                       default=False)
96
97     descr = OptionDescription('tiramisu', '', [booloption, objspaceoption,
98                                            wantref_option, stroption,
99                                            wantframework_option,
100                                            intoption, boolop])
101
102     config = Config(descr)
103     result = ['bool', 'objspace', 'wantref', 'str', 'wantframework', 'int', 'boolop']
104     assert config.getpaths() == result
105     r2 = ['bool', 'objspace', 'wantref', 'str', 'wantframework', 'int', 'boolop']
106     assert config.getpaths(allpaths=True) == r2
107
108 def test_str():
109     descr = make_description()
110     c = Config(descr)
111     c # does not crash
112
113 #def test_dir():
114 #    descr = make_description()
115 #    c = Config(descr)
116 #    print dir(c)
117
118 def test_make_dict():
119     "serialization of the whole config to a dict"
120     descr = OptionDescription("opt", "", [
121         OptionDescription("s1", "", [
122             BoolOption("a", "", default=False)]),
123         IntOption("int", "", default=42)])
124     config = Config(descr)
125     d = config.make_dict()
126     assert d == {"s1.a": False, "int": 42}
127     config.int = 43
128     config.s1.a = True
129     d = config.make_dict()
130     assert d == {"s1.a": True, "int": 43}
131     d2 = config.make_dict(flatten=True)
132     assert d2 == {'a': True, 'int': 43}
133
134 #def test_delattr():
135 #    "delattr, means suppression of an option in a config"
136 #    descr = OptionDescription("opt", "", [
137 #    OptionDescription("s1", "", [
138 #        BoolOption("a", "", default=False)]),
139 #    IntOption("int", "", default=42)])
140 #    c = Config(descr)
141 #    c.int = 45
142 #    assert c.int == 45
143 #    del c.int
144 #    assert c.int == 42
145 #    c.int = 45
146 #    assert c.int == 45
147
148 def test_find_in_config():
149     "finds option in config"
150     descr = make_description()
151     conf = Config(descr)
152     assert conf.find(byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
153     assert conf.find_first(byname='dummy') == conf.unwrap_from_path('gc.dummy')
154     assert conf.find(bytype=ChoiceOption) == [conf.unwrap_from_path('gc.name'), conf.unwrap_from_path('objspace')]
155     assert conf.find_first(bytype=ChoiceOption) == conf.unwrap_from_path('gc.name')
156     assert conf.find(byvalue='ref') == [conf.unwrap_from_path('gc.name')]
157     assert conf.find_first(byvalue='ref') == conf.unwrap_from_path('gc.name')
158     # combinaison of filters
159     assert conf.find(bytype=BoolOption, byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
160     assert conf.find_first(bytype=BoolOption, byname='dummy') == conf.unwrap_from_path('gc.dummy')
161     assert conf.find(byvalue=False, byname='dummy') == [conf.unwrap_from_path('gc.dummy')]
162     assert conf.find_first(byvalue=False, byname='dummy') == conf.unwrap_from_path('gc.dummy')
163     ## byattrs
164     #assert conf.find_first(byattrs= dict(default=2.3)) == conf.unwrap_from_path('gc.float')
165     #assert conf.find_first(byvalue=False, byname='dummy', byattrs=dict(default=False)) == conf.unwrap_from_path('gc.dummy')
166
167 def test_does_not_find_in_config():
168     descr = make_description()
169     conf = Config(descr)
170     raises(AttributeError, "conf.find(byname='IDontExist')")
171
172 #def test_validator():
173 #    "validates the integrity of an option towards a whole configuration"
174 #    def my_validator_1(config):
175 #        assert config is c
176
177 #    def my_validator_2(config):
178 #        assert config is c
179 #        raise ConflictConfigError
180
181 #    descr = OptionDescription("opt", "", [
182 #        BoolOption('booloption1', 'option test1', default=False,
183 #                   validator=my_validator_1),
184 #        BoolOption('booloption2', 'option test2', default=False,
185 #                   validator=my_validator_2),
186 #        BoolOption('booloption4', 'option test4', default=False,
187 #                   ),
188 #        ])
189 #    c = Config(descr)
190 #    c.booloption1 = True
191 ##    raises(ConfigError, "c.booloption2 = True")
192 ##    assert c.booloption2 is False
193 ##    raises(ConfigError, "c.booloption3 = True")
194 #    assert c.booloption2 is False
195 #    c.booloption4 = True
196 #    assert c.booloption2 is False
197 #    c.booloption2 = False
198 #    assert c.booloption2 is False
199 #