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