ice_validator/tests/test_heat_template_parameters_contain_required_fields.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START=======================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2017 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 #
  39 from collections import defaultdict
  40
  41 import pytest
  42 from tests import cached_yaml as yaml
  43
  44 from .helpers import validates
  45
  46
  47 @validates("R-36772", "R-44001")
  48 def test_heat_template_parameters_contain_required_fields(yaml_file):
  49     """
  50     Check that all parameters in the environment
  51     file have the required fields
  52     """
  53     required_keys = {"type", "description"}
  54
  55     with open(yaml_file) as fh:
  56         yml = yaml.load(fh)
  57
  58     # skip if parameters are not defined
  59     if "parameters" not in yml:
  60         pytest.skip("No parameters specified in the heat template")
  61
  62     invalid_params = defaultdict(list)
  63     for param, param_attrs in yml["parameters"].items():
  64         if not isinstance(param_attrs, dict):
  65             continue
  66         for key in required_keys:
  67             if key not in param_attrs:
  68                 invalid_params[param].append(key)
  69
  70     msg = [
  71         "Parameter {} is missing required attribute(s): {}".format(k, ", ".join(v))
  72         for k, v in invalid_params.items()
  73     ]
  74     msg = ". ".join(msg)
  75     assert not invalid_params, msg