conftest.py 4.51 KB
Newer Older
1
from collections import namedtuple, OrderedDict
2 3 4 5 6 7
import glob
import os
import re
import yaml


8
Scenario = namedtuple("Scenario", ["path", "qmin", "config"])
9 10


11 12 13 14 15 16 17 18 19
def ordered_load(stream, Loader=yaml.Loader, object_pairs_hook=OrderedDict):
    """Make YaML load to OrderedDict.
    This is done to ensure compability with Python versions prior to 3.6.
    See docs.python.org/3.6/whatsnew/3.6.html#new-dict-implementation for more information.

    repr(config) is a part of testcase's name in pytest.
    We need to ensure that it is ordered in the same way.
    See https://github.com/pytest-dev/pytest/issues/1075.
    """
20
    class OrderedLoader(Loader):  # pylint: disable=too-many-ancestors
21 22 23 24 25 26 27 28 29 30 31 32 33
        pass

    def construct_mapping(loader, node):
        loader.flatten_mapping(node)
        return object_pairs_hook(loader.construct_pairs(node))

    OrderedLoader.add_constructor(
        yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
        construct_mapping)

    return yaml.load(stream, OrderedLoader)


34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
def config_sanity_check(config_dict, config_name):
    """Checks if parsed configuration is valid"""
    mandatory_keys = {'name', 'binary', 'templates', 'configs', 'additional'}
    for cfg in config_dict['programs']:
        missing_keys = mandatory_keys - set(cfg.keys())
        assert not missing_keys, 'Mandatory fields in configuration are missing: %s' % missing_keys

        # sanity check templates vs. configs
        assert len(cfg['templates']) == len(cfg['configs']),\
            ('Number of jinja2 template files is not equal '
             'to number of config files to be generated for '
             'program "%s" (%s), i.e. len(templates) != len(configs)'
             % (cfg['name'], config_name))

        for additional in cfg["additional"]:
49
            assert isinstance(additional, str),\
50 51 52 53 54 55 56 57 58 59 60 61 62 63
                "All additional arguments in yaml should be strings. (%s, %s)"\
                % (cfg['name'], config_name)


def get_qmin_config(path):
    """Reads configuration from the *.rpl file and determines query-minimization setting."""
    with open(path) as f:
        for line in f:
            if re.search(r"^CONFIG_END", line) or re.search(r"^SCENARIO_BEGIN", line):
                return None
            if re.search(r"^\s*query-minimization:\s*(on|yes)", line):
                return True
            if re.search(r"^\s*query-minimization:\s*(off|no)", line):
                return False
64
    return None
65 66


67
def scenarios(paths, configs):
68
    """Returns list of *.rpl files from given path and packs them with their minimization setting"""
69

70 71
    assert len(paths) == len(configs),\
        "Number of --config has to be equal to number of --scenarios arguments."
72 73 74 75

    scenario_list = []

    for path, config in zip(paths, configs):
76
        config_dict = ordered_load(open(config), yaml.SafeLoader)
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
        config_sanity_check(config_dict, config)

        if os.path.isfile(path):
            filelist = [path]  # path to single file, accept it
        else:
            filelist = sorted(glob.glob(os.path.join(path, "*.rpl")))

        if not filelist:
            raise ValueError('no *.rpl files found in path "{}"'.format(path))

        for file in filelist:
            scenario_list.append(Scenario(file, get_qmin_config(file), config_dict))

    return scenario_list


93 94 95 96 97 98 99 100 101 102
def rpls(paths):
    for path in paths:
        if os.path.isfile(path):
            filelist = [path]  # path to single file, accept it
        else:
            filelist = sorted(glob.glob(os.path.join(path, "*.rpl")))

        return filelist


103
def pytest_addoption(parser):
104 105
    parser.addoption("--config", action="append", help="path to Deckard configuration .yaml file")
    parser.addoption("--scenarios", action="append", help="directory with .rpl files")
106 107 108


def pytest_generate_tests(metafunc):
109
    """This is pytest weirdness to parametrize the test over all the *.rpl files.
Štěpán Balážik's avatar
Štěpán Balážik committed
110 111 112
    See https://docs.pytest.org/en/latest/parametrize.html#basic-pytest-generate-tests-example
    for more info."""

113
    if 'scenario' in metafunc.fixturenames:
114 115
        if metafunc.config.option.config is None:
            configs = []
116
        else:
117
            configs = metafunc.config.option.config
118

119 120 121 122
        if metafunc.config.option.scenarios is None:
            paths = ["sets/resolver"] * len(configs)
        else:
            paths = metafunc.config.option.scenarios
123

124
        metafunc.parametrize("scenario", scenarios(paths, configs), ids=str)
125
    if 'rpl_path' in metafunc.fixturenames:
126
        paths = metafunc.config.option.scenarios
127
        metafunc.parametrize("rpl_path", rpls(paths), ids=str)