yardstick/common/template_format.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 # yardstick: this file is copied from python-heatclient and slightly modified
  14
  15 from __future__ import absolute_import
  16
  17 import yaml
  18 from oslo_serialization import jsonutils
  19
  20 if hasattr(yaml, 'CSafeLoader'):
  21     yaml_loader = yaml.CSafeLoader
  22 else:
  23     yaml_loader = yaml.SafeLoader
  24
  25 if hasattr(yaml, 'CSafeDumper'):
  26     yaml_dumper = yaml.CSafeDumper
  27 else:
  28     yaml_dumper = yaml.SafeDumper
  29
  30
  31 def _construct_yaml_str(self, node):
  32     # Override the default string handling function
  33     # to always return unicode objects
  34     return self.construct_scalar(node)
  35 yaml_loader.add_constructor(u'tag:yaml.org,2002:str', _construct_yaml_str)
  36 # Unquoted dates like 2013-05-23 in yaml files get loaded as objects of type
  37 # datetime.data which causes problems in API layer when being processed by
  38 # openstack.common.jsonutils. Therefore, make unicode string out of timestamps
  39 # until jsonutils can handle dates.
  40 yaml_loader.add_constructor(u'tag:yaml.org,2002:timestamp',
  41                             _construct_yaml_str)
  42
  43
  44 def parse(tmpl_str):
  45     """Takes a string and returns a dict containing the parsed structure.
  46
  47     This includes determination of whether the string is using the
  48     JSON or YAML format.
  49     """
  50     if tmpl_str.startswith('{'):
  51         tpl = jsonutils.loads(tmpl_str)
  52     else:
  53         try:
  54             # we already use SafeLoader when constructing special Heat YAML loader class
  55             tpl = yaml.load(tmpl_str, Loader=yaml_loader)
  56         except yaml.YAMLError as yea:
  57             raise ValueError(yea)
  58         else:
  59             if tpl is None:
  60                 tpl = {}
  61     # Looking for supported version keys in the loaded template
  62     if not ('HeatTemplateFormatVersion' in tpl or
  63             'heat_template_version' in tpl or
  64             'AWSTemplateFormatVersion' in tpl):
  65         raise ValueError("Template format version not found.")
  66     return tpl