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
;
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_context
*);
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 const struct torture_ui_ops
*ui_ops
;
80 char *active_testname
;
81 struct torture_test
*active_test
;
82 struct torture_tcase
*active_tcase
;
84 bool quiet
; /* Whether tests should avoid writing output to stdout */
86 enum torture_result last_result
;
93 struct event_context
*ev
;
97 * Describes a particular torture test
101 const char *description
;
103 /* Function to call to run this test */
104 bool (*run
) (struct torture_context
*torture_ctx
,
105 struct torture_tcase
*tcase
,
106 struct torture_test
*test
);
108 struct torture_test
*prev
, *next
;
110 /* Pointer to the actual test function. This is run by the
111 * run() function above. */
117 * Describes a particular test case.
119 struct torture_tcase
{
121 const char *description
;
122 bool (*setup
) (struct torture_context
*tcase
, void **data
);
123 bool (*teardown
) (struct torture_context
*tcase
, void *data
);
124 bool fixture_persistent
;
126 struct torture_test
*tests
;
127 struct torture_tcase
*prev
, *next
;
133 const char *description
;
134 struct torture_tcase
*testcases
;
135 struct torture_suite
*children
;
137 /* Pointers to siblings of this torture suite */
138 struct torture_suite
*prev
, *next
;
141 /** Create a new torture suite */
142 struct torture_suite
*torture_suite_create(TALLOC_CTX
*mem_ctx
,
145 /** Change the setup and teardown functions for a testcase */
146 void torture_tcase_set_fixture(struct torture_tcase
*tcase
,
147 bool (*setup
) (struct torture_context
*, void **),
148 bool (*teardown
) (struct torture_context
*, void *));
150 /* Add another test to run for a particular testcase */
151 struct torture_test
*torture_tcase_add_test(struct torture_tcase
*tcase
,
153 bool (*run
) (struct torture_context
*test
, const void *tcase_data
,
154 const void *test_data
),
155 const void *test_data
);
157 /* Add a testcase to a testsuite */
158 struct torture_tcase
*torture_suite_add_tcase(struct torture_suite
*suite
,
161 /* Convenience wrapper that adds a testcase against only one
162 * test will be run */
163 struct torture_tcase
*torture_suite_add_simple_tcase(
164 struct torture_suite
*suite
,
166 bool (*run
) (struct torture_context
*test
, const void *test_data
),
169 /* Convenience wrapper that adds a test that doesn't need any
171 struct torture_tcase
*torture_suite_add_simple_test(
172 struct torture_suite
*suite
,
174 bool (*run
) (struct torture_context
*test
));
176 /* Add a child testsuite to an existing testsuite */
177 bool torture_suite_add_suite(struct torture_suite
*suite
,
178 struct torture_suite
*child
);
180 /* Run the specified testsuite recursively */
181 bool torture_run_suite(struct torture_context
*context
,
182 struct torture_suite
*suite
);
184 /* Run the specified testcase */
185 bool torture_run_tcase(struct torture_context
*context
,
186 struct torture_tcase
*tcase
);
188 /* Run the specified test */
189 bool torture_run_test(struct torture_context
*context
,
190 struct torture_tcase
*tcase
,
191 struct torture_test
*test
);
193 void torture_comment(struct torture_context
*test
, const char *comment
, ...) PRINTF_ATTRIBUTE(2,3);
194 void torture_warning(struct torture_context
*test
, const char *comment
, ...) PRINTF_ATTRIBUTE(2,3);
195 void torture_result(struct torture_context
*test
,
196 enum torture_result
, const char *reason
, ...) PRINTF_ATTRIBUTE(3,4);
198 #define torture_assert(torture_ctx,expr,cmt) \
200 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
204 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
205 do { WERROR __got = got, __expected = expected; \
206 if (!W_ERROR_EQUAL(__got, __expected)) { \
207 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
212 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
213 do { NTSTATUS __got = got, __expected = expected; \
214 if (!NT_STATUS_EQUAL(__got, __expected)) { \
215 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
221 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
222 do { const char *__got = (got), *__expected = (expected); \
223 if (!strequal(__got, __expected)) { \
224 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
229 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
230 do { const char *__got = (got), *__expected = (expected); \
231 if (strcmp_safe(__got, __expected) != 0) { \
232 torture_result(torture_ctx, TORTURE_FAIL, \
233 __location__": "#got" was %s, expected %s: %s", \
234 __got, __expected, cmt); \
239 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
240 do { int __got = (got), __expected = (expected); \
241 if (__got != __expected) { \
242 torture_result(torture_ctx, TORTURE_FAIL, \
243 __location__": "#got" was %d, expected %d: %s", \
244 __got, __expected, cmt); \
249 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
250 do { uint64_t __got = (got), __expected = (expected); \
251 if (__got != __expected) { \
252 torture_result(torture_ctx, TORTURE_FAIL, \
253 __location__": "#got" was %llu, expected %llu: %s", \
254 (unsigned long long)__got, (unsigned long long)__expected, cmt); \
259 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
260 do { int __expected = (expected); \
261 if (errno != __expected) { \
262 torture_result(torture_ctx, TORTURE_FAIL, \
263 __location__": errno was %d (%s), expected %d: %s: %s", \
264 errno, strerror(errno), __expected, \
265 strerror(__expected), cmt); \
272 #define torture_skip(torture_ctx,cmt) do {\
273 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
276 #define torture_fail(torture_ctx,cmt) do {\
277 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
280 #define torture_fail_goto(torture_ctx,label,cmt) do {\
281 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
285 #define torture_out stderr
287 /* Convenience macros */
288 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
289 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
291 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
292 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
294 /* Getting settings */
295 const char *torture_setting_string(struct torture_context
*test
, \
297 const char *default_value
);
299 int torture_setting_int(struct torture_context
*test
,
303 bool torture_setting_bool(struct torture_context
*test
,
307 struct torture_suite
*torture_find_suite(struct torture_suite
*parent
,
311 #endif /* __TORTURE_UI_H__ */