ice_validator/tests/test_nested_parameter_args.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 import os
  40
  41 from tests.helpers import validates, traverse, load_yaml
  42
  43
  44 def is_get_param(arg):
  45     return isinstance(arg, dict) and "get_param" in arg
  46
  47
  48 class GetParamChecker:
  49     def __init__(self, yaml_file):
  50         self.errors = []
  51         self.filename = os.path.basename(yaml_file)
  52
  53     def __call__(self, keys, param_value, *args, **kwargs):
  54         if isinstance(param_value, str):
  55             return  # refers to a string or parameter - this is OK
  56         if "outputs" in keys:
  57             return  # output section is exempt from this requirement
  58         if isinstance(param_value, list):
  59             nested_get_params = (arg for arg in param_value if is_get_param(arg))
  60             args = (call["get_param"] for call in nested_get_params)
  61             invalid_args = (arg for arg in args if not isinstance(arg, str))
  62             # We don't check if the args really point to parameters, because that
  63             # check is already covered by test_05_all_get_param_have_defined_parameter
  64             # in test_initial_configuration.py
  65             if any(invalid_args):
  66                 self.errors.append(
  67                     (
  68                         "Invalid nesting of get_param detected in {} at {}. Calls to "
  69                         "get_param can only be nested two deep, and the argument to "
  70                         "the second get_param must only be a parameter name: {}"
  71                     ).format(
  72                         self.filename, " > ".join(keys), {"get_param": param_value}
  73                     )
  74                 )
  75
  76
  77 @validates("R-10834")
  78 def test_nested_parameter_args(yaml_file):
  79     heat = load_yaml(yaml_file)
  80     checker = GetParamChecker(yaml_file)
  81     traverse(heat, "get_param", checker)
  82     assert not checker.errors, ". ".join(checker.errors)