testutil: Add OpenSSL error stack printing wrapper TEST_openssl_errors
[openssl.git] / test / testutil / tests.c
1 /*
2  * Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include "../testutil.h"
11 #include "output.h"
12 #include "tu_local.h"
13
14 #include <string.h>
15 #include "../../e_os.h"
16
17 /* The size of memory buffers to display on failure */
18 #define MEM_BUFFER_SIZE     (21)
19
20 /*
21  * A common routine to output test failure messages.  Generally this should not
22  * be called directly, rather it should be called by the following functions.
23  *
24  * |desc| is a printf formatted description with arguments |args| that is
25  * supplied by the user and |desc| can be NULL.  |type| is the data type
26  * that was tested (int, char, ptr, ...).  |fmt| is a system provided
27  * printf format with following arguments that spell out the failure
28  * details i.e. the actual values compared and the operator used.
29  *
30  * The typical use for this is from an utility test function:
31  *
32  * int test6(const char *file, int line, int n) {
33  *     if (n != 6) {
34  *         test_fail_message(1, file, line, "int", "value %d is not %d", n, 6);
35  *         return 0;
36  *     }
37  *     return 1;
38  * }
39  *
40  * calling test6(3, "oops") will return 0 and produce out along the lines of:
41  *      FAIL oops: (int) value 3 is not 6\n
42  *
43  * It general, test_fail_message should not be called directly.
44  */
45 static void test_fail_message(const char *prefix, const char *file, int line,
46                               const char *type, const char *fmt, ...)
47             PRINTF_FORMAT(5, 6);
48
49 static void test_fail_message_va(const char *prefix, const char *file, int line,
50                                  const char *type, const char *fmt, va_list ap)
51 {
52     test_printf_stderr("%*s# ", subtest_level(), "");
53     test_puts_stderr(prefix != NULL ? prefix : "ERROR");
54     test_puts_stderr(":");
55     if (type)
56         test_printf_stderr(" (%s)", type);
57     if (fmt != NULL) {
58         test_puts_stderr(" ");
59         test_vprintf_stderr(fmt, ap);
60     }
61     if (file != NULL) {
62         test_printf_stderr(" @ %s:%d", file, line);
63     }
64     test_puts_stderr("\n");
65     test_flush_stderr();
66 }
67
68 static void test_fail_message(const char *prefix, const char *file, int line,
69                               const char *type, const char *fmt, ...)
70 {
71     va_list ap;
72
73     va_start(ap, fmt);
74     test_fail_message_va(prefix, file, line, type, fmt, ap);
75     va_end(ap);
76 }
77
78 void test_info_c90(const char *desc, ...)
79 {
80     va_list ap;
81
82     va_start(ap, desc);
83     test_fail_message_va("INFO", NULL, -1, NULL, desc, ap);
84     va_end(ap);
85 }
86
87 void test_info(const char *file, int line, const char *desc, ...)
88 {
89     va_list ap;
90
91     va_start(ap, desc);
92     test_fail_message_va("INFO", file, line, NULL, desc, ap);
93     va_end(ap);
94 }
95
96 void test_error_c90(const char *desc, ...)
97 {
98     va_list ap;
99
100     va_start(ap, desc);
101     test_fail_message(NULL, NULL, -1, NULL, desc, ap);
102     va_end(ap);
103 }
104
105 void test_error(const char *file, int line, const char *desc, ...)
106 {
107     va_list ap;
108
109     va_start(ap, desc);
110     test_fail_message_va(NULL, file, line, NULL, desc, ap);
111     va_end(ap);
112 }
113
114 void test_openssl_errors(void)
115 {
116     ERR_print_errors_cb(openssl_error_cb, NULL);
117 }
118
119 /*
120  * Define some comparisons between pairs of various types.
121  * These functions return 1 if the test is true.
122  * Otherwise, they return 0 and pretty-print diagnostics.
123  *
124  * In each case the functions produced are:
125  *  int test_name_eq(const type t1, const type t2, const char *desc, ...);
126  *  int test_name_ne(const type t1, const type t2, const char *desc, ...);
127  *  int test_name_lt(const type t1, const type t2, const char *desc, ...);
128  *  int test_name_le(const type t1, const type t2, const char *desc, ...);
129  *  int test_name_gt(const type t1, const type t2, const char *desc, ...);
130  *  int test_name_ge(const type t1, const type t2, const char *desc, ...);
131  *
132  * The t1 and t2 arguments are to be compared for equality, inequality,
133  * less than, less than or equal to, greater than and greater than or
134  * equal to respectively.  If the specified condition holds, the functions
135  * return 1.  If the condition does not hold, the functions print a diagnostic
136  * message and return 0.
137  *
138  * The desc argument is a printf format string followed by its arguments and
139  * this is included in the output if the condition being tested for is false.
140  */
141 #define DEFINE_COMPARISON(type, name, opname, op, fmt)                  \
142     int test_ ## name ## _ ## opname(const char *file, int line,        \
143                                      const char *s1, const char *s2,    \
144                                      const type t1, const type t2)      \
145     {                                                                   \
146         if (t1 op t2)                                                   \
147             return 1;                                                   \
148         test_fail_message(NULL, file, line, #type,                      \
149                           "%s [" fmt "] " #op " %s [" fmt "]",          \
150                           s1, t1, s2, t2);                              \
151         return 0;                                                       \
152     }
153
154 #define DEFINE_COMPARISONS(type, name, fmt)                             \
155     DEFINE_COMPARISON(type, name, eq, ==, fmt)                          \
156     DEFINE_COMPARISON(type, name, ne, !=, fmt)                          \
157     DEFINE_COMPARISON(type, name, lt, <, fmt)                           \
158     DEFINE_COMPARISON(type, name, le, <=, fmt)                          \
159     DEFINE_COMPARISON(type, name, gt, >, fmt)                           \
160     DEFINE_COMPARISON(type, name, ge, >=, fmt)
161
162 DEFINE_COMPARISONS(int, int, "%d")
163 DEFINE_COMPARISONS(unsigned int, uint, "%u")
164 DEFINE_COMPARISONS(char, char, "%c")
165 DEFINE_COMPARISONS(unsigned char, uchar, "%u")
166 DEFINE_COMPARISONS(long, long, "%ld")
167 DEFINE_COMPARISONS(unsigned long, ulong, "%lu")
168 DEFINE_COMPARISONS(size_t, size_t, "%zu")
169
170 DEFINE_COMPARISON(void *, ptr, eq, ==, "%p")
171 DEFINE_COMPARISON(void *, ptr, ne, !=, "%p")
172
173 int test_ptr_null(const char *file, int line, const char *s, const void *p)
174 {
175     if (p == NULL)
176         return 1;
177     test_fail_message(NULL, file, line, "ptr", "%s [%p] == NULL", s, p);
178     return 0;
179 }
180
181 int test_ptr(const char *file, int line, const char *s, const void *p)
182 {
183     if (p != NULL)
184         return 1;
185     test_fail_message(NULL, file, line, "ptr", "%s [%p] != NULL", s, p);
186     return 0;
187 }
188
189 int test_true(const char *file, int line, const char *s, int b)
190 {
191     if (b)
192         return 1;
193     test_fail_message(NULL, file, line, "bool", "%s [false] == true", s);
194     return 0;
195 }
196
197 int test_false(const char *file, int line, const char *s, int b)
198 {
199     if (!b)
200         return 1;
201     test_fail_message(NULL, file, line, "bool", "%s [true] == false", s);
202     return 0;
203 }
204
205 static const char *print_string_maybe_null(const char *s)
206 {
207     return s == NULL ? "(NULL)" : s;
208 }
209
210 int test_str_eq(const char *file, int line, const char *st1, const char *st2,
211                 const char *s1, const char *s2)
212 {
213     if (s1 == NULL && s2 == NULL)
214       return 1;
215     if (s1 == NULL || s2 == NULL || strcmp(s1, s2) != 0) {
216         test_fail_message(NULL, file, line, "string", "%s [%s] == %s [%s]",
217                           st1, print_string_maybe_null(s1),
218                           st2, print_string_maybe_null(s2));
219         return 0;
220     }
221     return 1;
222 }
223
224 int test_str_ne(const char *file, int line, const char *st1, const char *st2,
225                 const char *s1, const char *s2)
226 {
227     if ((s1 == NULL) ^ (s2 == NULL))
228       return 1;
229     if (s1 == NULL || strcmp(s1, s2) == 0) {
230         test_fail_message(NULL, file, line, "string", "%s [%s] != %s [%s]",
231                           st1, print_string_maybe_null(s1),
232                           st2, print_string_maybe_null(s2));
233         return 0;
234     }
235     return 1;
236 }
237
238 int test_strn_eq(const char *file, int line, const char *st1, const char *st2,
239                  const char *s1, const char *s2, size_t len)
240 {
241     int prec = (int)len;
242
243     if (s1 == NULL && s2 == NULL)
244       return 1;
245     if (s1 == NULL || s2 == NULL || strncmp(s1, s2, len) != 0) {
246         test_fail_message(NULL, file, line, "string", "%.s [%.*s] == %s [%.*s]",
247                           st1, prec, print_string_maybe_null(s1),
248                           st2, prec, print_string_maybe_null(s2));
249         return 0;
250     }
251     return 1;
252 }
253
254 int test_strn_ne(const char *file, int line, const char *st1, const char *st2,
255                  const char *s1, const char *s2, size_t len)
256 {
257     int prec = (int)len;
258
259     if ((s1 == NULL) ^ (s2 == NULL))
260       return 1;
261     if (s1 == NULL || strncmp(s1, s2, len) == 0) {
262         test_fail_message(NULL, file, line, "string", "%s [%.*s] != %s [%.*s]",
263                           st1, prec, print_string_maybe_null(s1),
264                           st2, prec, print_string_maybe_null(s2));
265         return 0;
266     }
267     return 1;
268 }
269
270 /*
271  * We could use OPENSSL_buf2hexstr() to do this but trying to allocate memory
272  * in a failure state isn't generally a great idea.
273  */
274 static const char *print_mem_maybe_null(const void *s, size_t n,
275                                         char out[MEM_BUFFER_SIZE])
276 {
277     size_t i;
278     const unsigned char *p = (const unsigned char *)s;
279     int pad = 2*n >= MEM_BUFFER_SIZE;
280
281     if (s == NULL)
282         return "(NULL)";
283     if (pad)
284         n = MEM_BUFFER_SIZE-4;
285     
286     for (i=0; i<2*n; i++) {
287         unsigned char c = (i & 1) != 0 ? p[i / 2] & 15 : p[i / 2] >> 4;
288         out[i] = "0123456789abcdef"[c];
289     }
290     if (pad) {
291         out[i++] = '.';
292         out[i++] = '.';
293         out[i++] = '.';
294     }
295     out[i] = '\0';
296         
297     return out;
298 }
299
300 int test_mem_eq(const char *file, int line, const char *st1, const char *st2,
301                 const void *s1, size_t n1, const void *s2, size_t n2)
302 {
303     char b1[MEM_BUFFER_SIZE], b2[MEM_BUFFER_SIZE];
304
305     if (s1 == NULL && s2 == NULL)
306         return 1;
307     if (n1 != n2) {
308         test_fail_message(NULL, file, line, "memory",
309                           "size mismatch %s %s [%zu] != %s %s [%zu]",
310                           st1, print_mem_maybe_null(s1, n1, b1), n1,
311                           st2, print_mem_maybe_null(s2, n2, b2), n2);
312         return 0;
313     }
314     if (s1 == NULL || s2 == NULL || memcmp(s1, s2, n1) != 0) {
315         test_fail_message(NULL, file, line, "memory",
316                           "%s %s [%zu] != %s %s [%zu]",
317                           st1, print_mem_maybe_null(s1, n1, b1), n1,
318                           st2, print_mem_maybe_null(s2, n2, b2), n2);
319         return 0;
320     }
321     return 1;
322 }
323
324 int test_mem_ne(const char *file, int line, const char *st1, const char *st2,
325                 const void *s1, size_t n1, const void *s2, size_t n2)
326 {
327     char b1[MEM_BUFFER_SIZE], b2[MEM_BUFFER_SIZE];
328
329     if ((s1 == NULL) ^ (s2 == NULL))
330       return 1;
331     if (n1 != n2)
332         return 1;
333     if (s1 == NULL || memcmp(s1, s2, n1) == 0) {
334         test_fail_message(NULL, file, line, "memory",
335                           "%s %s [%zu] != %s %s [%zu]",
336                           st1, print_mem_maybe_null(s1, n1, b1), n1,
337                           st2, print_mem_maybe_null(s2, n2, b2), n2);
338         return 0;
339     }
340     return 1;
341 }