aboutsummaryrefslogtreecommitdiffstats
path: root/ice_validator/tests/parametrizers.py
blob: 35cf6e01c275bbb574cf40472177ce74d3bbd875 (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
# -*- coding: utf8 -*-
# ============LICENSE_START====================================================
# org.onap.vvp/validation-scripts
# ===================================================================
# Copyright © 2017 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============================================
#
#

"""parametrizers
"""

from os import path, listdir
import re
from tests import cached_yaml as yaml
import pytest
from tests.helpers import get_parsed_yml_for_yaml_files, check_basename_ending
from tests.utils.nested_files import get_nested_files

VERSION = "1.0.0"

# pylint: disable=invalid-name


def get_template_dir(metafunc):
    """
    returns template_dir, either as its passed in on CLI
    or, during --self-test, the directory whos name matches
    the current tests module name
    """
    if metafunc.config.getoption("template_dir") is None:
        return path.join(
            path.dirname(metafunc.module.__file__),
            "fixtures",
            metafunc.function.__module__.split(".")[-1],
        )
    else:
        return metafunc.config.getoption("template_dir")[0]


def list_filenames_in_template_dir(
    metafunc, extensions, template_type="", sub_dirs=None
):
    """
    returns the filenames in a template_dir, either as its passed in
    on CLI or, during --self-test, the directory whos name matches
    the current tests module name
    """
    sub_dirs = [] if sub_dirs is None else sub_dirs
    template_dir = get_template_dir(metafunc)
    filenames = []
    if metafunc.config.getoption("self_test"):
        filenames = [
            path.join(template_dir, s, f)
            for s in sub_dirs
            for f in listdir(path.join(template_dir, s))
            if path.isfile(path.join(template_dir, s, f))
            and path.splitext(f)[-1] in extensions
            and check_basename_ending(template_type, path.splitext(f)[0])
        ]
    else:
        filenames = [
            path.join(template_dir, f)
            for f in listdir(template_dir)
            if path.isfile(path.join(template_dir, f))
            and path.splitext(f)[-1] in extensions
            and check_basename_ending(template_type, path.splitext(f)[0])
        ]
    return filenames


def list_template_dir(
    metafunc, extensions, exclude_nested=True, template_type="", sub_dirs=None
):
    """
    returns the filenames excluding the nested files for a template_dir,
    either as its passed in on CLI or, during --self-test, the
    directory whos name matches the current tests module name
    """
    sub_dirs = [] if sub_dirs is None else sub_dirs
    filenames = []
    nested_files = []
    filenames = list_filenames_in_template_dir(
        metafunc, extensions, template_type, sub_dirs
    )
    if exclude_nested:
        nested_files = get_nested_files(filenames)
    return list(set(filenames) - set(nested_files))


def get_filenames_list(
    metafunc, extensions=None, exclude_nested=False, template_type=""
):
    """
    returns the filename fixtures for the template dir, either as by how its
    passed in on CLI or, during --self-test, the directory whos name
    matches the current tests module name
    """
    extensions = [".yaml", ".yml", ".env"] if extensions is None else extensions
    if metafunc.config.getoption("self_test"):
        filenames_list = list_template_dir(
            metafunc, extensions, exclude_nested, template_type, ["pass"]
        )
        filenames_list += [
            pytest.mark.xfail(f, strict=True)
            for f in list_template_dir(
                metafunc, extensions, exclude_nested, template_type, ["fail"]
            )
        ]
    else:
        filenames_list = list_template_dir(
            metafunc, extensions, exclude_nested, template_type
        )

    return filenames_list


def get_filenames_lists(
    metafunc, extensions=None, exclude_nested=False, template_type=""
):
    """
    returns the list of files in the template dir, either as by how its
    passed in on CLI or, during --self-test, the directory whos name
    matches the current tests module name
    """
    extensions = [".yaml", ".yml", ".env"] if extensions is None else extensions
    filenames_lists = []
    if metafunc.config.getoption("self_test"):
        filenames_lists.append(
            list_template_dir(
                metafunc, extensions, exclude_nested, template_type, ["pass"]
            )
        )
        filenames_lists.append(
            pytest.mark.xfail(
                list_template_dir(
                    metafunc, extensions, exclude_nested, template_type, ["fail"]
                ),
                strict=True,
            )
        )
    else:
        filenames_lists.append(
            list_template_dir(metafunc, extensions, exclude_nested, template_type)
        )
    return filenames_lists


def get_parsed_yaml_files(
    metafunc, extensions, exclude_nested=True, template_type="", sections=None
):
    """
    returns the list of parsed yaml files in the specified template dir,
    either as by how its passed in on CLI or, during --self-test, the
    directory whos name matches the current tests module name
    """
    sections = [] if sections is None else sections
    extensions = [".yaml", ".yml"]

    if metafunc.config.getoption("self_test"):
        yaml_files = list_template_dir(
            metafunc, extensions, exclude_nested, template_type, ["pass"]
        )
        parsed_yml_list = get_parsed_yml_for_yaml_files(yaml_files, sections)

        yaml_files = list_template_dir(
            metafunc, extensions, exclude_nested, template_type, ["fail"]
        )
        parsed_yml_list = get_parsed_yml_for_yaml_files(yaml_files, sections)
        parsed_yml_list += [
            pytest.mark.xfail(parsed_yml, strict=True) for parsed_yml in parsed_yml_list
        ]
    else:
        yaml_files = list_template_dir(metafunc, extensions)
        parsed_yml_list = get_parsed_yml_for_yaml_files(yaml_files, sections)
    return parsed_yml_list


def parametrize_filenames(metafunc):
    """
    This param runs tests all files in the template dir
    """
    filenames = get_filenames_lists(metafunc)
    metafunc.parametrize("filenames", filenames)


def parametrize_filename(metafunc):
    """
    This param runs tests once for every file in the template dir
    """
    filenames = get_filenames_list(metafunc)
    metafunc.parametrize("filename", filenames)


def parametrize_yaml_files(metafunc):
    """
    This param runs tests for the yaml files in the template dir
    """
    yaml_files = get_filenames_lists(metafunc, [".yaml", ".yml"], False)
    metafunc.parametrize("yaml_files", yaml_files)


def parametrize_yaml_file(metafunc):
    """
    This param runs tests for every yaml file in the template dir
    """
    yaml_files = get_filenames_list(metafunc, [".yaml", ".yml"], False)
    metafunc.parametrize("yaml_file", yaml_files)


def parametrize_templates(metafunc):
    """
    This param runs tests for the template in the template dir
    """
    templates = get_filenames_lists(metafunc, [".yaml", ".yml"], True)
    metafunc.parametrize("templates", templates)


def parametrize_template(metafunc):
    """
    This param runs tests for every template in the template dir
    """
    templates = get_filenames_list(metafunc, [".yaml", ".yml"], True)
    metafunc.parametrize("template", templates)


def parametrize_parsed_yaml_file(metafunc):
    """
    This param runs tests for a parsed version of each yaml file
    in the template dir
    """
    parsed_yaml_files = get_parsed_yaml_files(metafunc, [".yaml", ".yml"], False)
    metafunc.parametrize("parsed_yaml_file", parsed_yaml_files)


def parametrize_heat_templates(metafunc):
    """
    This param runs tests for all heat templates in the template dir
    """
    heat_templates = get_filenames_lists(metafunc, [".yaml", ".yml"], True, "heat")
    metafunc.parametrize("heat_templates", heat_templates)


def parametrize_heat_template(metafunc):
    """
    This param runs tests for every heat template in the template dir
    """
    heat_templates = get_filenames_list(metafunc, [".yaml", ".yml"], True, "heat")
    metafunc.parametrize("heat_template", heat_templates)


def parametrize_volume_templates(metafunc):
    """
    This param runs tests for all volume templates in the template dir
    """
    volume_templates = get_filenames_lists(metafunc, [".yaml", ".yml"], True, "volume")
    metafunc.parametrize("volume_templates", volume_templates)


def parametrize_volume_template(metafunc):
    """

    This param runs tests for every volume template in the template dir
    """
    volume_templates = get_filenames_list(metafunc, [".yaml", ".yml"], True, "volume")
    metafunc.parametrize("volume_template", volume_templates)


def parametrize_environment_files(metafunc):
    """
    This param runs tests for all environment files in the template dir
    """
    env_files = get_filenames_lists(metafunc, [".env"])
    metafunc.parametrize("env_files", env_files)


def parametrize_environment_file(metafunc):
    """
    This param runs tests for every environment file in the template dir
    """
    env_files = get_filenames_list(metafunc, [".env"])
    metafunc.parametrize("env_file", env_files)


def parametrize_parsed_environment_file(metafunc):
    """
    This param runs tests for every parsed environment file
    in the template dir
    """
    parsed_env_files = get_parsed_yaml_files(metafunc, [".env"])
    metafunc.parametrize("parsed_env_file", parsed_env_files)


def parametrize_template_dir(metafunc):
    """
    This param passes a  the template_dir as passed in on CLI
    or, during --self-test, passes in the sub directories of
    template_dir/pass/ and template_dir/fail
    template_dir = get_template_dir(metafunc)
    """
    template_dir = get_template_dir(metafunc)

    if metafunc.config.getoption("self_test"):
        dirs = [
            path.join(template_dir, s, t)
            for s in ["pass"]
            for t in listdir(path.join(template_dir, s))
            if path.isdir(path.join(template_dir, s, t))
        ]

        dirs += [
            pytest.mark.xfail(path.join(template_dir, s, t))
            for s in ["fail"]
            for t in listdir(path.join(template_dir, s))
            if path.isdir(path.join(template_dir, s, t))
        ]
    else:
        dirs = [template_dir]

    metafunc.parametrize("template_dir", dirs)


def parametrize_environment_pair(metafunc, template_type=""):
    """
    Define a list of pairs of parsed yaml from the heat templates and
    environment files
    """
    pairs = []
    if metafunc.config.getoption("self_test"):
        sub_dirs = ["pass", "fail"]
        env_files = list_template_dir(metafunc, [".env"], True, template_type, sub_dirs)
        yaml_files = list_template_dir(
            metafunc, [".yaml", ".yml"], True, template_type, sub_dirs
        )
    else:
        env_files = list_template_dir(metafunc, [".env"], True, template_type)
        yaml_files = list_template_dir(metafunc, [".yaml", ".yml"], True, template_type)

    for filename in env_files:
        basename = path.splitext(filename)[0]
        if basename + ".yml" in yaml_files:
            yfilename = basename + ".yml"
        else:
            yfilename = basename + ".yaml"

        try:
            with open(filename) as fh:
                eyml = yaml.load(fh)
            with open(yfilename) as fh:
                yyml = yaml.load(fh)

            if "fail" in filename:
                pairs.append(
                    pytest.mark.xfail(
                        {"name": basename, "yyml": yyml, "eyml": eyml}, strict=True
                    )
                )
            else:
                pairs.append({"name": basename, "yyml": yyml, "eyml": eyml})

        except yaml.YAMLError as e:
            print(e)  # pylint: disable=superfluous-parens

    metafunc.parametrize("environment_pair", pairs)


def parametrize_heat_volume_pair(metafunc):
    """
    Define a list of pairs of parsed yaml from the a heat and volume
    template
    """
    pairs = []
    if metafunc.config.getoption("self_test"):
        sub_dirs = ["pass", "fail"]
        volume_files = list_template_dir(
            metafunc, [".yaml", ".yml"], True, "volume", sub_dirs
        )
        yaml_files = list_template_dir(metafunc, [".yaml", ".yml"], True, "", sub_dirs)
    else:
        volume_files = list_template_dir(metafunc, [".yaml", ".yml"], True, "volume")
        yaml_files = list_template_dir(metafunc, [".yaml", ".yml"], True)

    pattern = re.compile(r"\_volume$")
    for vfilename in volume_files:
        basename = pattern.sub("", path.splitext(vfilename)[0])
        if basename + ".yml" in yaml_files:
            yfilename = basename + ".yml"
        else:
            yfilename = basename + ".yaml"

        try:
            with open(vfilename) as fh:
                vyml = yaml.load(fh)
            with open(yfilename) as fh:
                yyml = yaml.load(fh)

            if "fail" in vfilename:
                pairs.append(
                    pytest.mark.xfail(
                        {"name": basename, "yyml": yyml, "vyml": vyml}, strict=True
                    )
                )
            else:
                pairs.append({"name": basename, "yyml": yyml, "vyml": vyml})

        except yaml.YAMLError as e:
            print(e)  # pylint: disable=superfluous-parens

    metafunc.parametrize("heat_volume_pair", pairs)