Infra
/
tiramisu
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

better error messages

This commit is contained in:
Emmanuel Garette 2016-09-11 16:18:23 +02:00
parent 3a5b1090c7
commit c21949c637
2 changed files with 45 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
tiramisu/option/baseoption.py
View File

@ -490,8 +490,15 @@ class Option(OnlyOption):
'submulti_index: {2}'.format(_value, _index, 'submulti_index: {2}'.format(_value, _index,
submulti_index), submulti_index),
exc_info=True) exc_info=True)
return ValueError(_('invalid value for option {0}: {1}' if '{0}'.format(err):
'').format(self.impl_getname(), err)) msg = _('{0} is an invalid {1} for option {2}: {3}'
'').format(_value, self.display_name,
self.impl_getname(), err)
else:
msg = _('{0} is an invalid {1} for option {2}'
'').format(_value, self.display_name,
self.impl_getname())
return ValueError(msg)
warning = None warning = None
error = calculation_validator(_value) error = calculation_validator(_value)
if not error: if not error:
@ -515,16 +522,23 @@ class Option(OnlyOption):
else: else:
return ret return ret
if warning: if warning:
msg = _("warning on the value of the option {0}: {1}").format( msg = _("attention, {0} could be an invalid {1} for option {2}: {3}").format(
self.impl_getname(), warning) _value, self.display_name, self.impl_getname(), warning)
if context is undefined or 'warnings' in \ if context is undefined or 'warnings' in \
context.cfgimpl_get_settings(): context.cfgimpl_get_settings():
warnings.warn_explicit(ValueWarning(msg, self), warnings.warn_explicit(ValueWarning(msg, self),
ValueWarning, ValueWarning,
self.__class__.__name__, 0) self.__class__.__name__, 0)
elif error: elif error:
return ValueError(_("invalid value for option {0}: {1}").format( if '{0}'.format(err):
self.impl_getname(), error)) msg = _("{0} is an invalid {1} for option {2}: {3}"
"").format(_value, self.display_name,
self.impl_getname(), error)
else:
msg = _("{0} is an invalid {1} for option {2}"
"").format(_value, self.display_name,
self.impl_getname())
return ValueError(msg)
# generic calculation # generic calculation
#if context is not undefined: #if context is not undefined:
@ -568,7 +582,7 @@ class Option(OnlyOption):
return err return err
else: else:
return self._valid_consistency(current_opt, None, context, return self._valid_consistency(current_opt, None, context,
None, None) None, None)
def impl_is_master_slaves(self, type_='both'): def impl_is_master_slaves(self, type_='both'):
"""FIXME """FIXME

32
tiramisu/option/option.py
View File

@ -37,6 +37,7 @@ class ChoiceOption(Option):
The option can also have the value ``None`` The option can also have the value ``None``
""" """
__slots__ = tuple() __slots__ = tuple()
display_name = _('choice')
def __init__(self, name, doc, values, default=None, def __init__(self, name, doc, values, default=None,
values_params=None, default_multi=None, requires=None, values_params=None, default_multi=None, requires=None,
@ -108,6 +109,7 @@ class ChoiceOption(Option):
class BoolOption(Option): class BoolOption(Option):
"represents a choice between ``True`` and ``False``" "represents a choice between ``True`` and ``False``"
__slots__ = tuple() __slots__ = tuple()
display_name = _('boolean')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -118,6 +120,7 @@ class BoolOption(Option):
class IntOption(Option): class IntOption(Option):
"represents a choice of an integer" "represents a choice of an integer"
__slots__ = tuple() __slots__ = tuple()
display_name = _('integer')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -128,6 +131,7 @@ class IntOption(Option):
class FloatOption(Option): class FloatOption(Option):
"represents a choice of a floating point number" "represents a choice of a floating point number"
__slots__ = tuple() __slots__ = tuple()
display_name = _('float')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -138,6 +142,7 @@ class FloatOption(Option):
class StrOption(Option): class StrOption(Option):
"represents the choice of a string" "represents the choice of a string"
__slots__ = tuple() __slots__ = tuple()
display_name = _('string')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -155,6 +160,7 @@ else:
"represents the choice of a unicode string" "represents the choice of a unicode string"
__slots__ = tuple() __slots__ = tuple()
_empty = u'' _empty = u''
display_name = _('string')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -165,6 +171,7 @@ else:
class PasswordOption(Option): class PasswordOption(Option):
"represents the choice of a password" "represents the choice of a password"
__slots__ = tuple() __slots__ = tuple()
display_name = _('password')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -176,6 +183,7 @@ class PasswordOption(Option):
class IPOption(Option): class IPOption(Option):
"represents the choice of an ip" "represents the choice of an ip"
__slots__ = tuple() __slots__ = tuple()
display_name = _('IP')
def __init__(self, name, doc, default=None, default_multi=None, def __init__(self, name, doc, default=None, default_multi=None,
requires=None, multi=False, callback=None, requires=None, multi=False, callback=None,
@ -204,29 +212,29 @@ class IPOption(Option):
if err: if err:
return err return err
if value.count('.') != 3: if value.count('.') != 3:
return ValueError(_('invalid IP')) return ValueError()
for val in value.split('.'): for val in value.split('.'):
if val.startswith("0") and len(val) > 1: if val.startswith("0") and len(val) > 1:
return ValueError(_('invalid IP')) # pragma: optional cover return ValueError() # pragma: optional cover
# 'standard' validation # 'standard' validation
try: try:
IP('{0}/32'.format(value)) IP('{0}/32'.format(value))
except ValueError: # pragma: optional cover except ValueError: # pragma: optional cover
return ValueError(_('invalid IP')) return ValueError()
def _second_level_validation(self, value, warnings_only): def _second_level_validation(self, value, warnings_only):
ip = IP('{0}/32'.format(value)) ip = IP('{0}/32'.format(value))
if not self._get_extra('_allow_reserved') and ip.iptype() == 'RESERVED': # pragma: optional cover if not self._get_extra('_allow_reserved') and ip.iptype() == 'RESERVED': # pragma: optional cover
if warnings_only: if warnings_only:
msg = _("IP is in reserved class") msg = _("shouldn't in reserved class")
else: else:
msg = _("invalid IP, mustn't be in reserved class") msg = _("mustn't be in reserved class")
return ValueError(msg) return ValueError(msg)
if self._get_extra('_private_only') and not ip.iptype() == 'PRIVATE': # pragma: optional cover if self._get_extra('_private_only') and not ip.iptype() == 'PRIVATE': # pragma: optional cover
if warnings_only: if warnings_only:
msg = _("IP is not in private class") msg = _("should be in private class")
else: else:
msg = _("invalid IP, must be in private class") msg = _("must be in private class")
return ValueError(msg) return ValueError(msg)
def _cons_in_network(self, opts, vals, warnings_only): def _cons_in_network(self, opts, vals, warnings_only):
@ -260,6 +268,7 @@ class PortOption(Option):
""" """
__slots__ = tuple() __slots__ = tuple()
port_re = re.compile(r"^[0-9]*$") port_re = re.compile(r"^[0-9]*$")
display_name = _('port')
def __init__(self, name, doc, default=None, default_multi=None, def __init__(self, name, doc, default=None, default_multi=None,
requires=None, multi=False, callback=None, requires=None, multi=False, callback=None,
@ -290,7 +299,6 @@ class PortOption(Option):
if extra['_max_value'] is None: if extra['_max_value'] is None:
raise ValueError(_('max value is empty')) # pragma: optional cover raise ValueError(_('max value is empty')) # pragma: optional cover
super(PortOption, self).__init__(name, doc, default=default, super(PortOption, self).__init__(name, doc, default=default,
default_multi=default_multi, default_multi=default_multi,
callback=callback, callback=callback,
@ -337,6 +345,7 @@ class PortOption(Option):
class NetworkOption(Option): class NetworkOption(Option):
"represents the choice of a network" "represents the choice of a network"
__slots__ = tuple() __slots__ = tuple()
display_name = _('network')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -366,6 +375,7 @@ class NetworkOption(Option):
class NetmaskOption(Option): class NetmaskOption(Option):
"represents the choice of a netmask" "represents the choice of a netmask"
__slots__ = tuple() __slots__ = tuple()
display_name = _('netmask')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -422,6 +432,7 @@ class NetmaskOption(Option):
class BroadcastOption(Option): class BroadcastOption(Option):
__slots__ = tuple() __slots__ = tuple()
display_name = _('broadcast')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -454,6 +465,7 @@ class DomainnameOption(Option):
fqdn: with tld, not supported yet fqdn: with tld, not supported yet
""" """
__slots__ = tuple() __slots__ = tuple()
display_name = _('domain name')
def __init__(self, name, doc, default=None, default_multi=None, def __init__(self, name, doc, default=None, default_multi=None,
requires=None, multi=False, callback=None, requires=None, multi=False, callback=None,
@ -552,6 +564,7 @@ class DomainnameOption(Option):
class EmailOption(DomainnameOption): class EmailOption(DomainnameOption):
__slots__ = tuple() __slots__ = tuple()
username_re = re.compile(r"^[\w!#$%&'*+\-/=?^`{|}~.]+$") username_re = re.compile(r"^[\w!#$%&'*+\-/=?^`{|}~.]+$")
display_name = _('email')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -577,6 +590,7 @@ class URLOption(DomainnameOption):
__slots__ = tuple() __slots__ = tuple()
proto_re = re.compile(r'(http|https)://') proto_re = re.compile(r'(http|https)://')
path_re = re.compile(r"^[A-Za-z0-9\-\._~:/\?#\[\]@!%\$&\'\(\)\*\+,;=]+$") path_re = re.compile(r"^[A-Za-z0-9\-\._~:/\?#\[\]@!%\$&\'\(\)\*\+,;=]+$")
display_name = _('URL')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -624,6 +638,7 @@ class UsernameOption(Option):
__slots__ = tuple() __slots__ = tuple()
#regexp build with 'man 8 adduser' informations #regexp build with 'man 8 adduser' informations
username_re = re.compile(r"^[a-z_][a-z0-9_-]{0,30}[$a-z0-9_-]{0,1}$") username_re = re.compile(r"^[a-z_][a-z0-9_-]{0,30}[$a-z0-9_-]{0,1}$")
display_name = _('username')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):
@ -638,6 +653,7 @@ class UsernameOption(Option):
class FilenameOption(Option): class FilenameOption(Option):
__slots__ = tuple() __slots__ = tuple()
path_re = re.compile(r"^[a-zA-Z0-9\-\._~/+]+$") path_re = re.compile(r"^[a-zA-Z0-9\-\._~/+]+$")
display_name = _('file name')
def _validate(self, value, context=undefined, current_opt=undefined, def _validate(self, value, context=undefined, current_opt=undefined,
returns_raise=False): returns_raise=False):