add test for impl_get_path_by_opt and impl_get_opt_by_path
[tiramisu.git] / test / test_config.py
1 # -*- coding: utf-8 -*-
2
3 """theses tests are much more to test that config, option description, vs...
4 **it's there** and answers via attribute access"""
5
6 import autopath
7 from py.test import raises
8
9 from tiramisu.config import Config
10 from tiramisu.option import IntOption, FloatOption, StrOption, ChoiceOption, \
11     BoolOption, UnicodeOption, OptionDescription
12 from tiramisu.error import ConflictError
13
14
15 def make_description():
16     gcoption = ChoiceOption('name', 'GC name', ('ref', 'framework'), 'ref')
17     gcdummy = BoolOption('dummy', 'dummy', default=False)
18     objspaceoption = ChoiceOption('objspace', 'Object space',
19                                   ('std', 'thunk'), 'std')
20     booloption = BoolOption('bool', 'Test boolean option', default=True)
21     intoption = IntOption('int', 'Test int option', default=0)
22     floatoption = FloatOption('float', 'Test float option', default=2.3)
23     stroption = StrOption('str', 'Test string option', default="abc", properties=('mandatory', ))
24     boolop = BoolOption('boolop', 'Test boolean option op', default=True)
25     wantref_option = BoolOption('wantref', 'Test requires', default=False)
26     wantframework_option = BoolOption('wantframework', 'Test requires',
27                                       default=False)
28
29     gcgroup = OptionDescription('gc', '', [gcoption, gcdummy, floatoption])
30     descr = OptionDescription('tiram', '', [gcgroup, booloption, objspaceoption,
31                                             wantref_option, stroption,
32                                             wantframework_option,
33                                             intoption, boolop])
34     return descr
35
36
37 def test_base_config():
38     """making a :class:`tiramisu.config.Config()` object
39     and a :class:`tiramisu.option.OptionDescription()` object
40     """
41     gcdummy = BoolOption('dummy', 'dummy', default=False)
42     descr = OptionDescription('tiramisu', '', [gcdummy])
43     cfg = Config(descr)
44     assert cfg.dummy is False
45     dm = cfg.unwrap_from_path('dummy')
46     assert dm._name == 'dummy'
47
48
49 def test_not_config():
50     assert raises(TypeError, "Config('str')")
51
52
53 def test_base_path():
54     gcdummy = BoolOption('dummy', 'dummy', default=False)
55     descr = OptionDescription('tiramisu', '', [gcdummy])
56     cfg = Config(descr)
57     assert cfg._impl_path is None
58     base = OptionDescription('config', '', [descr])
59     cfg = Config(base)
60     assert cfg._impl_path is None
61     assert cfg.tiramisu._impl_path == 'tiramisu'
62     nbase = OptionDescription('baseconfig', '', [base])
63     cfg = Config(nbase)
64     assert cfg._impl_path is None
65     assert cfg.config._impl_path == 'config'
66     assert cfg.config.tiramisu._impl_path == 'config.tiramisu'
67
68
69 def test_reset_value():
70     descr = make_description()
71     cfg = Config(descr)
72     assert cfg.gc.dummy is False
73     cfg.gc.dummy = True
74     assert cfg.gc.dummy is True
75
76
77 def test_base_config_and_groups():
78     descr = make_description()
79     # overrides the booloption default value
80     config = Config(descr)
81     config.bool = False
82     assert config.gc.name == 'ref'
83     assert config.bool is False
84     nm = config.unwrap_from_path('gc.name')
85     assert nm._name == 'name'
86     gc = config.unwrap_from_path('gc')
87     assert gc._name == 'gc'
88     #nm = config.unwrap_from_name('name')
89     #assert nm._name == 'name'
90
91
92 def test_base_config_in_a_tree():
93     "how options are organized into a tree, see :ref:`tree`"
94     descr = make_description()
95     config = Config(descr)
96     config.bool = False
97     assert config.gc.name == 'ref'
98     config.gc.name = 'framework'
99     assert config.gc.name == 'framework'
100     assert getattr(config, "gc.name") == 'framework'
101
102     assert config.objspace == 'std'
103     config.objspace = 'thunk'
104     assert config.objspace == 'thunk'
105
106     assert config.gc.float == 2.3
107     assert config.int == 0
108     config.gc.float = 3.4
109     config.int = 123
110     assert config.gc.float == 3.4
111     assert config.int == 123
112
113     assert not config.wantref
114
115     assert config.str == "abc"
116     config.str = "def"
117     assert config.str == "def"
118
119     raises(AttributeError, 'config.gc.foo = "bar"')
120
121     config = Config(descr)
122     config.bool = False
123     assert config.gc.name == 'ref'
124     config.wantframework = True
125
126
127 def test_cfgimpl_get_home_by_path():
128     " :meth:`tiramisu.config.SubConfig.cfgimpl_get_home_by_path()` to retrieve a path"
129     descr = make_description()
130     config = Config(descr)
131     config.bool = False
132     assert config.cfgimpl_get_home_by_path('gc.dummy')[1] == 'dummy'
133     assert config.cfgimpl_get_home_by_path('dummy')[1] == 'dummy'
134     #assert config.getpaths(include_groups=False) == ['gc.name', 'gc.dummy', 'gc.float', 'bool', 'objspace', 'wantref', 'str', 'wantframework', 'int', 'boolop']
135     #assert config.getpaths(include_groups=True) == ['gc', 'gc.name', 'gc.dummy', 'gc.float', 'bool', 'objspace', 'wantref', 'str', 'wantframework', 'int', 'boolop']
136
137
138 def test_information_config():
139     descr = make_description()
140     config = Config(descr)
141     string = 'some informations'
142     config.impl_set_information('info', string)
143     assert config.impl_get_information('info') == string
144
145
146 def test_config_impl_get_path_by_opt():
147     descr = make_description()
148     config = Config(descr)
149     dummy = config.unwrap_from_path('gc.dummy')
150     boo = config.unwrap_from_path('bool')
151     assert config.cfgimpl_get_description().impl_get_path_by_opt(boo) == 'bool'
152     assert config.cfgimpl_get_description().impl_get_path_by_opt(dummy) == 'gc.dummy'
153
154
155 def test_config_impl_get_opt_by_path():
156     descr = make_description()
157     config = Config(descr)
158     dummy = config.unwrap_from_path('gc.dummy')
159     boo = config.unwrap_from_path('bool')
160     assert config.cfgimpl_get_description().impl_get_opt_by_path('bool') == boo
161     assert config.cfgimpl_get_description().impl_get_opt_by_path('gc.dummy') == dummy
162
163
164 def test_information_display():
165     g1 = IntOption('g1', '', 1)
166     g2 = StrOption('g2', '', 'héhé')
167     g3 = UnicodeOption('g3', '', u'héhé')
168     g4 = BoolOption('g4', '', True)
169     g5 = StrOption('g5', '')
170     d1 = OptionDescription('od', '', [g1, g2, g3, g4, g5])
171     root = OptionDescription('root', '', [d1])
172     config = Config(root)
173     config.od == """g1 = 1
174 g2 = héhé
175 g3 = héhé
176 g4 = True
177 g5 = None"""
178     config == '[od]'
179
180
181 def test_get_modified_values():
182     g1 = IntOption('g1', '', 1)
183     g2 = StrOption('g2', '', 'héhé')
184     g3 = UnicodeOption('g3', '', u'héhé')
185     g4 = BoolOption('g4', '', True)
186     g5 = StrOption('g5', '')
187     d1 = OptionDescription('od', '', [g1, g2, g3, g4, g5])
188     root = OptionDescription('root', '', [d1])
189     config = Config(root)
190     assert config.cfgimpl_get_values().get_modified_values() == {}
191     config.od.g5 = 'yes'
192     assert config.cfgimpl_get_values().get_modified_values() == {'od.g5': ('user', 'yes')}
193     config.od.g4 = True
194     assert config.cfgimpl_get_values().get_modified_values() == {'od.g5': ('user', 'yes'), 'od.g4': ('user', True)}
195
196
197 def test_has_value():
198     g1 = IntOption('g1', '', 1)
199     g2 = StrOption('g2', '', 'héhé')
200     g3 = UnicodeOption('g3', '', u'héhé')
201     g4 = BoolOption('g4', '', True)
202     g5 = StrOption('g5', '')
203     d1 = OptionDescription('od', '', [g1, g2, g3, g4, g5])
204     root = OptionDescription('root', '', [d1])
205     config = Config(root)
206     assert not g5 in config.cfgimpl_get_values()
207     config.od.g5 = 'yes'
208     assert g5 in config.cfgimpl_get_values()
209
210
211 def test_values_not_setitem():
212     g1 = IntOption('g1', '', 1)
213     g2 = StrOption('g2', '', 'héhé')
214     g3 = UnicodeOption('g3', '', u'héhé')
215     g4 = BoolOption('g4', '', True)
216     g5 = StrOption('g5', '')
217     d1 = OptionDescription('od', '', [g1, g2, g3, g4, g5])
218     root = OptionDescription('root', '', [d1])
219     config = Config(root)
220     raises(ValueError, "config.cfgimpl_get_values()[g1] = 2")
221
222
223 def test_duplicated_option():
224     g1 = IntOption('g1', '', 1)
225     #in same OptionDescription
226     raises(ConflictError, "d1 = OptionDescription('od', '', [g1, g1])")
227     d1 = OptionDescription('od1', '', [g1])
228     d2 = OptionDescription('od2', '', [g1])
229     root = OptionDescription('root', '', [d1, d2])
230     #in different OptionDescription
231     raises(ConflictError, "config = Config(root)")