]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/contrib/openzfs/tests/test-runner/bin/zts-report.py.in
ena: Upgrade ena-com to freebsd v2.7.0
[FreeBSD/FreeBSD.git] / sys / contrib / openzfs / tests / test-runner / bin / zts-report.py.in
1 #!/usr/bin/env @PYTHON_SHEBANG@
2
3 #
4 # This file and its contents are supplied under the terms of the
5 # Common Development and Distribution License ("CDDL"), version 1.0.
6 # You may only use this file in accordance with the terms of version
7 # 1.0 of the CDDL.
8 #
9 # A full copy of the text of the CDDL should have accompanied this
10 # source.  A copy of the CDDL is also available via the Internet at
11 # http://www.illumos.org/license/CDDL.
12 #
13
14 #
15 # Copyright (c) 2017 by Delphix. All rights reserved.
16 # Copyright (c) 2018 by Lawrence Livermore National Security, LLC.
17 #
18 # This script must remain compatible with Python 3.6+.
19 #
20
21 import os
22 import re
23 import sys
24 import argparse
25
26 #
27 # This script parses the stdout of zfstest, which has this format:
28 #
29 # Test: /path/to/testa (run as root) [00:00] [PASS]
30 # Test: /path/to/testb (run as jkennedy) [00:00] [PASS]
31 # Test: /path/to/testc (run as root) [00:00] [FAIL]
32 # [...many more results...]
33 #
34 # Results Summary
35 # FAIL      22
36 # SKIP      32
37 # PASS    1156
38 #
39 # Running Time:   02:50:31
40 # Percent passed: 95.5%
41 # Log directory:  /var/tmp/test_results/20180615T205926
42 #
43
44 #
45 # Common generic reasons for a test or test group to be skipped.
46 #
47 # Some test cases are known to fail in ways which are not harmful or dangerous.
48 # In these cases simply mark the test as a known failure until it can be
49 # updated and the issue resolved.  Note that it's preferable to open a unique
50 # issue on the GitHub issue tracker for each test case failure.
51 #
52 known_reason = 'Known issue'
53
54 #
55 # Some tests require that a test user be able to execute the zfs utilities.
56 # This may not be possible when testing in-tree due to the default permissions
57 # on the user's home directory.  When testing this can be resolved by granting
58 # group read access.
59 #
60 # chmod 0750 $HOME
61 #
62 exec_reason = 'Test user execute permissions required for utilities'
63
64 #
65 # Some tests require that the kernel supports renameat2 syscall.
66 #
67 renameat2_reason = 'Kernel renameat2 support required'
68
69 #
70 # Some tests require the O_TMPFILE flag which was first introduced in the
71 # 3.11 kernel.
72 #
73 tmpfile_reason = 'Kernel O_TMPFILE support required'
74
75 #
76 # Some tests require the statx(2) system call on Linux which was first
77 # introduced in the 4.11 kernel.
78 #
79 statx_reason = 'Kernel statx(2) system call required on Linux'
80
81 #
82 # Some tests require that the lsattr utility support the project id feature.
83 #
84 project_id_reason = 'lsattr with set/show project ID required'
85
86 #
87 # Some tests require that the kernel support user namespaces.
88 #
89 user_ns_reason = 'Kernel user namespace support required'
90
91 #
92 # Some rewind tests can fail since nothing guarantees that old MOS blocks
93 # are not overwritten.  Snapshots protect datasets and data files but not
94 # the MOS.  Reasonable efforts are made in the test case to increase the
95 # odds that some txgs will have their MOS data left untouched, but it is
96 # never a sure thing.
97 #
98 rewind_reason = 'Arbitrary pool rewind is not guaranteed'
99
100 #
101 # Some tests require a minimum version of the fio benchmark utility.
102 # Older distributions such as CentOS 6.x only provide fio-2.0.13.
103 #
104 fio_reason = 'Fio v2.3 or newer required'
105
106 #
107 # Some tests require that the DISKS provided support the discard operation.
108 # Normally this is not an issue because loop back devices are used for DISKS
109 # and they support discard (TRIM/UNMAP).
110 #
111 trim_reason = 'DISKS must support discard (TRIM/UNMAP)'
112
113 #
114 # Some tests on FreeBSD require the fspacectl(2) system call and the
115 # truncate(1) utility supporting the -d option.  The system call was first
116 # introduced in FreeBSD version 1400032.
117 #
118 fspacectl_reason = 'fspacectl(2) and truncate -d support required'
119
120 #
121 # Some tests are not applicable to a platform or need to be updated to operate
122 # in the manor required by the platform.  Any tests which are skipped for this
123 # reason will be suppressed in the final analysis output.
124 #
125 na_reason = "Not applicable"
126
127 #
128 # Some test cases doesn't have all requirements to run on Github actions CI.
129 #
130 ci_reason = 'CI runner doesn\'t have all requirements'
131
132 #
133 # Idmapped mount is only supported in kernel version >= 5.12
134 #
135 idmap_reason = 'Idmapped mount needs kernel 5.12+'
136
137 #
138 # copy_file_range() is not supported by all kernels
139 #
140 cfr_reason = 'Kernel copy_file_range support required'
141 cfr_cross_reason = 'copy_file_range(2) cross-filesystem needs kernel 5.3+'
142
143 #
144 # These tests are known to fail, thus we use this list to prevent these
145 # failures from failing the job as a whole; only unexpected failures
146 # bubble up to cause this script to exit with a non-zero exit status.
147 #
148 # Format: { 'test-name': ['expected result', 'issue-number | reason'] }
149 #
150 # For each known failure it is recommended to link to a GitHub issue by
151 # setting the reason to the issue number.  Alternately, one of the generic
152 # reasons listed above can be used.
153 #
154 known = {
155     'casenorm/mixed_none_lookup_ci': ['FAIL', 7633],
156     'casenorm/mixed_formd_lookup_ci': ['FAIL', 7633],
157     'cli_root/zpool_import/import_rewind_device_replaced':
158         ['FAIL', rewind_reason],
159     'cli_user/misc/zfs_share_001_neg': ['SKIP', na_reason],
160     'cli_user/misc/zfs_unshare_001_neg': ['SKIP', na_reason],
161     'pool_checkpoint/checkpoint_discard_busy': ['SKIP', 12053],
162     'privilege/setup': ['SKIP', na_reason],
163     'refreserv/refreserv_004_pos': ['FAIL', known_reason],
164     'rootpool/setup': ['SKIP', na_reason],
165     'rsend/rsend_008_pos': ['SKIP', 6066],
166     'vdev_zaps/vdev_zaps_007_pos': ['FAIL', known_reason],
167 }
168
169 if sys.platform.startswith('freebsd'):
170     known.update({
171         'cli_root/zfs_receive/receive-o-x_props_override':
172             ['FAIL', known_reason],
173         'cli_root/zpool_resilver/zpool_resilver_concurrent':
174             ['SKIP', na_reason],
175         'cli_root/zpool_wait/zpool_wait_trim_basic': ['SKIP', trim_reason],
176         'cli_root/zpool_wait/zpool_wait_trim_cancel': ['SKIP', trim_reason],
177         'cli_root/zpool_wait/zpool_wait_trim_flag': ['SKIP', trim_reason],
178         'cli_root/zfs_unshare/zfs_unshare_008_pos': ['SKIP', na_reason],
179         'link_count/link_count_001': ['SKIP', na_reason],
180         'casenorm/mixed_create_failure': ['FAIL', 13215],
181         'mmap/mmap_sync_001_pos': ['SKIP', na_reason],
182         'rsend/send_raw_ashift': ['SKIP', 14961],
183     })
184 elif sys.platform.startswith('linux'):
185     known.update({
186         'casenorm/mixed_formd_lookup': ['FAIL', 7633],
187         'casenorm/mixed_formd_delete': ['FAIL', 7633],
188         'casenorm/sensitive_formd_lookup': ['FAIL', 7633],
189         'casenorm/sensitive_formd_delete': ['FAIL', 7633],
190         'removal/removal_with_zdb': ['SKIP', known_reason],
191         'cli_root/zfs_unshare/zfs_unshare_002_pos': ['SKIP', na_reason],
192     })
193
194
195 #
196 # These tests may occasionally fail or be skipped.  We want there failures
197 # to be reported but only unexpected failures should bubble up to cause
198 # this script to exit with a non-zero exit status.
199 #
200 # Format: { 'test-name': ['expected result', 'issue-number | reason'] }
201 #
202 # For each known failure it is recommended to link to a GitHub issue by
203 # setting the reason to the issue number.  Alternately, one of the generic
204 # reasons listed above can be used.
205 #
206 maybe = {
207     'append/threadsappend_001_pos': ['FAIL', 6136],
208     'chattr/setup': ['SKIP', exec_reason],
209     'crtime/crtime_001_pos': ['SKIP', statx_reason],
210     'cli_root/zdb/zdb_006_pos': ['FAIL', known_reason],
211     'cli_root/zfs_destroy/zfs_destroy_dev_removal_condense':
212         ['FAIL', known_reason],
213     'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason],
214     'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', 5479],
215     'cli_root/zfs_rollback/zfs_rollback_001_pos': ['FAIL', known_reason],
216     'cli_root/zfs_rollback/zfs_rollback_002_pos': ['FAIL', known_reason],
217     'cli_root/zfs_share/zfs_share_concurrent_shares': ['FAIL', known_reason],
218     'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason],
219     'cli_root/zfs_unshare/zfs_unshare_006_pos': ['SKIP', na_reason],
220     'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason],
221     'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', 6145],
222     'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', 6839],
223     'cli_root/zpool_initialize/zpool_initialize_import_export':
224         ['FAIL', 11948],
225     'cli_root/zpool_labelclear/zpool_labelclear_removed':
226         ['FAIL', known_reason],
227     'cli_root/zpool_trim/setup': ['SKIP', trim_reason],
228     'cli_root/zpool_upgrade/zpool_upgrade_004_pos': ['FAIL', 6141],
229     'delegate/setup': ['SKIP', exec_reason],
230     'fallocate/fallocate_punch-hole': ['SKIP', fspacectl_reason],
231     'history/history_004_pos': ['FAIL', 7026],
232     'history/history_005_neg': ['FAIL', 6680],
233     'history/history_006_neg': ['FAIL', 5657],
234     'history/history_008_pos': ['FAIL', known_reason],
235     'history/history_010_pos': ['SKIP', exec_reason],
236     'io/mmap': ['SKIP', fio_reason],
237     'largest_pool/largest_pool_001_pos': ['FAIL', known_reason],
238     'mmp/mmp_on_uberblocks': ['FAIL', known_reason],
239     'pam/setup': ['SKIP', "pamtester might be not available"],
240     'pool_checkpoint/checkpoint_discard_busy': ['FAIL', 11946],
241     'projectquota/setup': ['SKIP', exec_reason],
242     'removal/removal_condense_export': ['FAIL', known_reason],
243     'renameat2/setup': ['SKIP', renameat2_reason],
244     'reservation/reservation_008_pos': ['FAIL', 7741],
245     'reservation/reservation_018_pos': ['FAIL', 5642],
246     'snapshot/clone_001_pos': ['FAIL', known_reason],
247     'snapshot/snapshot_009_pos': ['FAIL', 7961],
248     'snapshot/snapshot_010_pos': ['FAIL', 7961],
249     'snapused/snapused_004_pos': ['FAIL', 5513],
250     'tmpfile/setup': ['SKIP', tmpfile_reason],
251     'trim/setup': ['SKIP', trim_reason],
252     'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason],
253     'user_namespace/setup': ['SKIP', user_ns_reason],
254     'userquota/setup': ['SKIP', exec_reason],
255     'vdev_zaps/vdev_zaps_004_pos': ['FAIL', known_reason],
256     'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', 5848],
257 }
258
259 if sys.platform.startswith('freebsd'):
260     maybe.update({
261         'cli_root/zfs_copies/zfs_copies_002_pos': ['FAIL', known_reason],
262         'cli_root/zfs_inherit/zfs_inherit_001_neg': ['FAIL', known_reason],
263         'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason],
264         'delegate/zfs_allow_003_pos': ['FAIL', known_reason],
265         'inheritance/inherit_001_pos': ['FAIL', 11829],
266         'pool_checkpoint/checkpoint_big_rewind': ['FAIL', 12622],
267         'pool_checkpoint/checkpoint_indirect': ['FAIL', 12623],
268         'resilver/resilver_restart_001': ['FAIL', known_reason],
269         'snapshot/snapshot_002_pos': ['FAIL', '14831'],
270     })
271 elif sys.platform.startswith('linux'):
272     maybe.update({
273         'bclone/bclone_crossfs_corner_cases': ['SKIP', cfr_cross_reason],
274         'bclone/bclone_crossfs_corner_cases_limited':
275             ['SKIP', cfr_cross_reason],
276         'bclone/bclone_crossfs_data': ['SKIP', cfr_cross_reason],
277         'bclone/bclone_crossfs_embedded': ['SKIP', cfr_cross_reason],
278         'bclone/bclone_crossfs_hole': ['SKIP', cfr_cross_reason],
279         'bclone/bclone_diffprops_all': ['SKIP', cfr_cross_reason],
280         'bclone/bclone_diffprops_checksum': ['SKIP', cfr_cross_reason],
281         'bclone/bclone_diffprops_compress': ['SKIP', cfr_cross_reason],
282         'bclone/bclone_diffprops_copies': ['SKIP', cfr_cross_reason],
283         'bclone/bclone_diffprops_recordsize': ['SKIP', cfr_cross_reason],
284         'bclone/bclone_prop_sync': ['SKIP', cfr_cross_reason],
285         'bclone/bclone_samefs_corner_cases': ['SKIP', cfr_reason],
286         'bclone/bclone_samefs_corner_cases_limited': ['SKIP', cfr_reason],
287         'bclone/bclone_samefs_data': ['SKIP', cfr_reason],
288         'bclone/bclone_samefs_embedded': ['SKIP', cfr_reason],
289         'bclone/bclone_samefs_hole': ['SKIP', cfr_reason],
290         'block_cloning/block_cloning_copyfilerange':
291             ['SKIP', cfr_reason],
292         'block_cloning/block_cloning_copyfilerange_cross_dataset':
293             ['SKIP', cfr_cross_reason],
294         'block_cloning/block_cloning_copyfilerange_fallback':
295             ['SKIP', cfr_reason],
296         'block_cloning/block_cloning_copyfilerange_fallback_same_txg':
297             ['SKIP', cfr_cross_reason],
298         'block_cloning/block_cloning_copyfilerange_partial':
299             ['SKIP', cfr_reason],
300         'block_cloning/block_cloning_cross_enc_dataset':
301             ['SKIP', cfr_cross_reason],
302         'block_cloning/block_cloning_disabled_copyfilerange':
303             ['SKIP', cfr_reason],
304         'block_cloning/block_cloning_lwb_buffer_overflow':
305             ['SKIP', cfr_reason],
306         'block_cloning/block_cloning_replay':
307             ['SKIP', cfr_reason],
308         'block_cloning/block_cloning_replay_encrypted':
309             ['SKIP', cfr_reason],
310         'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason],
311         'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason],
312         'fault/auto_online_002_pos': ['FAIL', 11889],
313         'fault/auto_replace_001_pos': ['FAIL', 14851],
314         'fault/auto_spare_002_pos': ['FAIL', 11889],
315         'fault/auto_spare_multiple': ['FAIL', 11889],
316         'fault/auto_spare_shared': ['FAIL', 11889],
317         'fault/decompress_fault': ['FAIL', 11889],
318         'idmap_mount/idmap_mount_001': ['SKIP', idmap_reason],
319         'idmap_mount/idmap_mount_002': ['SKIP', idmap_reason],
320         'idmap_mount/idmap_mount_003': ['SKIP', idmap_reason],
321         'idmap_mount/idmap_mount_004': ['SKIP', idmap_reason],
322         'idmap_mount/idmap_mount_005': ['SKIP', idmap_reason],
323         'io/io_uring': ['SKIP', 'io_uring support required'],
324         'limits/filesystem_limit': ['SKIP', known_reason],
325         'limits/snapshot_limit': ['SKIP', known_reason],
326         'mmp/mmp_active_import': ['FAIL', known_reason],
327         'mmp/mmp_exported_import': ['FAIL', known_reason],
328         'mmp/mmp_inactive_import': ['FAIL', known_reason],
329         'zvol/zvol_misc/zvol_misc_fua': ['SKIP', 14872],
330         'zvol/zvol_misc/zvol_misc_snapdev': ['FAIL', 12621],
331         'zvol/zvol_misc/zvol_misc_trim': ['SKIP', 14872],
332         'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason],
333     })
334
335 # Not all Github actions runners have scsi_debug module, so we may skip
336 #   some tests which use it.
337 if os.environ.get('CI') == 'true':
338     known.update({
339         'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason],
340         'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason],
341         'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason],
342         'cli_root/zpool_reopen/setup': ['SKIP', ci_reason],
343         'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason],
344         'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason],
345         'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason],
346         'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason],
347         'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason],
348         'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason],
349         'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason],
350         'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason],
351         'fault/auto_offline_001_pos': ['SKIP', ci_reason],
352         'fault/auto_online_001_pos': ['SKIP', ci_reason],
353         'fault/auto_online_002_pos': ['SKIP', ci_reason],
354         'fault/auto_replace_001_pos': ['SKIP', ci_reason],
355         'fault/auto_replace_002_pos': ['SKIP', ci_reason],
356         'fault/auto_spare_ashift': ['SKIP', ci_reason],
357         'fault/auto_spare_shared': ['SKIP', ci_reason],
358         'procfs/pool_state': ['SKIP', ci_reason],
359     })
360
361     maybe.update({
362         'events/events_002_pos': ['FAIL', 11546],
363     })
364
365
366 def process_results(pathname):
367     try:
368         f = open(pathname)
369     except IOError as e:
370         print('Error opening file:', e)
371         sys.exit(1)
372
373     prefix = '/zfs-tests/tests/(?:functional|perf/regression)/'
374     pattern = \
375         r'^Test(?:\s+\(\S+\))?:' + \
376         rf'\s*\S*{prefix}(\S+)' + \
377         r'\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]'
378     pattern_log = r'^\s*Log directory:\s*(\S*)'
379
380     d = {}
381     logdir = 'Could not determine log directory.'
382     for line in f.readlines():
383         m = re.match(pattern, line)
384         if m and len(m.groups()) == 4:
385             d[m.group(1)] = m.group(4)
386             continue
387
388         m = re.match(pattern_log, line)
389         if m:
390             logdir = m.group(1)
391
392     return d, logdir
393
394
395 class ListMaybesAction(argparse.Action):
396     def __init__(self,
397                  option_strings,
398                  dest="SUPPRESS",
399                  default="SUPPRESS",
400                  help="list flaky tests and exit"):
401         super(ListMaybesAction, self).__init__(
402             option_strings=option_strings,
403             dest=dest,
404             default=default,
405             nargs=0,
406             help=help)
407
408     def __call__(self, parser, namespace, values, option_string=None):
409         for test in maybe:
410             print(test)
411         sys.exit(0)
412
413
414 if __name__ == "__main__":
415     parser = argparse.ArgumentParser(description='Analyze ZTS logs')
416     parser.add_argument('logfile')
417     parser.add_argument('--list-maybes', action=ListMaybesAction)
418     parser.add_argument('--no-maybes', action='store_false', dest='maybes')
419     args = parser.parse_args()
420
421     results, logdir = process_results(args.logfile)
422
423     if not results:
424         print("\n\nNo test results were found.")
425         print("Log directory:", logdir)
426         sys.exit(0)
427
428     expected = []
429     unexpected = []
430     all_maybes = True
431
432     for test in list(results.keys()):
433         if results[test] == "PASS":
434             continue
435
436         setup = test.replace(os.path.basename(test), "setup")
437         if results[test] == "SKIP" and test != setup:
438             if setup in known and known[setup][0] == "SKIP":
439                 continue
440             if setup in maybe and maybe[setup][0] == "SKIP":
441                 continue
442
443         if (test in known and results[test] in known[test][0]):
444             expected.append(test)
445         elif test in maybe and results[test] in maybe[test][0]:
446             if results[test] == 'SKIP' or args.maybes:
447                 expected.append(test)
448             elif not args.maybes:
449                 unexpected.append(test)
450         else:
451             unexpected.append(test)
452             all_maybes = False
453
454     print("\nTests with results other than PASS that are expected:")
455     for test in sorted(expected):
456         issue_url = 'https://github.com/openzfs/zfs/issues/'
457
458         # Include the reason why the result is expected, given the following:
459         # 1. Suppress test results which set the "Not applicable" reason.
460         # 2. Numerical reasons are assumed to be GitHub issue numbers.
461         # 3. When an entire test group is skipped only report the setup reason.
462         if test in known:
463             if known[test][1] == na_reason:
464                 continue
465             elif isinstance(known[test][1], int):
466                 expect = f"{issue_url}{known[test][1]}"
467             else:
468                 expect = known[test][1]
469         elif test in maybe:
470             if isinstance(maybe[test][1], int):
471                 expect = f"{issue_url}{maybe[test][1]}"
472             else:
473                 expect = maybe[test][1]
474         elif setup in known and known[setup][0] == "SKIP" and setup != test:
475             continue
476         elif setup in maybe and maybe[setup][0] == "SKIP" and setup != test:
477             continue
478         else:
479             expect = "UNKNOWN REASON"
480         print(f"    {results[test]} {test} ({expect})")
481
482     print("\nTests with result of PASS that are unexpected:")
483     for test in sorted(known.keys()):
484         # We probably should not be silently ignoring the case
485         # where "test" is not in "results".
486         if test not in results or results[test] != "PASS":
487             continue
488         print(f"    {results[test]} {test} (expected {known[test][0]})")
489
490     print("\nTests with results other than PASS that are unexpected:")
491     for test in sorted(unexpected):
492         expect = "PASS" if test not in known else known[test][0]
493         print(f"    {results[test]} {test} (expected {expect})")
494
495     if len(unexpected) == 0:
496         sys.exit(0)
497     elif not args.maybes and all_maybes:
498         sys.exit(2)
499     else:
500         sys.exit(1)