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;
38 * These callbacks should be implemented by any backend that wishes
39 * to listen to reports from the torture tests.
43 void (*init) (struct torture_results *);
44 void (*comment) (struct torture_context *, const char *);
45 void (*warning) (struct torture_context *, const char *);
46 void (*suite_start) (struct torture_context *, struct torture_suite *);
47 void (*suite_finish) (struct torture_context *, struct torture_suite *);
48 void (*tcase_start) (struct torture_context *, struct torture_tcase *);
49 void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
50 void (*test_start) (struct torture_context *,
51 struct torture_tcase *,
52 struct torture_test *);
53 void (*test_result) (struct torture_context *,
54 enum torture_result, const char *reason);
57 void torture_ui_test_start(struct torture_context *context,
58 struct torture_tcase *tcase,
59 struct torture_test *test);
61 void torture_ui_test_result(struct torture_context *context,
62 enum torture_result result,
66 * Holds information about a specific run of the testsuite.
67 * The data in this structure should be considered private to
68 * the torture tests and should only be used directly by the torture
69 * code and the ui backends.
71 * Torture tests should instead call the torture_*() macros and functions
75 struct torture_context
77 struct torture_results *results;
79 char *active_testname;
80 struct torture_test *active_test;
81 struct torture_tcase *active_tcase;
83 enum torture_result last_result;
86 /** Directory used for temporary test data */
87 const char *outputdir;
90 struct tevent_context *ev;
92 /** Loadparm context (will go away in favor of torture_setting_ at some point) */
93 struct loadparm_context *lp_ctx;
96 struct torture_results
98 const struct torture_ui_ops *ui_ops;
101 /** Whether tests should avoid writing output to stdout */
108 * Describes a particular torture test
110 struct torture_test {
111 /** Short unique name for the test. */
114 /** Long description for the test. */
115 const char *description;
117 /** Whether this is a dangerous test
118 * (can corrupt the remote servers data or bring it down). */
121 /** Function to call to run this test */
122 bool (*run) (struct torture_context *torture_ctx,
123 struct torture_tcase *tcase,
124 struct torture_test *test);
126 struct torture_test *prev, *next;
128 /** Pointer to the actual test function. This is run by the
129 * run() function above. */
132 /** Use data for this test */
137 * Describes a particular test case.
139 struct torture_tcase {
141 const char *description;
142 bool (*setup) (struct torture_context *tcase, void **data);
143 bool (*teardown) (struct torture_context *tcase, void *data);
144 bool fixture_persistent;
146 struct torture_test *tests;
147 struct torture_tcase *prev, *next;
153 const char *description;
154 struct torture_tcase *testcases;
155 struct torture_suite *children;
157 /* Pointers to siblings of this torture suite */
158 struct torture_suite *prev, *next;
161 /** Create a new torture suite */
162 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
165 /** Change the setup and teardown functions for a testcase */
166 void torture_tcase_set_fixture(struct torture_tcase *tcase,
167 bool (*setup) (struct torture_context *, void **),
168 bool (*teardown) (struct torture_context *, void *));
170 /* Add another test to run for a particular testcase */
171 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
173 bool (*run) (struct torture_context *test,
174 const void *tcase_data, const void *test_data),
175 const void *test_data);
177 /* Add a testcase to a testsuite */
178 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
181 /* Convenience wrapper that adds a testcase against only one
182 * test will be run */
183 struct torture_tcase *torture_suite_add_simple_tcase_const(
184 struct torture_suite *suite,
186 bool (*run) (struct torture_context *test,
187 const void *test_data),
190 /* Convenience function that adds a test which only
191 * gets the test case data */
192 struct torture_test *torture_tcase_add_simple_test_const(
193 struct torture_tcase *tcase,
195 bool (*run) (struct torture_context *test,
196 const void *tcase_data));
198 /* Convenience wrapper that adds a test that doesn't need any
200 struct torture_tcase *torture_suite_add_simple_test(
201 struct torture_suite *suite,
203 bool (*run) (struct torture_context *test));
205 /* Add a child testsuite to an existing testsuite */
206 bool torture_suite_add_suite(struct torture_suite *suite,
207 struct torture_suite *child);
209 /* Run the specified testsuite recursively */
210 bool torture_run_suite(struct torture_context *context,
211 struct torture_suite *suite);
213 /* Run the specified testcase */
214 bool torture_run_tcase(struct torture_context *context,
215 struct torture_tcase *tcase);
217 /* Run the specified test */
218 bool torture_run_test(struct torture_context *context,
219 struct torture_tcase *tcase,
220 struct torture_test *test);
222 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
223 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
224 void torture_result(struct torture_context *test,
225 enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
227 #define torture_assert(torture_ctx,expr,cmt) \
229 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
233 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
234 do { WERROR __got = got, __expected = expected; \
235 if (!W_ERROR_EQUAL(__got, __expected)) { \
236 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
241 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
242 do { NTSTATUS __got = got, __expected = expected; \
243 if (!NT_STATUS_EQUAL(__got, __expected)) { \
244 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
249 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
250 do { enum ndr_err_code __got = got, __expected = expected; \
251 if (__got != __expected) { \
252 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
257 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
258 do { const char *__got = (got), *__expected = (expected); \
259 if (!strequal(__got, __expected)) { \
260 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
265 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
266 do { const char *__got = (got), *__expected = (expected); \
267 if (strcmp_safe(__got, __expected) != 0) { \
268 torture_result(torture_ctx, TORTURE_FAIL, \
269 __location__": "#got" was %s, expected %s: %s", \
270 __got, __expected, cmt); \
275 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
276 do { const void *__got = (got), *__expected = (expected); \
277 if (memcmp(__got, __expected, len) != 0) { \
278 torture_result(torture_ctx, TORTURE_FAIL, \
279 __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
284 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
285 do { const DATA_BLOB __got = (got), __expected = (expected); \
286 if (__got.length != __expected.length) { \
287 torture_result(torture_ctx, TORTURE_FAIL, \
288 __location__": "#got".len %d did not match "#expected" len %d: %s", \
289 (int)__got.length, (int)__expected.length, cmt); \
292 if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
293 torture_result(torture_ctx, TORTURE_FAIL, \
294 __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
299 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
302 const char *__expected = (expected); \
304 __got = file_load(filename, &__size, 0, torture_ctx); \
305 if (__got == NULL) { \
306 torture_result(torture_ctx, TORTURE_FAIL, \
307 __location__": unable to open %s: %s\n", \
312 if (strcmp_safe(__got, __expected) != 0) { \
313 torture_result(torture_ctx, TORTURE_FAIL, \
314 __location__": %s contained:\n%sExpected: %s%s\n", \
315 filename, __got, __expected, cmt); \
316 talloc_free(__got); \
319 talloc_free(__got); \
322 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
323 do { const char *__got, *__expected = (expected); \
325 __got = file_load(filename, *size, 0, torture_ctx); \
326 if (strcmp_safe(__got, __expected) != 0) { \
327 torture_result(torture_ctx, TORTURE_FAIL, \
328 __location__": %s contained:\n%sExpected: %s%s\n", \
329 __got, __expected, cmt); \
330 talloc_free(__got); \
333 talloc_free(__got); \
336 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
337 do { int __got = (got), __expected = (expected); \
338 if (__got != __expected) { \
339 torture_result(torture_ctx, TORTURE_FAIL, \
340 __location__": "#got" was %d, expected %d: %s", \
341 __got, __expected, cmt); \
346 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
347 do { uint64_t __got = (got), __expected = (expected); \
348 if (__got != __expected) { \
349 torture_result(torture_ctx, TORTURE_FAIL, \
350 __location__": "#got" was %llu, expected %llu: %s", \
351 (unsigned long long)__got, (unsigned long long)__expected, cmt); \
356 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
357 do { int __expected = (expected); \
358 if (errno != __expected) { \
359 torture_result(torture_ctx, TORTURE_FAIL, \
360 __location__": errno was %d (%s), expected %d: %s: %s", \
361 errno, strerror(errno), __expected, \
362 strerror(__expected), cmt); \
369 #define torture_skip(torture_ctx,cmt) do {\
370 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
373 #define torture_fail(torture_ctx,cmt) do {\
374 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
377 #define torture_fail_goto(torture_ctx,label,cmt) do {\
378 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
382 #define torture_out stderr
384 /* Convenience macros */
385 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
386 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
388 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
389 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
391 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
392 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
394 /* Getting settings */
395 const char *torture_setting_string(struct torture_context *test, \
397 const char *default_value);
399 int torture_setting_int(struct torture_context *test,
403 double torture_setting_double(struct torture_context *test,
405 double default_value);
407 bool torture_setting_bool(struct torture_context *test,
411 struct torture_suite *torture_find_suite(struct torture_suite *parent,
414 NTSTATUS torture_temp_dir(struct torture_context *tctx,
418 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
420 bool (*run) (struct torture_context *test, void *tcase_data));
423 bool torture_suite_init_tcase(struct torture_suite *suite,
424 struct torture_tcase *tcase,
427 struct torture_context *torture_context_init(struct tevent_context *event_ctx, struct torture_results *results);
429 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
431 struct torture_context *torture_context_child(struct torture_context *tctx);
433 extern const struct torture_ui_ops torture_subunit_ui_ops;
435 #endif /* __TORTURE_UI_H__ */