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 testcase */
222 bool torture_run_tcase(struct torture_context *context,
223 struct torture_tcase *tcase);
225 /* Run the specified test */
226 bool torture_run_test(struct torture_context *context,
227 struct torture_tcase *tcase,
228 struct torture_test *test);
230 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
231 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
232 void torture_result(struct torture_context *test,
233 enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
235 #define torture_assert(torture_ctx,expr,cmt) \
237 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
241 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
242 do { WERROR __got = got, __expected = expected; \
243 if (!W_ERROR_EQUAL(__got, __expected)) { \
244 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
249 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
250 do { NTSTATUS __got = got, __expected = expected; \
251 if (!NT_STATUS_EQUAL(__got, __expected)) { \
252 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
257 #define torture_assert_ntstatus_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
258 do { NTSTATUS __got = got, __expected = expected; \
259 if (!NT_STATUS_EQUAL(__got, __expected)) { \
260 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
266 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
267 do { enum ndr_err_code __got = got, __expected = expected; \
268 if (__got != __expected) { \
269 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
274 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
275 do { const char *__got = (got), *__expected = (expected); \
276 if (!strequal(__got, __expected)) { \
277 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
282 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
283 do { const char *__got = (got), *__expected = (expected); \
284 if (strcmp_safe(__got, __expected) != 0) { \
285 torture_result(torture_ctx, TORTURE_FAIL, \
286 __location__": "#got" was %s, expected %s: %s", \
287 __got, __expected, cmt); \
292 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
293 do { const char *__got = (got), *__expected = (expected); \
294 if (strcmp_safe(__got, __expected) != 0) { \
295 torture_result(torture_ctx, TORTURE_FAIL, \
296 __location__": "#got" was %s, expected %s: %s", \
297 __got, __expected, cmt); \
303 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
304 do { const void *__got = (got), *__expected = (expected); \
305 if (memcmp(__got, __expected, len) != 0) { \
306 torture_result(torture_ctx, TORTURE_FAIL, \
307 __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
312 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
313 do { const DATA_BLOB __got = (got), __expected = (expected); \
314 if (__got.length != __expected.length) { \
315 torture_result(torture_ctx, TORTURE_FAIL, \
316 __location__": "#got".len %d did not match "#expected" len %d: %s", \
317 (int)__got.length, (int)__expected.length, cmt); \
320 if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
321 torture_result(torture_ctx, TORTURE_FAIL, \
322 __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
327 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
330 const char *__expected = (expected); \
332 __got = file_load(filename, &__size, 0, torture_ctx); \
333 if (__got == NULL) { \
334 torture_result(torture_ctx, TORTURE_FAIL, \
335 __location__": unable to open %s: %s\n", \
340 if (strcmp_safe(__got, __expected) != 0) { \
341 torture_result(torture_ctx, TORTURE_FAIL, \
342 __location__": %s contained:\n%sExpected: %s%s\n", \
343 filename, __got, __expected, cmt); \
344 talloc_free(__got); \
347 talloc_free(__got); \
350 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
351 do { const char *__got, *__expected = (expected); \
353 __got = file_load(filename, *size, 0, torture_ctx); \
354 if (strcmp_safe(__got, __expected) != 0) { \
355 torture_result(torture_ctx, TORTURE_FAIL, \
356 __location__": %s contained:\n%sExpected: %s%s\n", \
357 __got, __expected, cmt); \
358 talloc_free(__got); \
361 talloc_free(__got); \
364 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
365 do { int __got = (got), __expected = (expected); \
366 if (__got != __expected) { \
367 torture_result(torture_ctx, TORTURE_FAIL, \
368 __location__": "#got" was %d, expected %d: %s", \
369 __got, __expected, cmt); \
374 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
375 do { int __got = (got), __expected = (expected); \
376 if (__got != __expected) { \
377 torture_result(torture_ctx, TORTURE_FAIL, \
378 __location__": "#got" was %d, expected %d: %s", \
379 __got, __expected, cmt); \
385 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
386 do { uint64_t __got = (got), __expected = (expected); \
387 if (__got != __expected) { \
388 torture_result(torture_ctx, TORTURE_FAIL, \
389 __location__": "#got" was %llu, expected %llu: %s", \
390 (unsigned long long)__got, (unsigned long long)__expected, cmt); \
395 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
396 do { int __expected = (expected); \
397 if (errno != __expected) { \
398 torture_result(torture_ctx, TORTURE_FAIL, \
399 __location__": errno was %d (%s), expected %d: %s: %s", \
400 errno, strerror(errno), __expected, \
401 strerror(__expected), cmt); \
408 #define torture_skip(torture_ctx,cmt) do {\
409 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
412 #define torture_skip_goto(torture_ctx,label,cmt) do {\
413 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
416 #define torture_fail(torture_ctx,cmt) do {\
417 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
420 #define torture_fail_goto(torture_ctx,label,cmt) do {\
421 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
425 #define torture_out stderr
427 /* Convenience macros */
428 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
429 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
431 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
432 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
434 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
435 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
437 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
438 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
440 /* Getting settings */
441 const char *torture_setting_string(struct torture_context *test, \
443 const char *default_value);
445 int torture_setting_int(struct torture_context *test,
449 double torture_setting_double(struct torture_context *test,
451 double default_value);
453 bool torture_setting_bool(struct torture_context *test,
457 struct torture_suite *torture_find_suite(struct torture_suite *parent,
460 unsigned long torture_setting_ulong(struct torture_context *test,
462 unsigned long default_value);
464 NTSTATUS torture_temp_dir(struct torture_context *tctx,
468 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
470 bool (*run) (struct torture_context *test, void *tcase_data));
473 bool torture_suite_init_tcase(struct torture_suite *suite,
474 struct torture_tcase *tcase,
476 int torture_suite_children_count(const struct torture_suite *suite);
478 struct torture_context *torture_context_init(struct tevent_context *event_ctx, struct torture_results *results);
480 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
482 struct torture_context *torture_context_child(struct torture_context *tctx);
484 extern const struct torture_ui_ops torture_subunit_ui_ops;
486 #endif /* __TORTURE_UI_H__ */