test_helper.h revision 323136
1/* $OpenBSD: test_helper.h,v 1.7 2017/03/14 01:10:07 dtucker Exp $ */ 2/* 3 * Copyright (c) 2011 Damien Miller <djm@mindrot.org> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18/* Utility functions/framework for regress tests */ 19 20#ifndef _TEST_HELPER_H 21#define _TEST_HELPER_H 22 23#include "includes.h" 24 25#include <sys/types.h> 26#ifdef HAVE_STDINT_H 27# include <stdint.h> 28#endif 29 30#include <openssl/bn.h> 31#include <openssl/err.h> 32 33enum test_predicate { 34 TEST_EQ, TEST_NE, TEST_LT, TEST_LE, TEST_GT, TEST_GE 35}; 36typedef void (test_onerror_func_t)(void *); 37 38/* Supplied by test suite */ 39void tests(void); 40 41const char *test_data_file(const char *name); 42void test_start(const char *n); 43void test_info(char *s, size_t len); 44void set_onerror_func(test_onerror_func_t *f, void *ctx); 45void test_done(void); 46void test_subtest_info(const char *fmt, ...) 47 __attribute__((format(printf, 1, 2))); 48void ssl_err_check(const char *file, int line); 49void assert_bignum(const char *file, int line, 50 const char *a1, const char *a2, 51 const BIGNUM *aa1, const BIGNUM *aa2, enum test_predicate pred); 52void assert_string(const char *file, int line, 53 const char *a1, const char *a2, 54 const char *aa1, const char *aa2, enum test_predicate pred); 55void assert_mem(const char *file, int line, 56 const char *a1, const char *a2, 57 const void *aa1, const void *aa2, size_t l, enum test_predicate pred); 58void assert_mem_filled(const char *file, int line, 59 const char *a1, 60 const void *aa1, u_char v, size_t l, enum test_predicate pred); 61void assert_int(const char *file, int line, 62 const char *a1, const char *a2, 63 int aa1, int aa2, enum test_predicate pred); 64void assert_size_t(const char *file, int line, 65 const char *a1, const char *a2, 66 size_t aa1, size_t aa2, enum test_predicate pred); 67void assert_u_int(const char *file, int line, 68 const char *a1, const char *a2, 69 u_int aa1, u_int aa2, enum test_predicate pred); 70void assert_long(const char *file, int line, 71 const char *a1, const char *a2, 72 long aa1, long aa2, enum test_predicate pred); 73void assert_long_long(const char *file, int line, 74 const char *a1, const char *a2, 75 long long aa1, long long aa2, enum test_predicate pred); 76void assert_char(const char *file, int line, 77 const char *a1, const char *a2, 78 char aa1, char aa2, enum test_predicate pred); 79void assert_ptr(const char *file, int line, 80 const char *a1, const char *a2, 81 const void *aa1, const void *aa2, enum test_predicate pred); 82void assert_u8(const char *file, int line, 83 const char *a1, const char *a2, 84 u_int8_t aa1, u_int8_t aa2, enum test_predicate pred); 85void assert_u16(const char *file, int line, 86 const char *a1, const char *a2, 87 u_int16_t aa1, u_int16_t aa2, enum test_predicate pred); 88void assert_u32(const char *file, int line, 89 const char *a1, const char *a2, 90 u_int32_t aa1, u_int32_t aa2, enum test_predicate pred); 91void assert_u64(const char *file, int line, 92 const char *a1, const char *a2, 93 u_int64_t aa1, u_int64_t aa2, enum test_predicate pred); 94 95#define TEST_START(n) test_start(n) 96#define TEST_DONE() test_done() 97#define TEST_ONERROR(f, c) set_onerror_func(f, c) 98#define SSL_ERR_CHECK() ssl_err_check(__FILE__, __LINE__) 99 100#define ASSERT_BIGNUM_EQ(a1, a2) \ 101 assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 102#define ASSERT_STRING_EQ(a1, a2) \ 103 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 104#define ASSERT_MEM_EQ(a1, a2, l) \ 105 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_EQ) 106#define ASSERT_MEM_FILLED_EQ(a1, c, l) \ 107 assert_mem_filled(__FILE__, __LINE__, #a1, a1, c, l, TEST_EQ) 108#define ASSERT_MEM_ZERO_EQ(a1, l) \ 109 assert_mem_filled(__FILE__, __LINE__, #a1, a1, '\0', l, TEST_EQ) 110#define ASSERT_INT_EQ(a1, a2) \ 111 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 112#define ASSERT_SIZE_T_EQ(a1, a2) \ 113 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 114#define ASSERT_U_INT_EQ(a1, a2) \ 115 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 116#define ASSERT_LONG_EQ(a1, a2) \ 117 assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 118#define ASSERT_LONG_LONG_EQ(a1, a2) \ 119 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 120#define ASSERT_CHAR_EQ(a1, a2) \ 121 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 122#define ASSERT_PTR_EQ(a1, a2) \ 123 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 124#define ASSERT_U8_EQ(a1, a2) \ 125 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 126#define ASSERT_U16_EQ(a1, a2) \ 127 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 128#define ASSERT_U32_EQ(a1, a2) \ 129 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 130#define ASSERT_U64_EQ(a1, a2) \ 131 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 132 133#define ASSERT_BIGNUM_NE(a1, a2) \ 134 assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 135#define ASSERT_STRING_NE(a1, a2) \ 136 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 137#define ASSERT_MEM_NE(a1, a2, l) \ 138 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_NE) 139#define ASSERT_MEM_ZERO_NE(a1, l) \ 140 assert_mem_filled(__FILE__, __LINE__, #a1, a1, '\0', l, TEST_NE) 141#define ASSERT_INT_NE(a1, a2) \ 142 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 143#define ASSERT_SIZE_T_NE(a1, a2) \ 144 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 145#define ASSERT_U_INT_NE(a1, a2) \ 146 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 147#define ASSERT_LONG_NE(a1, a2) \ 148 assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 149#define ASSERT_LONG_LONG_NE(a1, a2) \ 150 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 151#define ASSERT_CHAR_NE(a1, a2) \ 152 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 153#define ASSERT_PTR_NE(a1, a2) \ 154 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 155#define ASSERT_U8_NE(a1, a2) \ 156 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 157#define ASSERT_U16_NE(a1, a2) \ 158 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 159#define ASSERT_U32_NE(a1, a2) \ 160 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 161#define ASSERT_U64_NE(a1, a2) \ 162 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 163 164#define ASSERT_BIGNUM_LT(a1, a2) \ 165 assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 166#define ASSERT_STRING_LT(a1, a2) \ 167 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 168#define ASSERT_MEM_LT(a1, a2, l) \ 169 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_LT) 170#define ASSERT_INT_LT(a1, a2) \ 171 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 172#define ASSERT_SIZE_T_LT(a1, a2) \ 173 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 174#define ASSERT_U_INT_LT(a1, a2) \ 175 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 176#define ASSERT_LONG_LT(a1, a2) \ 177 assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 178#define ASSERT_LONG_LONG_LT(a1, a2) \ 179 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 180#define ASSERT_CHAR_LT(a1, a2) \ 181 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 182#define ASSERT_PTR_LT(a1, a2) \ 183 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 184#define ASSERT_U8_LT(a1, a2) \ 185 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 186#define ASSERT_U16_LT(a1, a2) \ 187 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 188#define ASSERT_U32_LT(a1, a2) \ 189 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 190#define ASSERT_U64_LT(a1, a2) \ 191 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 192 193#define ASSERT_BIGNUM_LE(a1, a2) \ 194 assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 195#define ASSERT_STRING_LE(a1, a2) \ 196 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 197#define ASSERT_MEM_LE(a1, a2, l) \ 198 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_LE) 199#define ASSERT_INT_LE(a1, a2) \ 200 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 201#define ASSERT_SIZE_T_LE(a1, a2) \ 202 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 203#define ASSERT_U_INT_LE(a1, a2) \ 204 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 205#define ASSERT_LONG_LE(a1, a2) \ 206 assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 207#define ASSERT_LONG_LONG_LE(a1, a2) \ 208 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 209#define ASSERT_CHAR_LE(a1, a2) \ 210 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 211#define ASSERT_PTR_LE(a1, a2) \ 212 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 213#define ASSERT_U8_LE(a1, a2) \ 214 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 215#define ASSERT_U16_LE(a1, a2) \ 216 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 217#define ASSERT_U32_LE(a1, a2) \ 218 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 219#define ASSERT_U64_LE(a1, a2) \ 220 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 221 222#define ASSERT_BIGNUM_GT(a1, a2) \ 223 assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 224#define ASSERT_STRING_GT(a1, a2) \ 225 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 226#define ASSERT_MEM_GT(a1, a2, l) \ 227 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_GT) 228#define ASSERT_INT_GT(a1, a2) \ 229 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 230#define ASSERT_SIZE_T_GT(a1, a2) \ 231 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 232#define ASSERT_U_INT_GT(a1, a2) \ 233 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 234#define ASSERT_LONG_GT(a1, a2) \ 235 assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 236#define ASSERT_LONG_LONG_GT(a1, a2) \ 237 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 238#define ASSERT_CHAR_GT(a1, a2) \ 239 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 240#define ASSERT_PTR_GT(a1, a2) \ 241 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 242#define ASSERT_U8_GT(a1, a2) \ 243 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 244#define ASSERT_U16_GT(a1, a2) \ 245 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 246#define ASSERT_U32_GT(a1, a2) \ 247 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 248#define ASSERT_U64_GT(a1, a2) \ 249 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 250 251#define ASSERT_BIGNUM_GE(a1, a2) \ 252 assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 253#define ASSERT_STRING_GE(a1, a2) \ 254 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 255#define ASSERT_MEM_GE(a1, a2, l) \ 256 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_GE) 257#define ASSERT_INT_GE(a1, a2) \ 258 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 259#define ASSERT_SIZE_T_GE(a1, a2) \ 260 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 261#define ASSERT_U_INT_GE(a1, a2) \ 262 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 263#define ASSERT_LONG_GE(a1, a2) \ 264 assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 265#define ASSERT_LONG_LONG_GE(a1, a2) \ 266 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 267#define ASSERT_CHAR_GE(a1, a2) \ 268 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 269#define ASSERT_PTR_GE(a1, a2) \ 270 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 271#define ASSERT_U8_GE(a1, a2) \ 272 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 273#define ASSERT_U16_GE(a1, a2) \ 274 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 275#define ASSERT_U32_GE(a1, a2) \ 276 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 277#define ASSERT_U64_GE(a1, a2) \ 278 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 279 280/* Fuzzing support */ 281 282struct fuzz; 283#define FUZZ_1_BIT_FLIP 0x00000001 /* Flip one bit at a time */ 284#define FUZZ_2_BIT_FLIP 0x00000002 /* Flip two bits at a time */ 285#define FUZZ_1_BYTE_FLIP 0x00000004 /* Flip one byte at a time */ 286#define FUZZ_2_BYTE_FLIP 0x00000008 /* Flip two bytes at a time */ 287#define FUZZ_TRUNCATE_START 0x00000010 /* Truncate from beginning */ 288#define FUZZ_TRUNCATE_END 0x00000020 /* Truncate from end */ 289#define FUZZ_BASE64 0x00000040 /* Try all base64 chars */ 290#define FUZZ_MAX FUZZ_BASE64 291 292/* Start fuzzing a blob of data with selected strategies (bitmask) */ 293struct fuzz *fuzz_begin(u_int strategies, const void *p, size_t l); 294 295/* Free a fuzz context */ 296void fuzz_cleanup(struct fuzz *fuzz); 297 298/* Prepare the next fuzz case in the series */ 299void fuzz_next(struct fuzz *fuzz); 300 301/* 302 * Check whether this fuzz case is identical to the original 303 * This is slow, but useful if the caller needs to ensure that all tests 304 * generated change the input (e.g. when fuzzing signatures). 305 */ 306int fuzz_matches_original(struct fuzz *fuzz); 307 308/* Determine whether the current fuzz sequence is exhausted (nonzero = yes) */ 309int fuzz_done(struct fuzz *fuzz); 310 311/* Return the length and a pointer to the current fuzzed case */ 312size_t fuzz_len(struct fuzz *fuzz); 313u_char *fuzz_ptr(struct fuzz *fuzz); 314 315/* Dump the current fuzz case to stderr */ 316void fuzz_dump(struct fuzz *fuzz); 317 318#endif /* _TEST_HELPER_H */ 319