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