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.
23 #include "torture/ui.h"
24 #include "torture/torture.h"
25 #include "lib/util/dlinklist.h"
27 void torture_comment(struct torture_context *context, const char *comment, ...)
32 if (!context->ui_ops->comment)
35 va_start(ap, comment);
36 tmp = talloc_vasprintf(context, comment, ap);
38 context->ui_ops->comment(context, tmp);
43 void torture_result(struct torture_context *context,
44 enum torture_result result, const char *fmt, ...)
50 context->last_result = result;
51 context->last_reason = talloc_vasprintf(context, fmt, ap);
55 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
57 struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
59 suite->name = talloc_strdup(suite, name);
60 suite->testcases = NULL;
61 suite->children = NULL;
66 void torture_tcase_set_fixture(struct torture_tcase *tcase,
67 BOOL (*setup) (struct torture_context *, void **),
68 BOOL (*teardown) (struct torture_context *, void *))
71 tcase->teardown = teardown;
74 static bool wrap_test_with_testcase(struct torture_context *torture_ctx,
75 struct torture_tcase *tcase,
76 struct torture_test *test)
78 bool (*fn) (struct torture_context *,
79 const void *tcase_data,
80 const void *test_data);
84 return fn(torture_ctx, tcase->data, test->data);
87 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
89 bool (*run) (struct torture_context *,
90 const void *tcase_data,
91 const void *test_data),
94 struct torture_test *test = talloc(tcase, struct torture_test);
96 test->name = talloc_strdup(test, name);
97 test->description = NULL;
98 test->run = wrap_test_with_testcase;
100 test->dangerous = False;
103 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
108 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
111 struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
113 tcase->name = talloc_strdup(tcase, name);
114 tcase->description = NULL;
116 tcase->teardown = NULL;
117 tcase->fixture_persistent = True;
120 DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
125 BOOL torture_run_suite(struct torture_context *context,
126 struct torture_suite *suite)
129 struct torture_tcase *tcase;
130 struct torture_suite *tsuite;
134 if (context->ui_ops->suite_start)
135 context->ui_ops->suite_start(context, suite);
137 old_testname = context->active_testname;
138 if (old_testname != NULL)
139 context->active_testname = talloc_asprintf(context, "%s-%s",
140 old_testname, suite->name);
142 context->active_testname = talloc_strdup(context, suite->name);
144 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
145 ret &= torture_run_tcase(context, tcase);
148 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
149 ret &= torture_run_suite(context, tsuite);
152 talloc_free(context->active_testname);
153 context->active_testname = old_testname;
155 if (context->ui_ops->suite_finish)
156 context->ui_ops->suite_finish(context, suite);
163 void torture_ui_test_start(struct torture_context *context,
164 struct torture_tcase *tcase,
165 struct torture_test *test)
167 if (context->ui_ops->test_start)
168 context->ui_ops->test_start(context, tcase, test);
171 int str_list_match(const char *name, char **list)
177 for (i = 0; list[i]; i++) {
178 if (gen_fnmatch(list[i], name) == 0)
184 void torture_ui_test_result(struct torture_context *context,
185 enum torture_result result,
188 if (context->ui_ops->test_result)
189 context->ui_ops->test_result(context, result, comment);
191 if (result == TORTURE_ERROR || result == TORTURE_FAIL)
192 context->returncode = false;
195 static BOOL internal_torture_run_test(struct torture_context *context,
196 struct torture_tcase *tcase,
197 struct torture_test *test,
203 if (test->dangerous && !torture_setting_bool(context, "dangerous", False)) {
204 torture_result(context, TORTURE_SKIP,
205 "disabled %s - enable dangerous tests to use", test->name);
209 if (!already_setup && tcase->setup &&
210 !tcase->setup(context, &(tcase->data)))
213 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
214 old_testname = context->active_testname;
215 context->active_testname = talloc_asprintf(context, "%s-%s",
216 old_testname, test->name);
218 context->active_tcase = tcase;
219 context->active_test = test;
221 torture_ui_test_start(context, tcase, test);
224 context->last_reason = NULL;
225 context->last_result = TORTURE_OK;
227 ret = test->run(context, tcase, test);
228 if (!ret && context->last_result == TORTURE_OK) {
229 if (context->last_reason == NULL)
230 context->last_reason = talloc_strdup(context, "Unknown error/failure");
231 context->last_result = TORTURE_ERROR;
234 torture_ui_test_result(context, context->last_result, context->last_reason);
236 talloc_free(context->last_reason);
238 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
239 talloc_free(context->active_testname);
240 context->active_testname = old_testname;
242 context->active_test = NULL;
243 context->active_tcase = NULL;
245 if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data))
251 BOOL torture_run_tcase(struct torture_context *context,
252 struct torture_tcase *tcase)
256 struct torture_test *test;
260 context->active_tcase = tcase;
261 if (context->ui_ops->tcase_start)
262 context->ui_ops->tcase_start(context, tcase);
264 if (tcase->fixture_persistent && tcase->setup
265 && !tcase->setup(context, &tcase->data)) {
270 old_testname = context->active_testname;
271 context->active_testname = talloc_asprintf(context, "%s-%s",
272 old_testname, tcase->name);
273 for (test = tcase->tests; test; test = test->next) {
274 ret &= internal_torture_run_test(context, tcase, test,
275 tcase->fixture_persistent);
277 talloc_free(context->active_testname);
278 context->active_testname = old_testname;
280 if (tcase->fixture_persistent && tcase->teardown &&
281 !tcase->teardown(context, tcase->data))
285 context->active_tcase = NULL;
287 if (context->ui_ops->tcase_finish)
288 context->ui_ops->tcase_finish(context, tcase);
295 BOOL torture_run_test(struct torture_context *context,
296 struct torture_tcase *tcase,
297 struct torture_test *test)
299 return internal_torture_run_test(context, tcase, test, False);
302 int torture_setting_int(struct torture_context *test, const char *name,
305 return lp_parm_int(-1, "torture", name, default_value);
308 bool torture_setting_bool(struct torture_context *test, const char *name,
311 return lp_parm_bool(-1, "torture", name, default_value);
314 const char *torture_setting_string(struct torture_context *test, const char *name,
315 const char *default_value)
317 const char *ret = lp_parm_string(-1, "torture", name);
320 return default_value;
325 static bool wrap_test_with_simple_tcase(struct torture_context *torture_ctx,
326 struct torture_tcase *tcase,
327 struct torture_test *test)
329 bool (*fn) (struct torture_context *, const void *tcase_data);
333 return fn(torture_ctx, test->data);
336 struct torture_tcase *torture_suite_add_simple_tcase(
337 struct torture_suite *suite,
339 bool (*run) (struct torture_context *test, const void *),
342 struct torture_tcase *tcase;
343 struct torture_test *test;
345 tcase = torture_suite_add_tcase(suite, name);
347 test = talloc(tcase, struct torture_test);
349 test->name = talloc_strdup(test, name);
350 test->description = NULL;
351 test->run = wrap_test_with_simple_tcase;
354 test->dangerous = False;
356 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
361 static bool wrap_simple_test(struct torture_context *torture_ctx,
362 struct torture_tcase *tcase,
363 struct torture_test *test)
365 bool (*fn) (struct torture_context *);
369 return fn(torture_ctx);
372 struct torture_tcase *torture_suite_add_simple_test(
373 struct torture_suite *suite,
375 bool (*run) (struct torture_context *test))
377 struct torture_test *test;
378 struct torture_tcase *tcase;
380 tcase = torture_suite_add_tcase(suite, name);
382 test = talloc(tcase, struct torture_test);
384 test->name = talloc_strdup(test, name);
385 test->description = NULL;
386 test->run = wrap_simple_test;
388 test->dangerous = false;
390 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
395 bool torture_suite_add_suite(struct torture_suite *suite,
396 struct torture_suite *child)
401 DLIST_ADD_END(suite->children, child, struct torture_suite *);
403 /* FIXME: Check for duplicates and return false if the
404 * added suite already exists as a child */
410 struct torture_suite *torture_find_suite(struct torture_suite *parent,
413 struct torture_suite *child;
415 for (child = parent->children; child; child = child->next)
416 if (!strcmp(child->name, name))