1 /*
2  * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
3  * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 #ifndef REGRESS_H_INCLUDED_
28 #define REGRESS_H_INCLUDED_
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #include "tinytest.h"
35 #include "tinytest_macros.h"
36 
37 extern struct testcase_t main_testcases[];
38 extern struct testcase_t evtag_testcases[];
39 extern struct testcase_t evbuffer_testcases[];
40 extern struct testcase_t finalize_testcases[];
41 extern struct testcase_t bufferevent_testcases[];
42 extern struct testcase_t bufferevent_iocp_testcases[];
43 extern struct testcase_t util_testcases[];
44 extern struct testcase_t signal_testcases[];
45 extern struct testcase_t http_testcases[];
46 extern struct testcase_t http_iocp_testcases[];
47 extern struct testcase_t dns_testcases[];
48 extern struct testcase_t rpc_testcases[];
49 extern struct testcase_t edgetriggered_testcases[];
50 extern struct testcase_t minheap_testcases[];
51 extern struct testcase_t iocp_testcases[];
52 extern struct testcase_t ssl_testcases[];
53 extern struct testcase_t listener_testcases[];
54 extern struct testcase_t listener_iocp_testcases[];
55 extern struct testcase_t thread_testcases[];
56 
57 extern struct evutil_weakrand_state test_weakrand_state;
58 
59 #define test_weakrand() (evutil_weakrand_(&test_weakrand_state))
60 
61 void regress_threads(void *);
62 void test_bufferevent_zlib(void *);
63 
64 /* Helpers to wrap old testcases */
65 extern evutil_socket_t pair[2];
66 extern int test_ok;
67 extern int called;
68 extern struct event_base *global_base;
69 extern int in_legacy_test_wrapper;
70 
71 int regress_make_tmpfile(const void *data, size_t datalen, char **filename_out);
72 
73 struct basic_test_data {
74 	struct event_base *base;
75 	evutil_socket_t pair[2];
76 
77 	void (*legacy_test_fn)(void);
78 
79 	void *setup_data;
80 };
81 extern const struct testcase_setup_t basic_setup;
82 
83 
84 extern const struct testcase_setup_t legacy_setup;
85 void run_legacy_test_fn(void *ptr);
86 
87 extern int libevent_tests_running_in_debug_mode;
88 
89 /* A couple of flags that basic/legacy_setup can support. */
90 #define TT_NEED_SOCKETPAIR	TT_FIRST_USER_FLAG
91 #define TT_NEED_BASE		(TT_FIRST_USER_FLAG<<1)
92 #define TT_NEED_DNS		(TT_FIRST_USER_FLAG<<2)
93 #define TT_LEGACY		(TT_FIRST_USER_FLAG<<3)
94 #define TT_NEED_THREADS		(TT_FIRST_USER_FLAG<<4)
95 #define TT_NO_LOGS		(TT_FIRST_USER_FLAG<<5)
96 #define TT_ENABLE_IOCP_FLAG	(TT_FIRST_USER_FLAG<<6)
97 #define TT_ENABLE_IOCP		(TT_ENABLE_IOCP_FLAG|TT_NEED_THREADS)
98 #define TT_ENABLE_DEBUG_MODE	(TT_ENABLE_IOCP_FLAG<<7)
99 
100 /* All the flags that a legacy test needs. */
101 #define TT_ISOLATED TT_FORK|TT_NEED_SOCKETPAIR|TT_NEED_BASE
102 
103 
104 #define BASIC(name,flags)						\
105 	{ #name, test_## name, flags, &basic_setup, NULL }
106 
107 #define LEGACY(name,flags)						\
108 	{ #name, run_legacy_test_fn, flags|TT_LEGACY, &legacy_setup,	\
109 	  test_## name }
110 
111 struct evutil_addrinfo;
112 struct evutil_addrinfo *ai_find_by_family(struct evutil_addrinfo *ai, int f);
113 struct evutil_addrinfo *ai_find_by_protocol(struct evutil_addrinfo *ai, int p);
114 int test_ai_eq_(const struct evutil_addrinfo *ai, const char *sockaddr_port,
115     int socktype, int protocol, int line);
116 
117 #define test_ai_eq(ai, str, s, p) do {					\
118 		if (test_ai_eq_((ai), (str), (s), (p), __LINE__)<0)	\
119 			goto end;					\
120 	} while (0)
121 
122 #define test_timeval_diff_leq(tv1, tv2, diff, tolerance)		\
123 	tt_int_op(labs(timeval_msec_diff((tv1), (tv2)) - diff), <=, tolerance)
124 
125 #define test_timeval_diff_eq(tv1, tv2, diff)				\
126 	test_timeval_diff_leq((tv1), (tv2), (diff), 50)
127 
128 long timeval_msec_diff(const struct timeval *start, const struct timeval *end);
129 
130 #ifndef _WIN32
131 pid_t regress_fork(void);
132 #endif
133 
134 #ifdef EVENT__HAVE_OPENSSL
135 #include <openssl/ssl.h>
136 EVP_PKEY *ssl_getkey(void);
137 X509 *ssl_getcert(EVP_PKEY *key);
138 SSL_CTX *get_ssl_ctx(void);
139 void init_ssl(void);
140 #endif
141 
142 void * basic_test_setup(const struct testcase_t *testcase);
143 int    basic_test_cleanup(const struct testcase_t *testcase, void *ptr);
144 
145 #ifdef __cplusplus
146 }
147 #endif
148 
149 #endif /* REGRESS_H_INCLUDED_ */
150