deb-murano/murano/dsl/typespec.py
Stan Lagun 1d72b9dd61 Specification of which property/argument violated contract was added
When some property or argument value violated its contract it was impossible
to tell which property/argument caused the exception.

This change adds prefix to ContractViolationException message that tells
not only which property or argument failed to validate but for composite
properties also the path within the data.
For example if we change ApacheHttpServer name property contract from
$.string() to $.int() we will get

[io.murano.Environment.applications[0]]
[io.murano.apps.apache.ApacheHttpServer.name]
Value 'ApacheHttpServer' violates int() contract

Also for check() contracts ability to provide custom
error message was added

Change-Id: I6953ec84140f4bed3d50aa181244f89682b2b2fb
Closes-Bug: #1496044
2015-09-28 01:11:55 +03:00

96 lines
3.3 KiB
Python

# Copyright (c) 2014 Mirantis, Inc.
#
# 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.
import sys
import weakref
from murano.dsl import exceptions
from murano.dsl import type_scheme
class PropertyUsages(object):
In = 'In'
Out = 'Out'
InOut = 'InOut'
Runtime = 'Runtime'
Const = 'Const'
Config = 'Config'
All = set([In, Out, InOut, Runtime, Const, Config])
Writable = set([Out, InOut, Runtime])
class Spec(object):
def __init__(self, declaration, container_class):
self._container_class = weakref.ref(container_class)
self._contract = type_scheme.TypeScheme(declaration['Contract'])
self._usage = declaration.get('Usage') or 'In'
self._default = declaration.get('Default')
self._has_default = 'Default' in declaration
if self._usage not in PropertyUsages.All:
raise exceptions.DslSyntaxError(
'Unknown type {0}. Must be one of ({1})'.format(
self._usage, ', '.join(PropertyUsages.All)))
def validate(self, value, this, owner, default=None):
if default is None:
default = self.default
return self._contract(
value, this.object_store.executor.create_object_context(
this.cast(self._container_class())),
this, owner, default)
@property
def default(self):
return self._default
@property
def has_default(self):
return self._has_default
@property
def usage(self):
return self._usage
class PropertySpec(Spec):
def __init__(self, property_name, declaration, container_class):
super(PropertySpec, self).__init__(declaration, container_class)
self.property_name = property_name
self.class_name = container_class.name
def validate(self, *args, **kwargs):
try:
return super(PropertySpec, self).validate(*args, **kwargs)
except exceptions.ContractViolationException as e:
msg = u'[{0}.{1}{2}] {3}'.format(
self.class_name, self.property_name, e.path, unicode(e))
raise exceptions.ContractViolationException, msg, sys.exc_info()[2]
class ArgumentSpec(Spec):
def __init__(self, method_name, arg_name, declaration, container_class):
super(ArgumentSpec, self).__init__(declaration, container_class)
self.method_name = method_name
self.arg_name = arg_name
self.class_name = container_class.name
def validate(self, *args, **kwargs):
try:
return super(ArgumentSpec, self).validate(*args, **kwargs)
except exceptions.ContractViolationException as e:
msg = u'[{0}::{1}({2}{3})] {4}'.format(
self.class_name, self.method_name, self.arg_name,
e.path, unicode(e))
raise exceptions.ContractViolationException, msg, sys.exc_info()[2]