xref: /kvm-unit-tests/lib/report.c (revision 5b9895f8a5d964a9b9efd9885b05493173012c76)
1 /*
2  * Test result reporting
3  *
4  * Copyright (c) Siemens AG, 2014
5  *
6  * Authors:
7  *  Jan Kiszka <jan.kiszka@siemens.com>
8  *  Andrew Jones <drjones@redhat.com>
9  *
10  * This work is licensed under the terms of the GNU LGPL, version 2.
11  */
12 
13 #include "libcflat.h"
14 #include "asm/spinlock.h"
15 
16 static unsigned int tests, failures, xfailures, kfailures, skipped;
17 static char prefixes[256];
18 static struct spinlock lock;
19 
20 #define PREFIX_DELIMITER ": "
21 
22 void report_passed(void)
23 {
24 	spin_lock(&lock);
25 	tests++;
26 	spin_unlock(&lock);
27 }
28 
29 void report_prefix_pushf(const char *prefix_fmt, ...)
30 {
31 	va_list va;
32 	unsigned int len;
33 	int start;
34 
35 	spin_lock(&lock);
36 
37 	len = strlen(prefixes);
38 	assert_msg(len < sizeof(prefixes), "%d >= %zu", len, sizeof(prefixes));
39 	start = len;
40 
41 	va_start(va, prefix_fmt);
42 	len += vsnprintf(&prefixes[len], sizeof(prefixes) - len, prefix_fmt,
43 			 va);
44 	va_end(va);
45 	assert_msg(len < sizeof(prefixes), "%d >= %zu", len, sizeof(prefixes));
46 
47 	assert_msg(!strstr(&prefixes[start], PREFIX_DELIMITER),
48 		   "Prefix \"%s\" contains delimiter \"" PREFIX_DELIMITER "\"",
49 		   &prefixes[start]);
50 
51 	len += snprintf(&prefixes[len], sizeof(prefixes) - len,
52 			PREFIX_DELIMITER);
53 	assert_msg(len < sizeof(prefixes), "%d >= %zu", len, sizeof(prefixes));
54 
55 	spin_unlock(&lock);
56 }
57 
58 void report_prefix_push(const char *prefix)
59 {
60 	report_prefix_pushf("%s", prefix);
61 }
62 
63 static void __report_prefix_pop(void)
64 {
65 	char *p, *q;
66 
67 	if (!*prefixes)
68 		return;
69 
70 	for (p = prefixes, q = strstr(p, PREFIX_DELIMITER) + 2;
71 			*q;
72 			p = q, q = strstr(p, PREFIX_DELIMITER) + 2)
73 		;
74 	*p = '\0';
75 }
76 
77 void report_prefix_pop(void)
78 {
79 	spin_lock(&lock);
80 	__report_prefix_pop();
81 	spin_unlock(&lock);
82 }
83 
84 void report_prefix_popn(int n)
85 {
86 	spin_lock(&lock);
87 	while (n--)
88 		__report_prefix_pop();
89 	spin_unlock(&lock);
90 }
91 
92 static void va_report(const char *msg_fmt,
93 		bool pass, bool xfail, bool kfail, bool skip, va_list va)
94 {
95 	const char *prefix = skip ? "SKIP"
96 				  : xfail ? (pass ? "XPASS" : "XFAIL")
97 				          : kfail ? (pass ? "PASS" : "KFAIL")
98 					          : (pass ? "PASS"  : "FAIL");
99 
100 	spin_lock(&lock);
101 
102 	tests++;
103 	printf("%s: ", prefix);
104 	puts(prefixes);
105 	vprintf(msg_fmt, va);
106 	puts("\n");
107 	if (skip)
108 		skipped++;
109 	else if (xfail && !pass)
110 		xfailures++;
111 	else if (kfail && !pass)
112 		kfailures++;
113 	else if (xfail || !pass)
114 		failures++;
115 
116 	spin_unlock(&lock);
117 }
118 
119 void report(bool pass, const char *msg_fmt, ...)
120 {
121 	va_list va;
122 	va_start(va, msg_fmt);
123 	va_report(msg_fmt, pass, false, false, false, va);
124 	va_end(va);
125 }
126 
127 void report_pass(const char *msg_fmt, ...)
128 {
129 	va_list va;
130 
131 	va_start(va, msg_fmt);
132 	va_report(msg_fmt, true, false, false, false, va);
133 	va_end(va);
134 }
135 
136 void report_fail(const char *msg_fmt, ...)
137 {
138 	va_list va;
139 
140 	va_start(va, msg_fmt);
141 	va_report(msg_fmt, false, false, false, false, va);
142 	va_end(va);
143 }
144 
145 void report_xfail(bool xfail, bool pass, const char *msg_fmt, ...)
146 {
147 	va_list va;
148 	va_start(va, msg_fmt);
149 	va_report(msg_fmt, pass, xfail, false, false, va);
150 	va_end(va);
151 }
152 
153 /*
154  * kfail is known failure. If kfail is true then test will succeed
155  * regardless of pass.
156  */
157 void report_kfail(bool kfail, bool pass, const char *msg_fmt, ...)
158 {
159 	va_list va;
160 	va_start(va, msg_fmt);
161 	va_report(msg_fmt, pass, false, kfail, false, va);
162 	va_end(va);
163 }
164 
165 void report_skip(const char *msg_fmt, ...)
166 {
167 	va_list va;
168 	va_start(va, msg_fmt);
169 	va_report(msg_fmt, false, false, false, true, va);
170 	va_end(va);
171 }
172 
173 void report_info(const char *msg_fmt, ...)
174 {
175 	va_list va;
176 
177 	spin_lock(&lock);
178 	puts("INFO: ");
179 	puts(prefixes);
180 	va_start(va, msg_fmt);
181 	vprintf(msg_fmt, va);
182 	va_end(va);
183 	puts("\n");
184 	spin_unlock(&lock);
185 }
186 
187 int report_summary(void)
188 {
189 	int ret;
190 	spin_lock(&lock);
191 
192 	printf("SUMMARY: %d tests", tests);
193 	if (failures)
194 		printf(", %d unexpected failures", failures);
195 	if (kfailures)
196 		printf(", %d known failures", kfailures);
197 	if (xfailures)
198 		printf(", %d expected failures", xfailures);
199 	if (skipped)
200 		printf(", %d skipped", skipped);
201 	printf("\n");
202 
203 	if (tests == skipped) {
204 		spin_unlock(&lock);
205 		/* Blame AUTOTOOLS for using 77 for skipped test and QEMU for
206 		 * mangling error codes in a way that gets 77 if we ... */
207 		return 77 >> 1;
208 	}
209 
210 	ret = failures > 0 ? 1 : 0;
211 	spin_unlock(&lock);
212 	return ret;
213 }
214 
215 void report_abort(const char *msg_fmt, ...)
216 {
217 	va_list va;
218 
219 	spin_lock(&lock);
220 	puts("ABORT: ");
221 	puts(prefixes);
222 	va_start(va, msg_fmt);
223 	vprintf(msg_fmt, va);
224 	va_end(va);
225 	puts("\n");
226 	spin_unlock(&lock);
227 	report_summary();
228 	abort();
229 }
230