tosca2heat/tosca-parser/toscaparser/tosca_template.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 import logging
  15 import os
  16
  17 from toscaparser.common.exception import ExceptionCollector
  18 from toscaparser.common.exception import InvalidTemplateVersion
  19 from toscaparser.common.exception import MissingRequiredFieldError
  20 from toscaparser.common.exception import UnknownFieldError
  21 from toscaparser.common.exception import ValidationError
  22 from toscaparser.elements.entity_type import update_definitions
  23 from toscaparser.extensions.exttools import ExtTools
  24 import toscaparser.imports
  25 from toscaparser.prereq.csar import CSAR
  26 from toscaparser.repositories import Repository
  27 from toscaparser.topology_template import TopologyTemplate
  28 from toscaparser.tpl_relationship_graph import ToscaGraph
  29 from toscaparser.utils.gettextutils import _
  30 import toscaparser.utils.yamlparser
  31
  32
  33 # TOSCA template key names
  34 SECTIONS = (DEFINITION_VERSION, DEFAULT_NAMESPACE, TEMPLATE_NAME,
  35             TOPOLOGY_TEMPLATE, TEMPLATE_AUTHOR, TEMPLATE_VERSION,
  36             DESCRIPTION, IMPORTS, DSL_DEFINITIONS, NODE_TYPES,
  37             RELATIONSHIP_TYPES, RELATIONSHIP_TEMPLATES,
  38             CAPABILITY_TYPES, ARTIFACT_TYPES, DATA_TYPES,
  39             POLICY_TYPES, GROUP_TYPES, REPOSITORIES) = \
  40            ('tosca_definitions_version', 'tosca_default_namespace',
  41             'template_name', 'topology_template', 'template_author',
  42             'template_version', 'description', 'imports', 'dsl_definitions',
  43             'node_types', 'relationship_types', 'relationship_templates',
  44             'capability_types', 'artifact_types', 'data_types',
  45             'policy_types', 'group_types', 'repositories')
  46 # Sections that are specific to individual template definitions
  47 SPECIAL_SECTIONS = (METADATA) = ('metadata')
  48
  49 log = logging.getLogger("tosca.model")
  50
  51 YAML_LOADER = toscaparser.utils.yamlparser.load_yaml
  52
  53
  54 class ToscaTemplate(object):
  55     exttools = ExtTools()
  56
  57     VALID_TEMPLATE_VERSIONS = ['tosca_simple_yaml_1_0']
  58
  59     VALID_TEMPLATE_VERSIONS.extend(exttools.get_versions())
  60
  61     ADDITIONAL_SECTIONS = {'tosca_simple_yaml_1_0': SPECIAL_SECTIONS}
  62
  63     ADDITIONAL_SECTIONS.update(exttools.get_sections())
  64
  65     '''Load the template data.'''
  66     def __init__(self, path=None, parsed_params=None, a_file=True,
  67                  yaml_dict_tpl=None, submaped_node_template=None):
  68         if submaped_node_template is None:
  69             ExceptionCollector.start()
  70         self.a_file = a_file
  71         self.input_path = None
  72         self.path = None
  73         self.tpl = None
  74         self.submaped_node_template = submaped_node_template
  75         self.nested_tosca_tpls = {}
  76         self.nested_tosca_templates = []
  77         if path:
  78             self.input_path = path
  79             self.path = self._get_path(path)
  80             if self.path:
  81                 self.tpl = YAML_LOADER(self.path, self.a_file)
  82             if yaml_dict_tpl:
  83                 msg = (_('Both path and yaml_dict_tpl arguments were '
  84                          'provided. Using path and ignoring yaml_dict_tpl.'))
  85                 log.info(msg)
  86                 print(msg)
  87         else:
  88             if yaml_dict_tpl:
  89                 self.tpl = yaml_dict_tpl
  90             else:
  91                 ExceptionCollector.appendException(
  92                     ValueError(_('No path or yaml_dict_tpl was provided. '
  93                                  'There is nothing to parse.')))
  94
  95         if self.tpl:
  96             self.parsed_params = parsed_params
  97             self._validate_field()
  98             self.version = self._tpl_version()
  99             self.relationship_types = self._tpl_relationship_types()
 100             self.description = self._tpl_description()
 101             self.topology_template = self._topology_template()
 102             self.repositories = self._tpl_repositories()
 103             if self.topology_template.tpl:
 104                 self.inputs = self._inputs()
 105                 self.relationship_templates = self._relationship_templates()
 106                 self.nodetemplates = self._nodetemplates()
 107                 self.outputs = self._outputs()
 108                 self._handle_nested_topo_templates()
 109                 self.graph = ToscaGraph(self.nodetemplates)
 110
 111         if submaped_node_template is None:
 112             ExceptionCollector.stop()
 113         self.verify_template()
 114
 115     def _topology_template(self):
 116         return TopologyTemplate(self._tpl_topology_template(),
 117                                 self._get_all_custom_defs(),
 118                                 self.relationship_types,
 119                                 self.parsed_params,
 120                                 self.submaped_node_template)
 121
 122     def _inputs(self):
 123         return self.topology_template.inputs
 124
 125     def _nodetemplates(self):
 126         return self.topology_template.nodetemplates
 127
 128     def _relationship_templates(self):
 129         return self.topology_template.relationship_templates
 130
 131     def _outputs(self):
 132         return self.topology_template.outputs
 133
 134     def _tpl_version(self):
 135         return self.tpl.get(DEFINITION_VERSION)
 136
 137     def _tpl_description(self):
 138         desc = self.tpl.get(DESCRIPTION)
 139         if desc:
 140             return desc.rstrip()
 141
 142     def _tpl_imports(self):
 143         return self.tpl.get(IMPORTS)
 144
 145     def _tpl_repositories(self):
 146         repositories = self.tpl.get(REPOSITORIES)
 147         reposit = []
 148         if repositories:
 149             for name, val in repositories.items():
 150                 reposits = Repository(name, val)
 151                 reposit.append(reposits)
 152         return reposit
 153
 154     def _tpl_relationship_types(self):
 155         return self._get_custom_types(RELATIONSHIP_TYPES)
 156
 157     def _tpl_relationship_templates(self):
 158         topology_template = self._tpl_topology_template()
 159         return topology_template.get(RELATIONSHIP_TEMPLATES)
 160
 161     def _tpl_topology_template(self):
 162         return self.tpl.get(TOPOLOGY_TEMPLATE)
 163
 164     def _get_all_custom_defs(self, imports=None):
 165         types = [IMPORTS, NODE_TYPES, CAPABILITY_TYPES, RELATIONSHIP_TYPES,
 166                  DATA_TYPES, POLICY_TYPES, GROUP_TYPES]
 167         custom_defs_final = {}
 168         custom_defs = self._get_custom_types(types, imports)
 169         if custom_defs:
 170             custom_defs_final.update(custom_defs)
 171             if custom_defs.get(IMPORTS):
 172                 import_defs = self._get_all_custom_defs(
 173                     custom_defs.get(IMPORTS))
 174                 custom_defs_final.update(import_defs)
 175
 176         # As imports are not custom_types, removing from the dict
 177         custom_defs_final.pop(IMPORTS, None)
 178         return custom_defs_final
 179
 180     def _get_custom_types(self, type_definitions, imports=None):
 181         """Handle custom types defined in imported template files
 182
 183         This method loads the custom type definitions referenced in "imports"
 184         section of the TOSCA YAML template.
 185         """
 186
 187         custom_defs = {}
 188         type_defs = []
 189         if not isinstance(type_definitions, list):
 190             type_defs.append(type_definitions)
 191         else:
 192             type_defs = type_definitions
 193
 194         if not imports:
 195             imports = self._tpl_imports()
 196
 197         if imports:
 198             custom_service = \
 199                 toscaparser.imports.ImportsLoader(imports, self.path,
 200                                                   type_defs, self.tpl)
 201
 202             nested_topo_tpls = custom_service.get_nested_topo_tpls()
 203             self._update_nested_topo_tpls(nested_topo_tpls)
 204
 205             custom_defs = custom_service.get_custom_defs()
 206             if not custom_defs:
 207                 return
 208
 209         # Handle custom types defined in current template file
 210         for type_def in type_defs:
 211             if type_def != IMPORTS:
 212                 inner_custom_types = self.tpl.get(type_def) or {}
 213                 if inner_custom_types:
 214                     custom_defs.update(inner_custom_types)
 215         return custom_defs
 216
 217     def _update_nested_topo_tpls(self, nested_topo_tpls):
 218         for tpl in nested_topo_tpls:
 219             filename, tosca_tpl = list(tpl.items())[0]
 220             if (tosca_tpl.get(TOPOLOGY_TEMPLATE) and
 221                filename not in list(self.nested_tosca_tpls.keys())):
 222                 self.nested_tosca_tpls.update(tpl)
 223
 224     def _handle_nested_topo_templates(self):
 225         for filename, tosca_tpl in self.nested_tosca_tpls.items():
 226             for nodetemplate in self.nodetemplates:
 227                 if self._is_substitution_mapped_node(nodetemplate, tosca_tpl):
 228                     nested_template = ToscaTemplate(
 229                         path=filename, parsed_params=self.parsed_params,
 230                         yaml_dict_tpl=tosca_tpl,
 231                         submaped_node_template=nodetemplate)
 232                     if nested_template.has_substitution_mappings():
 233                         filenames = [tpl.path for tpl in
 234                                      self.nested_tosca_templates]
 235                         if filename not in filenames:
 236                             self.nested_tosca_templates.append(nested_template)
 237
 238     def _validate_field(self):
 239         version = self._tpl_version()
 240         if not version:
 241             ExceptionCollector.appendException(
 242                 MissingRequiredFieldError(what='Template',
 243                                           required=DEFINITION_VERSION))
 244         else:
 245             self._validate_version(version)
 246             self.version = version
 247
 248         for name in self.tpl:
 249             if (name not in SECTIONS and
 250                name not in self.ADDITIONAL_SECTIONS.get(version, ())):
 251                 ExceptionCollector.appendException(
 252                     UnknownFieldError(what='Template', field=name))
 253
 254     def _validate_version(self, version):
 255         if version not in self.VALID_TEMPLATE_VERSIONS:
 256             ExceptionCollector.appendException(
 257                 InvalidTemplateVersion(
 258                     what=version,
 259                     valid_versions=', '. join(self.VALID_TEMPLATE_VERSIONS)))
 260         else:
 261             if version != 'tosca_simple_yaml_1_0':
 262                 update_definitions(version)
 263
 264     def _get_path(self, path):
 265         if path.lower().endswith('.yaml'):
 266             return path
 267         elif path.lower().endswith(('.zip', '.csar')):
 268             # a CSAR archive
 269             csar = CSAR(path, self.a_file)
 270             if csar.validate():
 271                 csar.decompress()
 272                 self.a_file = True  # the file has been decompressed locally
 273                 return os.path.join(csar.temp_dir, csar.get_main_template())
 274         else:
 275             ExceptionCollector.appendException(
 276                 ValueError(_('"%(path)s" is not a valid file.')
 277                            % {'path': path}))
 278
 279     def verify_template(self):
 280         if ExceptionCollector.exceptionsCaught():
 281             if self.input_path:
 282                 raise ValidationError(
 283                     message=(_('\nThe input "%(path)s" failed validation with '
 284                                'the following error(s): \n\n\t')
 285                              % {'path': self.input_path}) +
 286                     '\n\t'.join(ExceptionCollector.getExceptionsReport()))
 287             else:
 288                 raise ValidationError(
 289                     message=_('\nThe pre-parsed input failed validation with '
 290                               'the following error(s): \n\n\t') +
 291                     '\n\t'.join(ExceptionCollector.getExceptionsReport()))
 292         else:
 293             if self.input_path:
 294                 msg = (_('The input "%(path)s" successfully passed '
 295                          'validation.') % {'path': self.input_path})
 296             else:
 297                 msg = _('The pre-parsed input successfully passed validation.')
 298
 299             log.info(msg)
 300
 301     def _is_substitution_mapped_node(self, nodetemplate, tosca_tpl):
 302         """Return True if the nodetemple is substituted."""
 303         if (nodetemplate and not nodetemplate.substitution_mapped and
 304                 self.get_submaped_node_type(tosca_tpl) == nodetemplate.type and
 305                 len(nodetemplate.interfaces) < 1):
 306             return True
 307         else:
 308             return False
 309
 310     def get_submaped_node_type(self, tosca_tpl):
 311         """Return substitution mappings node type."""
 312         if tosca_tpl:
 313             return TopologyTemplate.get_submaped_node_type(
 314                 tosca_tpl.get(TOPOLOGY_TEMPLATE))
 315
 316     def has_substitution_mappings(self):
 317         """Return True if the template has valid substitution mappings."""
 318         return self.topology_template is not None and \
 319             self.topology_template.substitution_mappings is not None
 320
 321     def has_nested_templates(self):
 322         """Return True if the tosca template has nested templates."""
 323         return self.nested_tosca_templates is not None and \
 324             len(self.nested_tosca_templates) >= 1