2 # ============LICENSE_START=======================================================
3 # org.onap.vvp/validation-scripts
4 # ===================================================================
5 # Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 # ===================================================================
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
13 # http://www.apache.org/licenses/LICENSE-2.0
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.
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
28 # https://creativecommons.org/licenses/by/4.0/
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.
36 # ============LICENSE_END============================================
43 from tests import cached_yaml as yaml
45 from .helpers import validates
48 class VolumePairModule:
49 def __init__(self, volume_path):
50 self.volume_path = volume_path
53 def path_options(self):
54 expected_path, _ = self.volume_path.rsplit("_volume", maxsplit=1)
55 return (expected_path + ".yaml", expected_path + ".yml")
59 return any(os.path.exists(option) for option in self.path_options)
61 def get_module_path(self):
63 Return the path of the volume module's pair if it exists,
66 for option in self.path_options:
67 if os.path.exists(option):
73 def test_volume_module_name_matches_incremental_or_base_module(volume_template):
74 pair_module = VolumePairModule(volume_template)
75 assert pair_module.exists, (
76 "Could not find a corresponding module ({}) for " + "volume module ({})"
77 ).format(" or ".join(pair_module.path_options), volume_template)
80 @validates("R-11200", "R-07443")
81 def test_volume_outputs_consumed(template_dir, volume_template):
83 Check that all outputs in a volume template is consumed
84 by the corresponding heat template
86 pair_module = VolumePairModule(volume_template)
87 if not pair_module.exists:
88 pytest.skip("No pair module found for volume template")
89 with open(volume_template, "r") as f:
91 with open(pair_module.get_module_path(), "r") as f:
93 outputs = set(volume.get("outputs", {}).keys())
94 parameters = set(pair.get("parameters", {}).keys())
95 missing_output_parameters = outputs.difference(parameters)
96 assert not missing_output_parameters, (
97 "The output parameters ({}) in {} were not all "
98 "used by the expected module {}".format(
99 ",".join(missing_output_parameters), volume_template, pair_module
103 # Now make sure that none of the output parameters appear in any other
105 template_files = set(glob.glob("*.yaml")).union(glob.glob(".yml"))
107 for template_path in template_files:
108 if template_path in (pair_module, volume_template):
109 continue # Skip these files since we already checked this pair
110 with open(template_path, "r") as f:
111 template = yaml.load(f)
112 parameters = set(template.get("parameters", {}).keys())
113 misused_outputs = outputs.intersection(parameters)
115 errors[template_path] = misused_outputs
117 "{} ({})".format(path, ", ".join(params)) for path, params in errors.items()
120 "Volume output parameters detected in unexpected modules: " + message