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 O_TMPFILE flag which was first introduced in the 71# 3.11 kernel. 72# 73tmpfile_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# 79statx_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# 84project_id_reason = 'lsattr with set/show project ID required' 85 86# 87# Some tests require that the kernel support user namespaces. 88# 89user_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# 98rewind_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# 104fio_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# 111trim_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# 118fspacectl_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# 125na_reason = "Not applicable" 126 127# 128# Some test cases doesn't have all requirements to run on Github actions CI. 129# 130ci_reason = 'CI runner doesn\'t have all requirements' 131 132# 133# Idmapped mount is only supported in kernel version >= 5.12 134# 135idmap_reason = 'Idmapped mount needs kernel 5.12+' 136 137# 138# These tests are known to fail, thus we use this list to prevent these 139# failures from failing the job as a whole; only unexpected failures 140# bubble up to cause this script to exit with a non-zero exit status. 141# 142# Format: { 'test-name': ['expected result', 'issue-number | reason'] } 143# 144# For each known failure it is recommended to link to a GitHub issue by 145# setting the reason to the issue number. Alternately, one of the generic 146# reasons listed above can be used. 147# 148known = { 149 'casenorm/mixed_none_lookup_ci': ['FAIL', 7633], 150 'casenorm/mixed_formd_lookup_ci': ['FAIL', 7633], 151 'cli_root/zpool_import/import_rewind_device_replaced': 152 ['FAIL', rewind_reason], 153 'cli_user/misc/zfs_share_001_neg': ['SKIP', na_reason], 154 'cli_user/misc/zfs_unshare_001_neg': ['SKIP', na_reason], 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_wait/zpool_wait_trim_basic': ['SKIP', trim_reason], 167 'cli_root/zpool_wait/zpool_wait_trim_cancel': ['SKIP', trim_reason], 168 'cli_root/zpool_wait/zpool_wait_trim_flag': ['SKIP', trim_reason], 169 'cli_root/zfs_unshare/zfs_unshare_008_pos': ['SKIP', na_reason], 170 'link_count/link_count_001': ['SKIP', na_reason], 171 'casenorm/mixed_create_failure': ['FAIL', 13215], 172 'mmap/mmap_sync_001_pos': ['SKIP', na_reason], 173 }) 174elif sys.platform.startswith('linux'): 175 known.update({ 176 'casenorm/mixed_formd_lookup': ['FAIL', 7633], 177 'casenorm/mixed_formd_delete': ['FAIL', 7633], 178 'casenorm/sensitive_formd_lookup': ['FAIL', 7633], 179 'casenorm/sensitive_formd_delete': ['FAIL', 7633], 180 'removal/removal_with_zdb': ['SKIP', known_reason], 181 'cli_root/zfs_unshare/zfs_unshare_002_pos': ['SKIP', na_reason], 182 }) 183 184 185# 186# These tests may occasionally fail or be skipped. We want there failures 187# to be reported but only unexpected failures should bubble up to cause 188# this script to exit with a non-zero exit status. 189# 190# Format: { 'test-name': ['expected result', 'issue-number | reason'] } 191# 192# For each known failure it is recommended to link to a GitHub issue by 193# setting the reason to the issue number. Alternately, one of the generic 194# reasons listed above can be used. 195# 196maybe = { 197 'append/threadsappend_001_pos': ['FAIL', 6136], 198 'chattr/setup': ['SKIP', exec_reason], 199 'crtime/crtime_001_pos': ['SKIP', statx_reason], 200 'cli_root/zdb/zdb_006_pos': ['FAIL', known_reason], 201 'cli_root/zfs_destroy/zfs_destroy_dev_removal_condense': 202 ['FAIL', known_reason], 203 'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason], 204 'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', 5479], 205 'cli_root/zfs_rollback/zfs_rollback_001_pos': ['FAIL', known_reason], 206 'cli_root/zfs_rollback/zfs_rollback_002_pos': ['FAIL', known_reason], 207 'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason], 208 'cli_root/zfs_unshare/zfs_unshare_006_pos': ['SKIP', na_reason], 209 'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason], 210 'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', 6145], 211 'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', 6839], 212 'cli_root/zpool_initialize/zpool_initialize_import_export': 213 ['FAIL', 11948], 214 'cli_root/zpool_labelclear/zpool_labelclear_removed': 215 ['FAIL', known_reason], 216 'cli_root/zpool_trim/setup': ['SKIP', trim_reason], 217 'cli_root/zpool_upgrade/zpool_upgrade_004_pos': ['FAIL', 6141], 218 'delegate/setup': ['SKIP', exec_reason], 219 'fallocate/fallocate_punch-hole': ['SKIP', fspacectl_reason], 220 'history/history_004_pos': ['FAIL', 7026], 221 'history/history_005_neg': ['FAIL', 6680], 222 'history/history_006_neg': ['FAIL', 5657], 223 'history/history_008_pos': ['FAIL', known_reason], 224 'history/history_010_pos': ['SKIP', exec_reason], 225 'io/mmap': ['SKIP', fio_reason], 226 'largest_pool/largest_pool_001_pos': ['FAIL', known_reason], 227 'mmp/mmp_on_uberblocks': ['FAIL', known_reason], 228 'pam/setup': ['SKIP', "pamtester might be not available"], 229 'pool_checkpoint/checkpoint_discard_busy': ['FAIL', 11946], 230 'projectquota/setup': ['SKIP', exec_reason], 231 'removal/removal_condense_export': ['FAIL', known_reason], 232 'renameat2/setup': ['SKIP', renameat2_reason], 233 'reservation/reservation_008_pos': ['FAIL', 7741], 234 'reservation/reservation_018_pos': ['FAIL', 5642], 235 'snapshot/clone_001_pos': ['FAIL', known_reason], 236 'snapshot/snapshot_009_pos': ['FAIL', 7961], 237 'snapshot/snapshot_010_pos': ['FAIL', 7961], 238 'snapused/snapused_004_pos': ['FAIL', 5513], 239 'tmpfile/setup': ['SKIP', tmpfile_reason], 240 'trim/setup': ['SKIP', trim_reason], 241 'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason], 242 'user_namespace/setup': ['SKIP', user_ns_reason], 243 'userquota/setup': ['SKIP', exec_reason], 244 'vdev_zaps/vdev_zaps_004_pos': ['FAIL', known_reason], 245 'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', 5848], 246} 247 248if sys.platform.startswith('freebsd'): 249 maybe.update({ 250 'cli_root/zfs_copies/zfs_copies_002_pos': ['FAIL', known_reason], 251 'cli_root/zfs_inherit/zfs_inherit_001_neg': ['FAIL', known_reason], 252 'cli_root/zfs_share/zfs_share_concurrent_shares': 253 ['FAIL', known_reason], 254 'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason], 255 'delegate/zfs_allow_003_pos': ['FAIL', known_reason], 256 'inheritance/inherit_001_pos': ['FAIL', 11829], 257 'resilver/resilver_restart_001': ['FAIL', known_reason], 258 'pool_checkpoint/checkpoint_big_rewind': ['FAIL', 12622], 259 'pool_checkpoint/checkpoint_indirect': ['FAIL', 12623], 260 'snapshot/snapshot_002_pos': ['FAIL', '14831'], 261 }) 262elif sys.platform.startswith('linux'): 263 maybe.update({ 264 'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason], 265 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason], 266 'fault/auto_online_002_pos': ['FAIL', 11889], 267 'fault/auto_replace_001_pos': ['FAIL', 14851], 268 'fault/auto_spare_002_pos': ['FAIL', 11889], 269 'fault/auto_spare_multiple': ['FAIL', 11889], 270 'fault/auto_spare_shared': ['FAIL', 11889], 271 'fault/decompress_fault': ['FAIL', 11889], 272 'io/io_uring': ['SKIP', 'io_uring support required'], 273 'limits/filesystem_limit': ['SKIP', known_reason], 274 'limits/snapshot_limit': ['SKIP', known_reason], 275 'mmp/mmp_active_import': ['FAIL', known_reason], 276 'mmp/mmp_exported_import': ['FAIL', known_reason], 277 'mmp/mmp_inactive_import': ['FAIL', known_reason], 278 'zvol/zvol_misc/zvol_misc_snapdev': ['FAIL', 12621], 279 'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason], 280 'idmap_mount/idmap_mount_001': ['SKIP', idmap_reason], 281 'idmap_mount/idmap_mount_002': ['SKIP', idmap_reason], 282 'idmap_mount/idmap_mount_003': ['SKIP', idmap_reason], 283 'idmap_mount/idmap_mount_004': ['SKIP', idmap_reason], 284 'idmap_mount/idmap_mount_005': ['SKIP', idmap_reason], 285 }) 286 287 288# Not all Github actions runners have scsi_debug module, so we may skip 289# some tests which use it. 290if os.environ.get('CI') == 'true': 291 known.update({ 292 'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason], 293 'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason], 294 'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason], 295 'cli_root/zpool_reopen/setup': ['SKIP', ci_reason], 296 'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason], 297 'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason], 298 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason], 299 'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason], 300 'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason], 301 'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason], 302 'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason], 303 'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason], 304 'fault/auto_offline_001_pos': ['SKIP', ci_reason], 305 'fault/auto_online_001_pos': ['SKIP', ci_reason], 306 'fault/auto_online_002_pos': ['SKIP', ci_reason], 307 'fault/auto_replace_001_pos': ['SKIP', ci_reason], 308 'fault/auto_spare_ashift': ['SKIP', ci_reason], 309 'fault/auto_spare_shared': ['SKIP', ci_reason], 310 'procfs/pool_state': ['SKIP', ci_reason], 311 }) 312 313 maybe.update({ 314 'events/events_002_pos': ['FAIL', 11546], 315 }) 316 317 318def process_results(pathname): 319 try: 320 f = open(pathname) 321 except IOError as e: 322 print('Error opening file:', e) 323 sys.exit(1) 324 325 prefix = '/zfs-tests/tests/(?:functional|perf/regression)/' 326 pattern = \ 327 r'^Test(?:\s+\(\S+\))?:' + \ 328 rf'\s*\S*{prefix}(\S+)' + \ 329 r'\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]' 330 pattern_log = r'^\s*Log directory:\s*(\S*)' 331 332 d = {} 333 logdir = 'Could not determine log directory.' 334 for line in f.readlines(): 335 m = re.match(pattern, line) 336 if m and len(m.groups()) == 4: 337 d[m.group(1)] = m.group(4) 338 continue 339 340 m = re.match(pattern_log, line) 341 if m: 342 logdir = m.group(1) 343 344 return d, logdir 345 346 347class ListMaybesAction(argparse.Action): 348 def __init__(self, 349 option_strings, 350 dest="SUPPRESS", 351 default="SUPPRESS", 352 help="list flaky tests and exit"): 353 super(ListMaybesAction, self).__init__( 354 option_strings=option_strings, 355 dest=dest, 356 default=default, 357 nargs=0, 358 help=help) 359 360 def __call__(self, parser, namespace, values, option_string=None): 361 for test in maybe: 362 print(test) 363 sys.exit(0) 364 365 366if __name__ == "__main__": 367 parser = argparse.ArgumentParser(description='Analyze ZTS logs') 368 parser.add_argument('logfile') 369 parser.add_argument('--list-maybes', action=ListMaybesAction) 370 parser.add_argument('--no-maybes', action='store_false', dest='maybes') 371 args = parser.parse_args() 372 373 results, logdir = process_results(args.logfile) 374 375 if not results: 376 print("\n\nNo test results were found.") 377 print("Log directory:", logdir) 378 sys.exit(0) 379 380 expected = [] 381 unexpected = [] 382 all_maybes = True 383 384 for test in list(results.keys()): 385 if results[test] == "PASS": 386 continue 387 388 setup = test.replace(os.path.basename(test), "setup") 389 if results[test] == "SKIP" and test != setup: 390 if setup in known and known[setup][0] == "SKIP": 391 continue 392 if setup in maybe and maybe[setup][0] == "SKIP": 393 continue 394 395 if (test in known and results[test] in known[test][0]): 396 expected.append(test) 397 elif test in maybe and results[test] in maybe[test][0]: 398 if results[test] == 'SKIP' or args.maybes: 399 expected.append(test) 400 elif not args.maybes: 401 unexpected.append(test) 402 else: 403 unexpected.append(test) 404 all_maybes = False 405 406 print("\nTests with results other than PASS that are expected:") 407 for test in sorted(expected): 408 issue_url = 'https://github.com/openzfs/zfs/issues/' 409 410 # Include the reason why the result is expected, given the following: 411 # 1. Suppress test results which set the "Not applicable" reason. 412 # 2. Numerical reasons are assumed to be GitHub issue numbers. 413 # 3. When an entire test group is skipped only report the setup reason. 414 if test in known: 415 if known[test][1] == na_reason: 416 continue 417 elif isinstance(known[test][1], int): 418 expect = f"{issue_url}{known[test][1]}" 419 else: 420 expect = known[test][1] 421 elif test in maybe: 422 if isinstance(maybe[test][1], int): 423 expect = f"{issue_url}{maybe[test][1]}" 424 else: 425 expect = maybe[test][1] 426 elif setup in known and known[setup][0] == "SKIP" and setup != test: 427 continue 428 elif setup in maybe and maybe[setup][0] == "SKIP" and setup != test: 429 continue 430 else: 431 expect = "UNKNOWN REASON" 432 print(f" {results[test]} {test} ({expect})") 433 434 print("\nTests with result of PASS that are unexpected:") 435 for test in sorted(known.keys()): 436 # We probably should not be silently ignoring the case 437 # where "test" is not in "results". 438 if test not in results or results[test] != "PASS": 439 continue 440 print(f" {results[test]} {test} (expected {known[test][0]})") 441 442 print("\nTests with results other than PASS that are unexpected:") 443 for test in sorted(unexpected): 444 expect = "PASS" if test not in known else known[test][0] 445 print(f" {results[test]} {test} (expected {expect})") 446 447 if len(unexpected) == 0: 448 sys.exit(0) 449 elif not args.maybes and all_maybes: 450 sys.exit(2) 451 else: 452 sys.exit(1) 453