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