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