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     # make a dynamic subclass so we don't override global yaml Loader
  22     yaml_loader = type('HeatYamlLoader', (yaml.CSafeLoader,), {})
  23 else:
  24     yaml_loader = type('HeatYamlLoader', (yaml.SafeLoader,), {})
  25
  26 if hasattr(yaml, 'CSafeDumper'):
  27     yaml_dumper = yaml.CSafeDumper
  28 else:
  29     yaml_dumper = yaml.SafeDumper
  30
  31
  32 # This breaks NetworkServiceTestCase yaml loading, because we need to conversion to
  33 # native Python str() objects because we use use Trex and Trex is has broken unicode handling
  34 def _construct_yaml_str(self, node):
  35     # Override the default string handling function
  36     # to always return unicode objects
  37     return self.construct_scalar(node)
  38
  39 yaml_loader.add_constructor(u'tag:yaml.org,2002:str', _construct_yaml_str)
  40 # Unquoted dates like 2013-05-23 in yaml files get loaded as objects of type
  41 # datetime.data which causes problems in API layer when being processed by
  42 # openstack.common.jsonutils. Therefore, make unicode string out of timestamps
  43 # until jsonutils can handle dates.
  44 yaml_loader.add_constructor(u'tag:yaml.org,2002:timestamp',
  45                             _construct_yaml_str)
  46
  47
  48 def parse(tmpl_str):
  49     """Takes a string and returns a dict containing the parsed structure.
  50
  51     This includes determination of whether the string is using the
  52     JSON or YAML format.
  53     """
  54     if tmpl_str.startswith('{'):
  55         tpl = jsonutils.loads(tmpl_str)
  56     else:
  57         try:
  58             # we already use SafeLoader when constructing special Heat YAML loader class
  59             tpl = yaml.load(tmpl_str, Loader=yaml_loader)
  60         except yaml.YAMLError as yea:
  61             raise ValueError(yea)
  62         else:
  63             if tpl is None:
  64                 tpl = {}
  65     # Looking for supported version keys in the loaded template
  66     if not ('HeatTemplateFormatVersion' in tpl or
  67             'heat_template_version' in tpl or
  68             'AWSTemplateFormatVersion' in tpl):
  69         raise ValueError("Template format version not found.")
  70     return tpl