ice_validator/tests/test_nested_parameters.py

   1 # -*- coding: utf8 -*-
   2 # ============LICENSE_START====================================================
   3 # org.onap.vvp/validation-scripts
   4 # ===================================================================
   5 # Copyright © 2019 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
  40 """heat parameters
  41 """
  42 import pytest
  43 from tests import cached_yaml as yaml
  44 from tests.structures import Resource
  45 from .helpers import validates, prop_iterator
  46 import os
  47
  48 VERSION = "1.0.0"
  49
  50
  51 def check_nested_parameter_doesnt_change(yaml_file, nresource_type, *nprops):
  52     """
  53     yaml_file: input heat template
  54     nresource_type: target resource type to look for in nested file
  55     nprops: list of props to dig through to get to parameter
  56     """
  57     base_dir, _ = os.path.split(yaml_file)
  58     invalid_parameters = []
  59
  60     with open(yaml_file) as fh:
  61         yml = yaml.load(fh)
  62
  63     # skip if resources are not defined
  64     if "resources" not in yml:
  65         pytest.skip("No resources specified in the heat template")
  66
  67     for resource_id, resource in yml.get("resources", {}).items():
  68         resource_type = resource.get("type")
  69         if resource_type and (
  70             resource_type.endswith("yaml")
  71             or resource_type.endswith("yml")
  72             or resource_type == "OS::Heat::ResourceGroup"
  73         ):
  74             # workaround for subinterfaces
  75             metadata = resource.get("metadata")
  76             if metadata:
  77                 subinterface_type = metadata.get("subinterface_type")
  78                 if subinterface_type and subinterface_type == "network_collection":
  79                     continue
  80
  81             r = Resource(resource_id=resource_id, resource=resource)
  82             properties = r.get_nested_properties()
  83             resources = r.get_nested_yaml(base_dir).get("resources", {})
  84             for nrid, nresource_dict in resources.items():  # iterate through nested file until found target r type
  85
  86                 if (
  87                     nresource_dict.get("type")
  88                     and nresource_dict.get("type") != nresource_type
  89                 ):
  90                     continue
  91
  92                 for nparam in prop_iterator(nresource_dict, *nprops):  # get iterator of all target parameters
  93                     if nparam and "get_param" in nparam:  # iterator yields None if parameter isn't found
  94                         nparam = nparam.get("get_param")
  95                         for k1, v1 in properties.items():  # found nparam, now comparing to parent template
  96                             if isinstance(v1, dict) and "get_param" in v1:
  97                                 parameter = v1.get("get_param")
  98                                 # k1: nested resource parameter definition
  99                                 # parameter: parent parameter name
 100                                 # nparam: nested parameter name
 101
 102                                 # resolve list params like [param, { get_param: index }]
 103                                 if isinstance(nparam, list):
 104                                     nparam = nparam[0]
 105                                 if isinstance(parameter, list):
 106                                     parameter = parameter[0]
 107
 108                                 if k1 != nparam:  # we only care about the parameter we found in nested template
 109                                     continue
 110
 111                                 if k1 != parameter:
 112                                     msg = (
 113                                         "{} property {} cannot change when passed into "
 114                                         "a nested template. Nested parameter change detected in "
 115                                         "resource {}: parent parameter = {}, nested parameter = {}".format(
 116                                             nresource_type,
 117                                             nprops,
 118                                             resource_id,
 119                                             parameter,
 120                                             nparam,
 121                                         )
 122                                     )
 123                                     invalid_parameters.append(msg)
 124
 125     assert not invalid_parameters, "\n".join(invalid_parameters)
 126
 127
 128 # @validates("R-708564")
 129 # def test_parameter_name_doesnt_change_in_nested_template(yaml_file):
 130 #    check_nested_parameter_doesnt_change(yaml_file)
 131
 132 @validates("R-708564")
 133 def test_server_name_parameter_name_doesnt_change_in_nested_template(heat_template):
 134     check_nested_parameter_doesnt_change(heat_template, "OS::Nova::Server", "name")
 135
 136
 137 @validates("R-708564")
 138 def test_server_image_parameter_name_doesnt_change_in_nested_template(heat_template):
 139     check_nested_parameter_doesnt_change(heat_template, "OS::Nova::Server", "image")
 140
 141
 142 @validates("R-708564")
 143 def test_server_flavor_parameter_name_doesnt_change_in_nested_template(heat_template):
 144     check_nested_parameter_doesnt_change(heat_template, "OS::Nova::Server", "flavor")
 145
 146
 147 @validates("R-708564")
 148 def test_server_metadata_vnf_id_parameter_name_doesnt_change_in_nested_template(
 149     heat_template
 150 ):
 151     check_nested_parameter_doesnt_change(
 152         heat_template, "OS::Nova::Server", "metadata", "vnf_id"
 153     )
 154
 155
 156 @validates("R-708564")
 157 def test_server_metadata_vf_module_id_parameter_name_doesnt_change_in_nested_template(
 158     heat_template
 159 ):
 160     check_nested_parameter_doesnt_change(
 161         heat_template, "OS::Nova::Server", "metadata", "vf_module_id"
 162     )
 163
 164
 165 @validates("R-708564")
 166 def test_server_metadata_vnf_name_parameter_name_doesnt_change_in_nested_template(
 167     heat_template
 168 ):
 169     check_nested_parameter_doesnt_change(
 170         heat_template, "OS::Nova::Server", "metadata", "vnf_name"
 171     )
 172
 173
 174 @validates("R-708564")
 175 def test_server_metadata_vf_module_name_parameter_name_doesnt_change_in_nested_template(
 176     heat_template
 177 ):
 178     check_nested_parameter_doesnt_change(
 179         heat_template, "OS::Nova::Server", "metadata", "vf_module_name"
 180     )
 181
 182
 183 @validates("R-708564")
 184 def test_server_metadata_vm_role_parameter_name_doesnt_change_in_nested_template(
 185     heat_template
 186 ):
 187     check_nested_parameter_doesnt_change(
 188         heat_template, "OS::Nova::Server", "metadata", "vm_role"
 189     )
 190
 191
 192 @validates("R-708564")
 193 def test_server_metadata_vf_module_index_parameter_name_doesnt_change_in_nested_template(
 194     heat_template
 195 ):
 196     check_nested_parameter_doesnt_change(
 197         heat_template, "OS::Nova::Server", "metadata", "vf_module_index"
 198     )
 199
 200
 201 @validates("R-708564")
 202 def test_server_metadata_workload_context_parameter_name_doesnt_change_in_nested_template(
 203     heat_template
 204 ):
 205     check_nested_parameter_doesnt_change(
 206         heat_template, "OS::Nova::Server", "metadata", "workload_context"
 207     )
 208
 209
 210 @validates("R-708564")
 211 def test_server_metadata_environment_context_parameter_name_doesnt_change_in_nested_template(
 212     heat_template
 213 ):
 214     check_nested_parameter_doesnt_change(
 215         heat_template, "OS::Nova::Server", "metadata", "environment_context"
 216     )
 217
 218
 219 @validates("R-708564")
 220 def test_port_network_parameter_name_doesnt_change_in_nested_template(heat_template):
 221     check_nested_parameter_doesnt_change(heat_template, "OS::Neutron::Port", "network")
 222
 223
 224 @validates("R-708564")
 225 def test_port_fip_ip_parameter_name_doesnt_change_in_nested_template(heat_template):
 226     check_nested_parameter_doesnt_change(
 227         heat_template, "OS::Neutron::Port", "fixed_ips", "ip_address"
 228     )
 229
 230
 231 @validates("R-708564")
 232 def test_port_fip_subnet_parameter_name_doesnt_change_in_nested_template(heat_template):
 233     check_nested_parameter_doesnt_change(
 234         heat_template, "OS::Neutron::Port", "fixed_ips", "subnet"
 235     )
 236
 237
 238 @validates("R-708564")
 239 def test_port_aap_ip_parameter_name_doesnt_change_in_nested_template(heat_template):
 240     check_nested_parameter_doesnt_change(
 241         heat_template, "OS::Neutron::Port", "allowed_address_pairs", "ip_address"
 242     )
 243
 244
 245 @validates("R-708564")
 246 def test_vmi_net_ref_parameter_name_doesnt_change_in_nested_template(heat_template):
 247     check_nested_parameter_doesnt_change(
 248         heat_template, "OS::ContrailV2::VirtualMachineInterface", "virtual_network_refs"
 249     )
 250
 251
 252 @validates("R-708564")
 253 def test_vmi_aap_parameter_name_doesnt_change_in_nested_template(heat_template):
 254     check_nested_parameter_doesnt_change(
 255         heat_template,
 256         "OS::ContrailV2::VirtualMachineInterface",
 257         "virtual_machine_interface_allowed_address_pairs",
 258         "virtual_machine_interface_allowed_address_pairs_allowed_address_pair",
 259         "virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip",
 260         "virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix"
 261     )
 262
 263
 264 @validates("R-708564")
 265 def test_iip_instance_ip_parameter_name_doesnt_change_in_nested_template(heat_template):
 266     check_nested_parameter_doesnt_change(
 267         heat_template, "OS::ContrailV2::InstanceIp", "instance_ip_address"
 268     )
 269
 270
 271 @validates("R-708564")
 272 def test_iip_subnet_uuid_parameter_name_doesnt_change_in_nested_template(heat_template):
 273     check_nested_parameter_doesnt_change(
 274         heat_template, "OS::ContrailV2::InstanceIp", "subnet_uuid"
 275     )