xref: /freebsd/sys/contrib/openzfs/tests/test-runner/bin/zts-report.py.in (revision 2faf504d1ab821fe2b9df9d2afb49bb35e1334f4) 
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 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 NFS client and server utilities be installed.
86#
87share_reason = 'NFS client and server utilities required'
88
89#
90# Some tests require that the lsattr utility support the project id feature.
91#
92project_id_reason = 'lsattr with set/show project ID required'
93
94#
95# Some tests require that the kernel support user namespaces.
96#
97user_ns_reason = 'Kernel user namespace support required'
98
99#
100# Some rewind tests can fail since nothing guarantees that old MOS blocks
101# are not overwritten.  Snapshots protect datasets and data files but not
102# the MOS.  Reasonable efforts are made in the test case to increase the
103# odds that some txgs will have their MOS data left untouched, but it is
104# never a sure thing.
105#
106rewind_reason = 'Arbitrary pool rewind is not guaranteed'
107
108#
109# Some tests may by structured in a way that relies on exact knowledge
110# of how much free space in available in a pool.  These tests cannot be
111# made completely reliable because the internal details of how free space
112# is managed are not exposed to user space.
113#
114enospc_reason = 'Exact free space reporting is not guaranteed'
115
116#
117# Some tests require a minimum version of the fio benchmark utility.
118# Older distributions such as CentOS 6.x only provide fio-2.0.13.
119#
120fio_reason = 'Fio v2.3 or newer required'
121
122#
123# Some tests require that the DISKS provided support the discard operation.
124# Normally this is not an issue because loop back devices are used for DISKS
125# and they support discard (TRIM/UNMAP).
126#
127trim_reason = 'DISKS must support discard (TRIM/UNMAP)'
128
129#
130# Some tests are not applicable to a platform or need to be updated to operate
131# in the manor required by the platform.  Any tests which are skipped for this
132# reason will be suppressed in the final analysis output.
133#
134na_reason = "Not applicable"
135
136#
137# Some test cases doesn't have all requirements to run on Github actions CI.
138#
139ci_reason = 'CI runner doesn\'t have all requirements'
140
141summary = {
142    'total': float(0),
143    'passed': float(0),
144    'logfile': "Could not determine logfile location."
145}
146
147#
148# These tests are known to fail, thus we use this list to prevent these
149# failures from failing the job as a whole; only unexpected failures
150# bubble up to cause this script to exit with a non-zero exit status.
151#
152# Format: { 'test-name': ['expected result', 'issue-number | reason'] }
153#
154# For each known failure it is recommended to link to a GitHub issue by
155# setting the reason to the issue number.  Alternately, one of the generic
156# reasons listed above can be used.
157#
158known = {
159    'casenorm/mixed_none_lookup_ci': ['FAIL', '7633'],
160    'casenorm/mixed_formd_lookup_ci': ['FAIL', '7633'],
161    'cli_root/zfs_unshare/zfs_unshare_002_pos': ['SKIP', na_reason],
162    'cli_root/zfs_unshare/zfs_unshare_006_pos': ['SKIP', na_reason],
163    'cli_user/misc/zfs_share_001_neg': ['SKIP', na_reason],
164    'cli_user/misc/zfs_unshare_001_neg': ['SKIP', na_reason],
165    'privilege/setup': ['SKIP', na_reason],
166    'refreserv/refreserv_004_pos': ['FAIL', known_reason],
167    'rootpool/setup': ['SKIP', na_reason],
168    'rsend/rsend_008_pos': ['SKIP', '6066'],
169    'vdev_zaps/vdev_zaps_007_pos': ['FAIL', known_reason],
170}
171
172if sys.platform.startswith('freebsd'):
173    known.update({
174        'cli_root/zpool_wait/zpool_wait_trim_basic': ['SKIP', trim_reason],
175        'cli_root/zpool_wait/zpool_wait_trim_cancel': ['SKIP', trim_reason],
176        'cli_root/zpool_wait/zpool_wait_trim_flag': ['SKIP', trim_reason],
177        'link_count/link_count_001': ['SKIP', na_reason],
178    })
179elif sys.platform.startswith('linux'):
180    known.update({
181        'casenorm/mixed_formd_lookup': ['FAIL', '7633'],
182        'casenorm/mixed_formd_delete': ['FAIL', '7633'],
183        'casenorm/sensitive_formd_lookup': ['FAIL', '7633'],
184        'casenorm/sensitive_formd_delete': ['FAIL', '7633'],
185        'removal/removal_with_zdb': ['SKIP', known_reason],
186    })
187
188
189#
190# These tests may occasionally fail or be skipped.  We want there failures
191# to be reported but only unexpected failures should bubble up to cause
192# this script to exit with a non-zero exit status.
193#
194# Format: { 'test-name': ['expected result', 'issue-number | reason'] }
195#
196# For each known failure it is recommended to link to a GitHub issue by
197# setting the reason to the issue number.  Alternately, one of the generic
198# reasons listed above can be used.
199#
200maybe = {
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_destroy/zfs_destroy_dev_removal_condense':
205        ['FAIL', known_reason],
206    'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason],
207    'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', '5479'],
208    'cli_root/zfs_rollback/zfs_rollback_001_pos': ['FAIL', known_reason],
209    'cli_root/zfs_rollback/zfs_rollback_002_pos': ['FAIL', known_reason],
210    'cli_root/zfs_share/setup': ['SKIP', share_reason],
211    'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason],
212    'cli_root/zfs_unshare/setup': ['SKIP', share_reason],
213    'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason],
214    'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', '6145'],
215    'cli_root/zpool_import/import_rewind_device_replaced':
216        ['FAIL', rewind_reason],
217    'cli_root/zpool_import/import_rewind_config_changed':
218        ['FAIL', rewind_reason],
219    'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', '6839'],
220    'cli_root/zpool_initialize/zpool_initialize_import_export':
221        ['FAIL', '11948'],
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_upgrade/zpool_upgrade_004_pos': ['FAIL', '6141'],
226    'delegate/setup': ['SKIP', exec_reason],
227    'history/history_004_pos': ['FAIL', '7026'],
228    'history/history_005_neg': ['FAIL', '6680'],
229    'history/history_006_neg': ['FAIL', '5657'],
230    'history/history_008_pos': ['FAIL', known_reason],
231    'history/history_010_pos': ['SKIP', exec_reason],
232    'io/mmap': ['SKIP', fio_reason],
233    'largest_pool/largest_pool_001_pos': ['FAIL', known_reason],
234    'mmp/mmp_on_uberblocks': ['FAIL', known_reason],
235    'pyzfs/pyzfs_unittest': ['SKIP', python_deps_reason],
236    'no_space/enospc_002_pos': ['FAIL', enospc_reason],
237    'pool_checkpoint/checkpoint_discard_busy': ['FAIL', '11946'],
238    'projectquota/setup': ['SKIP', exec_reason],
239    'redundancy/redundancy_004_neg': ['FAIL', '7290'],
240    'redundancy/redundancy_draid_spare3': ['SKIP', known_reason],
241    'removal/removal_condense_export': ['FAIL', known_reason],
242    'reservation/reservation_008_pos': ['FAIL', '7741'],
243    'reservation/reservation_018_pos': ['FAIL', '5642'],
244    'rsend/rsend_019_pos': ['FAIL', '6086'],
245    'rsend/rsend_020_pos': ['FAIL', '6446'],
246    'rsend/rsend_021_pos': ['FAIL', '6446'],
247    'rsend/rsend_024_pos': ['FAIL', '5665'],
248    'rsend/send-c_volume': ['FAIL', '6087'],
249    'rsend/send_partial_dataset': ['FAIL', known_reason],
250    'snapshot/clone_001_pos': ['FAIL', known_reason],
251    'snapshot/snapshot_009_pos': ['FAIL', '7961'],
252    'snapshot/snapshot_010_pos': ['FAIL', '7961'],
253    'snapused/snapused_004_pos': ['FAIL', '5513'],
254    'tmpfile/setup': ['SKIP', tmpfile_reason],
255    'threadsappend/threadsappend_001_pos': ['FAIL', '6136'],
256    'trim/setup': ['SKIP', trim_reason],
257    'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason],
258    'user_namespace/setup': ['SKIP', user_ns_reason],
259    'userquota/setup': ['SKIP', exec_reason],
260    'vdev_zaps/vdev_zaps_004_pos': ['FAIL', '6935'],
261    'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', '5848'],
262    'pam/setup': ['SKIP', "pamtester might be not available"],
263}
264
265if sys.platform.startswith('freebsd'):
266    maybe.update({
267        'cli_root/zfs_copies/zfs_copies_002_pos': ['FAIL', known_reason],
268        'cli_root/zfs_inherit/zfs_inherit_001_neg': ['FAIL', known_reason],
269        'cli_root/zfs_receive/receive-o-x_props_override':
270            ['FAIL', known_reason],
271        'cli_root/zfs_share/zfs_share_011_pos': ['FAIL', known_reason],
272        'cli_root/zfs_share/zfs_share_concurrent_shares':
273            ['FAIL', known_reason],
274        'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason],
275        'cli_root/zpool_import/zpool_import_features_001_pos':
276            ['FAIL', '11854'],
277        'cli_root/zpool_import/zpool_import_features_002_neg':
278            ['FAIL', '11854'],
279        'cli_root/zpool_import/zpool_import_features_003_pos':
280            ['FAIL', '11854'],
281        'delegate/zfs_allow_003_pos': ['FAIL', known_reason],
282        'inheritance/inherit_001_pos': ['FAIL', '11829'],
283        'pool_checkpoint/checkpoint_zhack_feat': ['FAIL', '11854'],
284        'resilver/resilver_restart_001': ['FAIL', known_reason],
285        'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason],
286    })
287elif sys.platform.startswith('linux'):
288    maybe.update({
289        'alloc_class/alloc_class_009_pos': ['FAIL', known_reason],
290        'alloc_class/alloc_class_010_pos': ['FAIL', known_reason],
291        'alloc_class/alloc_class_011_neg': ['FAIL', known_reason],
292        'alloc_class/alloc_class_012_pos': ['FAIL', known_reason],
293        'alloc_class/alloc_class_013_pos': ['FAIL', '11888'],
294        'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason],
295        'cli_root/zpool_expand/zpool_expand_001_pos': ['FAIL', known_reason],
296        'cli_root/zpool_expand/zpool_expand_005_pos': ['FAIL', known_reason],
297        'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason],
298        'fault/auto_spare_shared': ['FAIL', '11889'],
299        'io/io_uring': ['SKIP', 'io_uring support required'],
300        'limits/filesystem_limit': ['SKIP', known_reason],
301        'limits/snapshot_limit': ['SKIP', known_reason],
302        'mmp/mmp_active_import': ['FAIL', known_reason],
303        'mmp/mmp_exported_import': ['FAIL', known_reason],
304        'mmp/mmp_inactive_import': ['FAIL', known_reason],
305        'refreserv/refreserv_raidz': ['FAIL', known_reason],
306        'rsend/rsend_007_pos': ['FAIL', known_reason],
307        'rsend/rsend_010_pos': ['FAIL', known_reason],
308        'rsend/rsend_011_pos': ['FAIL', known_reason],
309        'snapshot/rollback_003_pos': ['FAIL', known_reason],
310    })
311
312
313# Not all Github actions runners have scsi_debug module, so we may skip
314#   some tests which use it.
315if os.environ.get('CI') == 'true':
316    known.update({
317        'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason],
318        'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason],
319        'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason],
320        'cli_root/zpool_reopen/setup': ['SKIP', ci_reason],
321        'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason],
322        'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason],
323        'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason],
324        'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason],
325        'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason],
326        'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason],
327        'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason],
328        'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason],
329        'fault/auto_offline_001_pos': ['SKIP', ci_reason],
330        'fault/auto_online_001_pos': ['SKIP', ci_reason],
331        'fault/auto_online_002_pos': ['SKIP', ci_reason],
332        'fault/auto_replace_001_pos': ['SKIP', ci_reason],
333        'fault/auto_spare_ashift': ['SKIP', ci_reason],
334        'fault/auto_spare_shared': ['SKIP', ci_reason],
335        'procfs/pool_state': ['SKIP', ci_reason],
336    })
337
338    maybe.update({
339        'events/events_002_pos': ['FAIL', '11546'],
340    })
341
342
343def usage(s):
344    print(s)
345    sys.exit(1)
346
347
348def process_results(pathname):
349    try:
350        f = open(pathname)
351    except IOError as e:
352        print('Error opening file: %s' % e)
353        sys.exit(1)
354
355    prefix = '/zfs-tests/tests/functional/'
356    pattern = \
357        r'^Test(?:\s+\(\S+\))?:' + \
358        r'\s*\S*%s(\S+)\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]' \
359        % prefix
360    pattern_log = r'^\s*Log directory:\s*(\S*)'
361
362    d = {}
363    for line in f.readlines():
364        m = re.match(pattern, line)
365        if m and len(m.groups()) == 4:
366            summary['total'] += 1
367            if m.group(4) == "PASS":
368                summary['passed'] += 1
369            d[m.group(1)] = m.group(4)
370            continue
371
372        m = re.match(pattern_log, line)
373        if m:
374            summary['logfile'] = m.group(1)
375
376    return d
377
378
379if __name__ == "__main__":
380    if len(sys.argv) != 2:
381        usage('usage: %s <pathname>' % sys.argv[0])
382    results = process_results(sys.argv[1])
383
384    if summary['total'] == 0:
385        print("\n\nNo test results were found.")
386        print("Log directory:  %s" % summary['logfile'])
387        sys.exit(0)
388
389    expected = []
390    unexpected = []
391
392    for test in list(results.keys()):
393        if results[test] == "PASS":
394            continue
395
396        setup = test.replace(os.path.basename(test), "setup")
397        if results[test] == "SKIP" and test != setup:
398            if setup in known and known[setup][0] == "SKIP":
399                continue
400            if setup in maybe and maybe[setup][0] == "SKIP":
401                continue
402
403        if ((test not in known or results[test] not in known[test][0]) and
404                (test not in maybe or results[test] not in maybe[test][0])):
405            unexpected.append(test)
406        else:
407            expected.append(test)
408
409    print("\nTests with results other than PASS that are expected:")
410    for test in sorted(expected):
411        issue_url = 'https://github.com/openzfs/zfs/issues/'
412
413        # Include the reason why the result is expected, given the following:
414        # 1. Suppress test results which set the "Not applicable" reason.
415        # 2. Numerical reasons are assumed to be GitHub issue numbers.
416        # 3. When an entire test group is skipped only report the setup reason.
417        if test in known:
418            if known[test][1] == na_reason:
419                continue
420            elif known[test][1].isdigit():
421                expect = issue_url + known[test][1]
422            else:
423                expect = known[test][1]
424        elif test in maybe:
425            if maybe[test][1].isdigit():
426                expect = issue_url + maybe[test][1]
427            else:
428                expect = maybe[test][1]
429        elif setup in known and known[setup][0] == "SKIP" and setup != test:
430            continue
431        elif setup in maybe and maybe[setup][0] == "SKIP" and setup != test:
432            continue
433        else:
434            expect = "UNKNOWN REASON"
435        print("    %s %s (%s)" % (results[test], test, expect))
436
437    print("\nTests with result of PASS that are unexpected:")
438    for test in sorted(known.keys()):
439        # We probably should not be silently ignoring the case
440        # where "test" is not in "results".
441        if test not in results or results[test] != "PASS":
442            continue
443        print("    %s %s (expected %s)" % (results[test], test,
444                                           known[test][0]))
445
446    print("\nTests with results other than PASS that are unexpected:")
447    for test in sorted(unexpected):
448        expect = "PASS" if test not in known else known[test][0]
449        print("    %s %s (expected %s)" % (results[test], test, expect))
450
451    if len(unexpected) == 0:
452        sys.exit(0)
453    else:
454        sys.exit(1)
455