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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #ifndef __TORTURE_UI_H__
23 #define __TORTURE_UI_H__
26 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 (*comment) (struct torture_context *, const char *);
43 void (*suite_start) (struct torture_context *, struct torture_suite *);
44 void (*suite_finish) (struct torture_context *, struct torture_suite *);
45 void (*tcase_start) (struct torture_context *, struct torture_tcase *);
46 void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
47 void (*test_start) (struct torture_context *,
48 struct torture_tcase *,
49 struct torture_test *);
50 void (*test_result) (struct torture_context *,
51 enum torture_result, const char *reason);
54 void torture_ui_test_start(struct torture_context *context,
55 struct torture_tcase *tcase,
56 struct torture_test *test);
58 void torture_ui_test_result(struct torture_context *context,
59 enum torture_result result,
63 * Holds information about a specific run of the testsuite.
64 * The data in this structure should be considered private to
65 * the torture tests and should only be used directly by the torture
66 * code and the ui backends.
68 * Torture tests should instead call the torture_*() macros and functions
72 struct torture_context
74 const struct torture_ui_ops *ui_ops;
77 struct torture_test *active_test;
78 struct torture_tcase *active_tcase;
85 bool quiet; /* Whether tests should avoid writing output to stdout */
87 enum torture_result last_result;
95 * Describes a particular torture test
99 const char *description;
101 /* Function to call to run this test */
102 bool (*run) (struct torture_context *torture_ctx,
103 struct torture_tcase *tcase,
104 struct torture_test *test);
106 struct torture_test *prev, *next;
108 /* Pointer to the actual test function. This is run by the
109 * run() function above. */
115 * Describes a particular test case.
117 struct torture_tcase {
119 const char *description;
120 bool (*setup) (struct torture_context *tcase, void **data);
121 bool (*teardown) (struct torture_context *tcase, void *data);
122 bool fixture_persistent;
124 struct torture_test *tests;
125 struct torture_tcase *prev, *next;
131 const char *path; /* Used by subunit tests only */
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 wrapper that adds a test that doesn't need any
170 struct torture_tcase *torture_suite_add_simple_test(
171 struct torture_suite *suite,
173 bool (*run) (struct torture_context *test));
175 /* Add a child testsuite to an existing testsuite */
176 bool torture_suite_add_suite(struct torture_suite *suite,
177 struct torture_suite *child);
179 /* Run the specified testsuite recursively */
180 bool torture_run_suite(struct torture_context *context,
181 struct torture_suite *suite);
183 /* Run the specified testcase */
184 bool torture_run_tcase(struct torture_context *context,
185 struct torture_tcase *tcase);
187 /* Run the specified test */
188 bool torture_run_test(struct torture_context *context,
189 struct torture_tcase *tcase,
190 struct torture_test *test);
192 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
193 void torture_result(struct torture_context *test,
194 enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
196 #define torture_assert(torture_ctx,expr,cmt) \
198 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
202 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
203 do { WERROR __got = got, __expected = expected; \
204 if (!W_ERROR_EQUAL(__got, __expected)) { \
205 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
210 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
211 do { NTSTATUS __got = got, __expected = expected; \
212 if (!NT_STATUS_EQUAL(__got, __expected)) { \
213 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
219 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
220 do { const char *__got = (got), *__expected = (expected); \
221 if (!strequal(__got, __expected)) { \
222 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
227 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
228 do { const char *__got = (got), *__expected = (expected); \
229 if (strcmp_safe(__got, __expected) != 0) { \
230 torture_result(torture_ctx, TORTURE_FAIL, \
231 __location__": "#got" was %s, expected %s: %s", \
232 __got, __expected, cmt); \
237 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
238 do { int __got = (got), __expected = (expected); \
239 if (__got != __expected) { \
240 torture_result(torture_ctx, TORTURE_FAIL, \
241 __location__": "#got" was %d, expected %d: %s", \
242 __got, __expected, cmt); \
247 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
248 do { int __expected = (expected); \
249 if (errno != __expected) { \
250 torture_result(torture_ctx, TORTURE_FAIL, \
251 __location__": errno was %d (%s), expected %d: %s: %s", \
252 errno, strerror(errno), __expected, \
253 strerror(__expected), cmt); \
260 #define torture_skip(torture_ctx,cmt) do {\
261 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
264 #define torture_fail(torture_ctx,cmt) do {\
265 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
269 #define torture_out stderr
271 /* Convenience macros */
272 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
273 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
275 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
276 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
278 /* Getting settings */
279 const char *torture_setting_string(struct torture_context *test, \
281 const char *default_value);
283 int torture_setting_int(struct torture_context *test,
287 bool torture_setting_bool(struct torture_context *test,
291 struct torture_suite *torture_find_suite(struct torture_suite *parent,
295 #endif /* __TORTURE_UI_H__ */