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