forked from SatelliteQE/betelgeuse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tests.py
554 lines (487 loc) · 18.4 KB
/
tests.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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
"""Betelgeuse unit tests."""
import betelgeuse
import click
import mock
import pytest
import re
from click.testing import CliRunner
from betelgeuse import (
INVALID_CHARS_REGEX,
RST_PARSER,
JobNumberParamType,
PylarionLibException,
add_test_case,
add_test_record,
cli,
generate_test_steps,
load_custom_fields,
map_steps,
parse_junit,
parse_requirement_name,
parse_test_results,
)
from StringIO import StringIO
JUNIT_XML = """<testsuite tests="4">
<testcase classname="foo1" name="test_passed"></testcase>
<testcase classname="foo2" name="test_skipped">
<skipped message="Skipped message">...</skipped>
</testcase>
<testcase classname="foo3" name="test_failure">
<failure type="Type" message="Failure message">...</failure>
</testcase>
<testcase classname="foo4" name="test_error">
<error type="ExceptionName" message="Error message">...</error>
</testcase>
</testsuite>
"""
TEST_MODULE = '''
def test_something():
"""This test something."""
def test_something_else():
"""This test something else."""
'''
MULTIPLE_STEPS = """1. First step
2. Second step
3. Third step
"""
MULTIPLE_EXPECTEDRESULTS = """1. First step expected result.
2. Second step expected result.
3. Third step expected result.
"""
SINGLE_STEP = """Single step
"""
SINGLE_EXPECTEDRESULT = """Single step expected result.
"""
@pytest.fixture
def cli_runner():
"""Return a `click`->`CliRunner` object."""
return CliRunner()
def test_add_test_case_create():
"""Check if test case creation works."""
obj_cache = {
'collect_only': False,
'project': 'PROJECT',
}
with mock.patch.dict('betelgeuse.OBJ_CACHE', obj_cache):
with mock.patch.multiple(
'betelgeuse',
Requirement=mock.DEFAULT,
TestCase=mock.DEFAULT,
) as patches:
patches['Requirement'].return_value = []
test = mock.MagicMock()
test.docstring = 'Test the name feature'
test.name = 'test_name'
test.parent_class = 'NameTestCase'
test.testmodule = 'path/to/test_module.py'
test.tokens = {}
test.tokens['description'] = 'This is sample description'
add_test_case(('path/to/test_module.py', [test]))
patches['Requirement'].query.assert_called_once_with(
'Module', fields=['title', 'work_item_id'])
patches['Requirement'].create.assert_called_once_with(
'PROJECT', 'Module', '', reqtype='functional')
patches['TestCase'].query.assert_called_once_with(
'path.to.test_module.NameTestCase.test_name',
fields=[
'caseautomation',
'caseposneg',
'description',
'work_item_id',
]
)
patches['TestCase'].create.assert_called_once_with(
'PROJECT',
'test_name',
'<p>This is sample description</p>\n',
caseautomation='automated',
casecomponent='-',
caseimportance='medium',
caselevel='component',
caseposneg='positive',
setup=None,
subtype1='-',
test_case_id='path.to.test_module.NameTestCase.test_name',
testtype='functional',
upstream='no',
)
def test_add_test_record():
"""Check if test record creation works."""
test_run = mock.MagicMock()
obj_cache = {
'test_run': test_run,
'user': 'testuser',
'testcases': {
'module.NameTestCase.test_name':
'caffa7b0-fb9e-430b-903f-3f37fa28e0da',
},
}
with mock.patch.dict('betelgeuse.OBJ_CACHE', obj_cache):
with mock.patch.multiple(
'betelgeuse',
TestCase=mock.DEFAULT,
datetime=mock.DEFAULT,
testimony=mock.DEFAULT,
) as patches:
test_case = mock.MagicMock()
patches['TestCase'].query.return_value = [test_case]
testimony_test_function = mock.MagicMock()
testimony_test_function.testmodule = 'module.py'
testimony_test_function.parent_class = 'NameTestCase'
testimony_test_function.name = 'test_name'
patches['testimony'].get_testcases.return_value = {
'module.py': [testimony_test_function],
}
add_test_record({
'classname': 'module.NameTestCase',
'message': u'Test failed because it not worked',
'name': 'test_name',
'status': 'failure',
'time': '3.1415',
})
test_run.add_test_record_by_fields.assert_called_once_with(
duration=3.1415,
executed=patches['datetime'].datetime.now(),
executed_by='testuser',
test_case_id=test_case.work_item_id,
test_comment='Test failed because it not worked',
test_result='failed'
)
def test_generate_test_steps():
"""Check if test step generation works."""
steps = [('Step1', 'Result1'), ('Step2', 'Result2')]
with mock.patch.multiple(
'betelgeuse',
TestSteps=mock.DEFAULT,
TestStep=mock.DEFAULT,
) as patches:
patches['TestStep'].side_effect = [mock.MagicMock(), mock.MagicMock()]
test_steps = generate_test_steps(steps)
assert test_steps.keys == ['step', 'expectedResult']
for step, expected in zip(test_steps.steps, steps):
assert step.values == list(expected)
def test_load_custom_fields():
"""Check if custom fields can be loaded using = notation."""
assert load_custom_fields(('isautomated=true',)) == {
'isautomated': 'true'
}
def test_load_custom_fields_empty():
"""Check if empty value return empty dict for custom fields."""
assert load_custom_fields(('',)) == {}
def test_load_custom_fields_none():
"""Check if None value return empty dict for custom fields."""
assert load_custom_fields(None) == {}
def test_load_custom_fields_json():
"""Check if custom fields can be loaded using JSON data."""
assert load_custom_fields(('{"isautomated":true}',)) == {
'isautomated': True,
}
def test_map_single_step():
"""Check if mapping single step works."""
assert map_steps(SINGLE_STEP, SINGLE_EXPECTEDRESULT) == [
(u'<p>Single step</p>', '<p>Single step expected result.</p>')
]
def test_map_multiple_steps():
"""Check if mapping multiple steps works."""
assert map_steps(MULTIPLE_STEPS, MULTIPLE_EXPECTEDRESULTS) == [
('<p>First step</p>', '<p>First step expected result.</p>'),
('<p>Second step</p>', '<p>Second step expected result.</p>'),
('<p>Third step</p>', '<p>Third step expected result.</p>'),
]
def test_map_steps_parse_error():
"""Check if mapping multiple steps with a parse error works."""
multiple_steps = MULTIPLE_STEPS.replace('. ', '.', 1)
assert map_steps(multiple_steps, MULTIPLE_EXPECTEDRESULTS) == [(
RST_PARSER.parse(multiple_steps),
RST_PARSER.parse(MULTIPLE_EXPECTEDRESULTS),
)]
def test_parse_junit():
"""Check if jUnit parsing works."""
junit_xml = StringIO(JUNIT_XML)
assert parse_junit(junit_xml) == [
{'classname': 'foo1', 'name': 'test_passed', 'status': 'passed'},
{'classname': 'foo2', 'message': 'Skipped message',
'name': 'test_skipped', 'status': 'skipped'},
{'classname': 'foo3', 'name': 'test_failure',
'message': 'Failure message', 'status': 'failure', 'type': 'Type'},
{'classname': 'foo4', 'name': 'test_error', 'message': 'Error message',
'status': 'error', 'type': 'ExceptionName'}
]
junit_xml.close()
def test_rst_parser():
"""Check if rst parsing works."""
docstring = """Line one"""
generated_html = "<p>Line one</p>\n"
assert RST_PARSER.parse(docstring) == generated_html
def test_get_multiple_steps_diff_items():
"""Check if parsing multiple steps of different items works."""
multiple_steps = '\n'.join(MULTIPLE_STEPS.splitlines()[:-1])
assert map_steps(
multiple_steps, MULTIPLE_EXPECTEDRESULTS) == [(
RST_PARSER.parse(multiple_steps),
RST_PARSER.parse(MULTIPLE_EXPECTEDRESULTS),
)]
def test_invalid_test_run_chars_regex():
"""Check if invalid test run characters are handled."""
invalid_test_run_id = '\\/.:*"<>|~!@#$?%^&\'*()+`,='
assert re.sub(INVALID_CHARS_REGEX, '', invalid_test_run_id) == ''
def test_job_param_type():
"""Check if job paramter type works."""
job_param = JobNumberParamType()
with mock.patch('betelgeuse.multiprocessing') as multiprocessing:
job_param.convert('auto', None, None)
multiprocessing.cpu_count.assert_called_once_with()
with pytest.raises(click.BadParameter):
job_param.convert('-1', None, None)
def test_parse_requirement_name():
"""Check if parsing requirement name works."""
assert parse_requirement_name(
'tests/path/to/test_my_test_module.py') == 'My Test Module'
def test_parse_test_results():
"""Check if parsing test results works."""
test_results = [
{'status': u'passed',
'name': 'test_positive_read',
'classname': 'tests.api.test_ReadTestCase',
'file': 'tests/api/test_foo.py',
'time': '4.13224601746',
'line': '521'},
{'status': u'passed',
'name': 'test_positive_delete',
'classname': 'tests.api.test_ReadTestCase',
'file': 'tests/api/test_foo.py',
'time': '4.13224601746',
'line': '538'},
{'status': u'failure',
'name': 'test_negative_read',
'classname': 'tests.api.test_ReadTestCase',
'file': 'tests/api/test_foo.py',
'time': '4.13224601746',
'line': '218'},
{'status': u'skipped',
'name': 'test_positive_update',
'classname': 'tests.api.test_ReadTestCase',
'file': 'tests/api/test_foo.py',
'time': '4.13224601746',
'line': '112'},
{'status': u'error',
'name': 'test_positive_create',
'classname': 'tests.api.test_ReadTestCase',
'file': 'tests/api/test_foo.py',
'time': '4.13224601746',
'line': '788'},
]
summary = parse_test_results(test_results)
assert summary['passed'] == 2
assert summary['failure'] == 1
assert summary['skipped'] == 1
assert summary['error'] == 1
def test_test_case(cli_runner):
"""Check if test case command works."""
with cli_runner.isolated_filesystem():
with open('test_something.py', 'w') as handler:
handler.write(TEST_MODULE)
with mock.patch.multiple(
'betelgeuse',
TestCase=mock.DEFAULT,
multiprocessing=mock.DEFAULT,
testimony=mock.DEFAULT
) as patches:
pool = mock.MagicMock()
patches['multiprocessing'].Pool.return_value = pool
result = cli_runner.invoke(
cli,
['test-case', '--path', 'test_something.py', 'PROJECT']
)
assert result.exit_code == 0
pool.map.assert_called_once_with(
betelgeuse.add_test_case,
patches['testimony'].get_testcases().items()
)
pool.close.assert_called_once_with()
pool.join.assert_called_once_with()
def test_test_plan(cli_runner):
"""Check if test-plan command runs with minimal parameters."""
with mock.patch('betelgeuse.Plan') as plan:
plan.search.return_value = []
result = cli_runner.invoke(
cli,
[
'test-plan',
'--name', 'Test Plan Name',
'PROJECT'
]
)
assert result.exit_code == 0
plan.create.assert_called_once_with(
parent_id=None,
plan_id='Test_Plan_Name',
plan_name='Test Plan Name',
project_id='PROJECT',
template_id='release',
)
def test_test_plan_with_custom_fields(cli_runner):
"""Check if test-plan command runs with custom_fields."""
with mock.patch('betelgeuse.Plan') as plan:
test_plan = plan()
test_plan.status = 'open'
# Search will not return anything so new test plan will be created
plan.search.return_value = []
# Create command returns generated `test_plan` mock object
plan.create.return_value = test_plan
plan.update.return_value = []
result = cli_runner.invoke(
cli,
[
'test-plan',
'--name',
'Test Plan Name',
'--custom-fields',
'status=done',
'PROJECT'
]
)
assert result.exit_code == 0
plan.create.assert_called_once_with(
parent_id=None,
plan_id='Test_Plan_Name',
plan_name='Test Plan Name',
project_id='PROJECT',
template_id='release',
)
assert test_plan.status == 'done'
def test_test_plan_with_parent(cli_runner):
"""Check if test-plan command runs when passing a parent test plan."""
with mock.patch('betelgeuse.Plan') as plan:
plan.search.return_value = []
result = cli_runner.invoke(
cli,
[
'test-plan',
'--name', 'Test Plan Name',
'--parent-name', 'Parent Test Plan Name',
'PROJECT'
]
)
assert result.exit_code == 0
plan.create.assert_called_once_with(
parent_id='Parent_Test_Plan_Name',
plan_id='Test_Plan_Name',
plan_name='Test Plan Name',
project_id='PROJECT',
template_id='release',
)
def test_test_plan_with_iteration_type(cli_runner):
"""Check if test-plan command creates a iteration test plan."""
with mock.patch('betelgeuse.Plan') as plan:
plan.search.return_value = []
result = cli_runner.invoke(
cli,
[
'test-plan',
'--name', 'Test Plan Name',
'--plan-type', 'iteration',
'PROJECT'
]
)
assert result.exit_code == 0
plan.create.assert_called_once_with(
parent_id=None,
plan_id='Test_Plan_Name',
plan_name='Test Plan Name',
project_id='PROJECT',
template_id='iteration',
)
def test_test_results(cli_runner):
"""Check if test results command works."""
with cli_runner.isolated_filesystem():
with open('results.xml', 'w') as handler:
handler.write(JUNIT_XML)
result = cli_runner.invoke(
cli, ['test-results', '--path', 'results.xml'])
assert result.exit_code == 0
assert 'Error: 1\n' in result.output
assert 'Failure: 1\n' in result.output
assert 'Passed: 1\n' in result.output
assert 'Skipped: 1\n' in result.output
def test_test_results_default_path(cli_runner):
"""Check if test results in the default path works."""
with cli_runner.isolated_filesystem():
with open('junit-results.xml', 'w') as handler:
handler.write(JUNIT_XML)
result = cli_runner.invoke(cli, ['test-results'])
assert result.exit_code == 0
assert 'Error: 1\n' in result.output
assert 'Failure: 1\n' in result.output
assert 'Passed: 1\n' in result.output
assert 'Skipped: 1\n' in result.output
def test_test_run(cli_runner):
"""Check if test run command works."""
with cli_runner.isolated_filesystem():
with open('junit_report.xml', 'w') as handler:
handler.write(JUNIT_XML)
with mock.patch.multiple(
'betelgeuse',
TestRun=mock.DEFAULT,
multiprocessing=mock.DEFAULT,
testimony=mock.DEFAULT
) as patches:
pool = mock.MagicMock()
patches['multiprocessing'].Pool.return_value = pool
result = cli_runner.invoke(
cli,
['test-run', '--path', 'junit_report.xml', 'PROJECT']
)
assert result.exit_code == 0
patches['TestRun'].session.tx_begin.assert_called_once_with()
patches['TestRun'].session.tx_commit.assert_called_once_with()
pool.map.assert_called_once_with(
betelgeuse.add_test_record,
parse_junit('junit_report.xml')
)
pool.close.assert_called_once_with()
pool.join.assert_called_once_with()
def test_test_run_new_test_run(cli_runner):
"""Check if test run command works for a new test run."""
with cli_runner.isolated_filesystem():
with open('junit_report.xml', 'w') as handler:
handler.write(JUNIT_XML)
with mock.patch.multiple(
'betelgeuse',
TestRun=mock.DEFAULT,
multiprocessing=mock.DEFAULT,
testimony=mock.DEFAULT
) as patches:
pool = mock.MagicMock()
patches['multiprocessing'].Pool.return_value = pool
patches['TestRun'].side_effect = PylarionLibException
result = cli_runner.invoke(
cli,
[
'test-run',
'--path',
'junit_report.xml',
'--test-run-id',
'testrunid',
'--custom-fields',
'{"arch": "x86_64", "isautomated": true}',
'PROJECT'
]
)
assert result.exit_code == 0
patches['TestRun'].create.assert_called_once_with(
'PROJECT',
'testrunid',
'Empty',
arch='x86_64',
isautomated=True,
type='buildacceptance',
)
patches['TestRun'].session.tx_begin.assert_called_once_with()
patches['TestRun'].session.tx_commit.assert_called_once_with()
pool.map.assert_called_once_with(
betelgeuse.add_test_record,
parse_junit('junit_report.xml')
)
pool.close.assert_called_once_with()
pool.join.assert_called_once_with()