aboutsummaryrefslogtreecommitdiffstats
path: root/ice_validator/tests/helpers.py
blob: f4a368ce86f991050a16637ffb99338b41917a00 (plain)
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# -*- 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============================================
#
#

"""Helpers
"""

import os
import re
import zipfile
from collections import defaultdict
from typing import Set

from boltons import funcutils
from tests import cached_yaml as yaml

__path__ = [os.path.dirname(os.path.abspath(__file__))]
DEFAULT_OUTPUT_DIR = "{}/../output".format(__path__[0])
RE_BASE = re.compile(r"(^base$)|(^base_)|(_base_)|(_base$)")

INTRINSIC_FUNCTIONS = [
    "get_resource",
    "get_attr",
    "str_replace",
    "get_param",
    "list_join",
    "get_file",
    "resource_facade",
    "Fn::Select",
    "repeat",
    "digest",
    "str_split",
    "yaql",
    "map_replace",
    "map_merge",
]


def is_base_module(template_path):
    basename = os.path.basename(template_path).lower()
    name, extension = os.path.splitext(basename)
    is_yaml = extension in {".yml", ".yaml"}
    return is_yaml and RE_BASE.search(name) and not name.endswith("_volume")


def check_basename_ending(template_type, basename):
    """
    return True/False if the template type is matching
    the filename
    """
    if not template_type:
        return True
    elif template_type == "volume":
        return basename.endswith("_volume")
    else:
        return not basename.endswith("_volume")


def get_parsed_yml_for_yaml_files(yaml_files, sections=None):
    """
    get the parsed yaml for a list of yaml files
    """
    sections = [] if sections is None else sections
    parsed_yml_list = []
    for yaml_file in yaml_files:
        try:
            with open(yaml_file) as fh:
                yml = yaml.load(fh)
        except yaml.YAMLError as e:
            # pylint: disable=superfluous-parens
            print("Error in %s: %s" % (yaml_file, e))
            continue
        if yml:
            if sections:
                for k in yml.keys():
                    if k not in sections:
                        del yml[k]
            parsed_yml_list.append(yml)
    return parsed_yml_list


def validates(*requirement_ids):
    """Decorator that tags the test function with one or more requirement IDs.

    Example:
        >>> @validates('R-12345', 'R-12346')
        ... def test_something():
        ...     pass
        >>> assert test_something.requirement_ids == ['R-12345', 'R-12346']
    """
    # pylint: disable=missing-docstring
    def decorator(func):
        # NOTE: We use a utility here to ensure that function signatures are
        # maintained because pytest inspects function signatures to inject
        # fixtures.  I experimented with a few options, but this is the only
        # library that worked. Other libraries dynamically generated a
        # function at run-time, and then lost the requirement_ids attribute
        @funcutils.wraps(func)
        def wrapper(*args, **kw):
            return func(*args, **kw)

        wrapper.requirement_ids = requirement_ids
        return wrapper

    decorator.requirement_ids = requirement_ids
    return decorator


def categories(*all_of, any_of=None):
    any_of = set(any_of) if any_of else set()
    all_of = set(all_of) if all_of else set()

    def decorator(func):
        @funcutils.wraps(func)
        def wrapper(*args, **kw):
            return func(*args, **kw)

        wrapper.all_categories = all_of
        wrapper.any_categories = any_of
        return wrapper

    decorator.all_categories = all_of
    decorator.any_categories = any_of
    return decorator


def get_environment_pair(heat_template):
    """Returns a yaml/env pair given a yaml file"""
    base_dir, filename = os.path.split(heat_template)
    basename = os.path.splitext(filename)[0]
    env_template = os.path.join(base_dir, "{}.env".format(basename))
    if os.path.exists(env_template):
        with open(heat_template, "r") as fh:
            yyml = yaml.load(fh)
        with open(env_template, "r") as fh:
            eyml = yaml.load(fh)

        environment_pair = {"name": basename, "yyml": yyml, "eyml": eyml}
        return environment_pair

    return None


def find_environment_file(yaml_files):
    """
    Pass file and recursively step backwards until environment file is found

    :param yaml_files: list or string, start at size 1 and grows recursively
    :return: corresponding environment file for a file, or None
    """
    # sanitize
    if isinstance(yaml_files, str):
        yaml_files = [yaml_files]

    yaml_file = yaml_files[-1]
    filepath, filename = os.path.split(yaml_file)

    environment_pair = get_environment_pair(yaml_file)
    if environment_pair:
        return environment_pair

    for file in os.listdir(filepath):
        fq_name = "{}/{}".format(filepath, file)
        if fq_name.endswith("yaml") or fq_name.endswith("yml"):
            if fq_name not in yaml_files:
                with open(fq_name) as f:
                    yml = yaml.load(f)
                resources = yml.get("resources", {})
                for resource_id, resource in resources.items():
                    resource_type = resource.get("type", "")
                    if resource_type == "OS::Heat::ResourceGroup":
                        resource_type = (
                            resource.get("properties", {})
                            .get("resource_def", {})
                            .get("type", "")
                        )
                    # found called nested file
                    if resource_type == filename:
                        yaml_files.append(fq_name)
                        environment_pair = find_environment_file(yaml_files)

    return environment_pair


def load_yaml(yaml_file):
    """
    Load the YAML file at the given path.  If the file has previously been
    loaded, then a cached version will be returned.

    :param yaml_file: path to the YAML file
    :return: data structure loaded from the YAML file
    """
    with open(yaml_file) as fh:
        return yaml.load(fh)


def traverse(data, search_key, func, path=None):
    """
    Traverse the data structure provided via ``data`` looking for occurences
    of ``search_key``.  When ``search_key`` is found, the value associated
    with that key is passed to ``func``

    :param data:        arbitrary data structure of dicts and lists
    :param search_key:  key field to search for
    :param func:        Callable object that takes two parameters:
                        * A list representing the path of keys to search_key
                        * The value associated with the search_key
    """
    path = [] if path is None else path
    if isinstance(data, dict):
        for key, value in data.items():
            curr_path = path + [key]
            if key == search_key:
                func(curr_path, value)
            traverse(value, search_key, func, curr_path)
    elif isinstance(data, list):
        for value in data:
            curr_path = path + [value]
            if isinstance(value, (dict, list)):
                traverse(value, search_key, func, curr_path)
            elif value == search_key:
                func(curr_path, value)


def check_indices(pattern, values, value_type):
    """
    Checks that indices associated with the matched prefix start at 0 and
    increment by 1.  It returns a list of messages for any prefixes that
    violate the rules.

    :param pattern: Compiled regex that whose first group matches the prefix and
                    second group matches the index
    :param values:  sequence of string names that may or may not match the pattern
    :param name:    Type of value being checked (ex: IP Parameters). This will
                    be included in the error messages.
    :return:        List of error messages, empty list if no violations found
    """
    if not hasattr(pattern, "match"):
        raise RuntimeError("Pattern must be a compiled regex")

    prefix_indices = defaultdict(set)
    for value in values:
        m = pattern.match(value)
        if m:
            prefix_indices[m.group(1)].add(int(m.group(2)))

    invalid_params = []
    for prefix, indices in prefix_indices.items():
        indices = sorted(indices)
        if indices[0] != 0:
            invalid_params.append(
                "{} with prefix {} do not start at 0".format(value_type, prefix)
            )
        elif len(indices) - 1 != indices[-1]:
            invalid_params.append(
                (
                    "Index values of {} with prefix {} do not " + "increment by 1: {}"
                ).format(value_type, prefix, indices)
            )
    return invalid_params


def get_base_template_from_yaml_files(yaml_files):
    """Return first filepath to match RE_BASE
    """
    for filepath in yaml_files:
        basename = get_base_template_from_yaml_file(filepath)
        if basename:
            return basename
    return None


def get_base_template_from_yaml_file(yaml_file):
    (dirname, filename) = os.path.split(yaml_file)
    files = os.listdir(dirname)
    for file in files:
        basename, __ = os.path.splitext(os.path.basename(file))
        if (
            (__ == ".yaml" or __ == ".yml")
            and RE_BASE.search(basename)
            and basename.find("volume") == -1
        ):
            return os.path.join(dirname, "{}{}".format(basename, __))
    return None


def parameter_type_to_heat_type(parameter):
    # getting parameter format
    if isinstance(parameter, list):
        parameter_type = "comma_delimited_list"
    elif isinstance(parameter, str):
        parameter_type = "string"
    elif isinstance(parameter, dict):
        parameter_type = "json"
    elif isinstance(parameter, int) or isinstance(parameter, float):
        parameter_type = "number"
    elif isinstance(parameter, bool):
        parameter_type = "boolean"
    else:
        parameter_type = None

    return parameter_type


def prop_iterator(resource, *props):
    if "properties" in resource:
        resource = resource.get("properties")
    props = list(props)

    if isinstance(resource, dict) and any(
        x for x in INTRINSIC_FUNCTIONS if x in resource
    ):
        yield resource
    else:
        prop = resource.get(props.pop(0))
        if isinstance(prop, list):
            for x in prop:
                yield from prop_iterator(x, *props)
        elif isinstance(prop, dict):
            yield from prop_iterator(prop, *props)


def get_param(property_value):
    """
    Returns the first parameter name from a get_param or None if get_param is
    not used
    """
    if property_value and isinstance(property_value, dict):
        param = property_value.get("get_param")
        if param and isinstance(param, list) and len(param) > 0:
            return param[0]
        else:
            return param
    return None


def get_output_dir(config):
    """
    Retrieve the output directory for the reports and create it if necessary
    :param config: pytest configuration
    :return: output directory as string
    """
    output_dir = config.option.output_dir or DEFAULT_OUTPUT_DIR
    if not os.path.exists(output_dir):
        os.makedirs(output_dir, exist_ok=True)
    return output_dir


def first(seq, predicate, default=None):
    """
    Return the first item in sequence that satisfies the callable, predicate, or
    returns the default if not found.

    :param seq:         iterable sequence of objects
    :param predicate:   callable that accepts one item from the sequence
    :param default:     value to return if not found (default is None)
    :return:            default value if no item satisfies the predicate
    """
    return next((i for i in seq if predicate(i)), default)


def check(predicate, message):
    """
    Raise a RuntimeError with the provided message if predicate is False.

    Example:
        check(path.is_file(), "{} must be a file".format(path.as_posix()))

    :param predicate:   boolean condition
    :param message:     message
    """
    if not predicate:
        raise RuntimeError(message)


def unzip(zip_path, target_dir):
    """
    Extracts a Zip archive located at zip_path to target_dir (which will be
    created if it already exists)

    :param zip_path:    path to valid zip file
    :param target_dir:  directory to unzip zip_path
    """
    check(
        zipfile.is_zipfile(zip_path),
        "{} is not a valid zipfile or does not exist".format(zip_path),
    )
    archive = zipfile.ZipFile(zip_path)
    if not os.path.exists(target_dir):
        os.makedirs(target_dir, exist_ok=True)
    archive.extractall(path=target_dir)


def remove(sequence, exclude, key=None):
    """
    Remove a copy of sequence that items occur in exclude.

    :param sequence: sequence of objects
    :param exclude:  objects to excluded (must support ``in`` check)
    :param key:      optional function to extract key from item in sequence
    :return:         list of items not in the excluded
    """
    key_func = key if key else lambda x: x
    result = (s for s in sequence if key_func(s) not in exclude)
    return set(result) if isinstance(sequence, Set) else list(result)


def is_nova_server(resource):
    """
    checks resource is a nova server
    """
    return (
        isinstance(resource, dict)
        and "type" in resource
        and "properties" in resource
        and resource.get("type") == "OS::Nova::Server"
    )