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 MissingRequiredFieldError(TOSCAException):
  71     msg_fmt = _('%(what)s is missing required field "%(required)s".')
  72
  73
  74 class UnknownFieldError(TOSCAException):
  75     msg_fmt = _('%(what)s contains unknown field "%(field)s". Refer to the '
  76                 'definition to verify valid values.')
  77
  78
  79 class TypeMismatchError(TOSCAException):
  80     msg_fmt = _('%(what)s must be of type "%(type)s".')
  81
  82
  83 class InvalidNodeTypeError(TOSCAException):
  84     msg_fmt = _('Node type "%(what)s" is not a valid type.')
  85
  86
  87 class InvalidTypeError(TOSCAException):
  88     msg_fmt = _('Type "%(what)s" is not a valid type.')
  89
  90
  91 class InvalidTypeAdditionalRequirementsError(TOSCAException):
  92     msg_fmt = _('Additional requirements for type "%(type)s" not met.')
  93
  94
  95 class RangeValueError(TOSCAException):
  96     msg_fmt = _('The value "%(pvalue)s" of property "%(pname)s" is out of '
  97                 'range "(min:%(vmin)s, max:%(vmax)s)".')
  98
  99
 100 class InvalidSchemaError(TOSCAException):
 101     msg_fmt = _('%(message)s')
 102
 103
 104 class ValidationError(TOSCAException):
 105     msg_fmt = _('%(message)s')
 106
 107
 108 class UnknownInputError(TOSCAException):
 109     msg_fmt = _('Unknown input "%(input_name)s".')
 110
 111
 112 class InvalidPropertyValueError(TOSCAException):
 113     msg_fmt = _('Value of property "%(what)s" is invalid.')
 114
 115
 116 class InvalidTemplateVersion(TOSCAException):
 117     msg_fmt = _('The template version "%(what)s" is invalid. '
 118                 'Valid versions are "%(valid_versions)s".')
 119
 120
 121 class InvalidTOSCAVersionPropertyException(TOSCAException):
 122     msg_fmt = _('Value of TOSCA version property "%(what)s" is invalid.')
 123
 124
 125 class URLException(TOSCAException):
 126     msg_fmt = _('%(what)s')
 127
 128
 129 class ToscaExtImportError(TOSCAException):
 130     msg_fmt = _('Unable to import extension "%(ext_name)s". '
 131                 'Check to see that it exists and has no '
 132                 'language definition errors.')
 133
 134
 135 class ToscaExtAttributeError(TOSCAException):
 136     msg_fmt = _('Missing attribute in extension "%(ext_name)s". '
 137                 'Check to see that it has required attributes '
 138                 '"%(attrs)s" defined.')
 139
 140
 141 class InvalidGroupTargetException(TOSCAException):
 142     msg_fmt = _('"%(message)s"')
 143
 144
 145 class ExceptionCollector(object):
 146
 147     exceptions = []
 148     collecting = False
 149
 150     @staticmethod
 151     def clear():
 152         del ExceptionCollector.exceptions[:]
 153
 154     @staticmethod
 155     def start():
 156         ExceptionCollector.clear()
 157         ExceptionCollector.collecting = True
 158
 159     @staticmethod
 160     def stop():
 161         ExceptionCollector.collecting = False
 162
 163     @staticmethod
 164     def contains(exception):
 165         for ex in ExceptionCollector.exceptions:
 166             if str(ex) == str(exception):
 167                 return True
 168         return False
 169
 170     @staticmethod
 171     def appendException(exception):
 172         if ExceptionCollector.collecting:
 173             if not ExceptionCollector.contains(exception):
 174                 exception.trace = traceback.extract_stack()[:-1]
 175                 ExceptionCollector.exceptions.append(exception)
 176         else:
 177             raise exception
 178
 179     @staticmethod
 180     def exceptionsCaught():
 181         return len(ExceptionCollector.exceptions) > 0
 182
 183     @staticmethod
 184     def getTraceString(traceList):
 185         traceString = ''
 186         for entry in traceList:
 187             f, l, m, c = entry[0], entry[1], entry[2], entry[3]
 188             traceString += (_('\t\tFile %(file)s, line %(line)s, in '
 189                               '%(method)s\n\t\t\t%(call)s\n')
 190                             % {'file': f, 'line': l, 'method': m, 'call': c})
 191         return traceString
 192
 193     @staticmethod
 194     def getExceptionReportEntry(exception, full=True):
 195         entry = exception.__class__.__name__ + ': ' + str(exception)
 196         if full:
 197             entry += '\n' + ExceptionCollector.getTraceString(exception.trace)
 198         return entry
 199
 200     @staticmethod
 201     def getExceptions():
 202         return ExceptionCollector.exceptions
 203
 204     @staticmethod
 205     def getExceptionsReport(full=True):
 206         report = []
 207         for exception in ExceptionCollector.exceptions:
 208             report.append(
 209                 ExceptionCollector.getExceptionReportEntry(exception, full))
 210         return report
 211
 212     @staticmethod
 213     def assertExceptionMessage(exception, message):
 214         err_msg = exception.__name__ + ': ' + message
 215         report = ExceptionCollector.getExceptionsReport(False)
 216         assert err_msg in report, (_('Could not find "%(msg)s" in "%(rep)s".')
 217                                    % {'rep': report.__str__(), 'msg': err_msg})