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/>.
22 #include "torture/ui.h"
23 #include "torture/torture.h"
24 #include "lib/util/dlinklist.h"
26 void torture_comment(struct torture_context *context, const char *comment, ...)
31 if (!context->ui_ops->comment)
34 va_start(ap, comment);
35 tmp = talloc_vasprintf(context, comment, ap);
37 context->ui_ops->comment(context, tmp);
42 void torture_warning(struct torture_context *context, const char *comment, ...)
47 if (!context->ui_ops->warning)
50 va_start(ap, comment);
51 tmp = talloc_vasprintf(context, comment, ap);
53 context->ui_ops->warning(context, tmp);
58 void torture_result(struct torture_context *context,
59 enum torture_result result, const char *fmt, ...)
65 context->last_result = result;
66 context->last_reason = talloc_vasprintf(context, fmt, ap);
70 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
72 struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
74 suite->name = talloc_strdup(suite, name);
75 suite->testcases = NULL;
76 suite->children = NULL;
81 void torture_tcase_set_fixture(struct torture_tcase *tcase,
82 BOOL (*setup) (struct torture_context *, void **),
83 BOOL (*teardown) (struct torture_context *, void *))
86 tcase->teardown = teardown;
89 static bool wrap_test_with_testcase(struct torture_context *torture_ctx,
90 struct torture_tcase *tcase,
91 struct torture_test *test)
93 bool (*fn) (struct torture_context *,
94 const void *tcase_data,
95 const void *test_data);
99 return fn(torture_ctx, tcase->data, test->data);
102 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
104 bool (*run) (struct torture_context *,
105 const void *tcase_data,
106 const void *test_data),
109 struct torture_test *test = talloc(tcase, struct torture_test);
111 test->name = talloc_strdup(test, name);
112 test->description = NULL;
113 test->run = wrap_test_with_testcase;
115 test->dangerous = False;
118 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
123 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
126 struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
128 tcase->name = talloc_strdup(tcase, name);
129 tcase->description = NULL;
131 tcase->teardown = NULL;
132 tcase->fixture_persistent = True;
135 DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
140 BOOL torture_run_suite(struct torture_context *context,
141 struct torture_suite *suite)
144 struct torture_tcase *tcase;
145 struct torture_suite *tsuite;
149 if (context->ui_ops->suite_start)
150 context->ui_ops->suite_start(context, suite);
152 old_testname = context->active_testname;
153 if (old_testname != NULL)
154 context->active_testname = talloc_asprintf(context, "%s-%s",
155 old_testname, suite->name);
157 context->active_testname = talloc_strdup(context, suite->name);
159 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
160 ret &= torture_run_tcase(context, tcase);
163 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
164 ret &= torture_run_suite(context, tsuite);
167 talloc_free(context->active_testname);
168 context->active_testname = old_testname;
170 if (context->ui_ops->suite_finish)
171 context->ui_ops->suite_finish(context, suite);
178 void torture_ui_test_start(struct torture_context *context,
179 struct torture_tcase *tcase,
180 struct torture_test *test)
182 if (context->ui_ops->test_start)
183 context->ui_ops->test_start(context, tcase, test);
186 int str_list_match(const char *name, char **list)
192 for (i = 0; list[i]; i++) {
193 if (gen_fnmatch(list[i], name) == 0)
199 void torture_ui_test_result(struct torture_context *context,
200 enum torture_result result,
203 if (context->ui_ops->test_result)
204 context->ui_ops->test_result(context, result, comment);
206 if (result == TORTURE_ERROR || result == TORTURE_FAIL)
207 context->returncode = false;
210 static BOOL internal_torture_run_test(struct torture_context *context,
211 struct torture_tcase *tcase,
212 struct torture_test *test,
218 if (test->dangerous && !torture_setting_bool(context, "dangerous", False)) {
219 torture_result(context, TORTURE_SKIP,
220 "disabled %s - enable dangerous tests to use", test->name);
224 if (!already_setup && tcase->setup &&
225 !tcase->setup(context, &(tcase->data)))
228 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
229 old_testname = context->active_testname;
230 context->active_testname = talloc_asprintf(context, "%s-%s",
231 old_testname, test->name);
233 context->active_tcase = tcase;
234 context->active_test = test;
236 torture_ui_test_start(context, tcase, test);
239 context->last_reason = NULL;
240 context->last_result = TORTURE_OK;
242 ret = test->run(context, tcase, test);
243 if (!ret && context->last_result == TORTURE_OK) {
244 if (context->last_reason == NULL)
245 context->last_reason = talloc_strdup(context, "Unknown error/failure");
246 context->last_result = TORTURE_ERROR;
249 torture_ui_test_result(context, context->last_result, context->last_reason);
251 talloc_free(context->last_reason);
253 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
254 talloc_free(context->active_testname);
255 context->active_testname = old_testname;
257 context->active_test = NULL;
258 context->active_tcase = NULL;
260 if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data))
266 BOOL torture_run_tcase(struct torture_context *context,
267 struct torture_tcase *tcase)
271 struct torture_test *test;
275 context->active_tcase = tcase;
276 if (context->ui_ops->tcase_start)
277 context->ui_ops->tcase_start(context, tcase);
279 if (tcase->fixture_persistent && tcase->setup
280 && !tcase->setup(context, &tcase->data)) {
285 old_testname = context->active_testname;
286 context->active_testname = talloc_asprintf(context, "%s-%s",
287 old_testname, tcase->name);
288 for (test = tcase->tests; test; test = test->next) {
289 ret &= internal_torture_run_test(context, tcase, test,
290 tcase->fixture_persistent);
292 talloc_free(context->active_testname);
293 context->active_testname = old_testname;
295 if (tcase->fixture_persistent && tcase->teardown &&
296 !tcase->teardown(context, tcase->data))
300 context->active_tcase = NULL;
302 if (context->ui_ops->tcase_finish)
303 context->ui_ops->tcase_finish(context, tcase);
310 BOOL torture_run_test(struct torture_context *context,
311 struct torture_tcase *tcase,
312 struct torture_test *test)
314 return internal_torture_run_test(context, tcase, test, False);
317 int torture_setting_int(struct torture_context *test, const char *name,
320 return lp_parm_int(-1, "torture", name, default_value);
323 bool torture_setting_bool(struct torture_context *test, const char *name,
326 return lp_parm_bool(-1, "torture", name, default_value);
329 const char *torture_setting_string(struct torture_context *test, const char *name,
330 const char *default_value)
332 const char *ret = lp_parm_string(-1, "torture", name);
335 return default_value;
340 static bool wrap_test_with_simple_tcase(struct torture_context *torture_ctx,
341 struct torture_tcase *tcase,
342 struct torture_test *test)
344 bool (*fn) (struct torture_context *, const void *tcase_data);
348 return fn(torture_ctx, test->data);
351 struct torture_tcase *torture_suite_add_simple_tcase(
352 struct torture_suite *suite,
354 bool (*run) (struct torture_context *test, const void *),
357 struct torture_tcase *tcase;
358 struct torture_test *test;
360 tcase = torture_suite_add_tcase(suite, name);
362 test = talloc(tcase, struct torture_test);
364 test->name = talloc_strdup(test, name);
365 test->description = NULL;
366 test->run = wrap_test_with_simple_tcase;
369 test->dangerous = False;
371 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
376 static bool wrap_simple_test(struct torture_context *torture_ctx,
377 struct torture_tcase *tcase,
378 struct torture_test *test)
380 bool (*fn) (struct torture_context *);
384 return fn(torture_ctx);
387 struct torture_tcase *torture_suite_add_simple_test(
388 struct torture_suite *suite,
390 bool (*run) (struct torture_context *test))
392 struct torture_test *test;
393 struct torture_tcase *tcase;
395 tcase = torture_suite_add_tcase(suite, name);
397 test = talloc(tcase, struct torture_test);
399 test->name = talloc_strdup(test, name);
400 test->description = NULL;
401 test->run = wrap_simple_test;
403 test->dangerous = false;
405 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
410 bool torture_suite_add_suite(struct torture_suite *suite,
411 struct torture_suite *child)
416 DLIST_ADD_END(suite->children, child, struct torture_suite *);
418 /* FIXME: Check for duplicates and return false if the
419 * added suite already exists as a child */
425 struct torture_suite *torture_find_suite(struct torture_suite *parent,
428 struct torture_suite *child;
430 for (child = parent->children; child; child = child->next)
431 if (!strcmp(child->name, name))
437 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
438 struct torture_tcase *tcase,
439 struct torture_test *test)
441 bool (*fn) (struct torture_context *, const void *tcase_data);
445 return fn(torture_ctx, tcase->data);
448 struct torture_test *torture_tcase_add_simple_test(
449 struct torture_tcase *tcase,
451 bool (*run) (struct torture_context *test, const void *tcase_data))
453 struct torture_test *test;
455 test = talloc(tcase, struct torture_test);
457 test->name = talloc_strdup(test, name);
458 test->description = NULL;
459 test->run = wrap_test_with_simple_test;
462 test->dangerous = False;
464 DLIST_ADD_END(tcase->tests, test, struct torture_test *);