suppression of the notion of normal and expert mode
[tiramisu.git] / test / test_option_setting.py
1 "config.set() or config.setoption() or option.setoption()"
2 import autopath
3 from py.test import raises
4
5 from tiramisu.config import *
6 from tiramisu.option import *
7 from tiramisu.error import *
8
9 def make_description():
10     gcoption = ChoiceOption('name', 'GC name', ['ref', 'framework'], 'ref')
11     gcdummy = BoolOption('dummy', 'dummy', default=False)
12     objspaceoption = ChoiceOption('objspace', 'Object space',
13                                 ['std', 'thunk'], 'std')
14     booloption = BoolOption('bool', 'Test boolean option', default=True)
15     intoption = IntOption('int', 'Test int option', default=0)
16     floatoption = FloatOption('float', 'Test float option', default=2.3)
17     stroption = StrOption('str', 'Test string option', default="abc")
18     boolop = BoolOption('boolop', 'Test boolean option op', default=True)
19     wantref_option = BoolOption('wantref', 'Test requires', default=False)
20     wantframework_option = BoolOption('wantframework', 'Test requires',
21                                       default=False)    
22     gcgroup = OptionDescription('gc', '', [gcoption, gcdummy, floatoption])
23     descr = OptionDescription('tiramisu', '', [gcgroup, booloption, objspaceoption,
24                                            wantref_option, stroption,
25                                            wantframework_option,
26                                            intoption, boolop])
27     return descr
28 #____________________________________________________________
29 # change with __setattr__
30 def test_attribute_access():
31     "Once set, option values can't be changed again by attribute access"
32     s = StrOption("string", "", default="string")
33     descr = OptionDescription("options", "", [s])
34     config = Config(descr)
35     # let's try to change it again
36     config.string = "foo"
37     assert config.string == "foo"
38
39 def test_setitem():
40     s = StrOption("string", "", default=["string", "sdfsdf"], default_multi="prout", multi=True)
41     descr = OptionDescription("options", "", [s])
42     config = Config(descr)
43     print config.string[1]
44     config.string[1] = "titi"
45     print config.string[1]
46     
47 def test_reset():
48     "if value is None, resets to default owner"
49     s = StrOption("string", "", default="string")
50     descr = OptionDescription("options", "", [s])
51     config = Config(descr)
52     config.string = "foo"
53     assert config.string == "foo"
54     assert config._cfgimpl_value_owners['string'] == 'user'
55     config.string = None
56     assert config.string == 'string'
57     assert config._cfgimpl_value_owners['string'] == 'default'
58
59 def test_reset_with_multi():
60     s = StrOption("string", "", default=["string"], default_multi="string" , multi=True)
61     descr = OptionDescription("options", "", [s])
62     config = Config(descr)
63     config.string = []
64     assert config.string == ["string"]
65     assert config._cfgimpl_value_owners['string'] == ['default']
66     config.string = ["eggs", "spam", "foo"]
67     assert config._cfgimpl_value_owners['string'] == ['user', 'user', 'user']
68     config.string = []
69     assert config.string == ["string"]
70     assert config._cfgimpl_value_owners['string'] == ['default']
71     raises(ConfigError, "config.string = None")
72
73 def test_default_with_multi():
74     "default with multi is a list"
75     s = StrOption("string", "", default=[], default_multi="string" , multi=True)
76     descr = OptionDescription("options", "", [s])
77     config = Config(descr)
78     assert config.string == []
79     s = StrOption("string", "", default=None, default_multi="string" , multi=True)
80     descr = OptionDescription("options", "", [s])
81     config = Config(descr)
82     assert config.string == []
83     
84 def test_idontexist():
85     descr = make_description()
86     cfg = Config(descr)
87     raises(AttributeError, "cfg.idontexist")
88 # ____________________________________________________________
89 def test_attribute_access_with_multi():
90     s = StrOption("string", "", default=["string"], default_multi= "string" , multi=True)
91     descr = OptionDescription("options", "", [s])
92     config = Config(descr)
93     config.string = ["foo", "bar"]
94     assert config.string == ["foo", "bar"]
95
96 def test_item_access_with_multi():
97     s = StrOption("string", "", default=["string"], multi=True)
98     descr = OptionDescription("options", "", [s])
99     config = Config(descr)
100     config.string = ["foo", "bar"]
101     assert config.string == ["foo", "bar"]
102     assert config.string[0] == "foo"
103     # FIXME
104     config.string[0] = 'changetest'
105 #    assert config.string[0] == 'changetest'
106 #    assert config.string[
107
108 def test_access_with_multi_default():
109     s = StrOption("string", "", default=["string"], multi=True)
110     descr = OptionDescription("options", "", [s])
111     config = Config(descr)
112     assert config._cfgimpl_value_owners["string"] == ['default']
113     config.string = ["foo", "bar"]
114     assert config.string == ["foo", "bar"]
115     assert config._cfgimpl_value_owners["string"] == ['user', 'user']
116
117 #def test_attribute_access_with_multi2():
118 #    s = StrOption("string", "", default="string", multi=True)
119 #    descr = OptionDescription("options", "", [s])
120 #    config = Config(descr)
121 #    config.string = ["foo", "bar"]
122 #    assert config.string == ["foo", "bar"]
123
124 def test_multi_with_requires():
125     s = StrOption("string", "", default=["string"], default_multi="string", multi=True)
126     intoption = IntOption('int', 'Test int option', default=0)
127     stroption = StrOption('str', 'Test string option', default=["abc"], default_multi = "abc", 
128                           requires=[('int', 1, 'hide')], multi=True)
129     descr = OptionDescription("options", "", [s, intoption, stroption])
130     config = Config(descr)
131     assert stroption._is_hidden() == False
132     config.int = 1
133     raises(HiddenOptionError, "config.str = ['a', 'b']")
134     assert stroption._is_hidden()
135
136 def test__requires_with_inverted():
137     s = StrOption("string", "", default=["string"], multi=True)
138     intoption = IntOption('int', 'Test int option', default=0)
139     stroption = StrOption('str', 'Test string option', default=["abc"], default_multi = "abc",
140                           requires=[('int', 1, 'hide', 'inverted')], multi=True)
141     descr = OptionDescription("options", "", [s, intoption, stroption])
142     config = Config(descr)
143     assert stroption._is_hidden() == False
144     config.int = 1
145     assert stroption._is_hidden() == False
146
147 def test_multi_with_requires_in_another_group():
148     s = StrOption("string", "", default=["string"], multi=True)
149     intoption = IntOption('int', 'Test int option', default=0)
150     descr = OptionDescription("options", "", [intoption])
151     stroption = StrOption('str', 'Test string option', default=["abc"], 
152                           requires=[('int', 1, 'hide')], multi=True)
153     descr = OptionDescription("opt", "", [stroption])
154     descr2 = OptionDescription("opt2", "", [intoption, s, descr])
155     config = Config(descr2)
156     assert stroption._is_hidden() == False
157     config.int = 1
158     raises(HiddenOptionError,  "config.opt.str = ['a', 'b']")
159     assert stroption._is_hidden()
160
161 def test_apply_requires_from_config():
162     s = StrOption("string", "", default=["string"], multi=True)
163     intoption = IntOption('int', 'Test int option', default=0)
164     descr = OptionDescription("options", "", [intoption])
165     stroption = StrOption('str', 'Test string option', default=["abc"], 
166                           requires=[('int', 1, 'hide')], multi=True)
167     descr = OptionDescription("opt", "", [stroption])
168     descr2 = OptionDescription("opt2", "", [intoption, s, descr])
169     config = Config(descr2)
170     assert stroption._is_hidden() == False
171     config.int = 1
172     try:
173         config.opt.str
174     except:
175         pass 
176     assert stroption._is_hidden()
177     
178
179 def test_apply_requires_with_disabled():
180     s = StrOption("string", "", default=["string"], multi=True)
181     intoption = IntOption('int', 'Test int option', default=0)
182     descr = OptionDescription("options", "", [intoption])
183     stroption = StrOption('str', 'Test string option', default=["abc"], 
184                           requires=[('int', 1, 'disable')], multi=True)
185     descr = OptionDescription("opt", "", [stroption])
186     descr2 = OptionDescription("opt2", "", [intoption, s, descr])
187     config = Config(descr2)
188     assert stroption._is_disabled() == False
189     config.int = 1
190     try:
191         config.opt.str
192     except:
193         pass 
194     assert stroption._is_disabled()
195
196 def test_multi_with_requires_with_disabled_in_another_group():
197     s = StrOption("string", "", default=["string"], multi=True)
198     intoption = IntOption('int', 'Test int option', default=0)
199     descr = OptionDescription("options", "", [intoption])
200     stroption = StrOption('str', 'Test string option', default=["abc"], 
201                           requires=[('int', 1, 'disable')], multi=True)
202     descr = OptionDescription("opt", "", [stroption])
203     descr2 = OptionDescription("opt2", "", [intoption, s, descr])
204     config = Config(descr2)
205     assert stroption._is_disabled() == False
206     config.int = 1
207     raises(DisabledOptionError,  "config.opt.str = ['a', 'b']")
208     assert stroption._is_disabled()
209
210 def test_multi_with_requires_that_is_multi():
211     s = StrOption("string", "", default=["string"], multi=True)
212     intoption = IntOption('int', 'Test int option', default=[0], multi=True)
213     stroption = StrOption('str', 'Test string option', default=["abc"], 
214                           requires=[('int', [1, 1], 'hide')], multi=True)
215     descr = OptionDescription("options", "", [s, intoption, stroption])
216     config = Config(descr)
217     assert stroption._is_hidden() == False
218     config.int = [1, 1]
219     raises(HiddenOptionError, "config.str = ['a', 'b']")
220     assert stroption._is_hidden()
221
222 def test_multi_with_bool():
223     s = BoolOption("bool", "", default=[False], multi=True)
224     descr = OptionDescription("options", "", [s])
225     config = Config(descr)
226     assert descr.bool.multi == True
227     config.bool = [True, False]
228     assert config._cfgimpl_values['bool'] == [True, False]
229     assert config.bool == [True, False]
230
231 def test_multi_with_bool_two():
232     s = BoolOption("bool", "", default=[False], multi=True)
233     descr = OptionDescription("options", "", [s])
234     config = Config(descr)
235     assert descr.bool.multi == True
236     raises(ConfigError, "config.bool = True")
237
238 def test_choice_access_with_multi():
239     ch = ChoiceOption("t1", "", ["a", "b"], default=["a"], multi=True)
240     descr = OptionDescription("options", "", [ch])
241     config = Config(descr)
242     config.t1 = ["a", "b", "a", "b"]
243     assert config.t1 == ["a", "b", "a", "b"]
244 # ____________________________________________________________
245
246 def test_setoption_from_option():
247     "a setoption directly from the option is **not** a good practice"
248     booloption = BoolOption('bool', 'Test boolean option', default=True)
249     descr = OptionDescription('descr', '', [booloption])
250     cfg = Config(descr)
251     booloption.setoption(cfg, False, 'owner')
252     assert cfg.bool == False
253 #____________________________________________________________
254 def test_dwim_set():
255     descr = OptionDescription("opt", "", [
256         OptionDescription("sub", "", [
257             BoolOption("b1", ""),
258             ChoiceOption("c1", "", ['a', 'b', 'c'], 'a'),
259             BoolOption("d1", ""),
260         ]),
261         BoolOption("b2", ""),
262         BoolOption("d1", ""),
263     ])
264     c = Config(descr)
265     c.set(b1=False, c1='b')
266     assert not c.sub.b1
267     assert c.sub.c1 == 'b'
268     # new config, because you cannot change values once they are set
269     c = Config(descr)
270     c.set(b2=False, **{'sub.c1': 'c'})
271     assert not c.b2
272     assert c.sub.c1 == 'c'
273     raises(AmbigousOptionError, "c.set(d1=True)")
274     raises(NoMatchingOptionFound, "c.set(unknown='foo')")
275
276 def test_more_set():
277     descr = OptionDescription("opt", "", [
278         OptionDescription("s1", "", [
279             BoolOption("a", "", default=False)]),
280         IntOption("int", "", default=42)])
281     d = {'s1.a': True, 'int': 23}
282     config = Config(descr)
283     config.set(**d)
284     assert config.s1.a
285     assert config.int == 23
286
287 def test_set_with_hidden_option():
288     boolopt = BoolOption("a", "", default=False)
289     boolopt.hide()
290     descr = OptionDescription("opt", "", [
291         OptionDescription("s1", "", [boolopt]),
292         IntOption("int", "", default=42)])
293     d = {'s1.a': True, 'int': 23}
294     config = Config(descr)
295     raises(HiddenOptionError, "config.set(**d)")
296
297 def test_set_with_unknown_option():
298     boolopt = BoolOption("b", "", default=False)
299     descr = OptionDescription("opt", "", [
300         OptionDescription("s1", "", [boolopt]),
301         IntOption("int", "", default=42)])
302     d = {'s1.a': True, 'int': 23}
303     config = Config(descr)
304     raises(NoMatchingOptionFound, "config.set(**d)")
305
306
307 def test_set_symlink_option():
308     boolopt = BoolOption("b", "", default=False)
309     linkopt = SymLinkOption("c", "s1.b")
310     descr = OptionDescription("opt", "", 
311                               [linkopt, OptionDescription("s1", "", [boolopt])])
312     config = Config(descr)
313     setattr(config, "s1.b", True)
314     setattr(config, "s1.b", False)
315     assert config.s1.b == False
316     assert config.c == False
317     config.c = True
318     assert config.s1.b == True
319     assert config.c == True
320     config.c = False
321     assert config.s1.b == False
322     assert config.c == False
323     
324 #____________________________________________________________
325 def test_config_impl_values():
326     descr = make_description()
327     config = Config(descr, bool=False)
328 #    gcdummy.setoption(config, True, "user")
329 #    config.setoption("gc.dummy", True, "user")
330     #config.gc.dummy = True
331 #    config.setoption("bool", False, "user")
332     config.set(dummy=False)
333     assert config.gc._cfgimpl_values == {'dummy': False, 'float': 2.3, 'name': 'ref'}
334     ## acces to the option object 
335 #    config.gc._cfgimpl_descr.dummy.setoption(config, True, "user")
336     assert config.gc.dummy == False
337 #    config.set(dummy=True)
338 #    assert config.gc.dummy == True
339
340 #____________________________________________________________
341 def test_accepts_multiple_changes_from_option():
342     s = StrOption("string", "", default="string")
343     descr = OptionDescription("options", "", [s])
344     config = Config(descr)
345     config.string = "egg"
346     assert s.getdefault() == "string"
347     assert config.string == "egg"
348     s.setoption(config, 'blah', "default")
349     assert s.getdefault() == "blah"
350     assert config.string == "blah"
351     s.setoption(config, 'bol', "user")
352     assert config.string == 'bol'
353     config.override({'string': "blurp"})
354     assert config.string == 'blurp'
355     assert s.getdefault() == 'blurp'
356
357 def test_allow_multiple_changes_from_config():
358     """
359     a `setoption` from the config object is much like the attribute access, 
360     except the fact that value owner can bet set 
361     """
362     s = StrOption("string", "", default="string")
363     s2 = StrOption("string2", "", default="string")
364     suboption = OptionDescription("bip", "", [s2])
365     descr = OptionDescription("options", "", [s, suboption])
366     config = Config(descr)
367     config.setoption("string", 'blah', "user")
368     config.setoption("string", "oh", "user")    
369     assert config.string == "oh"
370     config.set(string2= 'blah')
371     assert config.bip.string2 == 'blah'
372 # ____________________________________________________________
373
374 def test_overrides_are_defaults():
375     descr = OptionDescription("test", "", [
376         BoolOption("b1", "", default=False),
377         BoolOption("b2", "", default=False),
378         ])
379     # overrides here
380     config = Config(descr, b2=True)
381     assert config.b2
382     # test with a require
383     config.b1 = True
384     assert config.b2
385  
386  # ____________________________________________________________
387  # accessing a value by the get method
388 def test_access_by_get():
389     descr = make_description()
390     cfg = Config(descr)
391     raises(NotFoundError, "cfg.get('idontexist')" )
392     assert cfg.get('wantref') == False
393     assert cfg.gc.dummy == False
394     assert cfg.get('dummy') == False
395
396 def test_access_by_get_whith_hide():
397     b1 = BoolOption("b1", "")
398     b1.hide()
399     descr = OptionDescription("opt", "", [
400     OptionDescription("sub", "", [
401         b1,
402         ChoiceOption("c1", "", ['a', 'b', 'c'], 'a'),
403         BoolOption("d1", ""),
404     ]),
405     BoolOption("b2", ""),
406     BoolOption("d1", ""),
407     ])
408     c = Config(descr)
409     raises(HiddenOptionError, "c.get('b1')")
410