xref: /linux/tools/testing/selftests/kselftest/ksft.py (revision e814f3fd16acfb7f9966773953de8f740a1e3202)
1# SPDX-License-Identifier: GPL-2.0
2#
3# Copyright (c) 2023 Collabora Ltd
4#
5# Kselftest helpers for outputting in KTAP format. Based on kselftest.h.
6#
7
8import sys
9
10ksft_cnt = {"pass": 0, "fail": 0, "skip": 0}
11ksft_num_tests = 0
12ksft_test_number = 1
13
14KSFT_PASS = 0
15KSFT_FAIL = 1
16KSFT_SKIP = 4
17
18
19def print_header():
20    print("TAP version 13")
21
22
23def set_plan(num_tests):
24    global ksft_num_tests
25    ksft_num_tests = num_tests
26    print("1..{}".format(num_tests))
27
28
29def print_cnts():
30    if ksft_cnt['skip'] > 0:
31        print(f"# {ksft_cnt['skip']} skipped test(s) detected. Consider enabling relevant config options to improve coverage.")
32
33    print(
34        f"# Totals: pass:{ksft_cnt['pass']} fail:{ksft_cnt['fail']} xfail:0 xpass:0 skip:{ksft_cnt['skip']} error:0"
35    )
36
37
38def print_msg(msg):
39    print(f"# {msg}")
40
41
42def _test_print(result, description, directive=None):
43    if directive:
44        directive_str = f"# {directive}"
45    else:
46        directive_str = ""
47
48    global ksft_test_number
49    print(f"{result} {ksft_test_number} {description} {directive_str}")
50    ksft_test_number += 1
51
52
53def test_result_pass(description):
54    _test_print("ok", description)
55    ksft_cnt["pass"] += 1
56
57
58def test_result_fail(description):
59    _test_print("not ok", description)
60    ksft_cnt["fail"] += 1
61
62
63def test_result_skip(description):
64    _test_print("ok", description, "SKIP")
65    ksft_cnt["skip"] += 1
66
67
68def test_result(condition, description=""):
69    if condition:
70        test_result_pass(description)
71    else:
72        test_result_fail(description)
73
74
75def finished():
76    if ksft_cnt["pass"] + ksft_cnt["skip"] == ksft_num_tests:
77        exit_code = KSFT_PASS
78    else:
79        exit_code = KSFT_FAIL
80
81    print_cnts()
82
83    sys.exit(exit_code)
84
85
86def exit_fail():
87    print_cnts()
88    sys.exit(KSFT_FAIL)
89
90
91def exit_pass():
92    print_cnts()
93    sys.exit(KSFT_PASS)
94