]>
git.proxmox.com Git - mirror_zfs.git/blob - tests/test-runner/bin/zts-report.py.in
1 #!/usr/bin/env @PYTHON_SHEBANG@
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
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.
15 # Copyright (c) 2017 by Delphix. All rights reserved.
16 # Copyright (c) 2018 by Lawrence Livermore National Security, LLC.
18 # This script must remain compatible with Python 3.6+.
27 # This script parses the stdout of zfstest, which has this format:
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...]
39 # Running Time: 02:50:31
40 # Percent passed: 95.5%
41 # Log directory: /var/tmp/test_results/20180615T205926
45 # Common generic reasons for a test or test group to be skipped.
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.
52 known_reason
= 'Known issue'
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
62 exec_reason
= 'Test user execute permissions required for utilities'
65 # Some tests require a minimum python version of 3.6 and will be skipped when
66 # the default system version is too old. There may also be tests which require
67 # additional python modules be installed, for example python3-cffi is required
70 python_reason
= 'Python v3.6 or newer required'
71 python_deps_reason
= 'Python modules missing: python3-cffi'
74 # Some tests require the O_TMPFILE flag which was first introduced in the
77 tmpfile_reason
= 'Kernel O_TMPFILE support required'
80 # Some tests require the statx(2) system call on Linux which was first
81 # introduced in the 4.11 kernel.
83 statx_reason
= 'Kernel statx(2) system call required on Linux'
86 # Some tests require that the NFS client and server utilities be installed.
88 share_reason
= 'NFS client and server utilities required'
91 # Some tests require that the lsattr utility support the project id feature.
93 project_id_reason
= 'lsattr with set/show project ID required'
96 # Some tests require that the kernel support user namespaces.
98 user_ns_reason
= 'Kernel user namespace support required'
101 # Some rewind tests can fail since nothing guarantees that old MOS blocks
102 # are not overwritten. Snapshots protect datasets and data files but not
103 # the MOS. Reasonable efforts are made in the test case to increase the
104 # odds that some txgs will have their MOS data left untouched, but it is
105 # never a sure thing.
107 rewind_reason
= 'Arbitrary pool rewind is not guaranteed'
110 # Some tests may by structured in a way that relies on exact knowledge
111 # of how much free space in available in a pool. These tests cannot be
112 # made completely reliable because the internal details of how free space
113 # is managed are not exposed to user space.
115 enospc_reason
= 'Exact free space reporting is not guaranteed'
118 # Some tests require a minimum version of the fio benchmark utility.
119 # Older distributions such as CentOS 6.x only provide fio-2.0.13.
121 fio_reason
= 'Fio v2.3 or newer required'
124 # Some tests require that the DISKS provided support the discard operation.
125 # Normally this is not an issue because loop back devices are used for DISKS
126 # and they support discard (TRIM/UNMAP).
128 trim_reason
= 'DISKS must support discard (TRIM/UNMAP)'
131 # Some tests on FreeBSD require the fspacectl(2) system call and the
132 # truncate(1) utility supporting the -d option. The system call was first
133 # introduced in FreeBSD version 1400032.
135 fspacectl_reason
= 'fspacectl(2) and truncate -d support required'
138 # Some tests are not applicable to a platform or need to be updated to operate
139 # in the manor required by the platform. Any tests which are skipped for this
140 # reason will be suppressed in the final analysis output.
142 na_reason
= "Not applicable"
145 # Some test cases doesn't have all requirements to run on Github actions CI.
147 ci_reason
= 'CI runner doesn\'t have all requirements'
152 'logfile': "Could not determine logfile location."
156 # These tests are known to fail, thus we use this list to prevent these
157 # failures from failing the job as a whole; only unexpected failures
158 # bubble up to cause this script to exit with a non-zero exit status.
160 # Format: { 'test-name': ['expected result', 'issue-number | reason'] }
162 # For each known failure it is recommended to link to a GitHub issue by
163 # setting the reason to the issue number. Alternately, one of the generic
164 # reasons listed above can be used.
167 'casenorm/mixed_none_lookup_ci': ['FAIL', '7633'],
168 'casenorm/mixed_formd_lookup_ci': ['FAIL', '7633'],
169 'cli_root/zfs_unshare/zfs_unshare_002_pos': ['SKIP', na_reason
],
170 'cli_root/zfs_unshare/zfs_unshare_006_pos': ['SKIP', na_reason
],
171 'cli_root/zpool_import/import_rewind_device_replaced':
172 ['FAIL', rewind_reason
],
173 'cli_user/misc/zfs_share_001_neg': ['SKIP', na_reason
],
174 'cli_user/misc/zfs_unshare_001_neg': ['SKIP', na_reason
],
175 'privilege/setup': ['SKIP', na_reason
],
176 'refreserv/refreserv_004_pos': ['FAIL', known_reason
],
177 'rootpool/setup': ['SKIP', na_reason
],
178 'rsend/rsend_008_pos': ['SKIP', '6066'],
179 'vdev_zaps/vdev_zaps_007_pos': ['FAIL', known_reason
],
182 if sys
.platform
.startswith('freebsd'):
184 'cli_root/zpool_wait/zpool_wait_trim_basic': ['SKIP', trim_reason
],
185 'cli_root/zpool_wait/zpool_wait_trim_cancel': ['SKIP', trim_reason
],
186 'cli_root/zpool_wait/zpool_wait_trim_flag': ['SKIP', trim_reason
],
187 'link_count/link_count_001': ['SKIP', na_reason
],
189 elif sys
.platform
.startswith('linux'):
191 'casenorm/mixed_formd_lookup': ['FAIL', '7633'],
192 'casenorm/mixed_formd_delete': ['FAIL', '7633'],
193 'casenorm/sensitive_formd_lookup': ['FAIL', '7633'],
194 'casenorm/sensitive_formd_delete': ['FAIL', '7633'],
195 'removal/removal_with_zdb': ['SKIP', known_reason
],
200 # These tests may occasionally fail or be skipped. We want there failures
201 # to be reported but only unexpected failures should bubble up to cause
202 # this script to exit with a non-zero exit status.
204 # Format: { 'test-name': ['expected result', 'issue-number | reason'] }
206 # For each known failure it is recommended to link to a GitHub issue by
207 # setting the reason to the issue number. Alternately, one of the generic
208 # reasons listed above can be used.
211 'chattr/setup': ['SKIP', exec_reason
],
212 'crtime/crtime_001_pos': ['SKIP', statx_reason
],
213 'cli_root/zdb/zdb_006_pos': ['FAIL', known_reason
],
214 'cli_root/zfs_destroy/zfs_destroy_dev_removal_condense':
215 ['FAIL', known_reason
],
216 'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason
],
217 'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', '5479'],
218 'cli_root/zfs_rollback/zfs_rollback_001_pos': ['FAIL', known_reason
],
219 'cli_root/zfs_rollback/zfs_rollback_002_pos': ['FAIL', known_reason
],
220 'cli_root/zfs_share/setup': ['SKIP', share_reason
],
221 'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason
],
222 'cli_root/zfs_unshare/setup': ['SKIP', share_reason
],
223 'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason
],
224 'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', '6145'],
225 'cli_root/zpool_import/import_rewind_config_changed':
226 ['FAIL', rewind_reason
],
227 'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', '6839'],
228 'cli_root/zpool_initialize/zpool_initialize_import_export':
230 'cli_root/zpool_labelclear/zpool_labelclear_removed':
231 ['FAIL', known_reason
],
232 'cli_root/zpool_trim/setup': ['SKIP', trim_reason
],
233 'cli_root/zpool_upgrade/zpool_upgrade_004_pos': ['FAIL', '6141'],
234 'delegate/setup': ['SKIP', exec_reason
],
235 'fallocate/fallocate_punch-hole': ['SKIP', fspacectl_reason
],
236 'history/history_004_pos': ['FAIL', '7026'],
237 'history/history_005_neg': ['FAIL', '6680'],
238 'history/history_006_neg': ['FAIL', '5657'],
239 'history/history_008_pos': ['FAIL', known_reason
],
240 'history/history_010_pos': ['SKIP', exec_reason
],
241 'io/mmap': ['SKIP', fio_reason
],
242 'largest_pool/largest_pool_001_pos': ['FAIL', known_reason
],
243 'mmp/mmp_on_uberblocks': ['FAIL', known_reason
],
244 'pyzfs/pyzfs_unittest': ['SKIP', python_deps_reason
],
245 'pool_checkpoint/checkpoint_discard_busy': ['FAIL', '11946'],
246 'projectquota/setup': ['SKIP', exec_reason
],
247 'redundancy/redundancy_004_neg': ['FAIL', '7290'],
248 'redundancy/redundancy_draid_spare3': ['SKIP', known_reason
],
249 'removal/removal_condense_export': ['FAIL', known_reason
],
250 'reservation/reservation_008_pos': ['FAIL', '7741'],
251 'reservation/reservation_018_pos': ['FAIL', '5642'],
252 'snapshot/clone_001_pos': ['FAIL', known_reason
],
253 'snapshot/snapshot_009_pos': ['FAIL', '7961'],
254 'snapshot/snapshot_010_pos': ['FAIL', '7961'],
255 'snapused/snapused_004_pos': ['FAIL', '5513'],
256 'tmpfile/setup': ['SKIP', tmpfile_reason
],
257 'threadsappend/threadsappend_001_pos': ['FAIL', '6136'],
258 'trim/setup': ['SKIP', trim_reason
],
259 'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason
],
260 'user_namespace/setup': ['SKIP', user_ns_reason
],
261 'userquota/setup': ['SKIP', exec_reason
],
262 'vdev_zaps/vdev_zaps_004_pos': ['FAIL', '6935'],
263 'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', '5848'],
264 'pam/setup': ['SKIP', "pamtester might be not available"],
267 if sys
.platform
.startswith('freebsd'):
269 'cli_root/zfs_copies/zfs_copies_002_pos': ['FAIL', known_reason
],
270 'cli_root/zfs_inherit/zfs_inherit_001_neg': ['FAIL', known_reason
],
271 'cli_root/zfs_receive/receive-o-x_props_override':
272 ['FAIL', known_reason
],
273 'cli_root/zfs_share/zfs_share_011_pos': ['FAIL', known_reason
],
274 'cli_root/zfs_share/zfs_share_concurrent_shares':
275 ['FAIL', known_reason
],
276 'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason
],
277 'delegate/zfs_allow_003_pos': ['FAIL', known_reason
],
278 'inheritance/inherit_001_pos': ['FAIL', '11829'],
279 'resilver/resilver_restart_001': ['FAIL', known_reason
],
280 'pool_checkpoint/checkpoint_big_rewind': ['FAIL', '12622'],
281 'pool_checkpoint/checkpoint_indirect': ['FAIL', '12623'],
283 elif sys
.platform
.startswith('linux'):
285 'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason
],
286 'cli_root/zpool_expand/zpool_expand_001_pos': ['FAIL', known_reason
],
287 'cli_root/zpool_expand/zpool_expand_005_pos': ['FAIL', known_reason
],
288 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason
],
289 'fault/auto_spare_shared': ['FAIL', '11889'],
290 'io/io_uring': ['SKIP', 'io_uring support required'],
291 'limits/filesystem_limit': ['SKIP', known_reason
],
292 'limits/snapshot_limit': ['SKIP', known_reason
],
293 'mmp/mmp_active_import': ['FAIL', known_reason
],
294 'mmp/mmp_exported_import': ['FAIL', known_reason
],
295 'mmp/mmp_inactive_import': ['FAIL', known_reason
],
296 'zvol/zvol_misc/zvol_misc_snapdev': ['FAIL', '12621'],
297 'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason
],
301 # Not all Github actions runners have scsi_debug module, so we may skip
302 # some tests which use it.
303 if os
.environ
.get('CI') == 'true':
305 'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason
],
306 'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason
],
307 'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason
],
308 'cli_root/zpool_reopen/setup': ['SKIP', ci_reason
],
309 'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason
],
310 'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason
],
311 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason
],
312 'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason
],
313 'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason
],
314 'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason
],
315 'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason
],
316 'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason
],
317 'fault/auto_offline_001_pos': ['SKIP', ci_reason
],
318 'fault/auto_online_001_pos': ['SKIP', ci_reason
],
319 'fault/auto_online_002_pos': ['SKIP', ci_reason
],
320 'fault/auto_replace_001_pos': ['SKIP', ci_reason
],
321 'fault/auto_spare_ashift': ['SKIP', ci_reason
],
322 'fault/auto_spare_shared': ['SKIP', ci_reason
],
323 'procfs/pool_state': ['SKIP', ci_reason
],
327 'events/events_002_pos': ['FAIL', '11546'],
336 def process_results(pathname
):
340 print('Error opening file: %s' % e
)
343 prefix
= '/zfs-tests/tests/functional/'
345 r
'^Test(?:\s+\(\S+\))?:' + \
346 r
'\s*\S*%s(\S+)\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]' \
348 pattern_log
= r
'^\s*Log directory:\s*(\S*)'
351 for line
in f
.readlines():
352 m
= re
.match(pattern
, line
)
353 if m
and len(m
.groups()) == 4:
354 summary
['total'] += 1
355 if m
.group(4) == "PASS":
356 summary
['passed'] += 1
357 d
[m
.group(1)] = m
.group(4)
360 m
= re
.match(pattern_log
, line
)
362 summary
['logfile'] = m
.group(1)
367 class ListMaybesAction(argparse
.Action
):
372 help="list flaky tests and exit"):
373 super(ListMaybesAction
, self
).__init
__(
374 option_strings
=option_strings
,
380 def __call__(self
, parser
, namespace
, values
, option_string
=None):
386 if __name__
== "__main__":
387 parser
= argparse
.ArgumentParser(description
='Analyze ZTS logs')
388 parser
.add_argument('logfile')
389 parser
.add_argument('--list-maybes', action
=ListMaybesAction
)
390 parser
.add_argument('--no-maybes', action
='store_false', dest
='maybes')
391 args
= parser
.parse_args()
393 results
= process_results(args
.logfile
)
395 if summary
['total'] == 0:
396 print("\n\nNo test results were found.")
397 print("Log directory: %s" % summary
['logfile'])
404 for test
in list(results
.keys()):
405 if results
[test
] == "PASS":
408 setup
= test
.replace(os
.path
.basename(test
), "setup")
409 if results
[test
] == "SKIP" and test
!= setup
:
410 if setup
in known
and known
[setup
][0] == "SKIP":
412 if setup
in maybe
and maybe
[setup
][0] == "SKIP":
415 if (test
in known
and results
[test
] in known
[test
][0]):
416 expected
.append(test
)
417 elif test
in maybe
and results
[test
] in maybe
[test
][0]:
418 if results
[test
] == 'SKIP' or args
.maybes
:
419 expected
.append(test
)
420 elif not args
.maybes
:
421 unexpected
.append(test
)
423 unexpected
.append(test
)
426 print("\nTests with results other than PASS that are expected:")
427 for test
in sorted(expected
):
428 issue_url
= 'https://github.com/openzfs/zfs/issues/'
430 # Include the reason why the result is expected, given the following:
431 # 1. Suppress test results which set the "Not applicable" reason.
432 # 2. Numerical reasons are assumed to be GitHub issue numbers.
433 # 3. When an entire test group is skipped only report the setup reason.
435 if known
[test
][1] == na_reason
:
437 elif known
[test
][1].isdigit():
438 expect
= issue_url
+ known
[test
][1]
440 expect
= known
[test
][1]
442 if maybe
[test
][1].isdigit():
443 expect
= issue_url
+ maybe
[test
][1]
445 expect
= maybe
[test
][1]
446 elif setup
in known
and known
[setup
][0] == "SKIP" and setup
!= test
:
448 elif setup
in maybe
and maybe
[setup
][0] == "SKIP" and setup
!= test
:
451 expect
= "UNKNOWN REASON"
452 print(" %s %s (%s)" % (results
[test
], test
, expect
))
454 print("\nTests with result of PASS that are unexpected:")
455 for test
in sorted(known
.keys()):
456 # We probably should not be silently ignoring the case
457 # where "test" is not in "results".
458 if test
not in results
or results
[test
] != "PASS":
460 print(" %s %s (expected %s)" % (results
[test
], test
,
463 print("\nTests with results other than PASS that are unexpected:")
464 for test
in sorted(unexpected
):
465 expect
= "PASS" if test
not in known
else known
[test
][0]
466 print(" %s %s (expected %s)" % (results
[test
], test
, expect
))
468 if len(unexpected
) == 0:
470 elif not args
.maybes
and all_maybes
: