ice_validator/tests/test_heat_template_structure.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START=======================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2018 AT&T Intellectual Property. All rights reserved.
   6 # ===================================================================
   7 #
   8 # Unless otherwise specified, all software contained herein is licensed
   9 # under the Apache License, Version 2.0 (the "License");
  10 # you may not use this software except in compliance with the License.
  11 # You may obtain a copy of the License at
  12 #
  13 #             http://www.apache.org/licenses/LICENSE-2.0
  14 #
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS,
  17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18 # See the License for the specific language governing permissions and
  19 # limitations under the License.
  20 #
  21 #
  22 #
  23 # Unless otherwise specified, all documentation contained herein is licensed
  24 # under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  25 # you may not use this documentation except in compliance with the License.
  26 # You may obtain a copy of the License at
  27 #
  28 #             https://creativecommons.org/licenses/by/4.0/
  29 #
  30 # Unless required by applicable law or agreed to in writing, documentation
  31 # distributed under the License is distributed on an "AS IS" BASIS,
  32 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  33 # See the License for the specific language governing permissions and
  34 # limitations under the License.
  35 #
  36 # ============LICENSE_END============================================
  37 #
  38 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
  39 #
  40 from .helpers import validates
  41 import yaml
  42
  43
  44 def test_heat_template_structure(yaml_file):
  45     '''
  46     Check that all heat templates only have the allowed sections
  47     '''
  48     key_values = ["heat_template_version", "description",
  49                   "parameter_groups", "parameters", "resources",
  50                   "outputs", "conditions"]
  51
  52     with open(yaml_file) as fh:
  53         yml = yaml.load(fh)
  54     assert all([k in key_values for k in yml])
  55
  56
  57 @validates('R-27078', 'R-39402', 'R-35414')
  58 def test_heat_template_structure_contains_required_sections(yaml_file):
  59     '''
  60     Check that all heat templates have the required sections
  61     '''
  62     required_key_values = ["heat_template_version", "description",
  63                            "parameters", "resources"]
  64
  65     with open(yaml_file) as fh:
  66         yml = yaml.load(fh)
  67     assert all([k in yml for k in required_key_values])
  68
  69
  70 def test_heat_template_structure_sections_have_the_right_format(yaml_file):
  71     '''
  72     Check that all heat templates have sections of the right format.
  73     Do note that it only tests for dicts or not dicts currently.
  74     '''
  75     key_values = ["heat_template_version", "description",
  76                   "parameter_groups", "parameters", "resources",
  77                   "outputs", "conditions"]
  78     key_values_not_dicts = ["heat_template_version", "description"]
  79
  80     with open(yaml_file) as fh:
  81         yml = yaml.load(fh)
  82
  83     is_dict = 0
  84     should_be_dict = 0
  85     is_not_dict = 0
  86     should_not_be_dict = 0
  87     for key_value in key_values:
  88         if key_value in yml:
  89             if isinstance(yml[key_value], dict):
  90                 is_dict += 1
  91                 if key_value not in key_values_not_dicts:
  92                     should_be_dict += 1
  93             elif not isinstance(yml[key_value], list):
  94                 is_not_dict += 1
  95                 if key_value in key_values_not_dicts:
  96                     should_not_be_dict += 1
  97     assert (is_dict == should_be_dict and
  98             is_not_dict == should_not_be_dict)
  99
 100
 101 @validates('R-11441')
 102 def test_parameter_type(yaml_file):
 103     types = [
 104         'string',
 105         'number',
 106         'json',
 107         'comma_delimited_list',
 108         'boolean',
 109     ]
 110     with open(yaml_file) as fh:
 111         yml = yaml.load(fh)
 112     for key, param in yml.get('parameters', {}).items():
 113         assert isinstance(param, dict), '%s parameter %s is not dict' % (
 114             yaml_file,
 115             key)
 116         assert 'type' in param, '%s parameter %s has no "type"' % (
 117             yaml_file,
 118             key)
 119         typ = param['type']
 120         assert typ in types, '%s parameter %s has invalid type "%s"' % (
 121             yaml_file,
 122             key,
 123             typ)