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
;
89 /** Indentation level */
93 struct event_context
*ev
;
95 /** Loadparm context (will go away in favor of torture_setting_ at some point) */
96 struct loadparm_context
*lp_ctx
;
99 struct torture_results
101 const struct torture_ui_ops
*ui_ops
;
104 /** Whether tests should avoid writing output to stdout */
111 * Describes a particular torture test
113 struct torture_test
{
114 /** Short unique name for the test. */
117 /** Long description for the test. */
118 const char *description
;
120 /** Whether this is a dangerous test
121 * (can corrupt the remote servers data or bring it down). */
124 /** Function to call to run this test */
125 bool (*run
) (struct torture_context
*torture_ctx
,
126 struct torture_tcase
*tcase
,
127 struct torture_test
*test
);
129 struct torture_test
*prev
, *next
;
131 /** Pointer to the actual test function. This is run by the
132 * run() function above. */
135 /** Use data for this test */
140 * Describes a particular test case.
142 struct torture_tcase
{
144 const char *description
;
145 bool (*setup
) (struct torture_context
*tcase
, void **data
);
146 bool (*teardown
) (struct torture_context
*tcase
, void *data
);
147 bool fixture_persistent
;
149 struct torture_test
*tests
;
150 struct torture_tcase
*prev
, *next
;
156 const char *description
;
157 struct torture_tcase
*testcases
;
158 struct torture_suite
*children
;
160 /* Pointers to siblings of this torture suite */
161 struct torture_suite
*prev
, *next
;
164 /** Create a new torture suite */
165 struct torture_suite
*torture_suite_create(TALLOC_CTX
*mem_ctx
,
168 /** Change the setup and teardown functions for a testcase */
169 void torture_tcase_set_fixture(struct torture_tcase
*tcase
,
170 bool (*setup
) (struct torture_context
*, void **),
171 bool (*teardown
) (struct torture_context
*, void *));
173 /* Add another test to run for a particular testcase */
174 struct torture_test
*torture_tcase_add_test_const(struct torture_tcase
*tcase
,
176 bool (*run
) (struct torture_context
*test
,
177 const void *tcase_data
, const void *test_data
),
178 const void *test_data
);
180 /* Add a testcase to a testsuite */
181 struct torture_tcase
*torture_suite_add_tcase(struct torture_suite
*suite
,
184 /* Convenience wrapper that adds a testcase against only one
185 * test will be run */
186 struct torture_tcase
*torture_suite_add_simple_tcase_const(
187 struct torture_suite
*suite
,
189 bool (*run
) (struct torture_context
*test
,
190 const void *test_data
),
193 /* Convenience function that adds a test which only
194 * gets the test case data */
195 struct torture_test
*torture_tcase_add_simple_test_const(
196 struct torture_tcase
*tcase
,
198 bool (*run
) (struct torture_context
*test
,
199 const void *tcase_data
));
201 /* Convenience wrapper that adds a test that doesn't need any
203 struct torture_tcase
*torture_suite_add_simple_test(
204 struct torture_suite
*suite
,
206 bool (*run
) (struct torture_context
*test
));
208 /* Add a child testsuite to an existing testsuite */
209 bool torture_suite_add_suite(struct torture_suite
*suite
,
210 struct torture_suite
*child
);
212 /* Run the specified testsuite recursively */
213 bool torture_run_suite(struct torture_context
*context
,
214 struct torture_suite
*suite
);
216 /* Run the specified testcase */
217 bool torture_run_tcase(struct torture_context
*context
,
218 struct torture_tcase
*tcase
);
220 /* Run the specified test */
221 bool torture_run_test(struct torture_context
*context
,
222 struct torture_tcase
*tcase
,
223 struct torture_test
*test
);
225 void torture_comment(struct torture_context
*test
, const char *comment
, ...) PRINTF_ATTRIBUTE(2,3);
226 void torture_warning(struct torture_context
*test
, const char *comment
, ...) PRINTF_ATTRIBUTE(2,3);
227 void torture_result(struct torture_context
*test
,
228 enum torture_result
, const char *reason
, ...) PRINTF_ATTRIBUTE(3,4);
230 #define torture_assert(torture_ctx,expr,cmt) \
232 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
236 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
237 do { WERROR __got = got, __expected = expected; \
238 if (!W_ERROR_EQUAL(__got, __expected)) { \
239 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
244 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
245 do { NTSTATUS __got = got, __expected = expected; \
246 if (!NT_STATUS_EQUAL(__got, __expected)) { \
247 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
252 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
253 do { enum ndr_err_code __got = got, __expected = expected; \
254 if (__got != __expected) { \
255 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
260 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
261 do { const char *__got = (got), *__expected = (expected); \
262 if (!strequal(__got, __expected)) { \
263 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
268 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
269 do { const char *__got = (got), *__expected = (expected); \
270 if (strcmp_safe(__got, __expected) != 0) { \
271 torture_result(torture_ctx, TORTURE_FAIL, \
272 __location__": "#got" was %s, expected %s: %s", \
273 __got, __expected, cmt); \
278 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
279 do { const void *__got = (got), *__expected = (expected); \
280 if (memcmp(__got, __expected, len) != 0) { \
281 torture_result(torture_ctx, TORTURE_FAIL, \
282 __location__": "#got" of len %d did not match"#expected": %s", (int)len, cmt); \
287 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
290 const char *__expected = (expected); \
292 __got = file_load(filename, &__size, 0, torture_ctx); \
293 if (__got == NULL) { \
294 torture_result(torture_ctx, TORTURE_FAIL, \
295 __location__": unable to open %s: %s\n", \
300 if (strcmp_safe(__got, __expected) != 0) { \
301 torture_result(torture_ctx, TORTURE_FAIL, \
302 __location__": %s contained:\n%sExpected: %s%s\n", \
303 filename, __got, __expected, cmt); \
304 talloc_free(__got); \
307 talloc_free(__got); \
310 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
311 do { const char *__got, *__expected = (expected); \
313 __got = file_load(filename, *size, 0, torture_ctx); \
314 if (strcmp_safe(__got, __expected) != 0) { \
315 torture_result(torture_ctx, TORTURE_FAIL, \
316 __location__": %s contained:\n%sExpected: %s%s\n", \
317 __got, __expected, cmt); \
318 talloc_free(__got); \
321 talloc_free(__got); \
324 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
325 do { int __got = (got), __expected = (expected); \
326 if (__got != __expected) { \
327 torture_result(torture_ctx, TORTURE_FAIL, \
328 __location__": "#got" was %d, expected %d: %s", \
329 __got, __expected, cmt); \
334 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
335 do { uint64_t __got = (got), __expected = (expected); \
336 if (__got != __expected) { \
337 torture_result(torture_ctx, TORTURE_FAIL, \
338 __location__": "#got" was %llu, expected %llu: %s", \
339 (unsigned long long)__got, (unsigned long long)__expected, cmt); \
344 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
345 do { int __expected = (expected); \
346 if (errno != __expected) { \
347 torture_result(torture_ctx, TORTURE_FAIL, \
348 __location__": errno was %d (%s), expected %d: %s: %s", \
349 errno, strerror(errno), __expected, \
350 strerror(__expected), cmt); \
357 #define torture_skip(torture_ctx,cmt) do {\
358 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
361 #define torture_fail(torture_ctx,cmt) do {\
362 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
365 #define torture_fail_goto(torture_ctx,label,cmt) do {\
366 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
370 #define torture_out stderr
372 /* Convenience macros */
373 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
374 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
376 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
377 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
379 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
380 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
382 /* Getting settings */
383 const char *torture_setting_string(struct torture_context
*test
, \
385 const char *default_value
);
387 int torture_setting_int(struct torture_context
*test
,
391 double torture_setting_double(struct torture_context
*test
,
393 double default_value
);
395 bool torture_setting_bool(struct torture_context
*test
,
399 struct torture_suite
*torture_find_suite(struct torture_suite
*parent
,
402 NTSTATUS
torture_temp_dir(struct torture_context
*tctx
,
406 struct torture_test
*torture_tcase_add_simple_test(struct torture_tcase
*tcase
,
408 bool (*run
) (struct torture_context
*test
, void *tcase_data
));
411 bool torture_suite_init_tcase(struct torture_suite
*suite
,
412 struct torture_tcase
*tcase
,
415 struct torture_context
*torture_context_init(struct event_context
*event_ctx
, struct torture_results
*results
);
417 struct torture_results
*torture_results_init(TALLOC_CTX
*mem_ctx
, const struct torture_ui_ops
*ui_ops
);
419 struct torture_context
*torture_context_child(struct torture_context
*tctx
);
421 extern const struct torture_ui_ops torture_subunit_ui_ops
;
423 #endif /* __TORTURE_UI_H__ */