tosca2heat/tosca-parser/toscaparser/elements/statefulentitytype.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 from toscaparser.common.exception import ExceptionCollector
  14 from toscaparser.common.exception import InvalidTypeError
  15 from toscaparser.elements.attribute_definition import AttributeDef
  16 from toscaparser.elements.entity_type import EntityType
  17 from toscaparser.elements.property_definition import PropertyDef
  18 from toscaparser.unsupportedtype import UnsupportedType
  19
  20
  21 class StatefulEntityType(EntityType):
  22     '''Class representing TOSCA states.'''
  23
  24     interfaces_node_lifecycle_operations = ['create',
  25                                             'configure', 'start',
  26                                             'stop', 'delete']
  27
  28     interfaces_relationship_configure_operations = ['post_configure_source',
  29                                                     'post_configure_target',
  30                                                     'add_target',
  31                                                     'remove_target']
  32
  33     def __init__(self, entitytype, prefix, custom_def=None):
  34         entire_entitytype = entitytype
  35         if UnsupportedType.validate_type(entire_entitytype):
  36             self.defs = None
  37         else:
  38             if entitytype.startswith(self.TOSCA + ":"):
  39                 entitytype = entitytype[(len(self.TOSCA) + 1):]
  40                 entire_entitytype = prefix + entitytype
  41             if not entitytype.startswith(self.TOSCA):
  42                 entire_entitytype = prefix + entitytype
  43             if entire_entitytype in list(self.TOSCA_DEF.keys()):
  44                 self.defs = self.TOSCA_DEF[entire_entitytype]
  45                 entitytype = entire_entitytype
  46             elif custom_def and entitytype in list(custom_def.keys()):
  47                 self.defs = custom_def[entitytype]
  48             else:
  49                 # avoid errors if self.defs = none
  50                 self.defs = {}
  51                 ExceptionCollector.appendException(
  52                     InvalidTypeError(what=entitytype))
  53         self.type = entitytype
  54
  55     def get_properties_def_objects(self):
  56         '''Return a list of property definition objects.'''
  57         properties = []
  58         props = self.get_definition(self.PROPERTIES)
  59         if props:
  60             for prop, schema in props.items():
  61                 properties.append(PropertyDef(prop, None, schema))
  62         return properties
  63
  64     def get_properties_def(self):
  65         '''Return a dictionary of property definition name-object pairs.'''
  66         return {prop.name: prop
  67                 for prop in self.get_properties_def_objects()}
  68
  69     def get_property_def_value(self, name):
  70         '''Return the property definition associated with a given name.'''
  71         props_def = self.get_properties_def()
  72         if props_def and name in props_def.keys():
  73             return props_def[name].value
  74
  75     def get_attributes_def_objects(self):
  76         '''Return a list of attribute definition objects.'''
  77         attrs = self.get_value(self.ATTRIBUTES, parent=True)
  78         if attrs:
  79             return [AttributeDef(attr, None, schema)
  80                     for attr, schema in attrs.items()]
  81         return []
  82
  83     def get_attributes_def(self):
  84         '''Return a dictionary of attribute definition name-object pairs.'''
  85         return {attr.name: attr
  86                 for attr in self.get_attributes_def_objects()}
  87
  88     def get_attribute_def_value(self, name):
  89         '''Return the attribute definition associated with a given name.'''
  90         attrs_def = self.get_attributes_def()
  91         if attrs_def and name in attrs_def.keys():
  92             return attrs_def[name].value