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 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 68# by the pyzfs tests. 69# 70python_deps_reason = 'Python modules missing: python3-cffi' 71 72# 73# Some tests require the O_TMPFILE flag which was first introduced in the 74# 3.11 kernel. 75# 76tmpfile_reason = 'Kernel O_TMPFILE support required' 77 78# 79# Some tests require the statx(2) system call on Linux which was first 80# introduced in the 4.11 kernel. 81# 82statx_reason = 'Kernel statx(2) system call required on Linux' 83 84# 85# Some tests require that the lsattr utility support the project id feature. 86# 87project_id_reason = 'lsattr with set/show project ID required' 88 89# 90# Some tests require that the kernel support user namespaces. 91# 92user_ns_reason = 'Kernel user namespace support required' 93 94# 95# Some rewind tests can fail since nothing guarantees that old MOS blocks 96# are not overwritten. Snapshots protect datasets and data files but not 97# the MOS. Reasonable efforts are made in the test case to increase the 98# odds that some txgs will have their MOS data left untouched, but it is 99# never a sure thing. 100# 101rewind_reason = 'Arbitrary pool rewind is not guaranteed' 102 103# 104# Some tests require a minimum version of the fio benchmark utility. 105# Older distributions such as CentOS 6.x only provide fio-2.0.13. 106# 107fio_reason = 'Fio v2.3 or newer required' 108 109# 110# Some tests require that the DISKS provided support the discard operation. 111# Normally this is not an issue because loop back devices are used for DISKS 112# and they support discard (TRIM/UNMAP). 113# 114trim_reason = 'DISKS must support discard (TRIM/UNMAP)' 115 116# 117# Some tests on FreeBSD require the fspacectl(2) system call and the 118# truncate(1) utility supporting the -d option. The system call was first 119# introduced in FreeBSD version 1400032. 120# 121fspacectl_reason = 'fspacectl(2) and truncate -d support required' 122 123# 124# Some tests are not applicable to a platform or need to be updated to operate 125# in the manor required by the platform. Any tests which are skipped for this 126# reason will be suppressed in the final analysis output. 127# 128na_reason = "Not applicable" 129 130# 131# Some test cases doesn't have all requirements to run on Github actions CI. 132# 133ci_reason = 'CI runner doesn\'t have all requirements' 134 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 'privilege/setup': ['SKIP', na_reason], 155 'refreserv/refreserv_004_pos': ['FAIL', known_reason], 156 'rootpool/setup': ['SKIP', na_reason], 157 'rsend/rsend_008_pos': ['SKIP', 6066], 158 'vdev_zaps/vdev_zaps_007_pos': ['FAIL', known_reason], 159} 160 161if sys.platform.startswith('freebsd'): 162 known.update({ 163 'cli_root/zfs_receive/receive-o-x_props_override': 164 ['FAIL', known_reason], 165 'cli_root/zpool_wait/zpool_wait_trim_basic': ['SKIP', trim_reason], 166 'cli_root/zpool_wait/zpool_wait_trim_cancel': ['SKIP', trim_reason], 167 'cli_root/zpool_wait/zpool_wait_trim_flag': ['SKIP', trim_reason], 168 'cli_root/zfs_unshare/zfs_unshare_008_pos': ['SKIP', na_reason], 169 'link_count/link_count_001': ['SKIP', na_reason], 170 'casenorm/mixed_create_failure': ['FAIL', 13215], 171 'mmap/mmap_sync_001_pos': ['SKIP', na_reason], 172 }) 173elif sys.platform.startswith('linux'): 174 known.update({ 175 'casenorm/mixed_formd_lookup': ['FAIL', 7633], 176 'casenorm/mixed_formd_delete': ['FAIL', 7633], 177 'casenorm/sensitive_formd_lookup': ['FAIL', 7633], 178 'casenorm/sensitive_formd_delete': ['FAIL', 7633], 179 'removal/removal_with_zdb': ['SKIP', known_reason], 180 'cli_root/zfs_unshare/zfs_unshare_002_pos': ['SKIP', na_reason], 181 }) 182 183 184# 185# These tests may occasionally fail or be skipped. We want there failures 186# to be reported but only unexpected failures should bubble up to cause 187# this script to exit with a non-zero exit status. 188# 189# Format: { 'test-name': ['expected result', 'issue-number | reason'] } 190# 191# For each known failure it is recommended to link to a GitHub issue by 192# setting the reason to the issue number. Alternately, one of the generic 193# reasons listed above can be used. 194# 195maybe = { 196 'chattr/setup': ['SKIP', exec_reason], 197 'crtime/crtime_001_pos': ['SKIP', statx_reason], 198 'cli_root/zdb/zdb_006_pos': ['FAIL', known_reason], 199 'cli_root/zfs_destroy/zfs_destroy_dev_removal_condense': 200 ['FAIL', known_reason], 201 'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason], 202 'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', 5479], 203 'cli_root/zfs_rollback/zfs_rollback_001_pos': ['FAIL', known_reason], 204 'cli_root/zfs_rollback/zfs_rollback_002_pos': ['FAIL', known_reason], 205 'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason], 206 'cli_root/zfs_unshare/zfs_unshare_006_pos': ['SKIP', na_reason], 207 'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason], 208 'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', 6145], 209 'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', 6839], 210 'cli_root/zpool_initialize/zpool_initialize_import_export': 211 ['FAIL', 11948], 212 'cli_root/zpool_labelclear/zpool_labelclear_removed': 213 ['FAIL', known_reason], 214 'cli_root/zpool_trim/setup': ['SKIP', trim_reason], 215 'cli_root/zpool_upgrade/zpool_upgrade_004_pos': ['FAIL', 6141], 216 'delegate/setup': ['SKIP', exec_reason], 217 'fallocate/fallocate_punch-hole': ['SKIP', fspacectl_reason], 218 'history/history_004_pos': ['FAIL', 7026], 219 'history/history_005_neg': ['FAIL', 6680], 220 'history/history_006_neg': ['FAIL', 5657], 221 'history/history_008_pos': ['FAIL', known_reason], 222 'history/history_010_pos': ['SKIP', exec_reason], 223 'io/mmap': ['SKIP', fio_reason], 224 'largest_pool/largest_pool_001_pos': ['FAIL', known_reason], 225 'mmp/mmp_on_uberblocks': ['FAIL', known_reason], 226 'pyzfs/pyzfs_unittest': ['SKIP', python_deps_reason], 227 'pool_checkpoint/checkpoint_discard_busy': ['FAIL', 11946], 228 'projectquota/setup': ['SKIP', exec_reason], 229 'removal/removal_condense_export': ['FAIL', known_reason], 230 'reservation/reservation_008_pos': ['FAIL', 7741], 231 'reservation/reservation_018_pos': ['FAIL', 5642], 232 'snapshot/clone_001_pos': ['FAIL', known_reason], 233 'snapshot/snapshot_009_pos': ['FAIL', 7961], 234 'snapshot/snapshot_010_pos': ['FAIL', 7961], 235 'snapused/snapused_004_pos': ['FAIL', 5513], 236 'tmpfile/setup': ['SKIP', tmpfile_reason], 237 'append/threadsappend_001_pos': ['FAIL', 6136], 238 'trim/setup': ['SKIP', trim_reason], 239 'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason], 240 'user_namespace/setup': ['SKIP', user_ns_reason], 241 'userquota/setup': ['SKIP', exec_reason], 242 'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', 5848], 243 'pam/setup': ['SKIP', "pamtester might be not available"], 244} 245 246if sys.platform.startswith('freebsd'): 247 maybe.update({ 248 'cli_root/zfs_copies/zfs_copies_002_pos': ['FAIL', known_reason], 249 'cli_root/zfs_inherit/zfs_inherit_001_neg': ['FAIL', known_reason], 250 'cli_root/zfs_share/zfs_share_concurrent_shares': 251 ['FAIL', known_reason], 252 'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason], 253 'delegate/zfs_allow_003_pos': ['FAIL', known_reason], 254 'inheritance/inherit_001_pos': ['FAIL', 11829], 255 'resilver/resilver_restart_001': ['FAIL', known_reason], 256 'pool_checkpoint/checkpoint_big_rewind': ['FAIL', 12622], 257 'pool_checkpoint/checkpoint_indirect': ['FAIL', 12623], 258 }) 259elif sys.platform.startswith('linux'): 260 maybe.update({ 261 'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason], 262 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason], 263 'fault/auto_spare_shared': ['FAIL', 11889], 264 'fault/auto_spare_multiple': ['FAIL', 11889], 265 'io/io_uring': ['SKIP', 'io_uring support required'], 266 'limits/filesystem_limit': ['SKIP', known_reason], 267 'limits/snapshot_limit': ['SKIP', known_reason], 268 'mmp/mmp_active_import': ['FAIL', known_reason], 269 'mmp/mmp_exported_import': ['FAIL', known_reason], 270 'mmp/mmp_inactive_import': ['FAIL', known_reason], 271 'zvol/zvol_misc/zvol_misc_snapdev': ['FAIL', 12621], 272 'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason], 273 }) 274 275 276# Not all Github actions runners have scsi_debug module, so we may skip 277# some tests which use it. 278if os.environ.get('CI') == 'true': 279 known.update({ 280 'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason], 281 'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason], 282 'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason], 283 'cli_root/zpool_reopen/setup': ['SKIP', ci_reason], 284 'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason], 285 'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason], 286 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason], 287 'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason], 288 'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason], 289 'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason], 290 'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason], 291 'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason], 292 'fault/auto_offline_001_pos': ['SKIP', ci_reason], 293 'fault/auto_online_001_pos': ['SKIP', ci_reason], 294 'fault/auto_online_002_pos': ['SKIP', ci_reason], 295 'fault/auto_replace_001_pos': ['SKIP', ci_reason], 296 'fault/auto_spare_ashift': ['SKIP', ci_reason], 297 'fault/auto_spare_shared': ['SKIP', ci_reason], 298 'procfs/pool_state': ['SKIP', ci_reason], 299 }) 300 301 maybe.update({ 302 'events/events_002_pos': ['FAIL', 11546], 303 }) 304 305 306def process_results(pathname): 307 try: 308 f = open(pathname) 309 except IOError as e: 310 print('Error opening file:', e) 311 sys.exit(1) 312 313 prefix = '/zfs-tests/tests/functional/' 314 pattern = \ 315 r'^Test(?:\s+\(\S+\))?:' + \ 316 rf'\s*\S*{prefix}(\S+)' + \ 317 r'\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]' 318 pattern_log = r'^\s*Log directory:\s*(\S*)' 319 320 d = {} 321 logdir = 'Could not determine log directory.' 322 for line in f.readlines(): 323 m = re.match(pattern, line) 324 if m and len(m.groups()) == 4: 325 d[m.group(1)] = m.group(4) 326 continue 327 328 m = re.match(pattern_log, line) 329 if m: 330 logdir = m.group(1) 331 332 return d, logdir 333 334 335class ListMaybesAction(argparse.Action): 336 def __init__(self, 337 option_strings, 338 dest="SUPPRESS", 339 default="SUPPRESS", 340 help="list flaky tests and exit"): 341 super(ListMaybesAction, self).__init__( 342 option_strings=option_strings, 343 dest=dest, 344 default=default, 345 nargs=0, 346 help=help) 347 348 def __call__(self, parser, namespace, values, option_string=None): 349 for test in maybe: 350 print(test) 351 sys.exit(0) 352 353 354if __name__ == "__main__": 355 parser = argparse.ArgumentParser(description='Analyze ZTS logs') 356 parser.add_argument('logfile') 357 parser.add_argument('--list-maybes', action=ListMaybesAction) 358 parser.add_argument('--no-maybes', action='store_false', dest='maybes') 359 args = parser.parse_args() 360 361 results, logdir = process_results(args.logfile) 362 363 if not results: 364 print("\n\nNo test results were found.") 365 print("Log directory:", logdir) 366 sys.exit(0) 367 368 expected = [] 369 unexpected = [] 370 all_maybes = True 371 372 for test in list(results.keys()): 373 if results[test] == "PASS": 374 continue 375 376 setup = test.replace(os.path.basename(test), "setup") 377 if results[test] == "SKIP" and test != setup: 378 if setup in known and known[setup][0] == "SKIP": 379 continue 380 if setup in maybe and maybe[setup][0] == "SKIP": 381 continue 382 383 if (test in known and results[test] in known[test][0]): 384 expected.append(test) 385 elif test in maybe and results[test] in maybe[test][0]: 386 if results[test] == 'SKIP' or args.maybes: 387 expected.append(test) 388 elif not args.maybes: 389 unexpected.append(test) 390 else: 391 unexpected.append(test) 392 all_maybes = False 393 394 print("\nTests with results other than PASS that are expected:") 395 for test in sorted(expected): 396 issue_url = 'https://github.com/openzfs/zfs/issues/' 397 398 # Include the reason why the result is expected, given the following: 399 # 1. Suppress test results which set the "Not applicable" reason. 400 # 2. Numerical reasons are assumed to be GitHub issue numbers. 401 # 3. When an entire test group is skipped only report the setup reason. 402 if test in known: 403 if known[test][1] == na_reason: 404 continue 405 elif isinstance(known[test][1], int): 406 expect = f"{issue_url}{known[test][1]}" 407 else: 408 expect = known[test][1] 409 elif test in maybe: 410 if isinstance(maybe[test][1], int): 411 expect = f"{issue_url}{maybe[test][1]}" 412 else: 413 expect = maybe[test][1] 414 elif setup in known and known[setup][0] == "SKIP" and setup != test: 415 continue 416 elif setup in maybe and maybe[setup][0] == "SKIP" and setup != test: 417 continue 418 else: 419 expect = "UNKNOWN REASON" 420 print(f" {results[test]} {test} ({expect})") 421 422 print("\nTests with result of PASS that are unexpected:") 423 for test in sorted(known.keys()): 424 # We probably should not be silently ignoring the case 425 # where "test" is not in "results". 426 if test not in results or results[test] != "PASS": 427 continue 428 print(f" {results[test]} {test} (expected {known[test][0]})") 429 430 print("\nTests with results other than PASS that are unexpected:") 431 for test in sorted(unexpected): 432 expect = "PASS" if test not in known else known[test][0] 433 print(f" {results[test]} {test} (expected {expect})") 434 435 if len(unexpected) == 0: 436 sys.exit(0) 437 elif not args.maybes and all_maybes: 438 sys.exit(2) 439 else: 440 sys.exit(1) 441