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
);
65 void torture_ui_test_start(struct torture_context
*context
,
66 struct torture_tcase
*tcase
,
67 struct torture_test
*test
);
69 void torture_ui_test_result(struct torture_context
*context
,
70 enum torture_result result
,
74 * Holds information about a specific run of the testsuite.
75 * The data in this structure should be considered private to
76 * the torture tests and should only be used directly by the torture
77 * code and the ui backends.
79 * Torture tests should instead call the torture_*() macros and functions
83 struct torture_context
85 struct torture_results
*results
;
87 char *active_testname
;
88 struct torture_test
*active_test
;
89 struct torture_tcase
*active_tcase
;
91 enum torture_result last_result
;
94 /** Directory used for temporary test data */
95 const char *outputdir
;
98 struct tevent_context
*ev
;
100 /** Loadparm context (will go away in favor of torture_setting_ at some point) */
101 struct loadparm_context
*lp_ctx
;
104 struct torture_results
106 const struct torture_ui_ops
*ui_ops
;
109 /** Whether tests should avoid writing output to stdout */
116 * Describes a particular torture test
118 struct torture_test
{
119 /** Short unique name for the test. */
122 /** Long description for the test. */
123 const char *description
;
125 /** Whether this is a dangerous test
126 * (can corrupt the remote servers data or bring it down). */
129 /** Function to call to run this test */
130 bool (*run
) (struct torture_context
*torture_ctx
,
131 struct torture_tcase
*tcase
,
132 struct torture_test
*test
);
134 struct torture_test
*prev
, *next
;
136 /** Pointer to the actual test function. This is run by the
137 * run() function above. */
140 /** Use data for this test */
145 * Describes a particular test case.
147 struct torture_tcase
{
149 const char *description
;
150 bool (*setup
) (struct torture_context
*tcase
, void **data
);
151 bool (*teardown
) (struct torture_context
*tcase
, void *data
);
152 bool fixture_persistent
;
154 struct torture_test
*tests
;
155 struct torture_tcase
*prev
, *next
;
161 const char *description
;
162 struct torture_tcase
*testcases
;
163 struct torture_suite
*children
;
165 /* Pointers to siblings of this torture suite */
166 struct torture_suite
*prev
, *next
;
169 /** Create a new torture suite */
170 struct torture_suite
*torture_suite_create(TALLOC_CTX
*mem_ctx
,
173 /** Change the setup and teardown functions for a testcase */
174 void torture_tcase_set_fixture(struct torture_tcase
*tcase
,
175 bool (*setup
) (struct torture_context
*, void **),
176 bool (*teardown
) (struct torture_context
*, void *));
178 /* Add another test to run for a particular testcase */
179 struct torture_test
*torture_tcase_add_test_const(struct torture_tcase
*tcase
,
181 bool (*run
) (struct torture_context
*test
,
182 const void *tcase_data
, const void *test_data
),
183 const void *test_data
);
185 /* Add a testcase to a testsuite */
186 struct torture_tcase
*torture_suite_add_tcase(struct torture_suite
*suite
,
189 /* Convenience wrapper that adds a testcase against only one
190 * test will be run */
191 struct torture_tcase
*torture_suite_add_simple_tcase_const(
192 struct torture_suite
*suite
,
194 bool (*run
) (struct torture_context
*test
,
195 const void *test_data
),
198 /* Convenience function that adds a test which only
199 * gets the test case data */
200 struct torture_test
*torture_tcase_add_simple_test_const(
201 struct torture_tcase
*tcase
,
203 bool (*run
) (struct torture_context
*test
,
204 const void *tcase_data
));
206 /* Convenience wrapper that adds a test that doesn't need any
208 struct torture_tcase
*torture_suite_add_simple_test(
209 struct torture_suite
*suite
,
211 bool (*run
) (struct torture_context
*test
));
213 /* Add a child testsuite to an existing testsuite */
214 bool torture_suite_add_suite(struct torture_suite
*suite
,
215 struct torture_suite
*child
);
217 /* Run the specified testsuite recursively */
218 bool torture_run_suite(struct torture_context
*context
,
219 struct torture_suite
*suite
);
221 /* Run the specified testsuite recursively, but only the specified
223 bool torture_run_suite_restricted(struct torture_context
*context
,
224 struct torture_suite
*suite
, const char **restricted
);
226 /* Run the specified testcase */
227 bool torture_run_tcase(struct torture_context
*context
,
228 struct torture_tcase
*tcase
);
230 /* Run the specified test */
231 bool torture_run_test(struct torture_context
*context
,
232 struct torture_tcase
*tcase
,
233 struct torture_test
*test
);
235 void torture_comment(struct torture_context
*test
, const char *comment
, ...) PRINTF_ATTRIBUTE(2,3);
236 void torture_warning(struct torture_context
*test
, const char *comment
, ...) PRINTF_ATTRIBUTE(2,3);
237 void torture_result(struct torture_context
*test
,
238 enum torture_result
, const char *reason
, ...) PRINTF_ATTRIBUTE(3,4);
240 #define torture_assert(torture_ctx,expr,cmt) \
242 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
246 #define torture_assert_goto(torture_ctx,expr,ret,label,cmt) \
248 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
253 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
254 do { WERROR __got = got, __expected = expected; \
255 if (!W_ERROR_EQUAL(__got, __expected)) { \
256 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
261 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
262 do { NTSTATUS __got = got, __expected = expected; \
263 if (!NT_STATUS_EQUAL(__got, __expected)) { \
264 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
269 #define torture_assert_ntstatus_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
270 do { NTSTATUS __got = got, __expected = expected; \
271 if (!NT_STATUS_EQUAL(__got, __expected)) { \
272 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
278 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
279 do { enum ndr_err_code __got = got, __expected = expected; \
280 if (__got != __expected) { \
281 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
286 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
287 do { const char *__got = (got), *__expected = (expected); \
288 if (!strequal(__got, __expected)) { \
289 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
294 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
295 do { const char *__got = (got), *__expected = (expected); \
296 if (strcmp_safe(__got, __expected) != 0) { \
297 torture_result(torture_ctx, TORTURE_FAIL, \
298 __location__": "#got" was %s, expected %s: %s", \
299 __got, __expected, cmt); \
304 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
305 do { const char *__got = (got), *__expected = (expected); \
306 if (strcmp_safe(__got, __expected) != 0) { \
307 torture_result(torture_ctx, TORTURE_FAIL, \
308 __location__": "#got" was %s, expected %s: %s", \
309 __got, __expected, cmt); \
315 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
316 do { const void *__got = (got), *__expected = (expected); \
317 if (memcmp(__got, __expected, len) != 0) { \
318 torture_result(torture_ctx, TORTURE_FAIL, \
319 __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
324 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
325 do { const DATA_BLOB __got = (got), __expected = (expected); \
326 if (__got.length != __expected.length) { \
327 torture_result(torture_ctx, TORTURE_FAIL, \
328 __location__": "#got".len %d did not match "#expected" len %d: %s", \
329 (int)__got.length, (int)__expected.length, cmt); \
332 if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
333 torture_result(torture_ctx, TORTURE_FAIL, \
334 __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
339 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
342 const char *__expected = (expected); \
344 __got = file_load(filename, &__size, 0, torture_ctx); \
345 if (__got == NULL) { \
346 torture_result(torture_ctx, TORTURE_FAIL, \
347 __location__": unable to open %s: %s\n", \
352 if (strcmp_safe(__got, __expected) != 0) { \
353 torture_result(torture_ctx, TORTURE_FAIL, \
354 __location__": %s contained:\n%sExpected: %s%s\n", \
355 filename, __got, __expected, cmt); \
356 talloc_free(__got); \
359 talloc_free(__got); \
362 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
363 do { const char *__got, *__expected = (expected); \
365 __got = file_load(filename, *size, 0, torture_ctx); \
366 if (strcmp_safe(__got, __expected) != 0) { \
367 torture_result(torture_ctx, TORTURE_FAIL, \
368 __location__": %s contained:\n%sExpected: %s%s\n", \
369 __got, __expected, cmt); \
370 talloc_free(__got); \
373 talloc_free(__got); \
376 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
377 do { int __got = (got), __expected = (expected); \
378 if (__got != __expected) { \
379 torture_result(torture_ctx, TORTURE_FAIL, \
380 __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
381 __got, __got, __expected, __expected, cmt); \
386 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
387 do { int __got = (got), __expected = (expected); \
388 if (__got != __expected) { \
389 torture_result(torture_ctx, TORTURE_FAIL, \
390 __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
391 __got, __got, __expected, __expected, cmt); \
397 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
398 do { uint64_t __got = (got), __expected = (expected); \
399 if (__got != __expected) { \
400 torture_result(torture_ctx, TORTURE_FAIL, \
401 __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
402 (unsigned long long)__got, (unsigned long long)__got, \
403 (unsigned long long)__expected, (unsigned long long)__expected, \
409 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
410 do { int __expected = (expected); \
411 if (errno != __expected) { \
412 torture_result(torture_ctx, TORTURE_FAIL, \
413 __location__": errno was %d (%s), expected %d: %s: %s", \
414 errno, strerror(errno), __expected, \
415 strerror(__expected), cmt); \
422 #define torture_skip(torture_ctx,cmt) do {\
423 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
426 #define torture_skip_goto(torture_ctx,label,cmt) do {\
427 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
430 #define torture_fail(torture_ctx,cmt) do {\
431 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
434 #define torture_fail_goto(torture_ctx,label,cmt) do {\
435 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
439 #define torture_out stderr
441 /* Convenience macros */
442 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
443 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
445 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
446 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
448 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
449 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
451 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
452 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
454 /* Getting settings */
455 const char *torture_setting_string(struct torture_context
*test
, \
457 const char *default_value
);
459 int torture_setting_int(struct torture_context
*test
,
463 double torture_setting_double(struct torture_context
*test
,
465 double default_value
);
467 bool torture_setting_bool(struct torture_context
*test
,
471 struct torture_suite
*torture_find_suite(struct torture_suite
*parent
,
474 unsigned long torture_setting_ulong(struct torture_context
*test
,
476 unsigned long default_value
);
478 NTSTATUS
torture_temp_dir(struct torture_context
*tctx
,
482 struct torture_test
*torture_tcase_add_simple_test(struct torture_tcase
*tcase
,
484 bool (*run
) (struct torture_context
*test
, void *tcase_data
));
487 bool torture_suite_init_tcase(struct torture_suite
*suite
,
488 struct torture_tcase
*tcase
,
490 int torture_suite_children_count(const struct torture_suite
*suite
);
492 struct torture_context
*torture_context_init(struct tevent_context
*event_ctx
, struct torture_results
*results
);
494 struct torture_results
*torture_results_init(TALLOC_CTX
*mem_ctx
, const struct torture_ui_ops
*ui_ops
);
496 struct torture_context
*torture_context_child(struct torture_context
*tctx
);
498 extern const struct torture_ui_ops torture_subunit_ui_ops
;
500 #endif /* __TORTURE_UI_H__ */