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 2.6+ and Python 3.4+. 19# 20 21import os 22import re 23import sys 24 25# 26# This script parses the stdout of zfstest, which has this format: 27# 28# Test: /path/to/testa (run as root) [00:00] [PASS] 29# Test: /path/to/testb (run as jkennedy) [00:00] [PASS] 30# Test: /path/to/testc (run as root) [00:00] [FAIL] 31# [...many more results...] 32# 33# Results Summary 34# FAIL 22 35# SKIP 32 36# PASS 1156 37# 38# Running Time: 02:50:31 39# Percent passed: 95.5% 40# Log directory: /var/tmp/test_results/20180615T205926 41# 42 43# 44# Common generic reasons for a test or test group to be skipped. 45# 46# Some test cases are known to fail in ways which are not harmful or dangerous. 47# In these cases simply mark the test as a known failure until it can be 48# updated and the issue resolved. Note that it's preferable to open a unique 49# issue on the GitHub issue tracker for each test case failure. 50# 51known_reason = 'Known issue' 52 53# 54# Some tests require that a test user be able to execute the zfs utilities. 55# This may not be possible when testing in-tree due to the default permissions 56# on the user's home directory. When testing this can be resolved by granting 57# group read access. 58# 59# chmod 0750 $HOME 60# 61exec_reason = 'Test user execute permissions required for utilities' 62 63# 64# Some tests require a minimum python version of 3.5 and will be skipped when 65# the default system version is too old. There may also be tests which require 66# additional python modules be installed, for example python-cffi is required 67# by the pyzfs tests. 68# 69python_reason = 'Python v3.5 or newer required' 70python_deps_reason = 'Python modules missing: python-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 that the NFS client and server utilities be installed. 80# 81share_reason = 'NFS client and server utilities required' 82 83# 84# Some tests require that the lsattr utility support the project id feature. 85# 86project_id_reason = 'lsattr with set/show project ID required' 87 88# 89# Some tests require that the kernel support user namespaces. 90# 91user_ns_reason = 'Kernel user namespace support required' 92 93# 94# Some rewind tests can fail since nothing guarantees that old MOS blocks 95# are not overwritten. Snapshots protect datasets and data files but not 96# the MOS. Reasonable efforts are made in the test case to increase the 97# odds that some txgs will have their MOS data left untouched, but it is 98# never a sure thing. 99# 100rewind_reason = 'Arbitrary pool rewind is not guaranteed' 101 102# 103# Some tests may by structured in a way that relies on exact knowledge 104# of how much free space in available in a pool. These tests cannot be 105# made completely reliable because the internal details of how free space 106# is managed are not exposed to user space. 107# 108enospc_reason = 'Exact free space reporting is not guaranteed' 109 110# 111# Some tests require a minimum version of the fio benchmark utility. 112# Older distributions such as CentOS 6.x only provide fio-2.0.13. 113# 114fio_reason = 'Fio v2.3 or newer required' 115 116# 117# Some tests require that the DISKS provided support the discard operation. 118# Normally this is not an issue because loop back devices are used for DISKS 119# and they support discard (TRIM/UNMAP). 120# 121trim_reason = 'DISKS must support discard (TRIM/UNMAP)' 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 135summary = { 136 'total': float(0), 137 'passed': float(0), 138 'logfile': "Could not determine logfile location." 139} 140 141# 142# These tests are known to fail, thus we use this list to prevent these 143# failures from failing the job as a whole; only unexpected failures 144# bubble up to cause this script to exit with a non-zero exit status. 145# 146# Format: { 'test-name': ['expected result', 'issue-number | reason'] } 147# 148# For each known failure it is recommended to link to a GitHub issue by 149# setting the reason to the issue number. Alternately, one of the generic 150# reasons listed above can be used. 151# 152known = { 153 'casenorm/mixed_none_lookup_ci': ['FAIL', '7633'], 154 'casenorm/mixed_formd_lookup_ci': ['FAIL', '7633'], 155 'cli_root/zfs_unshare/zfs_unshare_002_pos': ['SKIP', na_reason], 156 'cli_root/zfs_unshare/zfs_unshare_006_pos': ['SKIP', na_reason], 157 'cli_user/misc/zfs_share_001_neg': ['SKIP', na_reason], 158 'cli_user/misc/zfs_unshare_001_neg': ['SKIP', na_reason], 159 'privilege/setup': ['SKIP', na_reason], 160 'refreserv/refreserv_004_pos': ['FAIL', known_reason], 161 'rootpool/setup': ['SKIP', na_reason], 162 'rsend/rsend_008_pos': ['SKIP', '6066'], 163 'vdev_zaps/vdev_zaps_007_pos': ['FAIL', known_reason], 164} 165 166if sys.platform.startswith('freebsd'): 167 known.update({ 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 'link_count/link_count_001': ['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 }) 181 182 183# 184# These tests may occasionally fail or be skipped. We want there failures 185# to be reported but only unexpected failures should bubble up to cause 186# this script to exit with a non-zero exit status. 187# 188# Format: { 'test-name': ['expected result', 'issue-number | reason'] } 189# 190# For each known failure it is recommended to link to a GitHub issue by 191# setting the reason to the issue number. Alternately, one of the generic 192# reasons listed above can be used. 193# 194maybe = { 195 'chattr/setup': ['SKIP', exec_reason], 196 'cli_root/zdb/zdb_006_pos': ['FAIL', known_reason], 197 'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason], 198 'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', '5479'], 199 'cli_root/zfs_share/setup': ['SKIP', share_reason], 200 'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason], 201 'cli_root/zfs_unshare/setup': ['SKIP', share_reason], 202 'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason], 203 'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', '6145'], 204 'cli_root/zpool_import/import_rewind_device_replaced': 205 ['FAIL', rewind_reason], 206 'cli_root/zpool_import/import_rewind_config_changed': 207 ['FAIL', rewind_reason], 208 'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', '6839'], 209 'cli_root/zpool_trim/setup': ['SKIP', trim_reason], 210 'cli_root/zpool_upgrade/zpool_upgrade_004_pos': ['FAIL', '6141'], 211 'delegate/setup': ['SKIP', exec_reason], 212 'history/history_004_pos': ['FAIL', '7026'], 213 'history/history_005_neg': ['FAIL', '6680'], 214 'history/history_006_neg': ['FAIL', '5657'], 215 'history/history_008_pos': ['FAIL', known_reason], 216 'history/history_010_pos': ['SKIP', exec_reason], 217 'io/mmap': ['SKIP', fio_reason], 218 'largest_pool/largest_pool_001_pos': ['FAIL', known_reason], 219 'mmp/mmp_on_uberblocks': ['FAIL', known_reason], 220 'pyzfs/pyzfs_unittest': ['SKIP', python_deps_reason], 221 'no_space/enospc_002_pos': ['FAIL', enospc_reason], 222 'projectquota/setup': ['SKIP', exec_reason], 223 'redundancy/redundancy_004_neg': ['FAIL', '7290'], 224 'redundancy/redundancy_draid_spare3': ['SKIP', known_reason], 225 'reservation/reservation_008_pos': ['FAIL', '7741'], 226 'reservation/reservation_018_pos': ['FAIL', '5642'], 227 'rsend/rsend_019_pos': ['FAIL', '6086'], 228 'rsend/rsend_020_pos': ['FAIL', '6446'], 229 'rsend/rsend_021_pos': ['FAIL', '6446'], 230 'rsend/rsend_024_pos': ['FAIL', '5665'], 231 'rsend/send-c_volume': ['FAIL', '6087'], 232 'rsend/send_partial_dataset': ['FAIL', known_reason], 233 'snapshot/clone_001_pos': ['FAIL', known_reason], 234 'snapshot/snapshot_009_pos': ['FAIL', '7961'], 235 'snapshot/snapshot_010_pos': ['FAIL', '7961'], 236 'snapused/snapused_004_pos': ['FAIL', '5513'], 237 'tmpfile/setup': ['SKIP', tmpfile_reason], 238 'threadsappend/threadsappend_001_pos': ['FAIL', '6136'], 239 'trim/setup': ['SKIP', trim_reason], 240 'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason], 241 'user_namespace/setup': ['SKIP', user_ns_reason], 242 'userquota/setup': ['SKIP', exec_reason], 243 'vdev_zaps/vdev_zaps_004_pos': ['FAIL', '6935'], 244 'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', '5848'], 245 'pam/setup': ['SKIP', "pamtester might be not available"], 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_011_pos': ['FAIL', known_reason], 253 'cli_root/zfs_share/zfs_share_concurrent_shares': 254 ['FAIL', known_reason], 255 'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason], 256 'delegate/zfs_allow_003_pos': ['FAIL', known_reason], 257 'removal/removal_condense_export': ['FAIL', known_reason], 258 'removal/removal_with_export': ['FAIL', known_reason], 259 'resilver/resilver_restart_001': ['FAIL', known_reason], 260 'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason], 261 }) 262elif sys.platform.startswith('linux'): 263 maybe.update({ 264 'alloc_class/alloc_class_009_pos': ['FAIL', known_reason], 265 'alloc_class/alloc_class_010_pos': ['FAIL', known_reason], 266 'alloc_class/alloc_class_011_neg': ['FAIL', known_reason], 267 'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason], 268 'cli_root/zpool_expand/zpool_expand_001_pos': ['FAIL', known_reason], 269 'cli_root/zpool_expand/zpool_expand_005_pos': ['FAIL', known_reason], 270 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason], 271 'io/io_uring': ['SKIP', 'io_uring support required'], 272 'limits/filesystem_limit': ['SKIP', known_reason], 273 'limits/snapshot_limit': ['SKIP', known_reason], 274 'mmp/mmp_exported_import': ['FAIL', known_reason], 275 'mmp/mmp_inactive_import': ['FAIL', known_reason], 276 'refreserv/refreserv_raidz': ['FAIL', known_reason], 277 'rsend/rsend_007_pos': ['FAIL', known_reason], 278 'rsend/rsend_010_pos': ['FAIL', known_reason], 279 'rsend/rsend_011_pos': ['FAIL', known_reason], 280 'snapshot/rollback_003_pos': ['FAIL', known_reason], 281 }) 282 283 284# Not all Github actions runners have scsi_debug module, so we may skip 285# some tests which use it. 286if os.environ.get('CI') == 'true': 287 known.update({ 288 'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason], 289 'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason], 290 'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason], 291 'cli_root/zpool_reopen/setup': ['SKIP', ci_reason], 292 'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason], 293 'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason], 294 'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason], 295 'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason], 296 'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason], 297 'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason], 298 'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason], 299 'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason], 300 'fault/auto_offline_001_pos': ['SKIP', ci_reason], 301 'fault/auto_online_001_pos': ['SKIP', ci_reason], 302 'fault/auto_replace_001_pos': ['SKIP', ci_reason], 303 'fault/auto_spare_ashift': ['SKIP', ci_reason], 304 'fault/auto_spare_shared': ['SKIP', ci_reason], 305 'procfs/pool_state': ['SKIP', ci_reason], 306 }) 307 308 maybe.update({ 309 'events/events_002_pos': ['FAIL', '11546'], 310 }) 311 312 313def usage(s): 314 print(s) 315 sys.exit(1) 316 317 318def process_results(pathname): 319 try: 320 f = open(pathname) 321 except IOError as e: 322 print('Error opening file: %s' % e) 323 sys.exit(1) 324 325 prefix = '/zfs-tests/tests/functional/' 326 pattern = \ 327 r'^Test(?:\s+\(\S+\))?:' + \ 328 r'\s*\S*%s(\S+)\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]' \ 329 % prefix 330 pattern_log = r'^\s*Log directory:\s*(\S*)' 331 332 d = {} 333 for line in f.readlines(): 334 m = re.match(pattern, line) 335 if m and len(m.groups()) == 4: 336 summary['total'] += 1 337 if m.group(4) == "PASS": 338 summary['passed'] += 1 339 d[m.group(1)] = m.group(4) 340 continue 341 342 m = re.match(pattern_log, line) 343 if m: 344 summary['logfile'] = m.group(1) 345 346 return d 347 348 349if __name__ == "__main__": 350 if len(sys.argv) != 2: 351 usage('usage: %s <pathname>' % sys.argv[0]) 352 results = process_results(sys.argv[1]) 353 354 if summary['total'] == 0: 355 print("\n\nNo test results were found.") 356 print("Log directory: %s" % summary['logfile']) 357 sys.exit(0) 358 359 expected = [] 360 unexpected = [] 361 362 for test in list(results.keys()): 363 if results[test] == "PASS": 364 continue 365 366 setup = test.replace(os.path.basename(test), "setup") 367 if results[test] == "SKIP" and test != setup: 368 if setup in known and known[setup][0] == "SKIP": 369 continue 370 if setup in maybe and maybe[setup][0] == "SKIP": 371 continue 372 373 if ((test not in known or results[test] not in known[test][0]) and 374 (test not in maybe or results[test] not in maybe[test][0])): 375 unexpected.append(test) 376 else: 377 expected.append(test) 378 379 print("\nTests with results other than PASS that are expected:") 380 for test in sorted(expected): 381 issue_url = 'https://github.com/openzfs/zfs/issues/' 382 383 # Include the reason why the result is expected, given the following: 384 # 1. Suppress test results which set the "Not applicable" reason. 385 # 2. Numerical reasons are assumed to be GitHub issue numbers. 386 # 3. When an entire test group is skipped only report the setup reason. 387 if test in known: 388 if known[test][1] == na_reason: 389 continue 390 elif known[test][1].isdigit(): 391 expect = issue_url + known[test][1] 392 else: 393 expect = known[test][1] 394 elif test in maybe: 395 if maybe[test][1].isdigit(): 396 expect = issue_url + maybe[test][1] 397 else: 398 expect = maybe[test][1] 399 elif setup in known and known[setup][0] == "SKIP" and setup != test: 400 continue 401 elif setup in maybe and maybe[setup][0] == "SKIP" and setup != test: 402 continue 403 else: 404 expect = "UNKNOWN REASON" 405 print(" %s %s (%s)" % (results[test], test, expect)) 406 407 print("\nTests with result of PASS that are unexpected:") 408 for test in sorted(known.keys()): 409 # We probably should not be silently ignoring the case 410 # where "test" is not in "results". 411 if test not in results or results[test] != "PASS": 412 continue 413 print(" %s %s (expected %s)" % (results[test], test, 414 known[test][0])) 415 416 print("\nTests with results other than PASS that are unexpected:") 417 for test in sorted(unexpected): 418 expect = "PASS" if test not in known else known[test][0] 419 print(" %s %s (expected %s)" % (results[test], test, expect)) 420 421 if len(unexpected) == 0: 422 sys.exit(0) 423 else: 424 sys.exit(1) 425