Move libtorture to top-level.
[ira/wip.git] / lib / torture / torture.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 3 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, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef __TORTURE_UI_H__
22 #define __TORTURE_UI_H__
23
24 struct torture_test;
25 struct torture_context;
26 struct torture_suite;
27 struct torture_tcase;
28 struct torture_results;
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 (*init) (struct torture_results *);
44         void (*comment) (struct torture_context *, const char *);
45         void (*warning) (struct torture_context *, const char *);
46         void (*suite_start) (struct torture_context *, struct torture_suite *);
47         void (*suite_finish) (struct torture_context *, struct torture_suite *);
48         void (*tcase_start) (struct torture_context *, struct torture_tcase *); 
49         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
50         void (*test_start) (struct torture_context *, 
51                                                 struct torture_tcase *,
52                                                 struct torture_test *);
53         void (*test_result) (struct torture_context *, 
54                                                  enum torture_result, const char *reason);
55 };
56
57 void torture_ui_test_start(struct torture_context *context,
58                                                            struct torture_tcase *tcase,
59                                                            struct torture_test *test);
60
61 void torture_ui_test_result(struct torture_context *context,
62                                                                 enum torture_result result,
63                                                                 const char *comment);
64
65 /*
66  * Holds information about a specific run of the testsuite. 
67  * The data in this structure should be considered private to 
68  * the torture tests and should only be used directly by the torture 
69  * code and the ui backends.
70  *
71  * Torture tests should instead call the torture_*() macros and functions 
72  * specified below.
73  */
74
75 struct torture_context
76 {
77         struct torture_results *results;
78
79         char *active_testname;
80         struct torture_test *active_test;
81         struct torture_tcase *active_tcase;
82
83         enum torture_result last_result;
84         char *last_reason;
85
86         /** Directory used for temporary test data */
87         const char *outputdir;
88         
89         /** Indentation level */
90         int level;
91
92         /** Event context */
93         struct event_context *ev;
94
95         /** Loadparm context (will go away in favor of torture_setting_ at some point) */
96         struct loadparm_context *lp_ctx;
97 };
98
99 struct torture_results
100 {
101         const struct torture_ui_ops *ui_ops;
102         void *ui_data;
103
104         /** Whether tests should avoid writing output to stdout */
105         bool quiet;
106
107         bool returncode;
108
109
110 };
111
112 /* 
113  * Describes a particular torture test
114  */
115 struct torture_test {
116         /** Short unique name for the test. */
117         const char *name;
118
119         /** Long description for the test. */
120         const char *description;
121
122         /** Whether this is a dangerous test 
123          * (can corrupt the remote servers data or bring it down). */
124         bool dangerous;
125
126         /** Function to call to run this test */
127         bool (*run) (struct torture_context *torture_ctx, 
128                                  struct torture_tcase *tcase,
129                                  struct torture_test *test);
130
131         struct torture_test *prev, *next;
132
133         /** Pointer to the actual test function. This is run by the 
134           * run() function above. */
135         void *fn;
136
137         /** Use data for this test */
138         const void *data;
139 };
140
141 /* 
142  * Describes a particular test case.
143  */
144 struct torture_tcase {
145     const char *name;
146         const char *description;
147         bool (*setup) (struct torture_context *tcase, void **data);
148         bool (*teardown) (struct torture_context *tcase, void *data); 
149         bool fixture_persistent;
150         void *data;
151         struct torture_test *tests;
152         struct torture_tcase *prev, *next;
153 };
154
155 struct torture_suite
156 {
157         const char *name;
158         const char *description;
159         struct torture_tcase *testcases;
160         struct torture_suite *children;
161
162         /* Pointers to siblings of this torture suite */
163         struct torture_suite *prev, *next;
164 };
165
166 /** Create a new torture suite */
167 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
168                 const char *name);
169
170 /** Change the setup and teardown functions for a testcase */
171 void torture_tcase_set_fixture(struct torture_tcase *tcase,
172                 bool (*setup) (struct torture_context *, void **),
173                 bool (*teardown) (struct torture_context *, void *));
174
175 /* Add another test to run for a particular testcase */
176 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
177                 const char *name,
178                 bool (*run) (struct torture_context *test,
179                         const void *tcase_data, const void *test_data),
180                 const void *test_data);
181
182 /* Add a testcase to a testsuite */
183 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
184                                                          const char *name);
185
186 /* Convenience wrapper that adds a testcase against only one
187  * test will be run */
188 struct torture_tcase *torture_suite_add_simple_tcase_const(
189                 struct torture_suite *suite,
190                 const char *name,
191                 bool (*run) (struct torture_context *test,
192                         const void *test_data),
193                 const void *data);
194
195 /* Convenience function that adds a test which only
196  * gets the test case data */
197 struct torture_test *torture_tcase_add_simple_test_const(
198                 struct torture_tcase *tcase,
199                 const char *name,
200                 bool (*run) (struct torture_context *test,
201                         const void *tcase_data));
202
203 /* Convenience wrapper that adds a test that doesn't need any
204  * testcase data */
205 struct torture_tcase *torture_suite_add_simple_test(
206                 struct torture_suite *suite,
207                 const char *name,
208                 bool (*run) (struct torture_context *test));
209
210 /* Add a child testsuite to an existing testsuite */
211 bool torture_suite_add_suite(struct torture_suite *suite,
212                 struct torture_suite *child);
213
214 /* Run the specified testsuite recursively */
215 bool torture_run_suite(struct torture_context *context,
216                                            struct torture_suite *suite);
217
218 /* Run the specified testcase */
219 bool torture_run_tcase(struct torture_context *context,
220                                            struct torture_tcase *tcase);
221
222 /* Run the specified test */
223 bool torture_run_test(struct torture_context *context,
224                                           struct torture_tcase *tcase,
225                                           struct torture_test *test);
226
227 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
228 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
229 void torture_result(struct torture_context *test,
230                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
231
232 #define torture_assert(torture_ctx,expr,cmt) \
233         if (!(expr)) { \
234                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
235                 return false; \
236         }
237
238 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
239         do { WERROR __got = got, __expected = expected; \
240         if (!W_ERROR_EQUAL(__got, __expected)) { \
241                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
242                 return false; \
243         } \
244         } while (0)
245
246 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
247         do { NTSTATUS __got = got, __expected = expected; \
248         if (!NT_STATUS_EQUAL(__got, __expected)) { \
249                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
250                 return false; \
251         }\
252         } while(0)
253
254 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
255         do { enum ndr_err_code __got = got, __expected = expected; \
256         if (__got != __expected) { \
257                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
258                 return false; \
259         }\
260         } while(0)
261
262 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
263         do { const char *__got = (got), *__expected = (expected); \
264         if (!strequal(__got, __expected)) { \
265                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
266                 return false; \
267         } \
268         } while(0)
269
270 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
271         do { const char *__got = (got), *__expected = (expected); \
272         if (strcmp_safe(__got, __expected) != 0) { \
273                 torture_result(torture_ctx, TORTURE_FAIL, \
274                                            __location__": "#got" was %s, expected %s: %s", \
275                                            __got, __expected, cmt); \
276                 return false; \
277         } \
278         } while(0)
279
280 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
281         do { const void *__got = (got), *__expected = (expected); \
282         if (memcmp(__got, __expected, len) != 0) { \
283                 torture_result(torture_ctx, TORTURE_FAIL, \
284                                __location__": "#got" of len %d did not match"#expected": %s", (int)len, cmt); \
285                 return false; \
286         } \
287         } while(0)
288
289 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
290         do { \
291         char *__got; \
292         const char *__expected = (expected); \
293         size_t __size; \
294         __got = file_load(filename, &__size, 0, torture_ctx); \
295         if (__got == NULL) { \
296                 torture_result(torture_ctx, TORTURE_FAIL, \
297                                __location__": unable to open %s: %s\n", \
298                                filename, cmt); \
299                 return false; \
300         } \
301         \
302         if (strcmp_safe(__got, __expected) != 0) { \
303                 torture_result(torture_ctx, TORTURE_FAIL, \
304                         __location__": %s contained:\n%sExpected: %s%s\n", \
305                         filename, __got, __expected, cmt); \
306                 talloc_free(__got); \
307                 return false; \
308         } \
309         talloc_free(__got); \
310         } while(0)
311
312 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
313         do { const char *__got, *__expected = (expected); \
314         size_t __size; \
315         __got = file_load(filename, *size, 0, torture_ctx); \
316         if (strcmp_safe(__got, __expected) != 0) { \
317                 torture_result(torture_ctx, TORTURE_FAIL, \
318                                            __location__": %s contained:\n%sExpected: %s%s\n", \
319                                            __got, __expected, cmt); \
320                 talloc_free(__got); \
321                 return false; \
322         } \
323         talloc_free(__got); \
324         } while(0)
325
326 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
327         do { int __got = (got), __expected = (expected); \
328         if (__got != __expected) { \
329                 torture_result(torture_ctx, TORTURE_FAIL, \
330                         __location__": "#got" was %d, expected %d: %s", \
331                         __got, __expected, cmt); \
332                 return false; \
333         } \
334         } while(0)
335
336 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
337         do { uint64_t __got = (got), __expected = (expected); \
338         if (__got != __expected) { \
339                 torture_result(torture_ctx, TORTURE_FAIL, \
340                         __location__": "#got" was %llu, expected %llu: %s", \
341                         (unsigned long long)__got, (unsigned long long)__expected, cmt); \
342                 return false; \
343         } \
344         } while(0)
345
346 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
347         do { int __expected = (expected); \
348         if (errno != __expected) { \
349                 torture_result(torture_ctx, TORTURE_FAIL, \
350                         __location__": errno was %d (%s), expected %d: %s: %s", \
351                                            errno, strerror(errno), __expected, \
352                                            strerror(__expected), cmt); \
353                 return false; \
354         } \
355         } while(0)
356
357
358
359 #define torture_skip(torture_ctx,cmt) do {\
360                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
361                 return true; \
362         } while(0)
363 #define torture_fail(torture_ctx,cmt) do {\
364                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
365                 return false; \
366         } while (0)
367 #define torture_fail_goto(torture_ctx,label,cmt) do {\
368                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
369                 goto label; \
370         } while (0)
371
372 #define torture_out stderr
373
374 /* Convenience macros */
375 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
376                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
377
378 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
379                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
380
381 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
382                 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
383
384 /* Getting settings */
385 const char *torture_setting_string(struct torture_context *test, \
386                                                                    const char *name, 
387                                                                    const char *default_value);
388
389 int torture_setting_int(struct torture_context *test, 
390                                                 const char *name, 
391                                                 int default_value);
392
393 double torture_setting_double(struct torture_context *test, 
394                                                 const char *name, 
395                                                 double default_value);
396
397 bool torture_setting_bool(struct torture_context *test, 
398                                                   const char *name, 
399                                                   bool default_value);
400
401 struct torture_suite *torture_find_suite(struct torture_suite *parent, 
402                                                                                  const char *name);
403
404 NTSTATUS torture_temp_dir(struct torture_context *tctx, 
405                                    const char *prefix, 
406                                    char **tempdir);
407
408 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
409                 const char *name,
410                 bool (*run) (struct torture_context *test, void *tcase_data));
411
412
413 bool torture_suite_init_tcase(struct torture_suite *suite, 
414                               struct torture_tcase *tcase, 
415                               const char *name);
416
417 struct torture_context *torture_context_init(struct event_context *event_ctx, struct torture_results *results);
418
419 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
420
421 struct torture_context *torture_context_child(struct torture_context *tctx);
422
423 extern const struct torture_ui_ops torture_subunit_ui_ops;
424
425 #endif /* __TORTURE_UI_H__ */