2 Unix SMB/CIFS implementation.
3 SMB torture UI functions
5 Copyright (C) Jelmer Vernooij 2006-2008
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/>.
21 #include "source4/include/includes.h"
22 #include "../torture/torture.h"
23 #include "../lib/util/dlinklist.h"
24 #include "param/param.h"
25 #include "system/filesys.h"
28 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops)
30 struct torture_results *results = talloc_zero(mem_ctx, struct torture_results);
32 results->ui_ops = ui_ops;
33 results->returncode = true;
36 ui_ops->init(results);
42 * Initialize a torture context
44 struct torture_context *torture_context_init(struct tevent_context *event_ctx,
45 struct torture_results *results)
47 struct torture_context *torture = talloc_zero(event_ctx,
48 struct torture_context);
53 torture->ev = event_ctx;
54 torture->results = talloc_reference(torture, results);
60 * Create a sub torture context
62 struct torture_context *torture_context_child(struct torture_context *parent)
64 struct torture_context *subtorture = talloc_zero(parent, struct torture_context);
66 if (subtorture == NULL)
69 subtorture->ev = talloc_reference(subtorture, parent->ev);
70 subtorture->lp_ctx = talloc_reference(subtorture, parent->lp_ctx);
71 subtorture->outputdir = talloc_reference(subtorture, parent->outputdir);
72 subtorture->results = talloc_reference(subtorture, parent->results);
78 create a temporary directory.
80 _PUBLIC_ NTSTATUS torture_temp_dir(struct torture_context *tctx,
81 const char *prefix, char **tempdir)
83 SMB_ASSERT(tctx->outputdir != NULL);
85 *tempdir = talloc_asprintf(tctx, "%s/%s.XXXXXX", tctx->outputdir,
87 NT_STATUS_HAVE_NO_MEMORY(*tempdir);
89 if (mkdtemp(*tempdir) == NULL) {
90 return map_nt_error_from_unix(errno);
97 * Comment on the status/progress of a test
99 void torture_comment(struct torture_context *context, const char *comment, ...)
104 if (!context->results->ui_ops->comment)
107 va_start(ap, comment);
108 tmp = talloc_vasprintf(context, comment, ap);
111 context->results->ui_ops->comment(context, tmp);
117 * Print a warning about the current test
119 void torture_warning(struct torture_context *context, const char *comment, ...)
124 if (!context->results->ui_ops->warning)
127 va_start(ap, comment);
128 tmp = talloc_vasprintf(context, comment, ap);
131 context->results->ui_ops->warning(context, tmp);
137 * Store the result of a torture test.
139 void torture_result(struct torture_context *context,
140 enum torture_result result, const char *fmt, ...)
146 if (context->last_reason) {
147 torture_warning(context, "%s", context->last_reason);
148 talloc_free(context->last_reason);
151 context->last_result = result;
152 context->last_reason = talloc_vasprintf(context, fmt, ap);
157 * Create a new torture suite
159 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
161 struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
163 suite->name = talloc_strdup(suite, name);
164 suite->testcases = NULL;
165 suite->children = NULL;
171 * Set the setup() and teardown() functions for a testcase.
173 void torture_tcase_set_fixture(struct torture_tcase *tcase,
174 bool (*setup) (struct torture_context *, void **),
175 bool (*teardown) (struct torture_context *, void *))
177 tcase->setup = setup;
178 tcase->teardown = teardown;
181 static bool wrap_test_with_testcase_const(struct torture_context *torture_ctx,
182 struct torture_tcase *tcase,
183 struct torture_test *test)
185 bool (*fn) (struct torture_context *,
186 const void *tcase_data,
187 const void *test_data);
191 return fn(torture_ctx, tcase->data, test->data);
195 * Add a test that uses const data to a testcase
197 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
199 bool (*run) (struct torture_context *, const void *tcase_data,
200 const void *test_data),
203 struct torture_test *test = talloc(tcase, struct torture_test);
205 test->name = talloc_strdup(test, name);
206 test->description = NULL;
207 test->run = wrap_test_with_testcase_const;
209 test->dangerous = false;
212 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
220 bool torture_suite_init_tcase(struct torture_suite *suite,
221 struct torture_tcase *tcase,
224 tcase->name = talloc_strdup(tcase, name);
225 tcase->description = NULL;
227 tcase->teardown = NULL;
228 tcase->fixture_persistent = true;
231 DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
237 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
240 struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
242 if (!torture_suite_init_tcase(suite, tcase, name))
248 int torture_suite_children_count(const struct torture_suite *suite)
251 struct torture_tcase *tcase;
252 struct torture_test *test;
253 struct torture_suite *tsuite;
254 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
255 for (test = tcase->tests; test; test = test->next) {
259 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
266 * Run a torture test suite.
268 bool torture_run_suite(struct torture_context *context,
269 struct torture_suite *suite)
271 return torture_run_suite_restricted(context, suite, NULL);
274 bool torture_run_suite_restricted(struct torture_context *context,
275 struct torture_suite *suite, const char **restricted)
278 struct torture_tcase *tcase;
279 struct torture_suite *tsuite;
281 if (context->results->ui_ops->suite_start)
282 context->results->ui_ops->suite_start(context, suite);
284 /* FIXME: Adjust torture_suite_children_count if restricted != NULL */
285 context->results->ui_ops->progress(context,
286 torture_suite_children_count(suite), TORTURE_PROGRESS_SET);
288 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
289 ret &= torture_run_tcase_restricted(context, tcase, restricted);
292 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
293 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_PUSH);
294 ret &= torture_run_suite_restricted(context, tsuite, restricted);
295 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_POP);
298 if (context->results->ui_ops->suite_finish)
299 context->results->ui_ops->suite_finish(context, suite);
304 void torture_ui_test_start(struct torture_context *context,
305 struct torture_tcase *tcase,
306 struct torture_test *test)
308 if (context->results->ui_ops->test_start)
309 context->results->ui_ops->test_start(context, tcase, test);
312 void torture_ui_test_result(struct torture_context *context,
313 enum torture_result result,
316 if (context->results->ui_ops->test_result)
317 context->results->ui_ops->test_result(context, result, comment);
319 if (result == TORTURE_ERROR || result == TORTURE_FAIL)
320 context->results->returncode = false;
323 static bool test_needs_running(const char *name, const char **restricted)
326 if (restricted == NULL)
328 for (i = 0; restricted[i]; i++) {
329 if (!strcmp(name, restricted[i]))
335 static bool internal_torture_run_test(struct torture_context *context,
336 struct torture_tcase *tcase,
337 struct torture_test *test,
339 const char **restricted)
342 char *old_testname = NULL;
343 char *subunit_testname = NULL;
345 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
346 subunit_testname = talloc_asprintf(context, "%s.%s", tcase->name, test->name);
348 subunit_testname = talloc_strdup(context, test->name);
351 if (!test_needs_running(subunit_testname, restricted))
354 context->active_tcase = tcase;
355 context->active_test = test;
357 torture_ui_test_start(context, tcase, test);
359 context->last_reason = NULL;
360 context->last_result = TORTURE_OK;
362 if (!already_setup && tcase->setup &&
363 !tcase->setup(context, &(tcase->data))) {
364 if (context->last_reason == NULL)
365 context->last_reason = talloc_strdup(context, "Setup failure");
366 context->last_result = TORTURE_ERROR;
368 } else if (test->dangerous &&
369 !torture_setting_bool(context, "dangerous", false)) {
370 context->last_result = TORTURE_SKIP;
371 context->last_reason = talloc_asprintf(context,
372 "disabled %s - enable dangerous tests to use", test->name);
375 success = test->run(context, tcase, test);
377 if (!success && context->last_result == TORTURE_OK) {
378 if (context->last_reason == NULL)
379 context->last_reason = talloc_strdup(context, "Unknown error/failure");
380 context->last_result = TORTURE_ERROR;
384 if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data)) {
385 if (context->last_reason == NULL)
386 context->last_reason = talloc_strdup(context, "Setup failure");
387 context->last_result = TORTURE_ERROR;
391 torture_ui_test_result(context, context->last_result,
392 context->last_reason);
394 talloc_free(context->last_reason);
396 context->active_test = NULL;
397 context->active_tcase = NULL;
402 bool torture_run_tcase(struct torture_context *context,
403 struct torture_tcase *tcase)
405 return torture_run_tcase_restricted(context, tcase, NULL);
408 bool torture_run_tcase_restricted(struct torture_context *context,
409 struct torture_tcase *tcase, const char **restricted)
412 struct torture_test *test;
413 bool setup_succeeded = true;
414 const char * setup_reason = "Setup failed";
416 context->active_tcase = tcase;
417 if (context->results->ui_ops->tcase_start)
418 context->results->ui_ops->tcase_start(context, tcase);
420 if (tcase->fixture_persistent && tcase->setup) {
421 setup_succeeded = tcase->setup(context, &tcase->data);
424 if (!setup_succeeded) {
425 /* Uh-oh. The setup failed, so we can't run any of the tests
426 * in this testcase. The subunit format doesn't specify what
427 * to do here, so we keep the failure reason, and manually
428 * use it to fail every test.
430 if (context->last_reason != NULL) {
431 setup_reason = talloc_asprintf(context,
432 "Setup failed: %s", context->last_reason);
436 for (test = tcase->tests; test; test = test->next) {
437 if (setup_succeeded) {
438 ret &= internal_torture_run_test(context, tcase, test,
439 tcase->fixture_persistent, restricted);
441 context->active_tcase = tcase;
442 context->active_test = test;
443 torture_ui_test_start(context, tcase, test);
444 torture_ui_test_result(context, TORTURE_FAIL, setup_reason);
448 if (setup_succeeded && tcase->fixture_persistent && tcase->teardown &&
449 !tcase->teardown(context, tcase->data)) {
453 context->active_tcase = NULL;
454 context->active_test = NULL;
456 if (context->results->ui_ops->tcase_finish)
457 context->results->ui_ops->tcase_finish(context, tcase);
459 return (!setup_succeeded) ? false : ret;
462 bool torture_run_test(struct torture_context *context,
463 struct torture_tcase *tcase,
464 struct torture_test *test)
466 return internal_torture_run_test(context, tcase, test, false, NULL);
469 bool torture_run_test_restricted(struct torture_context *context,
470 struct torture_tcase *tcase,
471 struct torture_test *test,
472 const char **restricted)
474 return internal_torture_run_test(context, tcase, test, false, restricted);
477 int torture_setting_int(struct torture_context *test, const char *name,
480 return lpcfg_parm_int(test->lp_ctx, NULL, "torture", name, default_value);
483 unsigned long torture_setting_ulong(struct torture_context *test,
485 unsigned long default_value)
487 return lpcfg_parm_ulong(test->lp_ctx, NULL, "torture", name,
491 double torture_setting_double(struct torture_context *test, const char *name,
492 double default_value)
494 return lpcfg_parm_double(test->lp_ctx, NULL, "torture", name, default_value);
497 bool torture_setting_bool(struct torture_context *test, const char *name,
500 return lpcfg_parm_bool(test->lp_ctx, NULL, "torture", name, default_value);
503 const char *torture_setting_string(struct torture_context *test,
505 const char *default_value)
509 SMB_ASSERT(test != NULL);
510 SMB_ASSERT(test->lp_ctx != NULL);
512 ret = lpcfg_parm_string(test->lp_ctx, NULL, "torture", name);
515 return default_value;
520 static bool wrap_test_with_simple_tcase_const (
521 struct torture_context *torture_ctx,
522 struct torture_tcase *tcase,
523 struct torture_test *test)
525 bool (*fn) (struct torture_context *, const void *tcase_data);
529 return fn(torture_ctx, test->data);
532 struct torture_tcase *torture_suite_add_simple_tcase_const(
533 struct torture_suite *suite, const char *name,
534 bool (*run) (struct torture_context *test, const void *),
537 struct torture_tcase *tcase;
538 struct torture_test *test;
540 tcase = torture_suite_add_tcase(suite, name);
542 test = talloc(tcase, struct torture_test);
544 test->name = talloc_strdup(test, name);
545 test->description = NULL;
546 test->run = wrap_test_with_simple_tcase_const;
549 test->dangerous = false;
551 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
556 static bool wrap_simple_test(struct torture_context *torture_ctx,
557 struct torture_tcase *tcase,
558 struct torture_test *test)
560 bool (*fn) (struct torture_context *);
564 return fn(torture_ctx);
567 struct torture_tcase *torture_suite_add_simple_test(
568 struct torture_suite *suite,
570 bool (*run) (struct torture_context *test))
572 struct torture_test *test;
573 struct torture_tcase *tcase;
575 tcase = torture_suite_add_tcase(suite, name);
577 test = talloc(tcase, struct torture_test);
579 test->name = talloc_strdup(test, name);
580 test->description = NULL;
581 test->run = wrap_simple_test;
583 test->dangerous = false;
585 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
591 * Add a child testsuite to a testsuite.
593 bool torture_suite_add_suite(struct torture_suite *suite,
594 struct torture_suite *child)
599 DLIST_ADD_END(suite->children, child, struct torture_suite *);
601 /* FIXME: Check for duplicates and return false if the
602 * added suite already exists as a child */
608 * Find the child testsuite with the specified name.
610 struct torture_suite *torture_find_suite(struct torture_suite *parent,
613 struct torture_suite *child;
615 for (child = parent->children; child; child = child->next)
616 if (!strcmp(child->name, name))
622 static bool wrap_test_with_simple_test_const(struct torture_context *torture_ctx,
623 struct torture_tcase *tcase,
624 struct torture_test *test)
626 bool (*fn) (struct torture_context *, const void *tcase_data);
630 return fn(torture_ctx, tcase->data);
633 struct torture_test *torture_tcase_add_simple_test_const(
634 struct torture_tcase *tcase,
636 bool (*run) (struct torture_context *test,
637 const void *tcase_data))
639 struct torture_test *test;
641 test = talloc(tcase, struct torture_test);
643 test->name = talloc_strdup(test, name);
644 test->description = NULL;
645 test->run = wrap_test_with_simple_test_const;
648 test->dangerous = false;
650 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
655 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
656 struct torture_tcase *tcase,
657 struct torture_test *test)
659 bool (*fn) (struct torture_context *, void *tcase_data);
663 return fn(torture_ctx, tcase->data);
666 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
668 bool (*run) (struct torture_context *test, void *tcase_data))
670 struct torture_test *test;
672 test = talloc(tcase, struct torture_test);
674 test->name = talloc_strdup(test, name);
675 test->description = NULL;
676 test->run = wrap_test_with_simple_test;
679 test->dangerous = false;
681 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
686 void torture_ui_report_time(struct torture_context *context)
688 if (context->results->ui_ops->report_time)
689 context->results->ui_ops->report_time(context);