tests on frozen and None value
[tiramisu.git] / tiramisu / option.py
1 # -*- coding: utf-8 -*-
2 "option types and option description for the configuration management"
3 # Copyright (C) 2012 Team tiramisu (see AUTHORS for all contributors)
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18 #
19 # The original `Config` design model is unproudly borrowed from 
20 # the rough pypy's guys: http://codespeak.net/svn/pypy/dist/pypy/config/
21 # the whole pypy projet is under MIT licence
22 # ____________________________________________________________
23 from tiramisu.basetype import HiddenBaseType, DisabledBaseType
24 from tiramisu.error import (ConfigError, ConflictConfigError, NotFoundError, 
25     RequiresError, RequirementRecursionError, MandatoryError)
26 available_actions = ['hide', 'show', 'enable', 'disable', 'freeze', 'unfreeze']
27 reverse_actions = {'hide': 'show', 'show': 'hide', 
28                    'disable': 'enable', 'enable': 'disable',
29                    'freeze': 'unfreeze', 'unfreeze': 'freeze'}
30 # ____________________________________________________________
31 # OptionDescription authorized group_type values
32 group_types = ['default', 'family', 'group', 'master']
33 # ____________________________________________________________
34 # multi types 
35 class Multi(list):
36     "container that support items for the values of list (multi) options" 
37     def __init__(self, lst, config, child):
38         self.config = config
39         self.child = child
40         super(Multi, self).__init__(lst)
41         
42     def __setitem__(self, key, value):
43         return self.setoption(value, key)
44
45     def append(self, value):
46         self.setoption(value)
47    
48     def setoption(self, value, key=None):
49         owners = self.child.getowner(self.config)
50         # None is replaced by default_multi
51         if value == None:
52             defval = self.child.getdefault()
53             if key is not None and len(defval) > key:
54                 value = defval[key]
55             else:
56                 value = self.child.default_multi
57             who = 'default'
58         else:
59             who = self.config._cfgimpl_owner
60             if not self.child._validate(value):
61                 raise ConfigError("invalid value {0} "
62                     "for option {1}".format(str(value), self.child._name))
63         oldvalue = list(self)
64         oldowner = self.child.getowner(self.config)
65         if key is None:
66             ret = super(Multi, self).append(value)
67             oldvalue.append(None)
68             oldowner.append(who)
69         else:
70             ret = super(Multi, self).__setitem__(key, value)
71             oldowner[key] = who
72         self.config._cfgimpl_previous_values[self.child._name] = oldvalue
73         self.child.setowner(self.config, oldowner)
74         return ret
75         
76     def pop(self, key):
77         oldowner = self.child.getowner(self.config)
78         oldowner.pop(key)
79         self.child.setowner(self.config, oldowner)
80         super(Multi, self).pop(key)
81 # ____________________________________________________________
82 #
83 class Option(HiddenBaseType, DisabledBaseType):
84     #reminder: an Option object is **not** a container for the value
85     _frozen = False
86     _force_default_on_freeze = False
87     def __init__(self, name, doc, default=None, default_multi=None, 
88                  requires=None, mandatory=False, multi=False, callback=None, 
89                  callback_params=None):
90         self._name = name
91         self.doc = doc
92         self._requires = requires
93         self._mandatory = mandatory
94         self.multi = multi
95         if not self.multi and default_multi is not None:
96             raise ConfigError("a default_multi is set whereas multi is False"
97                   " in option: {0}".format(name)) 
98         if default_multi is not None and not self._validate(default_multi):
99             raise ConfigError("invalid default_multi value {0} "
100                 "for option {1}".format(str(default_multi), name))
101         self.default_multi = default_multi
102         #if self.multi and default_multi is None:
103             # _cfgimpl_warnings[name] = DefaultMultiWarning   
104         if callback is not None and (default is not None or default_multi is not None):
105             raise ConfigError("defaut values not allowed if option: {0} " 
106                 "is calculated".format(name))
107         self.callback = callback
108         if self.callback is None and callback_params is not None:
109             raise ConfigError("params defined for a callback function but"
110             " no callback defined yet for option {0}".format(name)) 
111         self.callback_params = callback_params
112         if self.multi == True:
113             if default == None:
114                 default = []
115             if not isinstance(default, list) or not self.validate(default):
116                 raise ConfigError("invalid default value {0} "
117                 "for option {1} : not list type".format(str(default), name))
118         else:
119             if default != None and not self.validate(default):
120                 raise ConfigError("invalid default value {0} " 
121                                          "for option {1}".format(str(default), name))
122         self.default = default
123         self.properties = [] # 'hidden', 'disabled'...
124       
125     def validate(self, value):
126         if self.multi == False:
127             # None allows the reset of the value
128             if value != None:
129                 return self._validate(value)
130         else:
131             if not isinstance(value, list): 
132                 raise ConfigError("invalid value {0} " 
133                         "for option {1} which must be a list".format(value,
134                         self._name))
135             for val in value:
136                 if val != None:
137                     # None allows the reset of the value
138                     if not self._validate(val):
139                         return False
140         return True
141
142     def getdefault(self):
143         return self.default
144
145     def is_empty_by_default(self):
146         if ((not self.is_multi() and self.default == None) or
147             (self.is_multi() and self.default == []) or None in self.default):
148             return True
149         return False
150
151     def force_default(self):
152         self._force_default_on_freeze = True
153
154     def hascallback_and_isfrozen():
155         return self._frozen and self.has_callback()
156
157     def is_forced_on_freeze(self):
158         return self._frozen and self._force_default_on_freeze
159
160     def getdoc(self):
161         return self.doc
162
163     def getcallback(self):
164         return self.callback
165     
166     def has_callback(self):
167         if self.callback == None:
168             return False
169         else:
170             return True
171
172     def getcallback_params(self):
173         return self.callback_params
174
175     def setowner(self, config, owner):
176         # config *must* be only the **parent** config (not the toplevel config) 
177         # owner is a **real* owner, a list is actually allowable here
178         name = self._name
179         if self.is_multi():
180             if not type(owner) == list:
181                 raise ConfigError("invalid owner for multi "
182                     "option: {0}".format(name))
183         config._cfgimpl_value_owners[name] = owner
184
185     def getowner(self, config):
186         # config *must* be only the **parent** config (not the toplevel config) 
187         return config._cfgimpl_value_owners[self._name]
188
189     def setoption(self, config, value, who):
190         "who is **not necessarily** a owner because it cannot be a list"
191         name = self._name
192         if not self.validate(value):
193             raise ConfigError('invalid value %s for option %s' % (value, name))
194         if self.is_mandatory():
195             # value shall not be '' for a mandatory option
196             # so '' is considered as being None
197             if not self.is_multi() and value == '':
198                 value = None
199             if self.is_multi() and '' in value:
200                 value = Multi([{'': None}.get(i, i) for i in value], config, self)
201             if config.is_mandatory() and ((self.is_multi() and value == []) or \
202                 (not self.is_multi() and value is None)):
203                 raise MandatoryError('cannot change the value to %s for '
204               'option %s' % (value, name))
205         if name not in config._cfgimpl_values:
206             raise AttributeError('unknown option %s' % (name))
207
208         if config.is_frozen() and self.is_frozen():
209             raise TypeError('cannot change the value to %s for '
210                'option %s' % (str(value), name))
211         if who == "default":
212             # changes the default value (and therefore resets the previous value)
213             if self._validate(value):
214                 self.default = value
215             else:
216                 raise ConfigError("invalid value %s for option %s" % (value, name))
217         apply_requires(self, config)
218         # FIXME put the validation for the multi somewhere else
219 #            # it is a multi **and** it has requires
220 #            if self.multi == True:
221 #                if type(value) != list:
222 #                    raise TypeError("value {0} must be a list".format(value))
223 #                if self._requires is not None:
224 #                    for reqname in self._requires:
225 #                        # FIXME : verify that the slaves are all multi
226 #                        #option = getattr(config._cfgimpl_descr, reqname)
227 #    #                    if not option.multi == True:
228 #    #                        raise ConflictConfigError("an option with requires "
229 #    #                         "has to be a list type : {0}".format(name)) 
230 #                        if len(config._cfgimpl_values[reqname]) != len(value):
231 #                            raise ConflictConfigError("an option with requires "
232 #                             "has not the same length of the others " 
233 #                             "in the group : {0}".format(reqname)) 
234         if type(config._cfgimpl_values[name]) == Multi:
235             config._cfgimpl_previous_values[name] = list(config._cfgimpl_values[name])
236         else:
237             config._cfgimpl_previous_values[name] = config._cfgimpl_values[name] 
238         config._cfgimpl_values[name] = value
239
240     def getkey(self, value):
241         return value
242     # ____________________________________________________________
243     def freeze(self):
244         self._frozen = True
245         return True
246
247     def unfreeze(self):
248         self._frozen = False
249
250     def is_frozen(self):
251         return self._frozen
252     # ____________________________________________________________
253     def is_multi(self):
254         return self.multi
255
256     def is_mandatory(self):
257         return self._mandatory
258         
259 class ChoiceOption(Option):
260     opt_type = 'string'
261     
262     def __init__(self, name, doc, values, default=None,
263                  requires=None, callback=None, callback_params=None,
264                  multi=False, mandatory=False, open_values=False):
265         self.values = values
266         if open_values not in [True, False]:
267             raise ConfigError('Open_values must be a boolean for '
268                               '{0}'.format(name))
269         self.open_values = open_values
270         super(ChoiceOption, self).__init__(name, doc, default=default,
271                            callback=callback, callback_params=callback_params, 
272                            requires=requires, multi=multi, mandatory=mandatory)
273
274     def _validate(self, value):
275         if not self.open_values:
276             return value is None or value in self.values
277         else:
278             return True
279
280 class BoolOption(Option):
281     opt_type = 'bool'
282     
283     def _validate(self, value):
284         return isinstance(value, bool)
285
286 # config level validator             
287 #    def setoption(self, config, value, who):
288 #        name = self._name
289 #        if value and self._validator is not None:
290 #            toplevel = config._cfgimpl_get_toplevel()
291 #            self._validator(toplevel)
292 #        super(BoolOption, self).setoption(config, value, who)
293
294 class IntOption(Option):
295     opt_type = 'int'
296     
297     def _validate(self, value):
298         return isinstance(value, int)
299
300 class FloatOption(Option):
301     opt_type = 'float'
302
303     def _validate(self, value):
304         return isinstance(value, float)
305
306 class StrOption(Option):
307     opt_type = 'string'
308     
309     def _validate(self, value):
310         return isinstance(value, str)
311                                      
312 class SymLinkOption(object):
313     opt_type = 'symlink'
314     
315     def __init__(self, name, path):
316         self._name = name
317         self.path = path 
318     
319     def setoption(self, config, value, who):
320         setattr(config, self.path, value) # .setoption(self.path, value, who)
321
322 class IPOption(Option):
323     opt_type = 'ip'
324     
325     def _validate(self, value):
326         # by now the validation is nothing but a string, use IPy instead
327         return isinstance(value, str)
328                                      
329 class NetmaskOption(Option):
330     opt_type = 'netmask'
331     
332     def _validate(self, value):
333         # by now the validation is nothing but a string, use IPy instead
334         return isinstance(value, str)
335                                      
336 class ArbitraryOption(Option):
337     def __init__(self, name, doc, default=None, defaultfactory=None, 
338                                    requires=None, multi=False, mandatory=False):
339         super(ArbitraryOption, self).__init__(name, doc, requires=requires,
340                                                multi=multi, mandatory=mandatory)
341         self.defaultfactory = defaultfactory
342         if defaultfactory is not None:
343             assert default is None
344
345     def _validate(self, value):
346         return True
347
348     def getdefault(self):
349         if self.defaultfactory is not None:
350             return self.defaultfactory()
351         return self.default
352
353 class OptionDescription(HiddenBaseType, DisabledBaseType):
354     group_type = 'default'
355
356     def __init__(self, name, doc, children, requires=None):
357         self._name = name
358         self.doc = doc
359         self._children = children
360         self._requires = requires
361         self._build()
362         self.properties = [] # 'hidden', 'disabled'...
363         
364     def getdoc(self):
365         return self.doc
366
367     def _build(self):
368         for child in self._children:
369             setattr(self, child._name, child)
370
371     def add_child(self, child):
372         "dynamically adds a configuration option"
373         #Nothing is static. Even the Mona Lisa is falling apart.
374         for ch in self._children:
375             if isinstance(ch, Option):
376                 if child._name == ch._name:
377                     raise ConflictConfigError("existing option : {0}".format(
378                                                                    child._name))
379         self._children.append(child)
380         setattr(self, child._name, child)
381     
382     def update_child(self, child):
383         "modification of an existing option"
384         # XXX : corresponds to the `redefine`, is it usefull 
385         pass
386         
387     def getkey(self, config):
388         return tuple([child.getkey(getattr(config, child._name))
389                       for child in self._children])
390
391     def getpaths(self, include_groups=False, currpath=None):
392         """returns a list of all paths in self, recursively
393            currpath should not be provided (helps with recursion)
394         """
395         if currpath is None:
396             currpath = []
397         paths = []
398         for option in self._children:
399             attr = option._name
400             if attr.startswith('_cfgimpl'):
401                 continue
402             value = getattr(self, attr)
403             if isinstance(value, OptionDescription):
404                 if include_groups:
405                     paths.append('.'.join(currpath + [attr]))
406                 currpath.append(attr)
407                 paths += value.getpaths(include_groups=include_groups,
408                                         currpath=currpath)
409                 currpath.pop()
410             else:
411                 paths.append('.'.join(currpath + [attr]))
412         return paths
413     # ____________________________________________________________
414
415     def set_group_type(self, group_type):
416         if group_type in group_types:
417             self.group_type = group_type
418         else:
419             raise ConfigError('not allowed value for group_type : {0}'.format(
420                               group_type))
421     
422     def get_group_type(self):
423         return self.group_type
424     # ____________________________________________________________
425     def hide(self):
426         super(OptionDescription, self).hide()
427         # FIXME : AND THE SUBCHILDREN ? 
428         for child in self._children:
429             if isinstance(child, OptionDescription):
430                 child.hide()
431     
432     def show(self):
433         # FIXME : AND THE SUBCHILDREN ?? 
434         super(OptionDescription, self).show()
435         for child in self._children:
436             if isinstance(child, OptionDescription):
437                 child.show()
438     # ____________________________________________________________
439     def disable(self):
440         super(OptionDescription, self).disable()
441         # FIXME : AND THE SUBCHILDREN ? 
442         for child in self._children:
443             if isinstance(child, OptionDescription):
444                 child.disable()
445     
446     def enable(self):
447         # FIXME : AND THE SUBCHILDREN ? 
448         super(OptionDescription, self).enable()
449         for child in self._children:
450             if isinstance(child, OptionDescription):
451                 child.enable()
452 # ____________________________________________________________
453 def apply_requires(opt, config):
454     if hasattr(opt, '_requires'):
455         if opt._requires is not None:
456             # malformed requirements
457             rootconfig = config._cfgimpl_get_toplevel()
458             for req in opt._requires:
459                 if not type(req) == tuple and len(req) in (3, 4):
460                     raise RequiresError("malformed requirements for option:"
461                                                    " {0}".format(opt._name))
462             # all actions **must** be identical
463             actions = [req[2] for req in opt._requires]
464             action = actions[0]
465             for act in actions:
466                 if act != action:
467                     raise RequiresError("malformed requirements for option:"
468                                                    " {0}".format(opt._name))
469             # filters the callbacks
470             matches = False
471             for req in opt._requires:
472                 if len(req) == 3:
473                     name, expected, action = req
474                     inverted = False
475                 if len(req) == 4:
476                     name, expected, action, inverted = req
477                     if inverted == 'inverted':
478                         inverted = True
479                 path = config._cfgimpl_get_path() + '.' + opt._name
480                 if name.startswith(path):
481                     raise RequirementRecursionError("malformed requirements imbrication "
482                           "detected for option: '{0}' with requirement on: '{1}'".format(path, name))
483                 homeconfig, shortname = \
484                                       rootconfig._cfgimpl_get_home_by_path(name)
485                 if shortname in homeconfig._cfgimpl_values:
486                     value = homeconfig._cfgimpl_values[shortname]
487                     if (not inverted and value == expected) or \
488                             (inverted and value != expected):
489                         if action not in available_actions:
490                             raise RequiresError("malformed requirements"
491                                            " for option: {0}".format(opt._name))
492                         getattr(opt, action)() #.hide() or show() or...
493                         # FIXME generic programming opt.property_launch(action, False)
494                         matches = True
495                 else: # option doesn't exist ! should not happen...
496                     raise NotFoundError("required option not found: "
497                                                              "{0}".format(name))
498             # no callback has been triggered, then just reverse the action
499             if not matches:
500                 getattr(opt, reverse_actions[action])()
501