2 * Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include "../testutil.h"
17 #include <internal/nelem.h>
20 * Output a failed test first line.
21 * All items are optional are generally not preinted if passed as NULL.
22 * The special cases are for prefix where "ERROR" is assumed and for left
23 * and right where a non-failure message is produced if either is NULL.
25 void test_fail_message_prefix(const char *prefix, const char *file,
26 int line, const char *type,
27 const char *left, const char *right,
30 test_printf_stderr("%s: ", prefix != NULL ? prefix : "ERROR");
32 test_printf_stderr("(%s) ", type);
34 if (left != NULL && right != NULL)
35 test_printf_stderr("'%s %s %s' failed", left, op, right);
37 test_printf_stderr("'%s'", op);
40 test_printf_stderr(" @ %s:%d", file, line);
42 test_printf_stderr("\n");
46 * A common routine to output test failure messages. Generally this should not
47 * be called directly, rather it should be called by the following functions.
49 * |desc| is a printf formatted description with arguments |args| that is
50 * supplied by the user and |desc| can be NULL. |type| is the data type
51 * that was tested (int, char, ptr, ...). |fmt| is a system provided
52 * printf format with following arguments that spell out the failure
53 * details i.e. the actual values compared and the operator used.
55 * The typical use for this is from an utility test function:
57 * int test6(const char *file, int line, int n) {
59 * test_fail_message(1, file, line, "int", "value %d is not %d", n, 6);
65 * calling test6(3, "oops") will return 0 and produce out along the lines of:
66 * FAIL oops: (int) value 3 is not 6\n
68 static void test_fail_message(const char *prefix, const char *file, int line,
69 const char *type, const char *left,
70 const char *right, const char *op,
74 static void test_fail_message_va(const char *prefix, const char *file,
75 int line, const char *type,
76 const char *left, const char *right,
77 const char *op, const char *fmt, va_list ap)
79 test_fail_message_prefix(prefix, file, line, type, left, right, op);
81 test_vprintf_stderr(fmt, ap);
82 test_printf_stderr("\n");
87 static void test_fail_message(const char *prefix, const char *file,
88 int line, const char *type,
89 const char *left, const char *right,
90 const char *op, const char *fmt, ...)
95 test_fail_message_va(prefix, file, line, type, left, right, op, fmt, ap);
99 void test_info_c90(const char *desc, ...)
104 test_fail_message_va("INFO", NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
108 void test_info(const char *file, int line, const char *desc, ...)
113 test_fail_message_va("INFO", file, line, NULL, NULL, NULL, NULL, desc, ap);
117 void test_error_c90(const char *desc, ...)
122 test_fail_message_va(NULL, NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
124 test_printf_stderr("\n");
127 void test_error(const char *file, int line, const char *desc, ...)
132 test_fail_message_va(NULL, file, line, NULL, NULL, NULL, NULL, desc, ap);
134 test_printf_stderr("\n");
137 void test_perror(const char *s)
140 * Using openssl_strerror_r causes linking issues since it isn't
141 * exported from libcrypto.so
143 TEST_error("%s: %s", s, strerror(errno));
146 void test_note(const char *fmt, ...)
152 test_vprintf_stderr(fmt, ap);
154 test_printf_stderr("\n");
159 void test_openssl_errors(void)
161 ERR_print_errors_cb(openssl_error_cb, NULL);
166 * Define some comparisons between pairs of various types.
167 * These functions return 1 if the test is true.
168 * Otherwise, they return 0 and pretty-print diagnostics.
170 * In each case the functions produced are:
171 * int test_name_eq(const type t1, const type t2, const char *desc, ...);
172 * int test_name_ne(const type t1, const type t2, const char *desc, ...);
173 * int test_name_lt(const type t1, const type t2, const char *desc, ...);
174 * int test_name_le(const type t1, const type t2, const char *desc, ...);
175 * int test_name_gt(const type t1, const type t2, const char *desc, ...);
176 * int test_name_ge(const type t1, const type t2, const char *desc, ...);
178 * The t1 and t2 arguments are to be compared for equality, inequality,
179 * less than, less than or equal to, greater than and greater than or
180 * equal to respectively. If the specified condition holds, the functions
181 * return 1. If the condition does not hold, the functions print a diagnostic
182 * message and return 0.
184 * The desc argument is a printf format string followed by its arguments and
185 * this is included in the output if the condition being tested for is false.
187 #define DEFINE_COMPARISON(type, name, opname, op, fmt) \
188 int test_ ## name ## _ ## opname(const char *file, int line, \
189 const char *s1, const char *s2, \
190 const type t1, const type t2) \
194 test_fail_message(NULL, file, line, #type, s1, s2, #op, \
195 "[" fmt "] compared to [" fmt "]", \
200 #define DEFINE_COMPARISONS(type, name, fmt) \
201 DEFINE_COMPARISON(type, name, eq, ==, fmt) \
202 DEFINE_COMPARISON(type, name, ne, !=, fmt) \
203 DEFINE_COMPARISON(type, name, lt, <, fmt) \
204 DEFINE_COMPARISON(type, name, le, <=, fmt) \
205 DEFINE_COMPARISON(type, name, gt, >, fmt) \
206 DEFINE_COMPARISON(type, name, ge, >=, fmt)
208 DEFINE_COMPARISONS(int, int, "%d")
209 DEFINE_COMPARISONS(unsigned int, uint, "%u")
210 DEFINE_COMPARISONS(char, char, "%c")
211 DEFINE_COMPARISONS(unsigned char, uchar, "%u")
212 DEFINE_COMPARISONS(long, long, "%ld")
213 DEFINE_COMPARISONS(unsigned long, ulong, "%lu")
214 DEFINE_COMPARISONS(size_t, size_t, "%zu")
216 DEFINE_COMPARISON(void *, ptr, eq, ==, "%p")
217 DEFINE_COMPARISON(void *, ptr, ne, !=, "%p")
219 int test_ptr_null(const char *file, int line, const char *s, const void *p)
223 test_fail_message(NULL, file, line, "ptr", s, "NULL", "==", "%p", p);
227 int test_ptr(const char *file, int line, const char *s, const void *p)
231 test_fail_message(NULL, file, line, "ptr", s, "NULL", "!=", "%p", p);
235 int test_true(const char *file, int line, const char *s, int b)
239 test_fail_message(NULL, file, line, "bool", s, "true", "==", "false");
243 int test_false(const char *file, int line, const char *s, int b)
247 test_fail_message(NULL, file, line, "bool", s, "false", "==", "true");
251 int test_str_eq(const char *file, int line, const char *st1, const char *st2,
252 const char *s1, const char *s2)
254 if (s1 == NULL && s2 == NULL)
256 if (s1 == NULL || s2 == NULL || strcmp(s1, s2) != 0) {
257 test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
258 s1, s1 == NULL ? 0 : strlen(s1),
259 s2, s2 == NULL ? 0 : strlen(s2));
265 int test_str_ne(const char *file, int line, const char *st1, const char *st2,
266 const char *s1, const char *s2)
268 if ((s1 == NULL) ^ (s2 == NULL))
270 if (s1 == NULL || strcmp(s1, s2) == 0) {
271 test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
272 s1, s1 == NULL ? 0 : strlen(s1),
273 s2, s2 == NULL ? 0 : strlen(s2));
279 int test_strn_eq(const char *file, int line, const char *st1, const char *st2,
280 const char *s1, const char *s2, size_t len)
282 if (s1 == NULL && s2 == NULL)
284 if (s1 == NULL || s2 == NULL || strncmp(s1, s2, len) != 0) {
285 test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
286 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, len),
287 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, len));
293 int test_strn_ne(const char *file, int line, const char *st1, const char *st2,
294 const char *s1, const char *s2, size_t len)
296 if ((s1 == NULL) ^ (s2 == NULL))
298 if (s1 == NULL || strncmp(s1, s2, len) == 0) {
299 test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
300 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, len),
301 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, len));
307 int test_mem_eq(const char *file, int line, const char *st1, const char *st2,
308 const void *s1, size_t n1, const void *s2, size_t n2)
310 if (s1 == NULL && s2 == NULL)
312 if (n1 != n2 || s1 == NULL || s2 == NULL || memcmp(s1, s2, n1) != 0) {
313 test_fail_memory_message(NULL, file, line, "memory", st1, st2, "==",
320 int test_mem_ne(const char *file, int line, const char *st1, const char *st2,
321 const void *s1, size_t n1, const void *s2, size_t n2)
323 if ((s1 == NULL) ^ (s2 == NULL))
327 if (s1 == NULL || memcmp(s1, s2, n1) == 0) {
328 test_fail_memory_message(NULL, file, line, "memory", st1, st2, "!=",
335 #define DEFINE_BN_COMPARISONS(opname, op, zero_cond) \
336 int test_BN_ ## opname(const char *file, int line, \
337 const char *s1, const char *s2, \
338 const BIGNUM *t1, const BIGNUM *t2) \
340 if (BN_cmp(t1, t2) op 0) \
342 test_fail_bignum_message(NULL, file, line, "BIGNUM", s1, s2, \
346 int test_BN_ ## opname ## _zero(const char *file, int line, \
347 const char *s, const BIGNUM *a) \
349 if (a != NULL &&(zero_cond)) \
351 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", \
356 DEFINE_BN_COMPARISONS(eq, ==, BN_is_zero(a))
357 DEFINE_BN_COMPARISONS(ne, !=, !BN_is_zero(a))
358 DEFINE_BN_COMPARISONS(gt, >, !BN_is_negative(a) && !BN_is_zero(a))
359 DEFINE_BN_COMPARISONS(ge, >=, !BN_is_negative(a) || BN_is_zero(a))
360 DEFINE_BN_COMPARISONS(lt, <, BN_is_negative(a) && !BN_is_zero(a))
361 DEFINE_BN_COMPARISONS(le, <=, BN_is_negative(a) || BN_is_zero(a))
363 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a)
365 if (a != NULL && BN_is_one(a))
367 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", s, "1", "==", a);
371 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a)
373 if (a != NULL && BN_is_odd(a))
375 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "ODD(", ")", s, a);
379 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a)
381 if (a != NULL && !BN_is_odd(a))
383 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "EVEN(", ")", s,
388 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws,
389 const BIGNUM *a, BN_ULONG w)
393 if (a != NULL && BN_is_word(a, w))
397 test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "==", a, bw);
402 int test_BN_abs_eq_word(const char *file, int line, const char *bns,
403 const char *ws, const BIGNUM *a, BN_ULONG w)
407 if (a != NULL && BN_abs_is_word(a, w))
411 BN_set_negative(aa, 0);
413 test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "abs==",