aboutsummaryrefslogtreecommitdiffstats
path: root/run_test.py
blob: 7e5b410884eafaa29e1de2674f669cc4a4101fac (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
import configparser
import importlib
import importlib.util
import logging.config
import os
import sys
import glob

from onapsdk.exceptions import ModuleError
import onaptests.utils.exceptions as onap_test_exceptions

SETTING_FILE_EXCEPTIONS = {
    "clearwater_ims": "clearwater_ims_nomulticloud_settings",
    "basic_cnf": "basic_cnf_yaml_settings",
    "basic_cds": "cba_enrichment_settings",
    "basic_network": "basic_network_nomulticloud_settings",
    "multi_vnf_macro": "multi_vnf_ubuntu_settings",
    "add_pnf_in_running_service": "instantiate_pnf_without_registration_event_settings"
}

MODULES_TO_RELOAD = [
    "onapsdk",
    "onaptests"
]

def get_entrypoints():
    config = configparser.ConfigParser()
    config.read('setup.cfg')
    entry_points = config['entry_points']['xtesting.testcase']
    config = configparser.ConfigParser()
    config.read_string(f"[entry_points]\n{entry_points}")
    entry_points = config['entry_points']
    entry_points_result = {}
    for test_name, entrypoint in entry_points.items():
        test_scenario_module, test_class = entrypoint.split(":")
        entry_points_result[test_name] = {
            "module": test_scenario_module,
            "class": test_class
        }
    return entry_points_result

def check_scenarios(scenarios, entry_points):
    path = importlib.util.find_spec(scenarios.__name__).submodule_search_locations
    modules = glob.glob(f"{path._path[0]}/*.py")
    all_mods = [ os.path.basename(f)[:-3] for f in modules if os.path.isfile(f) and not f.endswith('__init__.py')]
    for mod_name in all_mods:
        full_mod_name = f"{scenarios.__name__}.{mod_name}"
        if mod_name != "scenario_base":
            exists = False
            for test_name, entry_point in entry_points.items():
                if entry_point["module"] == full_mod_name:
                    exists = True
                    break
            if not exists:
                raise onap_test_exceptions.TestConfigurationException(
                    f"Scenario defined in {full_mod_name}.py is not added to setup.cfg file")

def run_test(test_name, validation, force_cleanup, entry_point):
    print(f"Configuring {test_name} test")
    settings_env = "ONAP_PYTHON_SDK_SETTINGS"
    if force_cleanup:
        validation_env = "PYTHON_SDK_TESTS_FORCE_CLEANUP"
        os.environ[validation_env] = "True"

    setting_file_name = f"{test_name}_settings"
    if test_name in SETTING_FILE_EXCEPTIONS:
        setting_file_name = SETTING_FILE_EXCEPTIONS[test_name]
    os.environ[settings_env] = f"onaptests.configuration.{setting_file_name}"
    try:
        basic_settings = importlib.import_module("onaptests.configuration.settings")
        if validation:
            basic_settings.IF_VALIDATION = True
        settings_module = importlib.import_module("onapsdk.configuration")
    except ModuleError:
        raise onap_test_exceptions.TestConfigurationException(
            f"Expected setting file {os.environ[settings_env]} not found")

    if validation:
        settings_module.settings.CLEANUP_FLAG = True
        settings_module.settings.CLEANUP_ACTIVITY_TIMER = 1
        settings_module.settings.SDC_CLEANUP = True
        settings_module.settings.SERVICE_DISTRIBUTION_SLEEP_TIME = 1

    # logging configuration for onapsdk, it is not requested for onaptests
    # Correction requested in onapsdk to avoid having this duplicate code
    logging.config.dictConfig(settings_module.settings.LOG_CONFIG)
    logger = logging.getLogger(test_name)
    logger.info(f"Running {test_name} test")

    scenarios = importlib.import_module("onaptests.scenario")
    test_module = importlib.import_module(entry_point["module"])

    test_instance = getattr(test_module, entry_point["class"])()
    if validation:
        validate_scenario_base_class(test_name, test_instance, scenarios)
    test_instance.run()
    test_instance.clean()
    if validation:
        logger.info(f"Validating {test_name} test")
        test_instance.validate()
    return scenarios

def validate_scenario_base_class(test_name, scenario, scenarios):
    has_scenario_base = False
    if test_name != scenario.case_name:
        raise onap_test_exceptions.TestConfigurationException(
            f"[{test_name}] Mismatch of scenario case name: {test_name} != {scenario.case_name}")
    if scenario.__class__.run != scenarios.scenario_base.ScenarioBase.run:
        raise onap_test_exceptions.TestConfigurationException(
            f"[{test_name}] scenario class overrides run() method what is forbidden")
    if scenario.__class__.clean != scenarios.scenario_base.ScenarioBase.clean:
        raise onap_test_exceptions.TestConfigurationException(
            f"[{test_name}] scenario class overrides clean() method what is forbidden")
    for base in scenario.__class__.__bases__:
        if base.__name__ in "ScenarioBase":
            has_scenario_base = True
            break
    if not has_scenario_base:
        raise onap_test_exceptions.TestConfigurationException(
            f"[{test_name}] {scenario.__class__.__name__} class does not inherit from ScenarioBase")

def main(argv):
    """Script is used to run one or all the tests.

    You need to specify a name of the test like 'basic_cps' or
    keyword 'all' that tells to run all the tests. You can also
    pass a second argument of any value that tells the script to run
    test(s) in the validation mode that checks only a basic setup of
    steps (like cleanup) and their execution in a certain order.

    Examplary use:
    - python run_test.py basic_vm_macro
    - python run_test.py basic_cps validation
    - python run_test.py all true
    """
    if len(argv) == 0:
        print("Required test name argument missing", file=sys.stderr)
        print("\nExample: python run_test.py basic_cps\n")
        exit(1)
    validation = len(argv) > 1
    force_cleanup = len(argv) > 2
    test_name = argv[0]
    entry_points = get_entrypoints()
    if test_name == "all":
        modules_reload = False
        scenarios = None
        for test_name, entry_point in entry_points.items():
            if modules_reload:
                modules_to_keep = dict()
                for module in sys.modules:
                    reload_module = False
                    for module_to_reload in MODULES_TO_RELOAD:
                        if module_to_reload in module:
                            reload_module = True
                            break
                    if not reload_module:
                        modules_to_keep[module] = sys.modules[module]
                sys.modules.clear()
                sys.modules.update(modules_to_keep)
            scenarios = run_test(
                test_name, validation, force_cleanup, entry_point)
            modules_reload = True
        if validation:
            check_scenarios(scenarios, entry_points)
    else:
        entry_point = entry_points[test_name]
        run_test(test_name, validation, force_cleanup, entry_point)

if __name__ == "__main__":
    main(sys.argv[1:])