2 Unix SMB/CIFS implementation.
3 SMB torture UI functions
5 Copyright (C) Jelmer Vernooij 2006
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.
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.
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/>.
21 #ifndef __TORTURE_UI_H__
22 #define __TORTURE_UI_H__
25 struct torture_context;
28 struct torture_results;
37 enum torture_progress_whence {
41 TORTURE_PROGRESS_PUSH,
45 * These callbacks should be implemented by any backend that wishes
46 * to listen to reports from the torture tests.
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 *);
66 void torture_ui_test_start(struct torture_context *context,
67 struct torture_tcase *tcase,
68 struct torture_test *test);
70 void torture_ui_test_result(struct torture_context *context,
71 enum torture_result result,
74 void torture_ui_report_time(struct torture_context *context);
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.
82 * Torture tests should instead call the torture_*() macros and functions
86 struct torture_context
88 struct torture_results *results;
90 struct torture_test *active_test;
91 struct torture_tcase *active_tcase;
93 enum torture_result last_result;
96 /** Directory used for temporary test data */
97 const char *outputdir;
100 struct tevent_context *ev;
102 /** Loadparm context (will go away in favor of torture_setting_ at some point) */
103 struct loadparm_context *lp_ctx;
106 struct torture_results
108 const struct torture_ui_ops *ui_ops;
111 /** Whether tests should avoid writing output to stdout */
118 * Describes a particular torture test
120 struct torture_test {
121 /** Short unique name for the test. */
124 /** Long description for the test. */
125 const char *description;
127 /** Whether this is a dangerous test
128 * (can corrupt the remote servers data or bring it down). */
131 /** Function to call to run this test */
132 bool (*run) (struct torture_context *torture_ctx,
133 struct torture_tcase *tcase,
134 struct torture_test *test);
136 struct torture_test *prev, *next;
138 /** Pointer to the actual test function. This is run by the
139 * run() function above. */
142 /** Use data for this test */
147 * Describes a particular test case.
149 struct torture_tcase {
151 const char *description;
152 bool (*setup) (struct torture_context *tcase, void **data);
153 bool (*teardown) (struct torture_context *tcase, void *data);
154 bool fixture_persistent;
156 struct torture_test *tests;
157 struct torture_tcase *prev, *next;
163 const char *description;
164 struct torture_tcase *testcases;
165 struct torture_suite *children;
167 /* Pointers to siblings of this torture suite */
168 struct torture_suite *prev, *next;
171 /** Create a new torture suite */
172 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
175 /** Change the setup and teardown functions for a testcase */
176 void torture_tcase_set_fixture(struct torture_tcase *tcase,
177 bool (*setup) (struct torture_context *, void **),
178 bool (*teardown) (struct torture_context *, void *));
180 /* Add another test to run for a particular testcase */
181 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
183 bool (*run) (struct torture_context *test,
184 const void *tcase_data, const void *test_data),
185 const void *test_data);
187 /* Add a testcase to a testsuite */
188 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
191 /* Convenience wrapper that adds a testcase against only one
192 * test will be run */
193 struct torture_tcase *torture_suite_add_simple_tcase_const(
194 struct torture_suite *suite,
196 bool (*run) (struct torture_context *test,
197 const void *test_data),
200 /* Convenience function that adds a test which only
201 * gets the test case data */
202 struct torture_test *torture_tcase_add_simple_test_const(
203 struct torture_tcase *tcase,
205 bool (*run) (struct torture_context *test,
206 const void *tcase_data));
208 /* Convenience wrapper that adds a test that doesn't need any
210 struct torture_tcase *torture_suite_add_simple_test(
211 struct torture_suite *suite,
213 bool (*run) (struct torture_context *test));
215 /* Add a child testsuite to an existing testsuite */
216 bool torture_suite_add_suite(struct torture_suite *suite,
217 struct torture_suite *child);
219 /* Run the specified testsuite recursively */
220 bool torture_run_suite(struct torture_context *context,
221 struct torture_suite *suite);
223 /* Run the specified testsuite recursively, but only the specified
225 bool torture_run_suite_restricted(struct torture_context *context,
226 struct torture_suite *suite, const char **restricted);
228 /* Run the specified testcase */
229 bool torture_run_tcase(struct torture_context *context,
230 struct torture_tcase *tcase);
232 bool torture_run_tcase_restricted(struct torture_context *context,
233 struct torture_tcase *tcase, const char **restricted);
235 /* Run the specified test */
236 bool torture_run_test(struct torture_context *context,
237 struct torture_tcase *tcase,
238 struct torture_test *test);
240 bool torture_run_test_restricted(struct torture_context *context,
241 struct torture_tcase *tcase,
242 struct torture_test *test,
243 const char **restricted);
245 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
246 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
247 void torture_result(struct torture_context *test,
248 enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
250 #define torture_assert(torture_ctx,expr,cmt) \
252 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
256 #define torture_assert_goto(torture_ctx,expr,ret,label,cmt) \
258 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
263 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
264 do { WERROR __got = got, __expected = expected; \
265 if (!W_ERROR_EQUAL(__got, __expected)) { \
266 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
271 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
272 do { NTSTATUS __got = got, __expected = expected; \
273 if (!NT_STATUS_EQUAL(__got, __expected)) { \
274 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
279 #define torture_assert_ntstatus_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
280 do { NTSTATUS __got = got, __expected = expected; \
281 if (!NT_STATUS_EQUAL(__got, __expected)) { \
282 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
288 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
289 do { enum ndr_err_code __got = got, __expected = expected; \
290 if (__got != __expected) { \
291 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, ndr_errstr(__got), __expected, __STRING(expected), cmt); \
296 #define torture_assert_hresult_equal(torture_ctx, got, expected, cmt) \
297 do { HRESULT __got = got, __expected = expected; \
298 if (!HRES_IS_EQUAL(__got, __expected)) { \
299 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", hresult_errstr(__got), hresult_errstr(__expected), cmt); \
304 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
305 do { const char *__got = (got), *__expected = (expected); \
306 if (!strequal(__got, __expected)) { \
307 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
312 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
313 do { const char *__got = (got), *__expected = (expected); \
314 if (strcmp_safe(__got, __expected) != 0) { \
315 torture_result(torture_ctx, TORTURE_FAIL, \
316 __location__": "#got" was %s, expected %s: %s", \
317 __got, __expected, cmt); \
322 #define torture_assert_strn_equal(torture_ctx,got,expected,len,cmt)\
323 do { const char *__got = (got), *__expected = (expected); \
324 if (strncmp(__got, __expected, len) != 0) { \
325 torture_result(torture_ctx, TORTURE_FAIL, \
326 __location__": "#got" %s of len %d did not match "#expected" %s: %s", \
327 __got, (int)len, __expected, cmt); \
332 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
333 do { const char *__got = (got), *__expected = (expected); \
334 if (strcmp_safe(__got, __expected) != 0) { \
335 torture_result(torture_ctx, TORTURE_FAIL, \
336 __location__": "#got" was %s, expected %s: %s", \
337 __got, __expected, cmt); \
343 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
344 do { const void *__got = (got), *__expected = (expected); \
345 if (memcmp(__got, __expected, len) != 0) { \
346 torture_result(torture_ctx, TORTURE_FAIL, \
347 __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
352 static inline void torture_dump_data_str_cb(const char *buf, void *private_data)
354 char **dump = (char **)private_data;
355 *dump = talloc_strdup_append_buffer(*dump, buf);
358 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
359 do { const DATA_BLOB __got = (got), __expected = (expected); \
360 if (__got.length != __expected.length) { \
361 torture_result(torture_ctx, TORTURE_FAIL, \
362 __location__": "#got".len %d did not match "#expected" len %d: %s", \
363 (int)__got.length, (int)__expected.length, cmt); \
366 if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
367 char *__dump = NULL; \
368 uint8_t __byte_a = 0x00;\
369 uint8_t __byte_b = 0x00;\
371 for (__i=0; __i < __expected.length; __i++) {\
372 __byte_a = __expected.data[__i];\
373 if (__i == __got.length) {\
377 __byte_b = __got.data[__i];\
378 if (__byte_a != __byte_b) {\
382 torture_warning(torture_ctx, "blobs differ at byte 0x%02X (%u)", __i, __i);\
383 torture_warning(torture_ctx, "expected byte[0x%02X] = 0x%02X got byte[0x%02X] = 0x%02X",\
384 __i, __byte_a, __i, __byte_b);\
385 __dump = talloc_strdup(torture_ctx, ""); \
386 dump_data_cb(__got.data, __got.length, true, \
387 torture_dump_data_str_cb, &__dump); \
388 torture_warning(torture_ctx, "got[0x%02X]: \n%s", \
389 (int)__got.length, __dump); \
390 TALLOC_FREE(__dump); \
391 __dump = talloc_strdup(torture_ctx, ""); \
392 dump_data_cb(__expected.data, __expected.length, true, \
393 torture_dump_data_str_cb, &__dump); \
394 torture_warning(torture_ctx, "expected[0x%02X]: \n%s", \
395 (int)__expected.length, __dump); \
396 TALLOC_FREE(__dump); \
397 torture_result(torture_ctx, TORTURE_FAIL, \
398 __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
403 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
406 const char *__expected = (expected); \
408 __got = file_load(filename, &__size, 0, torture_ctx); \
409 if (__got == NULL) { \
410 torture_result(torture_ctx, TORTURE_FAIL, \
411 __location__": unable to open %s: %s\n", \
416 if (strcmp_safe(__got, __expected) != 0) { \
417 torture_result(torture_ctx, TORTURE_FAIL, \
418 __location__": %s contained:\n%sExpected: %s%s\n", \
419 filename, __got, __expected, cmt); \
420 talloc_free(__got); \
423 talloc_free(__got); \
426 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
427 do { const char *__got, *__expected = (expected); \
429 __got = file_load(filename, *size, 0, torture_ctx); \
430 if (strcmp_safe(__got, __expected) != 0) { \
431 torture_result(torture_ctx, TORTURE_FAIL, \
432 __location__": %s contained:\n%sExpected: %s%s\n", \
433 __got, __expected, cmt); \
434 talloc_free(__got); \
437 talloc_free(__got); \
440 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
441 do { int __got = (got), __expected = (expected); \
442 if (__got != __expected) { \
443 torture_result(torture_ctx, TORTURE_FAIL, \
444 __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
445 __got, __got, __expected, __expected, cmt); \
450 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
451 do { int __got = (got), __expected = (expected); \
452 if (__got != __expected) { \
453 torture_result(torture_ctx, TORTURE_FAIL, \
454 __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
455 __got, __got, __expected, __expected, cmt); \
461 #define torture_assert_int_not_equal(torture_ctx,got,not_expected,cmt)\
462 do { int __got = (got), __not_expected = (not_expected); \
463 if (__got == __not_expected) { \
464 torture_result(torture_ctx, TORTURE_FAIL, \
465 __location__": "#got" was %d (0x%X), expected a different number: %s", \
466 __got, __got, cmt); \
471 #define torture_assert_int_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
472 do { int __got = (got), __not_expected = (not_expected); \
473 if (__got == __not_expected) { \
474 torture_result(torture_ctx, TORTURE_FAIL, \
475 __location__": "#got" was %d (0x%X), expected a different number: %s", \
476 __got, __got, cmt); \
482 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
483 do { uint64_t __got = (got), __expected = (expected); \
484 if (__got != __expected) { \
485 torture_result(torture_ctx, TORTURE_FAIL, \
486 __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
487 (unsigned long long)__got, (unsigned long long)__got, \
488 (unsigned long long)__expected, (unsigned long long)__expected, \
494 #define torture_assert_u64_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
495 do { uint64_t __got = (got), __expected = (expected); \
496 if (__got != __expected) { \
497 torture_result(torture_ctx, TORTURE_FAIL, \
498 __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
499 (unsigned long long)__got, (unsigned long long)__got, \
500 (unsigned long long)__expected, (unsigned long long)__expected, \
507 #define torture_assert_u64_not_equal(torture_ctx,got,not_expected,cmt)\
508 do { uint64_t __got = (got), __not_expected = (not_expected); \
509 if (__got == __not_expected) { \
510 torture_result(torture_ctx, TORTURE_FAIL, \
511 __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
512 (unsigned long long)__got, (unsigned long long)__got, \
518 #define torture_assert_u64_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
519 do { uint64_t __got = (got), __not_expected = (not_expected); \
520 if (__got == __not_expected) { \
521 torture_result(torture_ctx, TORTURE_FAIL, \
522 __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
523 (unsigned long long)__got, (unsigned long long)__got, \
530 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
531 do { int __expected = (expected); \
532 if (errno != __expected) { \
533 torture_result(torture_ctx, TORTURE_FAIL, \
534 __location__": errno was %d (%s), expected %d: %s: %s", \
535 errno, strerror(errno), __expected, \
536 strerror(__expected), cmt); \
541 #define torture_assert_guid_equal(torture_ctx,got,expected,cmt)\
542 do { struct GUID __got = (got), __expected = (expected); \
543 if (!GUID_equal(&__got, &__expected)) { \
544 torture_result(torture_ctx, TORTURE_FAIL, \
545 __location__": "#got" was %s, expected %s: %s", \
546 GUID_string(torture_ctx, &__got), GUID_string(torture_ctx, &__expected), cmt); \
551 #define torture_assert_nttime_equal(torture_ctx,got,expected,cmt) \
552 do { NTTIME __got = got, __expected = expected; \
553 if (!nt_time_equal(&__got, &__expected)) { \
554 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_time_string(tctx, __got), nt_time_string(tctx, __expected), cmt); \
559 #define torture_assert_sid_equal(torture_ctx,got,expected,cmt)\
560 do { struct dom_sid *__got = (got), *__expected = (expected); \
561 if (!dom_sid_equal(__got, __expected)) { \
562 torture_result(torture_ctx, TORTURE_FAIL, \
563 __location__": "#got" was %s, expected %s: %s", \
564 dom_sid_string(torture_ctx, __got), dom_sid_string(torture_ctx, __expected), cmt); \
569 #define torture_assert_not_null(torture_ctx,got,cmt)\
570 do { void *__got = (got); \
571 if (__got == NULL) { \
572 torture_result(torture_ctx, TORTURE_FAIL, \
573 __location__": "#got" was NULL, expected != NULL: %s", \
579 #define torture_assert_not_null_goto(torture_ctx,got,ret,label,cmt)\
580 do { void *__got = (got); \
581 if (__got == NULL) { \
582 torture_result(torture_ctx, TORTURE_FAIL, \
583 __location__": "#got" was NULL, expected != NULL: %s", \
590 #define torture_skip(torture_ctx,cmt) do {\
591 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
594 #define torture_skip_goto(torture_ctx,label,cmt) do {\
595 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
598 #define torture_fail(torture_ctx,cmt) do {\
599 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
602 #define torture_fail_goto(torture_ctx,label,cmt) do {\
603 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
607 #define torture_out stderr
609 /* Convenience macros */
610 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
611 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
613 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
614 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
616 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
617 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
619 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
620 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
622 #define torture_assert_hresult_ok(torture_ctx,expr,cmt) \
623 torture_assert_hresult_equal(torture_ctx,expr,HRES_ERROR(0), cmt)
625 /* Getting settings */
626 const char *torture_setting_string(struct torture_context *test, \
628 const char *default_value);
630 int torture_setting_int(struct torture_context *test,
634 double torture_setting_double(struct torture_context *test,
636 double default_value);
638 bool torture_setting_bool(struct torture_context *test,
642 struct torture_suite *torture_find_suite(struct torture_suite *parent,
645 unsigned long torture_setting_ulong(struct torture_context *test,
647 unsigned long default_value);
649 NTSTATUS torture_temp_dir(struct torture_context *tctx,
652 NTSTATUS torture_deltree_outputdir(struct torture_context *tctx);
654 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
656 bool (*run) (struct torture_context *test, void *tcase_data));
659 bool torture_suite_init_tcase(struct torture_suite *suite,
660 struct torture_tcase *tcase,
662 int torture_suite_children_count(const struct torture_suite *suite);
664 struct torture_context *torture_context_init(struct tevent_context *event_ctx, struct torture_results *results);
666 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
668 struct torture_context *torture_context_child(struct torture_context *tctx);
670 extern const struct torture_ui_ops torture_subunit_ui_ops;
671 extern const struct torture_ui_ops torture_simple_ui_ops;
673 #endif /* __TORTURE_UI_H__ */