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;
96 * Describes a particular torture test
100 const char *description;
102 /* Function to call to run this test */
103 bool (*run) (struct torture_context *torture_ctx,
104 struct torture_tcase *tcase,
105 struct torture_test *test);
107 struct torture_test *prev, *next;
109 /* Pointer to the actual test function. This is run by the
110 * run() function above. */
116 * Describes a particular test case.
118 struct torture_tcase {
120 const char *description;
121 bool (*setup) (struct torture_context *tcase, void **data);
122 bool (*teardown) (struct torture_context *tcase, void *data);
123 bool fixture_persistent;
125 struct torture_test *tests;
126 struct torture_tcase *prev, *next;
132 const char *description;
133 struct torture_tcase *testcases;
134 struct torture_suite *children;
136 /* Pointers to siblings of this torture suite */
137 struct torture_suite *prev, *next;
140 /** Create a new torture suite */
141 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
144 /** Change the setup and teardown functions for a testcase */
145 void torture_tcase_set_fixture(struct torture_tcase *tcase,
146 bool (*setup) (struct torture_context *, void **),
147 bool (*teardown) (struct torture_context *, void *));
149 /* Add another test to run for a particular testcase */
150 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
152 bool (*run) (struct torture_context *test, const void *tcase_data,
153 const void *test_data),
154 const void *test_data);
156 /* Add a testcase to a testsuite */
157 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
160 /* Convenience wrapper that adds a testcase against only one
161 * test will be run */
162 struct torture_tcase *torture_suite_add_simple_tcase(
163 struct torture_suite *suite,
165 bool (*run) (struct torture_context *test, const void *test_data),
168 /* Convenience function that adds a test which only
169 * gets the test case data */
170 struct torture_test *torture_tcase_add_simple_test(
171 struct torture_tcase *tcase,
173 bool (*run) (struct torture_context *test, const void *tcase_data));
175 /* Convenience wrapper that adds a test that doesn't need any
177 struct torture_tcase *torture_suite_add_simple_test(
178 struct torture_suite *suite,
180 bool (*run) (struct torture_context *test));
182 /* Add a child testsuite to an existing testsuite */
183 bool torture_suite_add_suite(struct torture_suite *suite,
184 struct torture_suite *child);
186 /* Run the specified testsuite recursively */
187 bool torture_run_suite(struct torture_context *context,
188 struct torture_suite *suite);
190 /* Run the specified testcase */
191 bool torture_run_tcase(struct torture_context *context,
192 struct torture_tcase *tcase);
194 /* Run the specified test */
195 bool torture_run_test(struct torture_context *context,
196 struct torture_tcase *tcase,
197 struct torture_test *test);
199 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
200 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
201 void torture_result(struct torture_context *test,
202 enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
204 #define torture_assert(torture_ctx,expr,cmt) \
206 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
210 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
211 do { WERROR __got = got, __expected = expected; \
212 if (!W_ERROR_EQUAL(__got, __expected)) { \
213 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
218 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
219 do { NTSTATUS __got = got, __expected = expected; \
220 if (!NT_STATUS_EQUAL(__got, __expected)) { \
221 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
227 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
228 do { const char *__got = (got), *__expected = (expected); \
229 if (!strequal(__got, __expected)) { \
230 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
235 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
236 do { const char *__got = (got), *__expected = (expected); \
237 if (strcmp_safe(__got, __expected) != 0) { \
238 torture_result(torture_ctx, TORTURE_FAIL, \
239 __location__": "#got" was %s, expected %s: %s", \
240 __got, __expected, cmt); \
245 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
248 const char *__expected = (expected); \
250 __got = file_load(filename, &__size, torture_ctx); \
251 if (__got == NULL) { \
252 torture_result(torture_ctx, TORTURE_FAIL, \
253 __location__": unable to open %s: %s\n", \
258 if (strcmp_safe(__got, __expected) != 0) { \
259 torture_result(torture_ctx, TORTURE_FAIL, \
260 __location__": %s contained:\n%sExpected: %s%s\n", \
261 filename, __got, __expected, cmt); \
262 talloc_free(__got); \
265 talloc_free(__got); \
268 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
269 do { const char *__got, *__expected = (expected); \
271 __got = file_load(filename, *size, torture_ctx); \
272 if (strcmp_safe(__got, __expected) != 0) { \
273 torture_result(torture_ctx, TORTURE_FAIL, \
274 __location__": %s contained:\n%sExpected: %s%s\n", \
275 __got, __expected, cmt); \
276 talloc_free(__got); \
279 talloc_free(__got); \
282 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
283 do { int __got = (got), __expected = (expected); \
284 if (__got != __expected) { \
285 torture_result(torture_ctx, TORTURE_FAIL, \
286 __location__": "#got" was %d, expected %d: %s", \
287 __got, __expected, cmt); \
292 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
293 do { uint64_t __got = (got), __expected = (expected); \
294 if (__got != __expected) { \
295 torture_result(torture_ctx, TORTURE_FAIL, \
296 __location__": "#got" was %llu, expected %llu: %s", \
297 (unsigned long long)__got, (unsigned long long)__expected, cmt); \
302 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
303 do { int __expected = (expected); \
304 if (errno != __expected) { \
305 torture_result(torture_ctx, TORTURE_FAIL, \
306 __location__": errno was %d (%s), expected %d: %s: %s", \
307 errno, strerror(errno), __expected, \
308 strerror(__expected), cmt); \
315 #define torture_skip(torture_ctx,cmt) do {\
316 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
319 #define torture_fail(torture_ctx,cmt) do {\
320 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
323 #define torture_fail_goto(torture_ctx,label,cmt) do {\
324 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
328 #define torture_out stderr
330 /* Convenience macros */
331 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
332 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
334 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
335 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
337 /* Getting settings */
338 const char *torture_setting_string(struct torture_context *test, \
340 const char *default_value);
342 int torture_setting_int(struct torture_context *test,
346 double torture_setting_double(struct torture_context *test,
348 double default_value);
350 bool torture_setting_bool(struct torture_context *test,
354 struct torture_suite *torture_find_suite(struct torture_suite *parent,
358 #endif /* __TORTURE_UI_H__ */