tosca2heat/tosca-parser/toscaparser/common/exception.py

   1 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   2 #    not use this file except in compliance with the License. You may obtain
   3 #    a copy of the License at
   4 #
   5 #         http://www.apache.org/licenses/LICENSE-2.0
   6 #
   7 #    Unless required by applicable law or agreed to in writing, software
   8 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   9 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  10 #    License for the specific language governing permissions and limitations
  11 #    under the License.
  12
  13 '''
  14 TOSCA exception classes
  15 '''
  16 import logging
  17 import sys
  18 import traceback
  19
  20 from toscaparser.utils.gettextutils import _
  21
  22
  23 log = logging.getLogger(__name__)
  24
  25
  26 class TOSCAException(Exception):
  27     '''Base exception class for TOSCA
  28
  29     To correctly use this class, inherit from it and define
  30     a 'msg_fmt' property.
  31
  32     '''
  33
  34     _FATAL_EXCEPTION_FORMAT_ERRORS = False
  35
  36     message = _('An unknown exception occurred.')
  37
  38     def __init__(self, **kwargs):
  39         try:
  40             self.message = self.msg_fmt % kwargs
  41         except KeyError:
  42             exc_info = sys.exc_info()
  43             log.exception(_('Exception in string format operation: %s')
  44                           % exc_info[1])
  45
  46             if TOSCAException._FATAL_EXCEPTION_FORMAT_ERRORS:
  47                 raise exc_info[0]
  48
  49     def __str__(self):
  50         return self.message
  51
  52     @staticmethod
  53     def generate_inv_schema_property_error(self, attr, value, valid_values):
  54         msg = (_('Schema definition of "%(propname)s" has '
  55                  '"%(attr)s" attribute with invalid value '
  56                  '"%(value1)s". The value must be one of '
  57                  '"%(value2)s".') % {"propname": self.name,
  58                                      "attr": attr,
  59                                      "value1": value,
  60                                      "value2": valid_values})
  61         ExceptionCollector.appendException(
  62             InvalidSchemaError(message=msg))
  63
  64     @staticmethod
  65     def set_fatal_format_exception(flag):
  66         if isinstance(flag, bool):
  67             TOSCAException._FATAL_EXCEPTION_FORMAT_ERRORS = flag
  68
  69
  70 class UnsupportedTypeError(TOSCAException):
  71     msg_fmt = _('Type "%(what)s" is valid TOSCA type'
  72                 ' but not supported at this time.')
  73
  74
  75 class MissingRequiredFieldError(TOSCAException):
  76     msg_fmt = _('%(what)s is missing required field "%(required)s".')
  77
  78
  79 class UnknownFieldError(TOSCAException):
  80     msg_fmt = _('%(what)s contains unknown field "%(field)s". Refer to the '
  81                 'definition to verify valid values.')
  82
  83
  84 class TypeMismatchError(TOSCAException):
  85     msg_fmt = _('%(what)s must be of type "%(type)s".')
  86
  87
  88 class InvalidNodeTypeError(TOSCAException):
  89     msg_fmt = _('Node type "%(what)s" is not a valid type.')
  90
  91
  92 class InvalidTypeError(TOSCAException):
  93     msg_fmt = _('Type "%(what)s" is not a valid type.')
  94
  95
  96 class InvalidTypeAdditionalRequirementsError(TOSCAException):
  97     msg_fmt = _('Additional requirements for type "%(type)s" not met.')
  98
  99
 100 class RangeValueError(TOSCAException):
 101     msg_fmt = _('The value "%(pvalue)s" of property "%(pname)s" is out of '
 102                 'range "(min:%(vmin)s, max:%(vmax)s)".')
 103
 104
 105 class InvalidSchemaError(TOSCAException):
 106     msg_fmt = _('%(message)s')
 107
 108
 109 class ValidationError(TOSCAException):
 110     msg_fmt = _('%(message)s')
 111
 112
 113 class UnknownInputError(TOSCAException):
 114     msg_fmt = _('Unknown input "%(input_name)s".')
 115
 116
 117 class MissingRequiredInputError(TOSCAException):
 118     msg_fmt = _('%(what)s is missing required input definition '
 119                 ' with name: "%(input_name)s".')
 120
 121
 122 class MissingRequiredParameterError(TOSCAException):
 123     msg_fmt = _('%(what)s is missing required parameter for input: '
 124                 '"%(input_name)s".')
 125
 126
 127 class InvalidPropertyValueError(TOSCAException):
 128     msg_fmt = _('Value of property "%(what)s" is invalid.')
 129
 130
 131 class InvalidTemplateVersion(TOSCAException):
 132     msg_fmt = _('The template version "%(what)s" is invalid. '
 133                 'Valid versions are "%(valid_versions)s".')
 134
 135
 136 class InvalidTOSCAVersionPropertyException(TOSCAException):
 137     msg_fmt = _('Value of TOSCA version property "%(what)s" is invalid.')
 138
 139
 140 class URLException(TOSCAException):
 141     msg_fmt = _('%(what)s')
 142
 143
 144 class ToscaExtImportError(TOSCAException):
 145     msg_fmt = _('Unable to import extension "%(ext_name)s". '
 146                 'Check to see that it exists and has no '
 147                 'language definition errors.')
 148
 149
 150 class ToscaExtAttributeError(TOSCAException):
 151     msg_fmt = _('Missing attribute in extension "%(ext_name)s". '
 152                 'Check to see that it has required attributes '
 153                 '"%(attrs)s" defined.')
 154
 155
 156 class InvalidGroupTargetException(TOSCAException):
 157     msg_fmt = _('"%(message)s"')
 158
 159
 160 class ExceptionCollector(object):
 161
 162     exceptions = []
 163     collecting = False
 164
 165     @staticmethod
 166     def clear():
 167         del ExceptionCollector.exceptions[:]
 168
 169     @staticmethod
 170     def start():
 171         ExceptionCollector.clear()
 172         ExceptionCollector.collecting = True
 173
 174     @staticmethod
 175     def stop():
 176         ExceptionCollector.collecting = False
 177
 178     @staticmethod
 179     def contains(exception):
 180         for ex in ExceptionCollector.exceptions:
 181             if str(ex) == str(exception):
 182                 return True
 183         return False
 184
 185     @staticmethod
 186     def appendException(exception):
 187         if ExceptionCollector.collecting:
 188             if not ExceptionCollector.contains(exception):
 189                 exception.trace = traceback.extract_stack()[:-1]
 190                 ExceptionCollector.exceptions.append(exception)
 191         else:
 192             raise exception
 193
 194     @staticmethod
 195     def exceptionsCaught():
 196         return len(ExceptionCollector.exceptions) > 0
 197
 198     @staticmethod
 199     def getTraceString(traceList):
 200         traceString = ''
 201         for entry in traceList:
 202             f, l, m, c = entry[0], entry[1], entry[2], entry[3]
 203             traceString += (_('\t\tFile %(file)s, line %(line)s, in '
 204                               '%(method)s\n\t\t\t%(call)s\n')
 205                             % {'file': f, 'line': l, 'method': m, 'call': c})
 206         return traceString
 207
 208     @staticmethod
 209     def getExceptionReportEntry(exception, full=True):
 210         entry = exception.__class__.__name__ + ': ' + str(exception)
 211         if full:
 212             entry += '\n' + ExceptionCollector.getTraceString(exception.trace)
 213         return entry
 214
 215     @staticmethod
 216     def getExceptions():
 217         return ExceptionCollector.exceptions
 218
 219     @staticmethod
 220     def getExceptionsReport(full=True):
 221         report = []
 222         for exception in ExceptionCollector.exceptions:
 223             report.append(
 224                 ExceptionCollector.getExceptionReportEntry(exception, full))
 225         return report
 226
 227     @staticmethod
 228     def assertExceptionMessage(exception, message):
 229         err_msg = exception.__name__ + ': ' + message
 230         report = ExceptionCollector.getExceptionsReport(False)
 231         assert err_msg in report, (_('Could not find "%(msg)s" in "%(rep)s".')
 232                                    % {'rep': report.__str__(), 'msg': err_msg})