-
Notifications
You must be signed in to change notification settings - Fork 114
/
conftest.py
433 lines (341 loc) · 15.3 KB
/
conftest.py
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
"""
This module is intended to be used for upgrade tests, that have two run stages,
First stage: pre_upgrade::
The test marked as pre_upgrade will be run the tests can save data, to be restored later in
post upgrade stage.
pytest -m "pre_upgrade" tests/foreman/upgrade
Second stage: post_upgrade::
The test marked as post upgrade will be run, any saved data in dependent pre_upgrade stage
can be restored, if a dependent test fail, the post upgrade test will be errored
pytest -m "post_upgrade" tests/foreman/upgrade
Example upgrade test module content: file test_upgrade.py::
import pytest
@pytest.mark.pre_upgrade
def test_capsule_pre_upgrade(save_test_data):
'''A pre upgrade test that should pass and save data'''
assert 1 == 1
data_value = {'id': 100, 'env_id': 500}
save_test_data(data_value)
@pytest.mark.pre_upgrade
def test_capsule_pre_upgrade_2(save_test_data):
'''A pre upgrade test that should pass and save data'''
assert 1 == 1
data_value = {'id': 1, 'cv_id': 3}
save_test_data(data_value)
@pytest.mark.pre_upgrade
def test_capsule_pre_upgrade_fail():
'''A pre upgrade test that should fail'''
assert 1 == 0
@pytest.mark.skip(reason="The post upgrade dependent tests should skip too")
@pytest.mark.pre_upgrade
def test_capsule_pre_upgrade_skipped():
'''A pre upgrade test that should be skipped'''
assert 1 == 0
@pytest.mark.post_upgrade(depend_on=test_capsule_pre_upgrade)
def test_capsule_post_upgrade(pre_upgrade_data):
'''Test with one dependent pre_upgrade test'''
assert pre_upgrade_data == {'id': 100, 'env_id': 500}
# The post_upgrade test can depend from many pre_upgrade tests
@pytest.mark.post_upgrade(depend_on=[test_capsule_pre_upgrade, test_capsule_pre_upgrade_2])
def test_capsule_post_upgrade_2(pre_upgrade_data):
'''Test with multiple dependent pre_upgrade tests'''
# The saved data is restored in the same order as in the list in depend_on
test_data, test_data_2 = pre_upgrade_data
assert test_data == {'id': 100, 'env_id': 500}
assert test_data_2 == {'id': 1, 'cv_id': 3}
@pytest.mark.post_upgrade(depend_on=test_capsule_pre_upgrade_fail)
def test_capsule_post_upgrade_fail(pre_upgrade_data):
'''Test must be skipped as test_capsule_pre_upgrade_fail should fail'''
assert 1 == 0
@pytest.mark.post_upgrade(depend_on=test_capsule_pre_upgrade_skipped)
def test_capsule_post_upgrade_skipped(pre_upgrade_data):
'''Test must be skipped as test_capsule_pre_upgrade_skipped should be skipped'''
assert 1 == 0
# in pre_upgrade scenario, test results should be
# 1 failed, 2 passed, 1 skipped, 4 deselected
# in post_upgrade scenario, test results should be
# 2 passed, 6 deselected
"""
import datetime
import functools
import json
import os
from box import Box
import pytest
from robottelo.config import settings
from robottelo.logging import logger
from robottelo.utils.decorators.func_locker import lock_function
pre_upgrade_failed_tests = []
PRE_UPGRADE_TESTS_FILE_OPTION = 'pre_upgrade_tests_file'
PRE_UPGRADE_TESTS_FILE_PATH = '/var/tmp/robottelo_pre_upgrade_failed_tests.json'
PRE_UPGRADE = False
POST_UPGRADE = False
PRE_UPGRADE_MARK = 'pre_upgrade'
POST_UPGRADE_MARK = 'post_upgrade'
TEST_NODE_ID_NAME = '__pytest_node_id'
__initiated = False
class OptionMarksError(Exception):
""" "Raised when upgrade marks are missing or badly used in runner options"""
def log(message, level="DEBUG"):
"""Pytest has a limitation to use logging.logger from conftest.py
so we need to emulate the logger by std-out the output
"""
now = datetime.datetime.now()
full_message = "{date} - conftest - {level} - {message}\n".format(
date=now.strftime("%Y-%m-%d %H:%M:%S"), level=level, message=message
)
print(full_message) # noqa
with open('robottelo.log', 'a') as log_file:
log_file.write(full_message)
# todo remove when upgrade_tests will be python 3 compatible
def create_dict(entities_dict):
"""Stores a global dictionary of entities created in satellite by the
scenarios tested, so that these entities can be retrieved post upgrade
to assert the test cases.
:param dict entities_dict: A dictionary of entities created in
satellite
"""
if os.path.exists('scenario_entities'):
with open('scenario_entities') as entities_data:
data = json.load(entities_data)
data.update(entities_dict)
with open('scenario_entities', 'w') as entities_data:
json.dump(data, entities_data)
else:
with open('scenario_entities', 'w') as entities_data:
json.dump(entities_dict, entities_data)
# todo remove when upgrade_tests will be python 3 compatible
def get_entity_data(scenario_name):
"""Fetches the dictionary of entities from the disk depending on the
Scenario name (class name in which test is defined)
:param str scenario_name: The name of the class for which the data is
to fetched
:returns dict entity_data: Returns a dictionary of entities
"""
with open('scenario_entities') as pref:
entity_data = json.load(pref)
return entity_data.get(scenario_name)
def get_all_entity_data():
"""Retrieves a dictionary containing data for entities in all scenarios.
Reads the contents of the 'scenario_entities' file using the JSON format,
and returns the resulting dictionary of entity data.
Returns:
-------
dict:
A dictionary containing information on entities in all scenarios,
with scenario_name as keys and corresponding attribute data as values.
"""
with open('scenario_entities') as pref:
return json.load(pref)
def _read_test_data(test_node_id):
"""Read the saved data of test at node id"""
try:
data = get_entity_data(test_node_id)
except KeyError:
data = None
return data
def _set_test_node_id(test_func, node_id):
"""Mark the test function with it's node_id"""
attribute_value = getattr(test_func, TEST_NODE_ID_NAME, None)
if attribute_value is None:
attribute_value = []
attribute_value.append(node_id)
setattr(test_func, TEST_NODE_ID_NAME, attribute_value)
def _get_test_node_id(test_func):
"""Return the test function node_id"""
return getattr(test_func, TEST_NODE_ID_NAME)
@lock_function
def _save_test_data(test_node_id, value):
"""Save the test data value with key node_id"""
create_dict({test_node_id: value})
@pytest.fixture
def save_test_data(request):
"""A fixture to allow saving test data
Usage::
@pytest.mark.pre_upgrade
def test_something_pre_upgrade(save_test_data):
...
save_test_data({'key': some_value})
"""
test_node_id = request.node.nodeid
return functools.partial(_save_test_data, test_node_id)
@pytest.fixture
def pre_upgrade_data(request):
"""A fixture to allow restoring the saved data in the pre_upgrade stage
Usage:
@pytest.mark.post_upgrade(depend_on=test_something_pre_upgrade)
def test_something_post_upgrade(pre_upgrade_data):
# Restoring
pre_upgrade_key_value = pre_upgrade_data['key'] or pre_upgrade_data.key
@pytest.mark.rhel_ver_list([param_1, param_2, param_3])
@pytest.mark.post_upgrade(depend_on=test_something_pre_upgrade)
def test_something_post_upgrade(pre_upgrade_data):
# Restoring
pre_upgrade_key_value = pre_upgrade_data['key'] or pre_upgrade_data.key
This fixture retrieves saved data from the pre_upgrade stage for use in the post_upgrade
stage. It looks for test functions marked with the 'post_upgrade' marker and retrieves
their dependencies.
The fixture provides the test data as a dictionary. Access the desired values using the
corresponding keys. It also parameterizes the post_upgrade test scenarios if the parameters
passed in the post_upgrade marker match with the pre_upgrade test scenario.
:param request: The pytest request object representing the test being executed.
:return: A Box object containing the test data for the pre_upgrade stage.
"""
dependant_on_functions = []
for marker in request.node.iter_markers(POST_UPGRADE_MARK):
depend_on = marker.kwargs.get('depend_on')
if isinstance(depend_on, list | tuple):
dependant_on_functions.extend(depend_on)
elif depend_on is not None:
dependant_on_functions.append(depend_on)
depend_on_node_ids = []
for f in dependant_on_functions:
depend_on_node_ids.extend(_get_test_node_id(f))
upgrade_data = {}
for test_node_id in depend_on_node_ids:
start_index = test_node_id.find('[') + 1
end_index = test_node_id.find(']')
extracted_value = test_node_id[start_index:end_index]
if request.param in extracted_value:
upgrade_data[extracted_value] = _read_test_data(test_node_id)
if len(upgrade_data) == 1:
param_value = next(iter(upgrade_data.values()))
else:
network_type = 'ipv6' if settings.server.is_ipv6 else 'ipv4'
param_value = upgrade_data.get(f'{request.param}-{network_type}')
if param_value is None:
pytest.fail(f"Invalid test parameter: {request.param}. Test data not found.")
return Box(param_value)
@pytest.fixture(scope='class')
def class_pre_upgrade_data(request):
"""Returns a dictionary of entity data for a specific upgrade test classes.
Filters the output of get_all_entity_data() to include only entities that
match the test class name and the name of the test function currently being run.
Args:
-----
request (pytest.FixtureRequest): A pytest FixtureRequest object containing
information about the current test.
Returns:
-------
Box: A Box object containing information on entities in the upgrade test class,
with entity IDs as keys and corresponding attribute data as values.
"""
data = {
key: value
for key, value in get_all_entity_data().items()
if f"{request.node.parent.name}::{request.node.name}" in key
}
return Box(data)
def pytest_configure(config):
"""Register custom markers to avoid warnings."""
markers = [
"pre_upgrade: Mark tests to run before upgrade.",
"post_upgrade(depend_on=None): Mark tests to run after upgrade.",
"fail: Mark test to fail if dependant test fails.",
]
for marker in markers:
config.addinivalue_line("markers", marker)
def pytest_addoption(parser):
"""This will add an option to the runner to be able to customize the location of the failed
tests file.
Usage::
pytest --pre_upgrade_tests_file file_location
Note: default location is /var/tmp/robottelo_pre_upgrade_failed_tests.json
"""
parser.addoption(
f'--{PRE_UPGRADE_TESTS_FILE_OPTION}',
action='store',
default=PRE_UPGRADE_TESTS_FILE_PATH,
)
def __initiate(config):
"""Do basic initialization for this module"""
global __initiated
if __initiated:
return
global pre_upgrade_failed_tests
global PRE_UPGRADE
global POST_UPGRADE
global PRE_UPGRADE_TESTS_FILE_PATH
PRE_UPGRADE_TESTS_FILE_PATH = getattr(config.option, PRE_UPGRADE_TESTS_FILE_OPTION)
if (
not [
upgrade_mark
for upgrade_mark in (PRE_UPGRADE_MARK, POST_UPGRADE_MARK)
if upgrade_mark in config.option.markexpr
]
and 'upgrades' in config.args[0]
): # Raise only if the `tests/upgrades` directory is selected
pytest.fail(
f'For upgrade scenarios either {PRE_UPGRADE_MARK} or {POST_UPGRADE_MARK} mark '
'must be provided'
)
if PRE_UPGRADE_MARK in config.option.markexpr:
pre_upgrade_failed_tests = []
PRE_UPGRADE = True
# remove file before begin
if os.path.exists(PRE_UPGRADE_TESTS_FILE_PATH):
os.unlink(PRE_UPGRADE_TESTS_FILE_PATH)
if POST_UPGRADE_MARK in config.option.markexpr:
if PRE_UPGRADE:
raise OptionMarksError(
'options error: cannot do pre_upgrade and post_upgrade at the same time'
)
POST_UPGRADE = True
pre_upgrade_failed_tests = []
if os.path.exists(PRE_UPGRADE_TESTS_FILE_PATH):
with open(PRE_UPGRADE_TESTS_FILE_PATH) as json_file:
pre_upgrade_failed_tests = json.load(json_file)
__initiated = True
def pytest_report_header(config):
"""Initialise at test runner startup"""
__initiate(config)
def pytest_terminal_summary(terminalreporter, exitstatus):
"""Add a section to terminal summary reporting."""
if PRE_UPGRADE:
# Save the failed tests to file
failed_test_reports = []
for key in ['failed', 'error', 'skipped']:
failed_test_reports.extend(terminalreporter.stats.get(key, []))
failed_test_node_ids = [test_report.nodeid for test_report in failed_test_reports]
logger.info('Save failed tests to file %s', PRE_UPGRADE_TESTS_FILE_PATH)
with open(PRE_UPGRADE_TESTS_FILE_PATH, 'w') as json_file:
json.dump(failed_test_node_ids, json_file)
def pytest_collection_modifyitems(items, config):
"""Called after collection has been performed"""
# ensure initiated
__initiate(config)
# mark the pre upgrade test functions with node_id
pre_upgrade_items = [
item for item in items if item.get_closest_marker(PRE_UPGRADE_MARK) is not None
]
for item in pre_upgrade_items:
_set_test_node_id(item.function, item.nodeid)
if POST_UPGRADE:
# will mark `fail` item/post_upgrade test if pre_upgrade test status failed.
post_upgrade_items = [
item for item in items if item.get_closest_marker(POST_UPGRADE_MARK) is not None
]
for item in post_upgrade_items:
dependant_on_functions = []
for marker in item.iter_markers(POST_UPGRADE_MARK):
depend_on = marker.kwargs.get('depend_on')
if isinstance(depend_on, list | tuple):
dependant_on_functions.extend(depend_on)
elif depend_on is not None:
dependant_on_functions.append(depend_on)
depend_on_node_ids = [_get_test_node_id(f) for f in dependant_on_functions]
for depend_on_node_id in depend_on_node_ids:
if depend_on_node_id in pre_upgrade_failed_tests:
item.add_marker(
pytest.mark.fail(reason=f'The dependant test {item.nodeid} failed!')
)
class DependentTestFailed(Exception):
"""Raise when the dependent test fails"""
pass
@pytest.fixture(autouse=True)
def post_upgrade_dependant_fail(request):
"""Called after fail mark added on post_upgrade tests using above collection modification"""
fail = request.node.get_closest_marker('fail')
if fail:
reason = fail.kwargs.get('reason')
raise DependentTestFailed(reason)