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/torture.h"
23 #include "../lib/util/dlinklist.h"
24 #include "param/param.h"
25 #include "system/filesys.h"
27 struct torture_context *torture_context_init(struct event_context *event_ctx,
28 const struct torture_ui_ops *ui_ops)
30 struct torture_context *torture = talloc_zero(event_ctx,
31 struct torture_context);
32 torture->ui_ops = ui_ops;
33 torture->returncode = true;
34 torture->ev = event_ctx;
37 ui_ops->init(torture);
43 create a temporary directory.
45 _PUBLIC_ NTSTATUS torture_temp_dir(struct torture_context *tctx,
49 SMB_ASSERT(tctx->outputdir != NULL);
51 *tempdir = talloc_asprintf(tctx, "%s/%s.XXXXXX", tctx->outputdir,
53 NT_STATUS_HAVE_NO_MEMORY(*tempdir);
55 if (mkdtemp(*tempdir) == NULL) {
56 return map_nt_error_from_unix(errno);
62 void torture_comment(struct torture_context *context, const char *comment, ...)
67 if (!context->ui_ops->comment)
70 va_start(ap, comment);
71 tmp = talloc_vasprintf(context, comment, ap);
73 context->ui_ops->comment(context, tmp);
78 void torture_warning(struct torture_context *context, const char *comment, ...)
83 if (!context->ui_ops->warning)
86 va_start(ap, comment);
87 tmp = talloc_vasprintf(context, comment, ap);
89 context->ui_ops->warning(context, tmp);
94 void torture_result(struct torture_context *context,
95 enum torture_result result, const char *fmt, ...)
101 if (context->last_reason) {
102 torture_warning(context, "%s", context->last_reason);
103 talloc_free(context->last_reason);
106 context->last_result = result;
107 context->last_reason = talloc_vasprintf(context, fmt, ap);
111 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
113 struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
115 suite->name = talloc_strdup(suite, name);
116 suite->testcases = NULL;
117 suite->children = NULL;
122 void torture_tcase_set_fixture(struct torture_tcase *tcase,
123 bool (*setup) (struct torture_context *, void **),
124 bool (*teardown) (struct torture_context *, void *))
126 tcase->setup = setup;
127 tcase->teardown = teardown;
130 static bool wrap_test_with_testcase_const(struct torture_context *torture_ctx,
131 struct torture_tcase *tcase,
132 struct torture_test *test)
134 bool (*fn) (struct torture_context *,
135 const void *tcase_data,
136 const void *test_data);
140 return fn(torture_ctx, tcase->data, test->data);
143 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
145 bool (*run) (struct torture_context *, const void *tcase_data,
146 const void *test_data),
149 struct torture_test *test = talloc(tcase, struct torture_test);
151 test->name = talloc_strdup(test, name);
152 test->description = NULL;
153 test->run = wrap_test_with_testcase_const;
155 test->dangerous = false;
158 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
164 bool torture_suite_init_tcase(struct torture_suite *suite,
165 struct torture_tcase *tcase,
168 tcase->name = talloc_strdup(tcase, name);
169 tcase->description = NULL;
171 tcase->teardown = NULL;
172 tcase->fixture_persistent = true;
175 DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
181 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
184 struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
186 if (!torture_suite_init_tcase(suite, tcase, name))
192 bool torture_run_suite(struct torture_context *context,
193 struct torture_suite *suite)
196 struct torture_tcase *tcase;
197 struct torture_suite *tsuite;
201 if (context->ui_ops->suite_start)
202 context->ui_ops->suite_start(context, suite);
204 old_testname = context->active_testname;
205 if (old_testname != NULL)
206 context->active_testname = talloc_asprintf(context, "%s-%s",
207 old_testname, suite->name);
209 context->active_testname = talloc_strdup(context, suite->name);
211 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
212 ret &= torture_run_tcase(context, tcase);
215 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
216 ret &= torture_run_suite(context, tsuite);
219 talloc_free(context->active_testname);
220 context->active_testname = old_testname;
222 if (context->ui_ops->suite_finish)
223 context->ui_ops->suite_finish(context, suite);
230 void torture_ui_test_start(struct torture_context *context,
231 struct torture_tcase *tcase,
232 struct torture_test *test)
234 if (context->ui_ops->test_start)
235 context->ui_ops->test_start(context, tcase, test);
238 void torture_ui_test_result(struct torture_context *context,
239 enum torture_result result,
242 if (context->ui_ops->test_result)
243 context->ui_ops->test_result(context, result, comment);
245 if (result == TORTURE_ERROR || result == TORTURE_FAIL)
246 context->returncode = false;
249 static bool internal_torture_run_test(struct torture_context *context,
250 struct torture_tcase *tcase,
251 struct torture_test *test,
257 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
258 old_testname = context->active_testname;
259 context->active_testname = talloc_asprintf(context, "%s-%s", old_testname, test->name);
262 context->active_tcase = tcase;
263 context->active_test = test;
265 torture_ui_test_start(context, tcase, test);
267 context->last_reason = NULL;
268 context->last_result = TORTURE_OK;
270 if (!already_setup && tcase->setup &&
271 !tcase->setup(context, &(tcase->data))) {
272 if (context->last_reason == NULL)
273 context->last_reason = talloc_strdup(context, "Setup failure");
274 context->last_result = TORTURE_ERROR;
276 } else if (test->dangerous &&
277 !torture_setting_bool(context, "dangerous", false)) {
278 context->last_result = TORTURE_SKIP;
279 context->last_reason = talloc_asprintf(context,
280 "disabled %s - enable dangerous tests to use", test->name);
283 success = test->run(context, tcase, test);
285 if (!success && context->last_result == TORTURE_OK) {
286 if (context->last_reason == NULL)
287 context->last_reason = talloc_strdup(context, "Unknown error/failure");
288 context->last_result = TORTURE_ERROR;
292 if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data)) {
293 if (context->last_reason == NULL)
294 context->last_reason = talloc_strdup(context, "Setup failure");
295 context->last_result = TORTURE_ERROR;
299 torture_ui_test_result(context, context->last_result,
300 context->last_reason);
302 talloc_free(context->last_reason);
304 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
305 talloc_free(context->active_testname);
306 context->active_testname = old_testname;
308 context->active_test = NULL;
309 context->active_tcase = NULL;
314 bool torture_run_tcase(struct torture_context *context,
315 struct torture_tcase *tcase)
319 struct torture_test *test;
323 context->active_tcase = tcase;
324 if (context->ui_ops->tcase_start)
325 context->ui_ops->tcase_start(context, tcase);
327 if (tcase->fixture_persistent && tcase->setup
328 && !tcase->setup(context, &tcase->data)) {
329 /* FIXME: Use torture ui ops for reporting this error */
330 fprintf(stderr, "Setup failed: ");
331 if (context->last_reason != NULL)
332 fprintf(stderr, "%s", context->last_reason);
333 fprintf(stderr, "\n");
338 old_testname = context->active_testname;
339 context->active_testname = talloc_asprintf(context, "%s-%s",
340 old_testname, tcase->name);
341 for (test = tcase->tests; test; test = test->next) {
342 ret &= internal_torture_run_test(context, tcase, test,
343 tcase->fixture_persistent);
345 talloc_free(context->active_testname);
346 context->active_testname = old_testname;
348 if (tcase->fixture_persistent && tcase->teardown &&
349 !tcase->teardown(context, tcase->data))
353 context->active_tcase = NULL;
355 if (context->ui_ops->tcase_finish)
356 context->ui_ops->tcase_finish(context, tcase);
363 bool torture_run_test(struct torture_context *context,
364 struct torture_tcase *tcase,
365 struct torture_test *test)
367 return internal_torture_run_test(context, tcase, test, false);
370 int torture_setting_int(struct torture_context *test, const char *name,
373 return lp_parm_int(test->lp_ctx, NULL, "torture", name, default_value);
376 double torture_setting_double(struct torture_context *test, const char *name,
377 double default_value)
379 return lp_parm_double(test->lp_ctx, NULL, "torture", name, default_value);
382 bool torture_setting_bool(struct torture_context *test, const char *name,
385 return lp_parm_bool(test->lp_ctx, NULL, "torture", name, default_value);
388 const char *torture_setting_string(struct torture_context *test,
390 const char *default_value)
394 SMB_ASSERT(test != NULL);
395 SMB_ASSERT(test->lp_ctx != NULL);
397 ret = lp_parm_string(test->lp_ctx, NULL, "torture", name);
400 return default_value;
405 static bool wrap_test_with_simple_tcase_const (
406 struct torture_context *torture_ctx,
407 struct torture_tcase *tcase,
408 struct torture_test *test)
410 bool (*fn) (struct torture_context *, const void *tcase_data);
414 return fn(torture_ctx, test->data);
417 struct torture_tcase *torture_suite_add_simple_tcase_const(
418 struct torture_suite *suite, const char *name,
419 bool (*run) (struct torture_context *test, const void *),
422 struct torture_tcase *tcase;
423 struct torture_test *test;
425 tcase = torture_suite_add_tcase(suite, name);
427 test = talloc(tcase, struct torture_test);
429 test->name = talloc_strdup(test, name);
430 test->description = NULL;
431 test->run = wrap_test_with_simple_tcase_const;
434 test->dangerous = false;
436 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
441 static bool wrap_simple_test(struct torture_context *torture_ctx,
442 struct torture_tcase *tcase,
443 struct torture_test *test)
445 bool (*fn) (struct torture_context *);
449 return fn(torture_ctx);
452 struct torture_tcase *torture_suite_add_simple_test(
453 struct torture_suite *suite,
455 bool (*run) (struct torture_context *test))
457 struct torture_test *test;
458 struct torture_tcase *tcase;
460 tcase = torture_suite_add_tcase(suite, name);
462 test = talloc(tcase, struct torture_test);
464 test->name = talloc_strdup(test, name);
465 test->description = NULL;
466 test->run = wrap_simple_test;
468 test->dangerous = false;
470 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
475 bool torture_suite_add_suite(struct torture_suite *suite,
476 struct torture_suite *child)
481 DLIST_ADD_END(suite->children, child, struct torture_suite *);
483 /* FIXME: Check for duplicates and return false if the
484 * added suite already exists as a child */
490 struct torture_suite *torture_find_suite(struct torture_suite *parent,
493 struct torture_suite *child;
495 for (child = parent->children; child; child = child->next)
496 if (!strcmp(child->name, name))
502 static bool wrap_test_with_simple_test_const(struct torture_context *torture_ctx,
503 struct torture_tcase *tcase,
504 struct torture_test *test)
506 bool (*fn) (struct torture_context *, const void *tcase_data);
510 return fn(torture_ctx, tcase->data);
513 struct torture_test *torture_tcase_add_simple_test_const(
514 struct torture_tcase *tcase,
516 bool (*run) (struct torture_context *test,
517 const void *tcase_data))
519 struct torture_test *test;
521 test = talloc(tcase, struct torture_test);
523 test->name = talloc_strdup(test, name);
524 test->description = NULL;
525 test->run = wrap_test_with_simple_test_const;
528 test->dangerous = false;
530 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
535 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
536 struct torture_tcase *tcase,
537 struct torture_test *test)
539 bool (*fn) (struct torture_context *, void *tcase_data);
543 return fn(torture_ctx, tcase->data);
546 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
548 bool (*run) (struct torture_context *test, void *tcase_data))
550 struct torture_test *test;
552 test = talloc(tcase, struct torture_test);
554 test->name = talloc_strdup(test, name);
555 test->description = NULL;
556 test->run = wrap_test_with_simple_test;
559 test->dangerous = false;
561 DLIST_ADD_END(tcase->tests, test, struct torture_test *);