smbd: Use leases_db in lease_match()
[gd/samba-autobuild/.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 enum torture_progress_whence {
38         TORTURE_PROGRESS_SET,
39         TORTURE_PROGRESS_CUR,
40         TORTURE_PROGRESS_POP,
41         TORTURE_PROGRESS_PUSH,
42 };
43
44 /* 
45  * These callbacks should be implemented by any backend that wishes 
46  * to listen to reports from the torture tests.
47  */
48 struct torture_ui_ops
49 {
50         void (*init) (struct torture_results *);
51         void (*comment) (struct torture_context *, const char *);
52         void (*warning) (struct torture_context *, const char *);
53         void (*suite_start) (struct torture_context *, struct torture_suite *);
54         void (*suite_finish) (struct torture_context *, struct torture_suite *);
55         void (*tcase_start) (struct torture_context *, struct torture_tcase *); 
56         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
57         void (*test_start) (struct torture_context *, 
58                                                 struct torture_tcase *,
59                                                 struct torture_test *);
60         void (*test_result) (struct torture_context *, 
61                                                  enum torture_result, const char *reason);
62         void (*progress) (struct torture_context *, int offset, enum torture_progress_whence whence);
63         void (*report_time) (struct torture_context *);
64 };
65
66 void torture_ui_test_start(struct torture_context *context,
67                                                            struct torture_tcase *tcase,
68                                                            struct torture_test *test);
69
70 void torture_ui_test_result(struct torture_context *context,
71                                                                 enum torture_result result,
72                                                                 const char *comment);
73
74 void torture_ui_report_time(struct torture_context *context);
75
76 /*
77  * Holds information about a specific run of the testsuite. 
78  * The data in this structure should be considered private to 
79  * the torture tests and should only be used directly by the torture 
80  * code and the ui backends.
81  *
82  * Torture tests should instead call the torture_*() macros and functions 
83  * specified below.
84  */
85
86 struct torture_context
87 {
88         struct torture_results *results;
89
90         struct torture_test *active_test;
91         struct torture_tcase *active_tcase;
92
93         enum torture_result last_result;
94         char *last_reason;
95
96         /** Directory used for temporary test data */
97         const char *outputdir;
98
99         /** Event context */
100         struct tevent_context *ev;
101
102         /** Loadparm context (will go away in favor of torture_setting_ at some point) */
103         struct loadparm_context *lp_ctx;
104
105         int conn_index;
106 };
107
108 struct torture_results
109 {
110         const struct torture_ui_ops *ui_ops;
111         void *ui_data;
112
113         /** Whether tests should avoid writing output to stdout */
114         bool quiet;
115
116         bool returncode;
117 };
118
119 /* 
120  * Describes a particular torture test
121  */
122 struct torture_test {
123         /** Short unique name for the test. */
124         const char *name;
125
126         /** Long description for the test. */
127         const char *description;
128
129         /** Whether this is a dangerous test 
130          * (can corrupt the remote servers data or bring it down). */
131         bool dangerous;
132
133         /** Function to call to run this test */
134         bool (*run) (struct torture_context *torture_ctx, 
135                                  struct torture_tcase *tcase,
136                                  struct torture_test *test);
137
138         struct torture_test *prev, *next;
139
140         /** Pointer to the actual test function. This is run by the 
141           * run() function above. */
142         void *fn;
143
144         /** Use data for this test */
145         const void *data;
146 };
147
148 /* 
149  * Describes a particular test case.
150  */
151 struct torture_tcase {
152     const char *name;
153         const char *description;
154         bool (*setup) (struct torture_context *tcase, void **data);
155         bool (*teardown) (struct torture_context *tcase, void *data); 
156         bool fixture_persistent;
157         void *data;
158         struct torture_test *tests;
159         struct torture_tcase *prev, *next;
160 };
161
162 struct torture_suite
163 {
164         const char *name;
165         const char *description;
166         struct torture_tcase *testcases;
167         struct torture_suite *children;
168
169         /* Pointers to siblings of this torture suite */
170         struct torture_suite *prev, *next;
171 };
172
173 /** Create a new torture suite */
174 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
175                 const char *name);
176
177 /** Change the setup and teardown functions for a testcase */
178 void torture_tcase_set_fixture(struct torture_tcase *tcase,
179                 bool (*setup) (struct torture_context *, void **),
180                 bool (*teardown) (struct torture_context *, void *));
181
182 /* Add another test to run for a particular testcase */
183 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
184                 const char *name,
185                 bool (*run) (struct torture_context *test,
186                         const void *tcase_data, const void *test_data),
187                 const void *test_data);
188
189 /* Add a testcase to a testsuite */
190 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
191                                                          const char *name);
192
193 /* Convenience wrapper that adds a testcase against only one
194  * test will be run */
195 struct torture_tcase *torture_suite_add_simple_tcase_const(
196                 struct torture_suite *suite,
197                 const char *name,
198                 bool (*run) (struct torture_context *test,
199                         const void *test_data),
200                 const void *data);
201
202 /* Convenience function that adds a test which only
203  * gets the test case data */
204 struct torture_test *torture_tcase_add_simple_test_const(
205                 struct torture_tcase *tcase,
206                 const char *name,
207                 bool (*run) (struct torture_context *test,
208                         const void *tcase_data));
209
210 /* Convenience wrapper that adds a test that doesn't need any
211  * testcase data */
212 struct torture_tcase *torture_suite_add_simple_test(
213                 struct torture_suite *suite,
214                 const char *name,
215                 bool (*run) (struct torture_context *test));
216
217 /* Add a child testsuite to an existing testsuite */
218 bool torture_suite_add_suite(struct torture_suite *suite,
219                 struct torture_suite *child);
220
221 /* Run the specified testsuite recursively */
222 bool torture_run_suite(struct torture_context *context,
223                                            struct torture_suite *suite);
224
225 /* Run the specified testsuite recursively, but only the specified 
226  * tests */
227 bool torture_run_suite_restricted(struct torture_context *context, 
228                        struct torture_suite *suite, const char **restricted);
229
230 /* Run the specified testcase */
231 bool torture_run_tcase(struct torture_context *context,
232                                            struct torture_tcase *tcase);
233
234 bool torture_run_tcase_restricted(struct torture_context *context, 
235                        struct torture_tcase *tcase, const char **restricted);
236
237 /* Run the specified test */
238 bool torture_run_test(struct torture_context *context,
239                                           struct torture_tcase *tcase,
240                                           struct torture_test *test);
241
242 bool torture_run_test_restricted(struct torture_context *context,
243                                           struct torture_tcase *tcase,
244                                           struct torture_test *test,
245                                           const char **restricted);
246
247 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
248 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
249 void torture_result(struct torture_context *test,
250                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
251
252 #define torture_assert(torture_ctx,expr,cmt) \
253         if (!(expr)) { \
254                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
255                 return false; \
256         }
257
258 #define torture_assert_goto(torture_ctx,expr,ret,label,cmt) \
259         if (!(expr)) { \
260                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
261                 ret = false; \
262                 goto label; \
263         }
264
265 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
266         do { WERROR __got = got, __expected = expected; \
267         if (!W_ERROR_EQUAL(__got, __expected)) { \
268                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
269                 return false; \
270         } \
271         } while (0)
272
273 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
274         do { NTSTATUS __got = got, __expected = expected; \
275         if (!NT_STATUS_EQUAL(__got, __expected)) { \
276                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
277                 return false; \
278         }\
279         } while(0)
280
281 #define torture_assert_ntstatus_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
282         do { NTSTATUS __got = got, __expected = expected; \
283         if (!NT_STATUS_EQUAL(__got, __expected)) { \
284                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
285                 ret = false; \
286                 goto label; \
287         }\
288         } while(0)
289
290 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
291         do { enum ndr_err_code __got = got, __expected = expected; \
292         if (__got != __expected) { \
293                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, ndr_errstr(__got), __expected, __STRING(expected), cmt); \
294                 return false; \
295         }\
296         } while(0)
297
298 #define torture_assert_ndr_err_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
299         do { enum ndr_err_code __got = got, __expected = expected; \
300         if (__got != __expected) { \
301                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, ndr_errstr(__got), __expected, __STRING(expected), cmt); \
302                 ret = false; \
303                 goto label; \
304         }\
305         } while(0)
306
307 #define torture_assert_hresult_equal(torture_ctx, got, expected, cmt) \
308         do { HRESULT __got = got, __expected = expected; \
309         if (!HRES_IS_EQUAL(__got, __expected)) { \
310                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", hresult_errstr(__got), hresult_errstr(__expected), cmt); \
311                 return false; \
312         } \
313         } while (0)
314
315 #define torture_assert_krb5_error_equal(torture_ctx, got, expected, cmt) \
316         do { krb5_error_code __got = got, __expected = expected; \
317         if (__got != __expected) { \
318                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, error_message(__got), __expected, error_message(__expected), cmt); \
319                 return false; \
320         } \
321         } while (0)
322
323 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
324         do { const char *__got = (got), *__expected = (expected); \
325         if (!strequal(__got, __expected)) { \
326                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
327                 return false; \
328         } \
329         } while(0)
330
331 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
332         do { const char *__got = (got), *__expected = (expected); \
333         if (strcmp_safe(__got, __expected) != 0) { \
334                 torture_result(torture_ctx, TORTURE_FAIL, \
335                                            __location__": "#got" was %s, expected %s: %s", \
336                                            __got, __expected, cmt); \
337                 return false; \
338         } \
339         } while(0)
340
341 #define torture_assert_strn_equal(torture_ctx,got,expected,len,cmt)\
342         do { const char *__got = (got), *__expected = (expected); \
343         if (strncmp(__got, __expected, len) != 0) { \
344                 torture_result(torture_ctx, TORTURE_FAIL, \
345                                            __location__": "#got" %s of len %d did not match "#expected" %s: %s", \
346                                            __got, (int)len, __expected, cmt); \
347                 return false; \
348         } \
349         } while(0)
350
351 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
352         do { const char *__got = (got), *__expected = (expected); \
353         if (strcmp_safe(__got, __expected) != 0) { \
354                 torture_result(torture_ctx, TORTURE_FAIL, \
355                                            __location__": "#got" was %s, expected %s: %s", \
356                                            __got, __expected, cmt); \
357                 ret = false; \
358                 goto label; \
359         } \
360         } while(0)
361
362 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
363         do { const void *__got = (got), *__expected = (expected); \
364         if (memcmp(__got, __expected, len) != 0) { \
365                 torture_result(torture_ctx, TORTURE_FAIL, \
366                                __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
367                 return false; \
368         } \
369         } while(0)
370
371 #define torture_assert_mem_equal_goto(torture_ctx,got,expected,len,ret,label,cmt) \
372         do { const void *__got = (got), *__expected = (expected); \
373         if (memcmp(__got, __expected, len) != 0) { \
374                 torture_result(torture_ctx, TORTURE_FAIL, \
375                                __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
376                 ret = false; \
377                 goto label; \
378         } \
379         } while(0)
380
381 #define torture_assert_mem_not_equal_goto(torture_ctx,got,expected,len,ret,label,cmt) \
382         do { const void *__got = (got), *__expected = (expected); \
383         if (memcmp(__got, __expected, len) == 0) { \
384                 torture_result(torture_ctx, TORTURE_FAIL, \
385                                __location__": "#got" of len %d unexpectedly matches "#expected": %s", (int)len, cmt); \
386                 ret = false; \
387                 goto label; \
388         } \
389         } while(0)
390
391 static inline void torture_dump_data_str_cb(const char *buf, void *private_data)
392 {
393         char **dump = (char **)private_data;
394         *dump = talloc_strdup_append_buffer(*dump, buf);
395 }
396
397 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
398         do { const DATA_BLOB __got = (got), __expected = (expected); \
399         if (__got.length != __expected.length) { \
400                 torture_result(torture_ctx, TORTURE_FAIL, \
401                                __location__": "#got".len %d did not match "#expected" len %d: %s", \
402                                (int)__got.length, (int)__expected.length, cmt); \
403                 return false; \
404         } \
405         if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
406                 char *__dump = NULL; \
407                 uint8_t __byte_a = 0x00;\
408                 uint8_t __byte_b = 0x00;\
409                 int __i;\
410                 for (__i=0; __i < __expected.length; __i++) {\
411                         __byte_a = __expected.data[__i];\
412                         if (__i == __got.length) {\
413                                 __byte_b = 0x00;\
414                                 break;\
415                         }\
416                         __byte_b = __got.data[__i];\
417                         if (__byte_a != __byte_b) {\
418                                 break;\
419                         }\
420                 }\
421                 torture_warning(torture_ctx, "blobs differ at byte 0x%02X (%u)", __i, __i);\
422                 torture_warning(torture_ctx, "expected byte[0x%02X] = 0x%02X got byte[0x%02X] = 0x%02X",\
423                                 __i, __byte_a, __i, __byte_b);\
424                 __dump = talloc_strdup(torture_ctx, ""); \
425                 dump_data_cb(__got.data, __got.length, true, \
426                              torture_dump_data_str_cb, &__dump); \
427                 torture_warning(torture_ctx, "got[0x%02X]: \n%s", \
428                                 (int)__got.length, __dump); \
429                 TALLOC_FREE(__dump); \
430                 __dump = talloc_strdup(torture_ctx, ""); \
431                 dump_data_cb(__expected.data, __expected.length, true, \
432                              torture_dump_data_str_cb, &__dump); \
433                 torture_warning(torture_ctx, "expected[0x%02X]: \n%s", \
434                                 (int)__expected.length, __dump); \
435                 TALLOC_FREE(__dump); \
436                 torture_result(torture_ctx, TORTURE_FAIL, \
437                                __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
438                 return false; \
439         } \
440         } while(0)
441
442 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
443         do { \
444         char *__got; \
445         const char *__expected = (expected); \
446         size_t __size; \
447         __got = file_load(filename, &__size, 0, torture_ctx); \
448         if (__got == NULL) { \
449                 torture_result(torture_ctx, TORTURE_FAIL, \
450                                __location__": unable to open %s: %s\n", \
451                                filename, cmt); \
452                 return false; \
453         } \
454         \
455         if (strcmp_safe(__got, __expected) != 0) { \
456                 torture_result(torture_ctx, TORTURE_FAIL, \
457                         __location__": %s contained:\n%sExpected: %s%s\n", \
458                         filename, __got, __expected, cmt); \
459                 talloc_free(__got); \
460                 return false; \
461         } \
462         talloc_free(__got); \
463         } while(0)
464
465 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
466         do { const char *__got, *__expected = (expected); \
467         size_t __size; \
468         __got = file_load(filename, *size, 0, torture_ctx); \
469         if (strcmp_safe(__got, __expected) != 0) { \
470                 torture_result(torture_ctx, TORTURE_FAIL, \
471                                            __location__": %s contained:\n%sExpected: %s%s\n", \
472                                            __got, __expected, cmt); \
473                 talloc_free(__got); \
474                 return false; \
475         } \
476         talloc_free(__got); \
477         } while(0)
478
479 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
480         do { int __got = (got), __expected = (expected); \
481         if (__got != __expected) { \
482                 torture_result(torture_ctx, TORTURE_FAIL, \
483                         __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
484                         __got, __got, __expected, __expected, cmt); \
485                 return false; \
486         } \
487         } while(0)
488
489 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
490         do { int __got = (got), __expected = (expected); \
491         if (__got != __expected) { \
492                 torture_result(torture_ctx, TORTURE_FAIL, \
493                         __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
494                         __got, __got, __expected, __expected, cmt); \
495                 ret = false; \
496                 goto label; \
497         } \
498         } while(0)
499
500 #define torture_assert_int_not_equal(torture_ctx,got,not_expected,cmt)\
501         do { int __got = (got), __not_expected = (not_expected); \
502         if (__got == __not_expected) { \
503                 torture_result(torture_ctx, TORTURE_FAIL, \
504                         __location__": "#got" was %d (0x%X), expected a different number: %s", \
505                         __got, __got, cmt); \
506                 return false; \
507         } \
508         } while(0)
509
510 #define torture_assert_int_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
511         do { int __got = (got), __not_expected = (not_expected); \
512         if (__got == __not_expected) { \
513                 torture_result(torture_ctx, TORTURE_FAIL, \
514                         __location__": "#got" was %d (0x%X), expected a different number: %s", \
515                         __got, __got, cmt); \
516                 ret = false; \
517                 goto label; \
518         } \
519         } while(0)
520
521 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
522         do { uint64_t __got = (got), __expected = (expected); \
523         if (__got != __expected) { \
524                 torture_result(torture_ctx, TORTURE_FAIL, \
525                         __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
526                         (unsigned long long)__got, (unsigned long long)__got, \
527                         (unsigned long long)__expected, (unsigned long long)__expected, \
528                         cmt); \
529                 return false; \
530         } \
531         } while(0)
532
533 #define torture_assert_u64_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
534         do { uint64_t __got = (got), __expected = (expected); \
535         if (__got != __expected) { \
536                 torture_result(torture_ctx, TORTURE_FAIL, \
537                         __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
538                         (unsigned long long)__got, (unsigned long long)__got, \
539                         (unsigned long long)__expected, (unsigned long long)__expected, \
540                         cmt); \
541                 ret = false; \
542                 goto label; \
543         } \
544         } while(0)
545
546 #define torture_assert_u64_not_equal(torture_ctx,got,not_expected,cmt)\
547         do { uint64_t __got = (got), __not_expected = (not_expected); \
548         if (__got == __not_expected) { \
549                 torture_result(torture_ctx, TORTURE_FAIL, \
550                         __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
551                         (unsigned long long)__got, (unsigned long long)__got, \
552                         cmt); \
553                 return false; \
554         } \
555         } while(0)
556
557 #define torture_assert_u64_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
558         do { uint64_t __got = (got), __not_expected = (not_expected); \
559         if (__got == __not_expected) { \
560                 torture_result(torture_ctx, TORTURE_FAIL, \
561                         __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
562                         (unsigned long long)__got, (unsigned long long)__got, \
563                         cmt); \
564                 ret = false; \
565                 goto label; \
566         } \
567         } while(0)
568
569 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
570         do { int __expected = (expected); \
571         if (errno != __expected) { \
572                 torture_result(torture_ctx, TORTURE_FAIL, \
573                         __location__": errno was %d (%s), expected %d: %s: %s", \
574                                            errno, strerror(errno), __expected, \
575                                            strerror(__expected), cmt); \
576                 return false; \
577         } \
578         } while(0)
579
580 #define torture_assert_guid_equal(torture_ctx,got,expected,cmt)\
581         do {const struct GUID __got = (got), __expected = (expected); \
582         if (!GUID_equal(&__got, &__expected)) { \
583                 torture_result(torture_ctx, TORTURE_FAIL, \
584                         __location__": "#got" was %s, expected %s: %s", \
585                         GUID_string(torture_ctx, &__got), GUID_string(torture_ctx, &__expected), cmt); \
586                 return false; \
587         } \
588         } while(0)
589
590 #define torture_assert_nttime_equal(torture_ctx,got,expected,cmt) \
591         do { NTTIME __got = got, __expected = expected; \
592         if (!nt_time_equal(&__got, &__expected)) { \
593                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_time_string(tctx, __got), nt_time_string(tctx, __expected), cmt); \
594                 return false; \
595         }\
596         } while(0)
597
598 #define torture_assert_sid_equal(torture_ctx,got,expected,cmt)\
599         do {const struct dom_sid *__got = (got), *__expected = (expected); \
600         if (!dom_sid_equal(__got, __expected)) { \
601                 torture_result(torture_ctx, TORTURE_FAIL, \
602                                            __location__": "#got" was %s, expected %s: %s", \
603                                            dom_sid_string(torture_ctx, __got), dom_sid_string(torture_ctx, __expected), cmt); \
604                 return false; \
605         } \
606         } while(0)
607
608 #define torture_assert_not_null(torture_ctx,got,cmt)\
609         do {const void *__got = (got); \
610         if (__got == NULL) { \
611                 torture_result(torture_ctx, TORTURE_FAIL, \
612                         __location__": "#got" was NULL, expected != NULL: %s", \
613                         cmt); \
614                 return false; \
615         } \
616         } while(0)
617
618 #define torture_assert_not_null_goto(torture_ctx,got,ret,label,cmt)\
619         do {const void *__got = (got); \
620         if (__got == NULL) { \
621                 torture_result(torture_ctx, TORTURE_FAIL, \
622                         __location__": "#got" was NULL, expected != NULL: %s", \
623                         cmt); \
624                 ret = false; \
625                 goto label; \
626         } \
627         } while(0)
628
629 #define torture_skip(torture_ctx,cmt) do {\
630                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
631                 return true; \
632         } while(0)
633 #define torture_skip_goto(torture_ctx,label,cmt) do {\
634                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
635                 goto label; \
636         } while(0)
637 #define torture_fail(torture_ctx,cmt) do {\
638                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
639                 return false; \
640         } while (0)
641 #define torture_fail_goto(torture_ctx,label,cmt) do {\
642                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
643                 goto label; \
644         } while (0)
645
646 #define torture_out stderr
647
648 /* Convenience macros */
649 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
650                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
651
652 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
653                 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
654
655 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
656                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
657
658 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
659                 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
660
661 #define torture_assert_ndr_success_goto(torture_ctx,expr,ret,label,cmt) \
662                 torture_assert_ndr_err_equal_goto(torture_ctx,expr,NDR_ERR_SUCCESS,ret,label,cmt)
663
664 #define torture_assert_hresult_ok(torture_ctx,expr,cmt) \
665                 torture_assert_hresult_equal(torture_ctx,expr,HRES_ERROR(0), cmt)
666
667 /* Getting settings */
668 const char *torture_setting_string(struct torture_context *test, \
669                                                                    const char *name, 
670                                                                    const char *default_value);
671
672 int torture_setting_int(struct torture_context *test, 
673                                                 const char *name, 
674                                                 int default_value);
675
676 double torture_setting_double(struct torture_context *test, 
677                                                 const char *name, 
678                                                 double default_value);
679
680 bool torture_setting_bool(struct torture_context *test, 
681                                                   const char *name, 
682                                                   bool default_value);
683
684 struct torture_suite *torture_find_suite(struct torture_suite *parent, 
685                                                                                  const char *name);
686
687 unsigned long torture_setting_ulong(struct torture_context *test,
688                                     const char *name,
689                                     unsigned long default_value);
690
691 NTSTATUS torture_temp_dir(struct torture_context *tctx, 
692                                    const char *prefix, 
693                                    char **tempdir);
694 NTSTATUS torture_deltree_outputdir(struct torture_context *tctx);
695
696 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
697                 const char *name,
698                 bool (*run) (struct torture_context *test, void *tcase_data));
699
700
701 bool torture_suite_init_tcase(struct torture_suite *suite, 
702                               struct torture_tcase *tcase, 
703                               const char *name);
704 int torture_suite_children_count(const struct torture_suite *suite);
705
706 struct torture_context *torture_context_init(struct tevent_context *event_ctx, struct torture_results *results);
707
708 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
709
710 struct torture_context *torture_context_child(struct torture_context *tctx);
711
712 extern const struct torture_ui_ops torture_subunit_ui_ops;
713 extern const struct torture_ui_ops torture_simple_ui_ops;
714
715 #endif /* __TORTURE_UI_H__ */