2 # ============LICENSE_START====================================================
3 # org.onap.vvp/validation-scripts
4 # ===================================================================
5 # Copyright © 2019 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============================================
46 from collections import defaultdict
47 from typing import Set
49 from boltons import funcutils
50 from tests import cached_yaml as yaml
52 __path__ = [os.path.dirname(os.path.abspath(__file__))]
53 DEFAULT_OUTPUT_DIR = "{}/../output".format(__path__[0])
54 RE_BASE = re.compile(r"(^base$)|(^base_)|(_base_)|(_base$)")
57 def is_base_module(template_path):
58 basename = os.path.basename(template_path).lower()
59 name, extension = os.path.splitext(basename)
60 is_yaml = extension in {".yml", ".yaml"}
61 return is_yaml and RE_BASE.search(name) and not name.endswith("_volume")
64 def check_basename_ending(template_type, basename):
66 return True/False if the template type is matching
71 elif template_type == "volume":
72 return basename.endswith("_volume")
74 return not basename.endswith("_volume")
77 def get_parsed_yml_for_yaml_files(yaml_files, sections=None):
79 get the parsed yaml for a list of yaml files
81 sections = [] if sections is None else sections
83 for yaml_file in yaml_files:
85 with open(yaml_file) as fh:
87 except yaml.YAMLError as e:
88 # pylint: disable=superfluous-parens
89 print("Error in %s: %s" % (yaml_file, e))
96 parsed_yml_list.append(yml)
97 return parsed_yml_list
100 def validates(*requirement_ids):
101 """Decorator that tags the test function with one or more requirement IDs.
104 >>> @validates('R-12345', 'R-12346')
105 ... def test_something():
107 >>> assert test_something.requirement_ids == ['R-12345', 'R-12346']
109 # pylint: disable=missing-docstring
111 # NOTE: We use a utility here to ensure that function signatures are
112 # maintained because pytest inspects function signatures to inject
113 # fixtures. I experimented with a few options, but this is the only
114 # library that worked. Other libraries dynamically generated a
115 # function at run-time, and then lost the requirement_ids attribute
116 @funcutils.wraps(func)
117 def wrapper(*args, **kw):
118 return func(*args, **kw)
120 wrapper.requirement_ids = requirement_ids
123 decorator.requirement_ids = requirement_ids
127 def categories(*categories):
129 @funcutils.wraps(func)
130 def wrapper(*args, **kw):
131 return func(*args, **kw)
133 wrapper.categories = categories
136 decorator.categories = categories
140 def get_environment_pair(heat_template):
141 """Returns a yaml/env pair given a yaml file"""
142 base_dir, filename = os.path.split(heat_template)
143 basename = os.path.splitext(filename)[0]
144 env_template = os.path.join(base_dir, "{}.env".format(basename))
145 if os.path.exists(env_template):
146 with open(heat_template, "r") as fh:
148 with open(env_template, "r") as fh:
151 environment_pair = {"name": basename, "yyml": yyml, "eyml": eyml}
152 return environment_pair
157 def find_environment_file(yaml_files):
159 Pass file and recursively step backwards until environment file is found
161 :param yaml_files: list or string, start at size 1 and grows recursively
162 :return: corresponding environment file for a file, or None
165 if isinstance(yaml_files, str):
166 yaml_files = [yaml_files]
168 yaml_file = yaml_files[-1]
169 filepath, filename = os.path.split(yaml_file)
171 environment_pair = get_environment_pair(yaml_file)
173 return environment_pair
175 for file in os.listdir(filepath):
176 fq_name = "{}/{}".format(filepath, file)
177 if fq_name.endswith("yaml") or fq_name.endswith("yml"):
178 if fq_name not in yaml_files:
179 with open(fq_name) as f:
181 resources = yml.get("resources", {})
182 for resource_id, resource in resources.items():
183 resource_type = resource.get("type", "")
184 if resource_type == "OS::Heat::ResourceGroup":
186 resource.get("properties", {})
187 .get("resource_def", {})
190 # found called nested file
191 if resource_type == filename:
192 yaml_files.append(fq_name)
193 environment_pair = find_environment_file(yaml_files)
195 return environment_pair
198 def load_yaml(yaml_file):
200 Load the YAML file at the given path. If the file has previously been
201 loaded, then a cached version will be returned.
203 :param yaml_file: path to the YAML file
204 :return: data structure loaded from the YAML file
206 with open(yaml_file) as fh:
210 def traverse(data, search_key, func, path=None):
212 Traverse the data structure provided via ``data`` looking for occurences
213 of ``search_key``. When ``search_key`` is found, the value associated
214 with that key is passed to ``func``
216 :param data: arbitrary data structure of dicts and lists
217 :param search_key: key field to search for
218 :param func: Callable object that takes two parameters:
219 * A list representing the path of keys to search_key
220 * The value associated with the search_key
222 path = [] if path is None else path
223 if isinstance(data, dict):
224 for key, value in data.items():
225 curr_path = path + [key]
226 if key == search_key:
227 func(curr_path, value)
228 traverse(value, search_key, func, curr_path)
229 elif isinstance(data, list):
231 curr_path = path + [value]
232 if isinstance(value, (dict, list)):
233 traverse(value, search_key, func, curr_path)
234 elif value == search_key:
235 func(curr_path, value)
238 def check_indices(pattern, values, value_type):
240 Checks that indices associated with the matched prefix start at 0 and
241 increment by 1. It returns a list of messages for any prefixes that
244 :param pattern: Compiled regex that whose first group matches the prefix and
245 second group matches the index
246 :param values: sequence of string names that may or may not match the pattern
247 :param name: Type of value being checked (ex: IP Parameters). This will
248 be included in the error messages.
249 :return: List of error messages, empty list if no violations found
251 if not hasattr(pattern, "match"):
252 raise RuntimeError("Pattern must be a compiled regex")
254 prefix_indices = defaultdict(set)
256 m = pattern.match(value)
258 prefix_indices[m.group(1)].add(int(m.group(2)))
261 for prefix, indices in prefix_indices.items():
262 indices = sorted(indices)
264 invalid_params.append(
265 "{} with prefix {} do not start at 0".format(value_type, prefix)
267 elif len(indices) - 1 != indices[-1]:
268 invalid_params.append(
270 "Index values of {} with prefix {} do not " + "increment by 1: {}"
271 ).format(value_type, prefix, indices)
273 return invalid_params
276 def get_base_template_from_yaml_files(yaml_files):
277 """Return first filepath to match RE_BASE
279 for filepath in yaml_files:
280 basename = get_base_template_from_yaml_file(filepath)
286 def get_base_template_from_yaml_file(yaml_file):
287 (dirname, filename) = os.path.split(yaml_file)
288 files = os.listdir(dirname)
290 basename, __ = os.path.splitext(os.path.basename(file))
292 (__ == ".yaml" or __ == ".yml")
293 and RE_BASE.search(basename)
294 and basename.find("volume") == -1
296 return os.path.join(dirname, "{}{}".format(basename, __))
300 def parameter_type_to_heat_type(parameter):
301 # getting parameter format
302 if isinstance(parameter, list):
303 parameter_type = "comma_delimited_list"
304 elif isinstance(parameter, str):
305 parameter_type = "string"
306 elif isinstance(parameter, dict):
307 parameter_type = "json"
308 elif isinstance(parameter, int) or isinstance(parameter, float):
309 parameter_type = "number"
310 elif isinstance(parameter, bool):
311 parameter_type = "boolean"
313 parameter_type = None
315 return parameter_type
318 def prop_iterator(resource, *props):
319 terminators = ["get_resource", "get_attr", "str_replace", "get_param"]
320 if "properties" in resource:
321 resource = resource.get("properties")
324 if isinstance(resource, dict) and any(x for x in terminators if x in resource):
327 prop = resource.get(props.pop(0))
328 if isinstance(prop, list):
330 yield from prop_iterator(x, *props)
331 elif isinstance(prop, dict):
332 yield from prop_iterator(prop, *props)
335 def get_param(property_value):
337 Returns the first parameter name from a get_param or None if get_param is
340 if property_value and isinstance(property_value, dict):
341 param = property_value.get("get_param")
342 if param and isinstance(param, list) and len(param) > 0:
349 def get_output_dir(config):
351 Retrieve the output directory for the reports and create it if necessary
352 :param config: pytest configuration
353 :return: output directory as string
355 output_dir = config.option.output_dir or DEFAULT_OUTPUT_DIR
356 if not os.path.exists(output_dir):
357 os.makedirs(output_dir, exist_ok=True)
361 def first(seq, predicate, default=None):
363 Return the first item in sequence that satisfies the callable, predicate, or
364 returns the default if not found.
366 :param seq: iterable sequence of objects
367 :param predicate: callable that accepts one item from the sequence
368 :param default: value to return if not found (default is None)
369 :return: default value if no item satisfies the predicate
371 return next((i for i in seq if predicate(i)), default)
374 def check(predicate, message):
376 Raise a RuntimeError with the provided message if predicate is False.
379 check(path.is_file(), "{} must be a file".format(path.as_posix()))
381 :param predicate: boolean condition
382 :param message: message
385 raise RuntimeError(message)
388 def unzip(zip_path, target_dir):
390 Extracts a Zip archive located at zip_path to target_dir (which will be
391 created if it already exists)
393 :param zip_path: path to valid zip file
394 :param target_dir: directory to unzip zip_path
396 check(zipfile.is_zipfile(zip_path), "{} is not a valid zipfile or does not exist".format(zip_path))
397 archive = zipfile.ZipFile(zip_path)
398 if not os.path.exists(target_dir):
399 os.makedirs(target_dir, exist_ok=True)
400 archive.extractall(path=target_dir)
403 def remove(sequence, exclude, key=None):
405 Remove a copy of sequence that items occur in exclude.
407 :param sequence: sequence of objects
408 :param exclude: objects to excluded (must support ``in`` check)
409 :param key: optional function to extract key from item in sequence
410 :return: list of items not in the excluded
412 key_func = key if key else lambda x: x
413 result = (s for s in sequence if key_func(s) not in exclude)
414 return set(result) if isinstance(sequence, Set) else list(result)
417 def is_nova_server(resource):
419 checks resource is a nova server
421 return isinstance(resource, dict) and "type" in resource and "properties" in resource and resource.get("type") == "OS::Nova::Server"