ice_validator/tests/test_heat_parameter_section.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 pytest
  42 import re
  43 import yaml
  44
  45 # one or more (alphanumeric or underscore)
  46 RE_VALID_PARAMETER_NAME = re.compile(r"[\w_]+$")
  47
  48
  49 def test_parameter_valid_keys(yaml_file):
  50     """
  51     Make sure each parameter is a dict and only contain
  52     valid keys
  53     """
  54     key_values = ["type", "label", "description", "hidden", "constraints", "immutable"]
  55
  56     with open(yaml_file) as fh:
  57         yml = yaml.load(fh)
  58
  59     # skip if parameters are not defined
  60     if "parameters" not in yml:
  61         pytest.skip("No parameters specified in the heat template")
  62
  63     invalid_params = []
  64     for v1 in yml["parameters"].values():
  65         if not isinstance(v1, dict):
  66             continue
  67         detected_keys = set(v1) & set(key_values)
  68         if set(v1) != set(detected_keys):
  69             invalid_params.append(str(v1))
  70
  71     assert not set(invalid_params)
  72
  73
  74 @validates("R-90526")
  75 def test_default_values(yaml_file):
  76     """
  77     Make sure no default values are set for any parameter.
  78     """
  79     with open(yaml_file) as fh:
  80         yml = yaml.load(fh)
  81
  82     # skip if parameters are not defined
  83     if "parameters" not in yml:
  84         pytest.skip("No parameters specified in the heat template")
  85
  86     invalid_params = []
  87     for v1 in yml["parameters"].values():
  88         if not isinstance(v1, dict):
  89             continue
  90         if any(k == "default" for k in v1):
  91             invalid_params.append(str(v1))
  92
  93     assert not set(invalid_params)
  94
  95
  96 @validates("R-25877")
  97 def test_parameter_names(yaml_file):
  98     """
  99     A VNF's Heat Orchestration Template's parameter name
 100     (i.e., <param name>) **MUST** contain only alphanumeric
 101     characters and underscores ('_').
 102     """
 103     with open(yaml_file) as fh:
 104         yml = yaml.load(fh)
 105
 106     # skip if parameters are not defined
 107     if "parameters" not in yml:
 108         pytest.skip("No parameters specified in the heat template")
 109
 110     for key in yml["parameters"]:
 111         assert RE_VALID_PARAMETER_NAME.match(
 112             key
 113         ), '%s parameter "%s" not alphanumeric or underscore' % (yaml_file, key)