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_krb5_error_equal(torture_ctx, got, expected, cmt) \
305 do { krb5_error_code __got = got, __expected = expected; \
306 if (__got != __expected) { \
307 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, error_message(__got), __expected, error_message(__expected), cmt); \
312 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
313 do { const char *__got = (got), *__expected = (expected); \
314 if (!strequal(__got, __expected)) { \
315 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
320 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
321 do { const char *__got = (got), *__expected = (expected); \
322 if (strcmp_safe(__got, __expected) != 0) { \
323 torture_result(torture_ctx, TORTURE_FAIL, \
324 __location__": "#got" was %s, expected %s: %s", \
325 __got, __expected, cmt); \
330 #define torture_assert_strn_equal(torture_ctx,got,expected,len,cmt)\
331 do { const char *__got = (got), *__expected = (expected); \
332 if (strncmp(__got, __expected, len) != 0) { \
333 torture_result(torture_ctx, TORTURE_FAIL, \
334 __location__": "#got" %s of len %d did not match "#expected" %s: %s", \
335 __got, (int)len, __expected, cmt); \
340 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
341 do { const char *__got = (got), *__expected = (expected); \
342 if (strcmp_safe(__got, __expected) != 0) { \
343 torture_result(torture_ctx, TORTURE_FAIL, \
344 __location__": "#got" was %s, expected %s: %s", \
345 __got, __expected, cmt); \
351 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
352 do { const void *__got = (got), *__expected = (expected); \
353 if (memcmp(__got, __expected, len) != 0) { \
354 torture_result(torture_ctx, TORTURE_FAIL, \
355 __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
360 static inline void torture_dump_data_str_cb(const char *buf
, void *private_data
)
362 char **dump
= (char **)private_data
;
363 *dump
= talloc_strdup_append_buffer(*dump
, buf
);
366 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
367 do { const DATA_BLOB __got = (got), __expected = (expected); \
368 if (__got.length != __expected.length) { \
369 torture_result(torture_ctx, TORTURE_FAIL, \
370 __location__": "#got".len %d did not match "#expected" len %d: %s", \
371 (int)__got.length, (int)__expected.length, cmt); \
374 if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
375 char *__dump = NULL; \
376 uint8_t __byte_a = 0x00;\
377 uint8_t __byte_b = 0x00;\
379 for (__i=0; __i < __expected.length; __i++) {\
380 __byte_a = __expected.data[__i];\
381 if (__i == __got.length) {\
385 __byte_b = __got.data[__i];\
386 if (__byte_a != __byte_b) {\
390 torture_warning(torture_ctx, "blobs differ at byte 0x%02X (%u)", __i, __i);\
391 torture_warning(torture_ctx, "expected byte[0x%02X] = 0x%02X got byte[0x%02X] = 0x%02X",\
392 __i, __byte_a, __i, __byte_b);\
393 __dump = talloc_strdup(torture_ctx, ""); \
394 dump_data_cb(__got.data, __got.length, true, \
395 torture_dump_data_str_cb, &__dump); \
396 torture_warning(torture_ctx, "got[0x%02X]: \n%s", \
397 (int)__got.length, __dump); \
398 TALLOC_FREE(__dump); \
399 __dump = talloc_strdup(torture_ctx, ""); \
400 dump_data_cb(__expected.data, __expected.length, true, \
401 torture_dump_data_str_cb, &__dump); \
402 torture_warning(torture_ctx, "expected[0x%02X]: \n%s", \
403 (int)__expected.length, __dump); \
404 TALLOC_FREE(__dump); \
405 torture_result(torture_ctx, TORTURE_FAIL, \
406 __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
411 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
414 const char *__expected = (expected); \
416 __got = file_load(filename, &__size, 0, torture_ctx); \
417 if (__got == NULL) { \
418 torture_result(torture_ctx, TORTURE_FAIL, \
419 __location__": unable to open %s: %s\n", \
424 if (strcmp_safe(__got, __expected) != 0) { \
425 torture_result(torture_ctx, TORTURE_FAIL, \
426 __location__": %s contained:\n%sExpected: %s%s\n", \
427 filename, __got, __expected, cmt); \
428 talloc_free(__got); \
431 talloc_free(__got); \
434 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
435 do { const char *__got, *__expected = (expected); \
437 __got = file_load(filename, *size, 0, torture_ctx); \
438 if (strcmp_safe(__got, __expected) != 0) { \
439 torture_result(torture_ctx, TORTURE_FAIL, \
440 __location__": %s contained:\n%sExpected: %s%s\n", \
441 __got, __expected, cmt); \
442 talloc_free(__got); \
445 talloc_free(__got); \
448 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
449 do { int __got = (got), __expected = (expected); \
450 if (__got != __expected) { \
451 torture_result(torture_ctx, TORTURE_FAIL, \
452 __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
453 __got, __got, __expected, __expected, cmt); \
458 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
459 do { int __got = (got), __expected = (expected); \
460 if (__got != __expected) { \
461 torture_result(torture_ctx, TORTURE_FAIL, \
462 __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
463 __got, __got, __expected, __expected, cmt); \
469 #define torture_assert_int_not_equal(torture_ctx,got,not_expected,cmt)\
470 do { int __got = (got), __not_expected = (not_expected); \
471 if (__got == __not_expected) { \
472 torture_result(torture_ctx, TORTURE_FAIL, \
473 __location__": "#got" was %d (0x%X), expected a different number: %s", \
474 __got, __got, cmt); \
479 #define torture_assert_int_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
480 do { int __got = (got), __not_expected = (not_expected); \
481 if (__got == __not_expected) { \
482 torture_result(torture_ctx, TORTURE_FAIL, \
483 __location__": "#got" was %d (0x%X), expected a different number: %s", \
484 __got, __got, cmt); \
490 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
491 do { uint64_t __got = (got), __expected = (expected); \
492 if (__got != __expected) { \
493 torture_result(torture_ctx, TORTURE_FAIL, \
494 __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
495 (unsigned long long)__got, (unsigned long long)__got, \
496 (unsigned long long)__expected, (unsigned long long)__expected, \
502 #define torture_assert_u64_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
503 do { uint64_t __got = (got), __expected = (expected); \
504 if (__got != __expected) { \
505 torture_result(torture_ctx, TORTURE_FAIL, \
506 __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
507 (unsigned long long)__got, (unsigned long long)__got, \
508 (unsigned long long)__expected, (unsigned long long)__expected, \
515 #define torture_assert_u64_not_equal(torture_ctx,got,not_expected,cmt)\
516 do { uint64_t __got = (got), __not_expected = (not_expected); \
517 if (__got == __not_expected) { \
518 torture_result(torture_ctx, TORTURE_FAIL, \
519 __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
520 (unsigned long long)__got, (unsigned long long)__got, \
526 #define torture_assert_u64_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
527 do { uint64_t __got = (got), __not_expected = (not_expected); \
528 if (__got == __not_expected) { \
529 torture_result(torture_ctx, TORTURE_FAIL, \
530 __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
531 (unsigned long long)__got, (unsigned long long)__got, \
538 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
539 do { int __expected = (expected); \
540 if (errno != __expected) { \
541 torture_result(torture_ctx, TORTURE_FAIL, \
542 __location__": errno was %d (%s), expected %d: %s: %s", \
543 errno, strerror(errno), __expected, \
544 strerror(__expected), cmt); \
549 #define torture_assert_guid_equal(torture_ctx,got,expected,cmt)\
550 do {const struct GUID __got = (got), __expected = (expected); \
551 if (!GUID_equal(&__got, &__expected)) { \
552 torture_result(torture_ctx, TORTURE_FAIL, \
553 __location__": "#got" was %s, expected %s: %s", \
554 GUID_string(torture_ctx, &__got), GUID_string(torture_ctx, &__expected), cmt); \
559 #define torture_assert_nttime_equal(torture_ctx,got,expected,cmt) \
560 do { NTTIME __got = got, __expected = expected; \
561 if (!nt_time_equal(&__got, &__expected)) { \
562 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_time_string(tctx, __got), nt_time_string(tctx, __expected), cmt); \
567 #define torture_assert_sid_equal(torture_ctx,got,expected,cmt)\
568 do {const struct dom_sid *__got = (got), *__expected = (expected); \
569 if (!dom_sid_equal(__got, __expected)) { \
570 torture_result(torture_ctx, TORTURE_FAIL, \
571 __location__": "#got" was %s, expected %s: %s", \
572 dom_sid_string(torture_ctx, __got), dom_sid_string(torture_ctx, __expected), cmt); \
577 #define torture_assert_not_null(torture_ctx,got,cmt)\
578 do {const void *__got = (got); \
579 if (__got == NULL) { \
580 torture_result(torture_ctx, TORTURE_FAIL, \
581 __location__": "#got" was NULL, expected != NULL: %s", \
587 #define torture_assert_not_null_goto(torture_ctx,got,ret,label,cmt)\
588 do {const void *__got = (got); \
589 if (__got == NULL) { \
590 torture_result(torture_ctx, TORTURE_FAIL, \
591 __location__": "#got" was NULL, expected != NULL: %s", \
598 #define torture_skip(torture_ctx,cmt) do {\
599 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
602 #define torture_skip_goto(torture_ctx,label,cmt) do {\
603 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
606 #define torture_fail(torture_ctx,cmt) do {\
607 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
610 #define torture_fail_goto(torture_ctx,label,cmt) do {\
611 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
615 #define torture_out stderr
617 /* Convenience macros */
618 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
619 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
621 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
622 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
624 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
625 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
627 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
628 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
630 #define torture_assert_hresult_ok(torture_ctx,expr,cmt) \
631 torture_assert_hresult_equal(torture_ctx,expr,HRES_ERROR(0), cmt)
633 /* Getting settings */
634 const char *torture_setting_string(struct torture_context
*test
, \
636 const char *default_value
);
638 int torture_setting_int(struct torture_context
*test
,
642 double torture_setting_double(struct torture_context
*test
,
644 double default_value
);
646 bool torture_setting_bool(struct torture_context
*test
,
650 struct torture_suite
*torture_find_suite(struct torture_suite
*parent
,
653 unsigned long torture_setting_ulong(struct torture_context
*test
,
655 unsigned long default_value
);
657 NTSTATUS
torture_temp_dir(struct torture_context
*tctx
,
660 NTSTATUS
torture_deltree_outputdir(struct torture_context
*tctx
);
662 struct torture_test
*torture_tcase_add_simple_test(struct torture_tcase
*tcase
,
664 bool (*run
) (struct torture_context
*test
, void *tcase_data
));
667 bool torture_suite_init_tcase(struct torture_suite
*suite
,
668 struct torture_tcase
*tcase
,
670 int torture_suite_children_count(const struct torture_suite
*suite
);
672 struct torture_context
*torture_context_init(struct tevent_context
*event_ctx
, struct torture_results
*results
);
674 struct torture_results
*torture_results_init(TALLOC_CTX
*mem_ctx
, const struct torture_ui_ops
*ui_ops
);
676 struct torture_context
*torture_context_child(struct torture_context
*tctx
);
678 extern const struct torture_ui_ops torture_subunit_ui_ops
;
679 extern const struct torture_ui_ops torture_simple_ui_ops
;
681 #endif /* __TORTURE_UI_H__ */