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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
#!/usr/bin/env python3
"""
Unit tests for the GNU test results comparison script.
"""
import unittest
import json
import tempfile
import os
from unittest.mock import patch
from io import StringIO
from util.compare_test_results import (
flatten_test_results,
load_ignore_list,
identify_test_changes,
main,
)
class TestFlattenTestResults(unittest.TestCase):
"""Tests for the flatten_test_results function."""
def test_basic_flattening(self):
"""Test basic flattening of nested test results."""
test_data = {
"ls": {"test1": "PASS", "test2": "FAIL"},
"cp": {"test3": "SKIP", "test4": "ERROR"},
}
expected = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "FAIL",
"tests/cp/test3": "SKIP",
"tests/cp/test4": "ERROR",
}
self.assertEqual(flatten_test_results(test_data), expected)
def test_empty_dict(self):
"""Test flattening an empty dictionary."""
self.assertEqual(flatten_test_results({}), {})
def test_single_util(self):
"""Test flattening results with a single utility."""
test_data = {"ls": {"test1": "PASS", "test2": "FAIL"}}
expected = {"tests/ls/test1": "PASS", "tests/ls/test2": "FAIL"}
self.assertEqual(flatten_test_results(test_data), expected)
def test_empty_tests(self):
"""Test flattening with a utility that has no tests."""
test_data = {"ls": {}, "cp": {"test1": "PASS"}}
expected = {"tests/cp/test1": "PASS"}
self.assertEqual(flatten_test_results(test_data), expected)
def test_log_extension_removal(self):
"""Test that .log extensions are removed."""
test_data = {"ls": {"test1.log": "PASS", "test2": "FAIL"}}
expected = {"tests/ls/test1": "PASS", "tests/ls/test2": "FAIL"}
self.assertEqual(flatten_test_results(test_data), expected)
class TestLoadIgnoreList(unittest.TestCase):
"""Tests for the load_ignore_list function."""
def test_load_ignores(self):
"""Test loading ignore list from a file."""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp.write(
"tests/tail/inotify-dir-recreate\ntests/timeout/timeout\ntests/rm/rm1\n"
)
tmp_path = tmp.name
try:
ignore_list = load_ignore_list(tmp_path)
self.assertEqual(
ignore_list,
{
"tests/tail/inotify-dir-recreate",
"tests/timeout/timeout",
"tests/rm/rm1",
},
)
finally:
os.unlink(tmp_path)
def test_empty_file(self):
"""Test loading an empty ignore file."""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp_path = tmp.name
try:
ignore_list = load_ignore_list(tmp_path)
self.assertEqual(ignore_list, set())
finally:
os.unlink(tmp_path)
def test_with_comments_and_blanks(self):
"""Test loading ignore file with comments and blank lines."""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp.write(
"tests/tail/inotify-dir-recreate\n# A comment\n\ntests/timeout/timeout\n#Indented comment\n tests/rm/rm1 \n"
)
tmp_path = tmp.name
try:
ignore_list = load_ignore_list(tmp_path)
self.assertEqual(
ignore_list,
{
"tests/tail/inotify-dir-recreate",
"tests/timeout/timeout",
"tests/rm/rm1",
},
)
finally:
os.unlink(tmp_path)
def test_nonexistent_file(self):
"""Test behavior with a nonexistent file."""
result = load_ignore_list("/nonexistent/file/path")
self.assertEqual(result, set())
class TestIdentifyTestChanges(unittest.TestCase):
"""Tests for the identify_test_changes function."""
def test_regressions(self):
"""Test identifying regressions."""
current = {
"tests/ls/test1": "FAIL",
"tests/ls/test2": "ERROR",
"tests/cp/test3": "PASS",
"tests/cp/test4": "SKIP",
}
reference = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "PASS",
"tests/cp/test3": "PASS",
"tests/cp/test4": "FAIL",
}
regressions, _, _, _, _ = identify_test_changes(current, reference)
self.assertEqual(sorted(regressions), ["tests/ls/test1", "tests/ls/test2"])
def test_fixes(self):
"""Test identifying fixes."""
current = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "PASS",
"tests/cp/test3": "FAIL",
"tests/cp/test4": "SKIP",
}
reference = {
"tests/ls/test1": "FAIL",
"tests/ls/test2": "ERROR",
"tests/cp/test3": "PASS",
"tests/cp/test4": "FAIL",
}
_, fixes, _, _, _ = identify_test_changes(current, reference)
self.assertEqual(sorted(fixes), ["tests/ls/test1", "tests/ls/test2"])
def test_newly_skipped(self):
"""Test identifying newly skipped tests."""
current = {
"tests/ls/test1": "SKIP",
"tests/ls/test2": "SKIP",
"tests/cp/test3": "PASS",
}
reference = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "FAIL",
"tests/cp/test3": "PASS",
}
_, _, newly_skipped, _, _ = identify_test_changes(current, reference)
self.assertEqual(newly_skipped, ["tests/ls/test1"])
def test_newly_passing(self):
"""Test identifying newly passing tests."""
current = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "PASS",
"tests/cp/test3": "SKIP",
}
reference = {
"tests/ls/test1": "SKIP",
"tests/ls/test2": "FAIL",
"tests/cp/test3": "SKIP",
}
_, _, _, newly_passing, _ = identify_test_changes(current, reference)
self.assertEqual(newly_passing, ["tests/ls/test1"])
def test_all_categories(self):
"""Test identifying all categories of changes simultaneously."""
current = {
"tests/ls/test1": "FAIL", # Regression
"tests/ls/test2": "PASS", # Fix
"tests/cp/test3": "SKIP", # Newly skipped
"tests/cp/test4": "PASS", # Newly passing
"tests/rm/test5": "PASS", # No change
"tests/rm/test6": "FAIL", # Newly failing
}
reference = {
"tests/ls/test1": "PASS", # Regression
"tests/ls/test2": "FAIL", # Fix
"tests/cp/test3": "PASS", # Newly skipped
"tests/cp/test4": "SKIP", # Newly passing
"tests/rm/test5": "PASS", # No change
"tests/rm/test6": "SKIP", # Newly failing
}
regressions, fixes, newly_skipped, newly_passing, newly_failing = (
identify_test_changes(current, reference)
)
self.assertEqual(regressions, ["tests/ls/test1"])
self.assertEqual(fixes, ["tests/ls/test2"])
self.assertEqual(newly_skipped, ["tests/cp/test3"])
self.assertEqual(newly_passing, ["tests/cp/test4"])
self.assertEqual(newly_failing, ["tests/rm/test6"])
def test_new_and_removed_tests(self):
"""Test handling of tests that are only in one of the datasets."""
current = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "FAIL",
"tests/cp/new_test": "PASS",
}
reference = {
"tests/ls/test1": "PASS",
"tests/ls/test2": "PASS",
"tests/rm/old_test": "FAIL",
}
regressions, fixes, newly_skipped, newly_passing, newly_failing = (
identify_test_changes(current, reference)
)
self.assertEqual(regressions, ["tests/ls/test2"])
self.assertEqual(fixes, [])
self.assertEqual(newly_skipped, [])
self.assertEqual(newly_passing, [])
self.assertEqual(newly_failing, [])
def test_newly_failing(self):
"""Test identifying newly failing tests (SKIP -> FAIL)."""
current = {
"tests/ls/test1": "FAIL",
"tests/ls/test2": "ERROR",
"tests/cp/test3": "PASS",
}
reference = {
"tests/ls/test1": "SKIP",
"tests/ls/test2": "SKIP",
"tests/cp/test3": "SKIP",
}
_, _, _, _, newly_failing = identify_test_changes(current, reference)
self.assertEqual(sorted(newly_failing), ["tests/ls/test1", "tests/ls/test2"])
def test_skip_to_fail_not_regression(self):
"""Test that SKIP -> FAIL is not counted as a regression."""
current = {
"tests/ls/test1": "FAIL",
"tests/ls/test2": "FAIL",
}
reference = {
"tests/ls/test1": "SKIP",
"tests/ls/test2": "PASS",
}
regressions, _, _, _, newly_failing = identify_test_changes(current, reference)
self.assertEqual(regressions, ["tests/ls/test2"])
self.assertEqual(newly_failing, ["tests/ls/test1"])
class TestMainFunction(unittest.TestCase):
"""Integration tests for the main function."""
def setUp(self):
"""Set up test files needed for main function tests."""
self.current_data = {
"ls": {
"test1": "PASS",
"test2": "FAIL",
"test3": "PASS",
"test4": "SKIP",
"test5": "PASS",
},
"cp": {"test1": "PASS", "test2": "PASS"},
}
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
json.dump(self.current_data, tmp)
self.current_json = tmp.name
self.reference_data = {
"ls": {
"test1": "PASS",
"test2": "PASS",
"test3": "FAIL",
"test4": "PASS",
"test5": "SKIP",
},
"cp": {"test1": "FAIL", "test2": "ERROR"},
}
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
json.dump(self.reference_data, tmp)
self.reference_json = tmp.name
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp.write("tests/ls/test2\ntests/cp/test1\n")
self.ignore_file = tmp.name
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
self.output_file = tmp.name
def tearDown(self):
"""Clean up test files after tests."""
for file_path in [
self.current_json,
self.reference_json,
self.ignore_file,
self.output_file,
]:
if os.path.exists(file_path):
os.unlink(file_path)
def test_main_exit_code_with_real_regressions(self):
"""Test main function exit code with real regressions."""
current_flat = flatten_test_results(self.current_data)
reference_flat = flatten_test_results(self.reference_data)
regressions, _, _, _, _ = identify_test_changes(current_flat, reference_flat)
self.assertIn("tests/ls/test2", regressions)
ignore_list = load_ignore_list(self.ignore_file)
real_regressions = [r for r in regressions if r not in ignore_list]
self.assertNotIn("tests/ls/test2", real_regressions)
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp.write(
"tests/cp/test1\n"
) # only ignore tests/cp/test1, not tests/ls/test2
new_ignore_file = tmp.name
try:
new_ignore_list = load_ignore_list(new_ignore_file)
new_real_regressions = [r for r in regressions if r not in new_ignore_list]
# tests/ls/test2 should now be in real_regressions
self.assertIn("tests/ls/test2", new_real_regressions)
# In main(), this would cause a non-zero exit code
would_exit_with_error = len(new_real_regressions) > 0
self.assertTrue(would_exit_with_error)
finally:
os.unlink(new_ignore_file)
def test_filter_intermittent_fixes(self):
"""Test that fixes in the ignore list are filtered properly."""
current_flat = flatten_test_results(self.current_data)
reference_flat = flatten_test_results(self.reference_data)
_, fixes, _, _, _ = identify_test_changes(current_flat, reference_flat)
# tests/cp/test1 and tests/cp/test2 should be fixed but tests/cp/test1 is in ignore list
self.assertIn("tests/cp/test1", fixes)
self.assertIn("tests/cp/test2", fixes)
ignore_list = load_ignore_list(self.ignore_file)
real_fixes = [f for f in fixes if f not in ignore_list]
intermittent_fixes = [f for f in fixes if f in ignore_list]
# tests/cp/test1 should be identified as intermittent
self.assertIn("tests/cp/test1", intermittent_fixes)
# tests/cp/test2 should be identified as a real fix
self.assertIn("tests/cp/test2", real_fixes)
class TestOutputFunctionality(unittest.TestCase):
"""Tests focused on the output generation of the script."""
def setUp(self):
"""Set up test files needed for output tests."""
self.current_data = {
"ls": {
"test1": "PASS",
"test2": "FAIL", # Regression but in ignore list
"test3": "PASS", # Fix
},
"cp": {
"test1": "PASS", # Fix but in ignore list
"test2": "SKIP", # Newly skipped
"test4": "PASS", # Newly passing
},
}
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
json.dump(self.current_data, tmp)
self.current_json = tmp.name
self.reference_data = {
"ls": {
"test1": "PASS", # No change
"test2": "PASS", # Regression but in ignore list
"test3": "FAIL", # Fix
},
"cp": {
"test1": "FAIL", # Fix but in ignore list
"test2": "PASS", # Newly skipped
"test4": "SKIP", # Newly passing
},
}
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
json.dump(self.reference_data, tmp)
self.reference_json = tmp.name
# Create an ignore file
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp.write("tests/ls/test2\ntests/cp/test1\n")
self.ignore_file = tmp.name
def tearDown(self):
"""Clean up test files after tests."""
for file_path in [self.current_json, self.reference_json, self.ignore_file]:
if os.path.exists(file_path):
os.unlink(file_path)
if hasattr(self, "output_file") and os.path.exists(self.output_file):
os.unlink(self.output_file)
@patch("sys.stdout", new_callable=StringIO)
@patch("sys.stderr", new_callable=StringIO)
def test_console_output_formatting(self, mock_stderr, mock_stdout):
"""Test the formatting of console output."""
with patch(
"sys.argv",
[
"compare_test_results.py",
self.current_json,
self.reference_json,
"--ignore-file",
self.ignore_file,
],
):
try:
main()
except SystemExit:
pass # Expected to exit with a status code
stdout_content = mock_stdout.getvalue()
self.assertIn("Total tests in current run:", stdout_content)
self.assertIn("New regressions: 0", stdout_content)
self.assertIn("Intermittent regressions: 1", stdout_content)
self.assertIn("Fixed tests: 1", stdout_content)
self.assertIn("Intermittent fixes: 1", stdout_content)
self.assertIn("Newly skipped tests: 1", stdout_content)
self.assertIn("Newly passing tests (previously skipped): 1", stdout_content)
stderr_content = mock_stderr.getvalue()
self.assertIn("INTERMITTENT ISSUES (ignored regressions):", stderr_content)
self.assertIn("Skip an intermittent issue tests/ls/test2", stderr_content)
self.assertIn("INTERMITTENT ISSUES (ignored fixes):", stderr_content)
self.assertIn("Skipping an intermittent issue tests/cp/test1", stderr_content)
self.assertIn("FIXED TESTS:", stderr_content)
self.assertIn(
"Congrats! The gnu test tests/ls/test3 is no longer failing!",
stderr_content,
)
self.assertIn("NEWLY SKIPPED TESTS:", stderr_content)
self.assertIn("Note: The gnu test tests/cp/test2", stderr_content)
self.assertIn("NEWLY PASSING TESTS (previously skipped):", stderr_content)
self.assertIn(
"Congrats! The gnu test tests/cp/test4 is now passing!", stderr_content
)
def test_file_output_generation(self):
"""Test that the output file is generated correctly."""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
self.output_file = tmp.name
with patch(
"sys.argv",
[
"compare_test_results.py",
self.current_json,
self.reference_json,
"--ignore-file",
self.ignore_file,
"--output",
self.output_file,
],
):
try:
main()
except SystemExit:
pass # Expected to exit with a status code
self.assertTrue(os.path.exists(self.output_file))
with open(self.output_file, "r") as f:
output_content = f.read()
self.assertIn("Skip an intermittent issue tests/ls/test2", output_content)
self.assertIn("Skipping an intermittent issue tests/cp/test1", output_content)
self.assertIn(
"Congrats! The gnu test tests/ls/test3 is no longer failing!",
output_content,
)
self.assertIn("Note: The gnu test tests/cp/test2", output_content)
self.assertIn(
"Congrats! The gnu test tests/cp/test4 is now passing!", output_content
)
def test_exit_code_with_no_regressions(self):
"""Test that the script exits with code 0 when there are no regressions."""
with patch(
"sys.argv",
[
"compare_test_results.py",
self.current_json,
self.reference_json,
"--ignore-file",
self.ignore_file,
],
):
# Instead of assertRaises, just call main() and check its return value
exit_code = main()
# Since all regressions are in the ignore list, should exit with 0
self.assertEqual(exit_code, 0)
def test_exit_code_with_regressions(self):
"""Test that the script exits with code 1 when there are real regressions."""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as tmp:
tmp.write("tests/cp/test1\n") # Only ignore cp/test1
new_ignore_file = tmp.name
try:
with patch(
"sys.argv",
[
"compare_test_results.py",
self.current_json,
self.reference_json,
"--ignore-file",
new_ignore_file,
],
):
# Just call main() and check its return value
exit_code = main()
# Since ls/test2 is now a real regression, should exit with 1
self.assertEqual(exit_code, 1)
finally:
os.unlink(new_ignore_file)
def test_github_actions_formatting(self):
"""Test that the output is formatted for GitHub Actions."""
with patch("sys.stderr", new_callable=StringIO) as mock_stderr:
with patch(
"sys.argv",
[
"compare_test_results.py",
self.current_json,
self.reference_json,
"--ignore-file",
self.ignore_file,
],
):
try:
main()
except SystemExit:
pass # Expected to exit with a status code
stderr_content = mock_stderr.getvalue()
self.assertIn(
"::notice ::", stderr_content
) # For fixes and informational messages
self.assertIn("::warning ::", stderr_content) # For newly skipped tests
if __name__ == "__main__":
unittest.main()
|
