r21055: Fix executable bit.
[tprouty/samba.git] / source4 / torture / ui.h
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB torture UI functions
4
5    Copyright (C) Jelmer Vernooij 2006
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #ifndef __TORTURE_UI_H__
23 #define __TORTURE_UI_H__
24
25 struct torture_test;
26 struct torture_context;
27 struct torture_suite;
28 struct torture_tcase;
29
30 enum torture_result { 
31         TORTURE_OK=0, 
32         TORTURE_FAIL=1,
33         TORTURE_ERROR=2,
34         TORTURE_SKIP=3
35 };
36
37 /* 
38  * These callbacks should be implemented by any backend that wishes 
39  * to listen to reports from the torture tests.
40  */
41 struct torture_ui_ops
42 {
43         void (*comment) (struct torture_context *, const char *);
44         void (*suite_start) (struct torture_context *, struct torture_suite *);
45         void (*suite_finish) (struct torture_context *, struct torture_suite *);
46         void (*tcase_start) (struct torture_context *, struct torture_tcase *); 
47         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
48         void (*test_start) (struct torture_context *, 
49                                                 struct torture_tcase *,
50                                                 struct torture_test *);
51         void (*test_result) (struct torture_context *, 
52                                                  enum torture_result, const char *reason);
53 };
54
55 void torture_ui_test_start(struct torture_context *context,
56                                                            struct torture_tcase *tcase,
57                                                            struct torture_test *test);
58
59 void torture_ui_test_result(struct torture_context *context,
60                                                                 enum torture_result result,
61                                                                 const char *comment);
62
63 /*
64  * Holds information about a specific run of the testsuite. 
65  * The data in this structure should be considered private to 
66  * the torture tests and should only be used directly by the torture 
67  * code and the ui backends.
68  *
69  * Torture tests should instead call the torture_*() macros and functions 
70  * specified below.
71  */
72
73 struct torture_context
74 {
75         const struct torture_ui_ops *ui_ops;
76         void *ui_data;
77
78         char *active_testname;
79         struct torture_test *active_test;
80         struct torture_tcase *active_tcase;
81
82         bool quiet; /* Whether tests should avoid writing output to stdout */
83
84         enum torture_result last_result;
85         char *last_reason;
86
87         bool returncode;
88
89         char *outputdir;
90         int level;
91 };
92
93 /* 
94  * Describes a particular torture test
95  */
96 struct torture_test {
97         const char *name;
98         const char *description;
99         bool dangerous;
100         /* Function to call to run this test */
101         bool (*run) (struct torture_context *torture_ctx, 
102                                  struct torture_tcase *tcase,
103                                  struct torture_test *test);
104
105         struct torture_test *prev, *next;
106
107         /* Pointer to the actual test function. This is run by the 
108          * run() function above. */
109         void *fn;
110         const void *data;
111 };
112
113 /* 
114  * Describes a particular test case.
115  */
116 struct torture_tcase {
117     const char *name;
118         const char *description;
119         bool (*setup) (struct torture_context *tcase, void **data);
120         bool (*teardown) (struct torture_context *tcase, void *data); 
121         bool fixture_persistent;
122         void *data;
123         struct torture_test *tests;
124         struct torture_tcase *prev, *next;
125 };
126
127 struct torture_suite
128 {
129         const char *name;
130         const char *description;
131         struct torture_tcase *testcases;
132         struct torture_suite *children;
133
134         /* Pointers to siblings of this torture suite */
135         struct torture_suite *prev, *next;
136 };
137
138 /** Create a new torture suite */
139 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx, 
140                                                                                    const char *name);
141
142 /** Change the setup and teardown functions for a testcase */
143 void torture_tcase_set_fixture(struct torture_tcase *tcase, 
144                 bool (*setup) (struct torture_context *, void **),
145                 bool (*teardown) (struct torture_context *, void *));
146
147 /* Add another test to run for a particular testcase */
148 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase, 
149                 const char *name, 
150                 bool (*run) (struct torture_context *test, const void *tcase_data,
151                                          const void *test_data),
152                 const void *test_data);
153
154 /* Add a testcase to a testsuite */
155 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite, 
156                                                          const char *name);
157
158 /* Convenience wrapper that adds a testcase against only one 
159  * test will be run */
160 struct torture_tcase *torture_suite_add_simple_tcase(
161                 struct torture_suite *suite, 
162                 const char *name,
163                 bool (*run) (struct torture_context *test, const void *test_data),
164                 const void *data);
165
166 /* Convenience wrapper that adds a test that doesn't need any 
167  * testcase data */
168 struct torture_tcase *torture_suite_add_simple_test(
169                 struct torture_suite *suite, 
170                 const char *name,
171                 bool (*run) (struct torture_context *test));
172
173 /* Add a child testsuite to an existing testsuite */
174 bool torture_suite_add_suite(struct torture_suite *suite,
175                                                          struct torture_suite *child);
176
177 /* Run the specified testsuite recursively */
178 bool torture_run_suite(struct torture_context *context, 
179                                            struct torture_suite *suite);
180
181 /* Run the specified testcase */
182 bool torture_run_tcase(struct torture_context *context, 
183                                            struct torture_tcase *tcase);
184
185 /* Run the specified test */
186 bool torture_run_test(struct torture_context *context, 
187                                           struct torture_tcase *tcase,
188                                           struct torture_test *test);
189
190 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
191 void torture_result(struct torture_context *test, 
192                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
193
194 #define torture_assert(torture_ctx,expr,cmt) \
195         if (!(expr)) { \
196                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
197                 return false; \
198         }
199
200 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
201         do { WERROR __got = got, __expected = expected; \
202         if (!W_ERROR_EQUAL(__got, __expected)) { \
203                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
204                 return false; \
205         } \
206         } while (0)
207
208 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
209         do { NTSTATUS __got = got, __expected = expected; \
210         if (!NT_STATUS_EQUAL(__got, __expected)) { \
211                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
212                 return false; \
213         }\
214         } while(0)
215
216
217 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
218         do { const char *__got = (got), *__expected = (expected); \
219         if (!strequal(__got, __expected)) { \
220                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
221                 return false; \
222         } \
223         } while(0)
224
225 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
226         do { const char *__got = (got), *__expected = (expected); \
227         if (strcmp_safe(__got, __expected) != 0) { \
228                 torture_result(torture_ctx, TORTURE_FAIL, \
229                                            __location__": "#got" was %s, expected %s: %s", \
230                                            __got, __expected, cmt); \
231                 return false; \
232         } \
233         } while(0)
234
235 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
236         do { int __got = (got), __expected = (expected); \
237         if (__got != __expected) { \
238                 torture_result(torture_ctx, TORTURE_FAIL, \
239                                          __location__": "#got" was %d, expected %d: %s", \
240                                            __got, __expected, cmt); \
241                 return false; \
242         } \
243         } while(0)
244
245 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
246         do { int __expected = (expected); \
247         if (errno != __expected) { \
248                 torture_result(torture_ctx, TORTURE_FAIL, \
249                         __location__": errno was %d (%s), expected %d: %s: %s", \
250                                            errno, strerror(errno), __expected, \
251                                            strerror(__expected), cmt); \
252                 return false; \
253         } \
254         } while(0)
255
256
257
258 #define torture_skip(torture_ctx,cmt) do {\
259                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
260                 return true; \
261         } while(0)
262 #define torture_fail(torture_ctx,cmt) do {\
263                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
264                 return false; \
265         } while (0)
266
267 #define torture_out stderr
268
269 /* Convenience macros */
270 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
271                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
272
273 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
274                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
275
276 /* Getting settings */
277 const char *torture_setting_string(struct torture_context *test, \
278                                                                    const char *name, 
279                                                                    const char *default_value);
280
281 int torture_setting_int(struct torture_context *test, 
282                                                 const char *name, 
283                                                 int default_value);
284
285 bool torture_setting_bool(struct torture_context *test, 
286                                                   const char *name, 
287                                                   bool default_value);
288
289 struct torture_suite *torture_find_suite(struct torture_suite *parent, 
290                                                                                  const char *name);
291
292
293 #endif /* __TORTURE_UI_H__ */