xref: /freebsd/sys/contrib/openzfs/tests/test-runner/bin/zts-report.py.in (revision 33b8c039a960bcff3471baf5929558c4d1500727) 
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_destroy/zfs_destroy_dev_removal_condense':
198        ['FAIL', known_reason],
199    'cli_root/zfs_get/zfs_get_004_pos': ['FAIL', known_reason],
200    'cli_root/zfs_get/zfs_get_009_pos': ['SKIP', '5479'],
201    'cli_root/zfs_rollback/zfs_rollback_001_pos': ['FAIL', known_reason],
202    'cli_root/zfs_rollback/zfs_rollback_002_pos': ['FAIL', known_reason],
203    'cli_root/zfs_share/setup': ['SKIP', share_reason],
204    'cli_root/zfs_snapshot/zfs_snapshot_002_neg': ['FAIL', known_reason],
205    'cli_root/zfs_unshare/setup': ['SKIP', share_reason],
206    'cli_root/zpool_add/zpool_add_004_pos': ['FAIL', known_reason],
207    'cli_root/zpool_destroy/zpool_destroy_001_pos': ['SKIP', '6145'],
208    'cli_root/zpool_import/import_rewind_device_replaced':
209        ['FAIL', rewind_reason],
210    'cli_root/zpool_import/import_rewind_config_changed':
211        ['FAIL', rewind_reason],
212    'cli_root/zpool_import/zpool_import_missing_003_pos': ['SKIP', '6839'],
213    'cli_root/zpool_initialize/zpool_initialize_import_export':
214        ['FAIL', '11948'],
215    'cli_root/zpool_labelclear/zpool_labelclear_removed':
216        ['FAIL', known_reason],
217    'cli_root/zpool_trim/setup': ['SKIP', trim_reason],
218    'cli_root/zpool_upgrade/zpool_upgrade_004_pos': ['FAIL', '6141'],
219    'delegate/setup': ['SKIP', exec_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    'l2arc/persist_l2arc_005_pos': ['FAIL', known_reason],
227    'l2arc/persist_l2arc_007_pos': ['FAIL', '11887'],
228    'largest_pool/largest_pool_001_pos': ['FAIL', known_reason],
229    'mmp/mmp_on_uberblocks': ['FAIL', known_reason],
230    'pyzfs/pyzfs_unittest': ['SKIP', python_deps_reason],
231    'no_space/enospc_002_pos': ['FAIL', enospc_reason],
232    'pool_checkpoint/checkpoint_discard_busy': ['FAIL', '11946'],
233    'projectquota/setup': ['SKIP', exec_reason],
234    'redundancy/redundancy_004_neg': ['FAIL', '7290'],
235    'redundancy/redundancy_draid_spare3': ['SKIP', known_reason],
236    'removal/removal_condense_export': ['FAIL', known_reason],
237    'reservation/reservation_008_pos': ['FAIL', '7741'],
238    'reservation/reservation_018_pos': ['FAIL', '5642'],
239    'rsend/rsend_019_pos': ['FAIL', '6086'],
240    'rsend/rsend_020_pos': ['FAIL', '6446'],
241    'rsend/rsend_021_pos': ['FAIL', '6446'],
242    'rsend/rsend_024_pos': ['FAIL', '5665'],
243    'rsend/send-c_volume': ['FAIL', '6087'],
244    'rsend/send_partial_dataset': ['FAIL', known_reason],
245    'snapshot/clone_001_pos': ['FAIL', known_reason],
246    'snapshot/snapshot_009_pos': ['FAIL', '7961'],
247    'snapshot/snapshot_010_pos': ['FAIL', '7961'],
248    'snapused/snapused_004_pos': ['FAIL', '5513'],
249    'tmpfile/setup': ['SKIP', tmpfile_reason],
250    'threadsappend/threadsappend_001_pos': ['FAIL', '6136'],
251    'trim/setup': ['SKIP', trim_reason],
252    'upgrade/upgrade_projectquota_001_pos': ['SKIP', project_id_reason],
253    'user_namespace/setup': ['SKIP', user_ns_reason],
254    'userquota/setup': ['SKIP', exec_reason],
255    'vdev_zaps/vdev_zaps_004_pos': ['FAIL', '6935'],
256    'zvol/zvol_ENOSPC/zvol_ENOSPC_001_pos': ['FAIL', '5848'],
257    'pam/setup': ['SKIP', "pamtester might be not available"],
258}
259
260if sys.platform.startswith('freebsd'):
261    maybe.update({
262        'cli_root/zfs_copies/zfs_copies_002_pos': ['FAIL', known_reason],
263        'cli_root/zfs_inherit/zfs_inherit_001_neg': ['FAIL', known_reason],
264        'cli_root/zfs_receive/receive-o-x_props_override':
265            ['FAIL', known_reason],
266        'cli_root/zfs_share/zfs_share_011_pos': ['FAIL', known_reason],
267        'cli_root/zfs_share/zfs_share_concurrent_shares':
268            ['FAIL', known_reason],
269        'cli_root/zpool_import/zpool_import_012_pos': ['FAIL', known_reason],
270        'cli_root/zpool_import/zpool_import_features_001_pos':
271            ['FAIL', '11854'],
272        'cli_root/zpool_import/zpool_import_features_002_neg':
273            ['FAIL', '11854'],
274        'cli_root/zpool_import/zpool_import_features_003_pos':
275            ['FAIL', '11854'],
276        'delegate/zfs_allow_003_pos': ['FAIL', known_reason],
277        'inheritance/inherit_001_pos': ['FAIL', '11829'],
278        'pool_checkpoint/checkpoint_zhack_feat': ['FAIL', '11854'],
279        'resilver/resilver_restart_001': ['FAIL', known_reason],
280        'zvol/zvol_misc/zvol_misc_volmode': ['FAIL', known_reason],
281    })
282elif sys.platform.startswith('linux'):
283    maybe.update({
284        'alloc_class/alloc_class_009_pos': ['FAIL', known_reason],
285        'alloc_class/alloc_class_010_pos': ['FAIL', known_reason],
286        'alloc_class/alloc_class_011_neg': ['FAIL', known_reason],
287        'alloc_class/alloc_class_012_pos': ['FAIL', known_reason],
288        'alloc_class/alloc_class_013_pos': ['FAIL', '11888'],
289        'cli_root/zfs_rename/zfs_rename_002_pos': ['FAIL', known_reason],
290        'cli_root/zpool_expand/zpool_expand_001_pos': ['FAIL', known_reason],
291        'cli_root/zpool_expand/zpool_expand_005_pos': ['FAIL', known_reason],
292        'cli_root/zpool_reopen/zpool_reopen_003_pos': ['FAIL', known_reason],
293        'fault/auto_spare_shared': ['FAIL', '11889'],
294        'io/io_uring': ['SKIP', 'io_uring support required'],
295        'limits/filesystem_limit': ['SKIP', known_reason],
296        'limits/snapshot_limit': ['SKIP', known_reason],
297        'mmp/mmp_active_import': ['FAIL', known_reason],
298        'mmp/mmp_exported_import': ['FAIL', known_reason],
299        'mmp/mmp_inactive_import': ['FAIL', known_reason],
300        'refreserv/refreserv_raidz': ['FAIL', known_reason],
301        'rsend/rsend_007_pos': ['FAIL', known_reason],
302        'rsend/rsend_010_pos': ['FAIL', known_reason],
303        'rsend/rsend_011_pos': ['FAIL', known_reason],
304        'snapshot/rollback_003_pos': ['FAIL', known_reason],
305    })
306
307
308# Not all Github actions runners have scsi_debug module, so we may skip
309#   some tests which use it.
310if os.environ.get('CI') == 'true':
311    known.update({
312        'cli_root/zpool_expand/zpool_expand_001_pos': ['SKIP', ci_reason],
313        'cli_root/zpool_expand/zpool_expand_003_neg': ['SKIP', ci_reason],
314        'cli_root/zpool_expand/zpool_expand_005_pos': ['SKIP', ci_reason],
315        'cli_root/zpool_reopen/setup': ['SKIP', ci_reason],
316        'cli_root/zpool_reopen/zpool_reopen_001_pos': ['SKIP', ci_reason],
317        'cli_root/zpool_reopen/zpool_reopen_002_pos': ['SKIP', ci_reason],
318        'cli_root/zpool_reopen/zpool_reopen_003_pos': ['SKIP', ci_reason],
319        'cli_root/zpool_reopen/zpool_reopen_004_pos': ['SKIP', ci_reason],
320        'cli_root/zpool_reopen/zpool_reopen_005_pos': ['SKIP', ci_reason],
321        'cli_root/zpool_reopen/zpool_reopen_006_neg': ['SKIP', ci_reason],
322        'cli_root/zpool_reopen/zpool_reopen_007_pos': ['SKIP', ci_reason],
323        'cli_root/zpool_split/zpool_split_wholedisk': ['SKIP', ci_reason],
324        'fault/auto_offline_001_pos': ['SKIP', ci_reason],
325        'fault/auto_online_001_pos': ['SKIP', ci_reason],
326        'fault/auto_replace_001_pos': ['SKIP', ci_reason],
327        'fault/auto_spare_ashift': ['SKIP', ci_reason],
328        'fault/auto_spare_shared': ['SKIP', ci_reason],
329        'procfs/pool_state': ['SKIP', ci_reason],
330    })
331
332    maybe.update({
333        'events/events_002_pos': ['FAIL', '11546'],
334    })
335
336
337def usage(s):
338    print(s)
339    sys.exit(1)
340
341
342def process_results(pathname):
343    try:
344        f = open(pathname)
345    except IOError as e:
346        print('Error opening file: %s' % e)
347        sys.exit(1)
348
349    prefix = '/zfs-tests/tests/functional/'
350    pattern = \
351        r'^Test(?:\s+\(\S+\))?:' + \
352        r'\s*\S*%s(\S+)\s*\(run as (\S+)\)\s*\[(\S+)\]\s*\[(\S+)\]' \
353        % prefix
354    pattern_log = r'^\s*Log directory:\s*(\S*)'
355
356    d = {}
357    for line in f.readlines():
358        m = re.match(pattern, line)
359        if m and len(m.groups()) == 4:
360            summary['total'] += 1
361            if m.group(4) == "PASS":
362                summary['passed'] += 1
363            d[m.group(1)] = m.group(4)
364            continue
365
366        m = re.match(pattern_log, line)
367        if m:
368            summary['logfile'] = m.group(1)
369
370    return d
371
372
373if __name__ == "__main__":
374    if len(sys.argv) != 2:
375        usage('usage: %s <pathname>' % sys.argv[0])
376    results = process_results(sys.argv[1])
377
378    if summary['total'] == 0:
379        print("\n\nNo test results were found.")
380        print("Log directory:  %s" % summary['logfile'])
381        sys.exit(0)
382
383    expected = []
384    unexpected = []
385
386    for test in list(results.keys()):
387        if results[test] == "PASS":
388            continue
389
390        setup = test.replace(os.path.basename(test), "setup")
391        if results[test] == "SKIP" and test != setup:
392            if setup in known and known[setup][0] == "SKIP":
393                continue
394            if setup in maybe and maybe[setup][0] == "SKIP":
395                continue
396
397        if ((test not in known or results[test] not in known[test][0]) and
398                (test not in maybe or results[test] not in maybe[test][0])):
399            unexpected.append(test)
400        else:
401            expected.append(test)
402
403    print("\nTests with results other than PASS that are expected:")
404    for test in sorted(expected):
405        issue_url = 'https://github.com/openzfs/zfs/issues/'
406
407        # Include the reason why the result is expected, given the following:
408        # 1. Suppress test results which set the "Not applicable" reason.
409        # 2. Numerical reasons are assumed to be GitHub issue numbers.
410        # 3. When an entire test group is skipped only report the setup reason.
411        if test in known:
412            if known[test][1] == na_reason:
413                continue
414            elif known[test][1].isdigit():
415                expect = issue_url + known[test][1]
416            else:
417                expect = known[test][1]
418        elif test in maybe:
419            if maybe[test][1].isdigit():
420                expect = issue_url + maybe[test][1]
421            else:
422                expect = maybe[test][1]
423        elif setup in known and known[setup][0] == "SKIP" and setup != test:
424            continue
425        elif setup in maybe and maybe[setup][0] == "SKIP" and setup != test:
426            continue
427        else:
428            expect = "UNKNOWN REASON"
429        print("    %s %s (%s)" % (results[test], test, expect))
430
431    print("\nTests with result of PASS that are unexpected:")
432    for test in sorted(known.keys()):
433        # We probably should not be silently ignoring the case
434        # where "test" is not in "results".
435        if test not in results or results[test] != "PASS":
436            continue
437        print("    %s %s (expected %s)" % (results[test], test,
438                                           known[test][0]))
439
440    print("\nTests with results other than PASS that are unexpected:")
441    for test in sorted(unexpected):
442        expect = "PASS" if test not in known else known[test][0]
443        print("    %s %s (expected %s)" % (results[test], test, expect))
444
445    if len(unexpected) == 0:
446        sys.exit(0)
447    else:
448        sys.exit(1)
449