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;
37 * These callbacks should be implemented by any backend that wishes
38 * to listen to reports from the torture tests.
42 void (*init) (struct torture_context *);
43 void (*comment) (struct torture_context *, const char *);
44 void (*warning) (struct torture_context *, const char *);
45 void (*suite_start) (struct torture_context *, struct torture_suite *);
46 void (*suite_finish) (struct torture_context *, struct torture_suite *);
47 void (*tcase_start) (struct torture_context *, struct torture_tcase *);
48 void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
49 void (*test_start) (struct torture_context *,
50 struct torture_tcase *,
51 struct torture_test *);
52 void (*test_result) (struct torture_context *,
53 enum torture_result, const char *reason);
56 void torture_ui_test_start(struct torture_context *context,
57 struct torture_tcase *tcase,
58 struct torture_test *test);
60 void torture_ui_test_result(struct torture_context *context,
61 enum torture_result result,
65 * Holds information about a specific run of the testsuite.
66 * The data in this structure should be considered private to
67 * the torture tests and should only be used directly by the torture
68 * code and the ui backends.
70 * Torture tests should instead call the torture_*() macros and functions
74 struct torture_context
76 const struct torture_ui_ops *ui_ops;
79 char *active_testname;
80 struct torture_test *active_test;
81 struct torture_tcase *active_tcase;
83 bool quiet; /* Whether tests should avoid writing output to stdout */
85 enum torture_result last_result;
90 const char *outputdir;
92 struct event_context *ev;
94 struct loadparm_context *lp_ctx;
98 * Describes a particular torture test
100 struct torture_test {
102 const char *description;
104 /* Function to call to run this test */
105 bool (*run) (struct torture_context *torture_ctx,
106 struct torture_tcase *tcase,
107 struct torture_test *test);
109 struct torture_test *prev, *next;
111 /* Pointer to the actual test function. This is run by the
112 * run() function above. */
118 * Describes a particular test case.
120 struct torture_tcase {
122 const char *description;
123 bool (*setup) (struct torture_context *tcase, void **data);
124 bool (*teardown) (struct torture_context *tcase, void *data);
125 bool fixture_persistent;
127 struct torture_test *tests;
128 struct torture_tcase *prev, *next;
134 const char *description;
135 struct torture_tcase *testcases;
136 struct torture_suite *children;
138 /* Pointers to siblings of this torture suite */
139 struct torture_suite *prev, *next;
142 /** Create a new torture suite */
143 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
146 /** Change the setup and teardown functions for a testcase */
147 void torture_tcase_set_fixture(struct torture_tcase *tcase,
148 bool (*setup) (struct torture_context *, void **),
149 bool (*teardown) (struct torture_context *, void *));
151 /* Add another test to run for a particular testcase */
152 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
154 bool (*run) (struct torture_context *test,
155 const void *tcase_data, const void *test_data),
156 const void *test_data);
158 /* Add a testcase to a testsuite */
159 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
162 /* Convenience wrapper that adds a testcase against only one
163 * test will be run */
164 struct torture_tcase *torture_suite_add_simple_tcase_const(
165 struct torture_suite *suite,
167 bool (*run) (struct torture_context *test,
168 const void *test_data),
171 /* Convenience function that adds a test which only
172 * gets the test case data */
173 struct torture_test *torture_tcase_add_simple_test_const(
174 struct torture_tcase *tcase,
176 bool (*run) (struct torture_context *test,
177 const void *tcase_data));
179 /* Convenience wrapper that adds a test that doesn't need any
181 struct torture_tcase *torture_suite_add_simple_test(
182 struct torture_suite *suite,
184 bool (*run) (struct torture_context *test));
186 /* Add a child testsuite to an existing testsuite */
187 bool torture_suite_add_suite(struct torture_suite *suite,
188 struct torture_suite *child);
190 /* Run the specified testsuite recursively */
191 bool torture_run_suite(struct torture_context *context,
192 struct torture_suite *suite);
194 /* Run the specified testcase */
195 bool torture_run_tcase(struct torture_context *context,
196 struct torture_tcase *tcase);
198 /* Run the specified test */
199 bool torture_run_test(struct torture_context *context,
200 struct torture_tcase *tcase,
201 struct torture_test *test);
203 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
204 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
205 void torture_result(struct torture_context *test,
206 enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
208 #define torture_assert(torture_ctx,expr,cmt) \
210 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
214 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
215 do { WERROR __got = got, __expected = expected; \
216 if (!W_ERROR_EQUAL(__got, __expected)) { \
217 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
222 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
223 do { NTSTATUS __got = got, __expected = expected; \
224 if (!NT_STATUS_EQUAL(__got, __expected)) { \
225 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
230 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
231 do { enum ndr_err_code __got = got, __expected = expected; \
232 if (__got != __expected) { \
233 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
238 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
239 do { const char *__got = (got), *__expected = (expected); \
240 if (!strequal(__got, __expected)) { \
241 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
246 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
247 do { const char *__got = (got), *__expected = (expected); \
248 if (strcmp_safe(__got, __expected) != 0) { \
249 torture_result(torture_ctx, TORTURE_FAIL, \
250 __location__": "#got" was %s, expected %s: %s", \
251 __got, __expected, cmt); \
256 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
257 do { const void *__got = (got), *__expected = (expected); \
258 if (memcmp(__got, __expected, len) != 0) { \
259 torture_result(torture_ctx, TORTURE_FAIL, \
260 __location__": "#got" of len %d did not match"#expected": %s", len, cmt); \
265 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
268 const char *__expected = (expected); \
270 __got = file_load(filename, &__size, torture_ctx); \
271 if (__got == NULL) { \
272 torture_result(torture_ctx, TORTURE_FAIL, \
273 __location__": unable to open %s: %s\n", \
278 if (strcmp_safe(__got, __expected) != 0) { \
279 torture_result(torture_ctx, TORTURE_FAIL, \
280 __location__": %s contained:\n%sExpected: %s%s\n", \
281 filename, __got, __expected, cmt); \
282 talloc_free(__got); \
285 talloc_free(__got); \
288 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
289 do { const char *__got, *__expected = (expected); \
291 __got = file_load(filename, *size, torture_ctx); \
292 if (strcmp_safe(__got, __expected) != 0) { \
293 torture_result(torture_ctx, TORTURE_FAIL, \
294 __location__": %s contained:\n%sExpected: %s%s\n", \
295 __got, __expected, cmt); \
296 talloc_free(__got); \
299 talloc_free(__got); \
302 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
303 do { int __got = (got), __expected = (expected); \
304 if (__got != __expected) { \
305 torture_result(torture_ctx, TORTURE_FAIL, \
306 __location__": "#got" was %d, expected %d: %s", \
307 __got, __expected, cmt); \
312 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
313 do { uint64_t __got = (got), __expected = (expected); \
314 if (__got != __expected) { \
315 torture_result(torture_ctx, TORTURE_FAIL, \
316 __location__": "#got" was %llu, expected %llu: %s", \
317 (unsigned long long)__got, (unsigned long long)__expected, cmt); \
322 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
323 do { int __expected = (expected); \
324 if (errno != __expected) { \
325 torture_result(torture_ctx, TORTURE_FAIL, \
326 __location__": errno was %d (%s), expected %d: %s: %s", \
327 errno, strerror(errno), __expected, \
328 strerror(__expected), cmt); \
335 #define torture_skip(torture_ctx,cmt) do {\
336 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
339 #define torture_fail(torture_ctx,cmt) do {\
340 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
343 #define torture_fail_goto(torture_ctx,label,cmt) do {\
344 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
348 #define torture_out stderr
350 /* Convenience macros */
351 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
352 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
354 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
355 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
357 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
358 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
360 /* Getting settings */
361 const char *torture_setting_string(struct torture_context *test, \
363 const char *default_value);
365 int torture_setting_int(struct torture_context *test,
369 double torture_setting_double(struct torture_context *test,
371 double default_value);
373 bool torture_setting_bool(struct torture_context *test,
377 struct torture_suite *torture_find_suite(struct torture_suite *parent,
380 NTSTATUS torture_temp_dir(struct torture_context *tctx,
384 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
386 bool (*run) (struct torture_context *test, void *tcase_data));
389 bool torture_suite_init_tcase(struct torture_suite *suite,
390 struct torture_tcase *tcase,
393 struct torture_context *torture_context_init(struct event_context *event_ctx,
394 const struct torture_ui_ops *ui_ops);
396 #endif /* __TORTURE_UI_H__ */