build-htmlman-nogit: manpages-3 has been moved to manpages.
[Samba/id10ts.git] / lib / torture / torture.c
blob1b0a9564db2a0b649464b010af7015ec020d1447
1 /*
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"
26 #include "system/dir.h"
29 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops)
31 struct torture_results *results = talloc_zero(mem_ctx, struct torture_results);
33 results->ui_ops = ui_ops;
34 results->returncode = true;
36 if (ui_ops->init)
37 ui_ops->init(results);
39 return results;
42 /**
43 * Initialize a torture context
45 struct torture_context *torture_context_init(struct tevent_context *event_ctx,
46 struct torture_results *results)
48 struct torture_context *torture = talloc_zero(event_ctx,
49 struct torture_context);
51 if (torture == NULL)
52 return NULL;
54 torture->ev = event_ctx;
55 torture->results = talloc_reference(torture, results);
57 return torture;
60 /**
61 * Create a sub torture context
63 struct torture_context *torture_context_child(struct torture_context *parent)
65 struct torture_context *subtorture = talloc_zero(parent, struct torture_context);
67 if (subtorture == NULL)
68 return NULL;
70 subtorture->ev = talloc_reference(subtorture, parent->ev);
71 subtorture->lp_ctx = talloc_reference(subtorture, parent->lp_ctx);
72 subtorture->outputdir = talloc_reference(subtorture, parent->outputdir);
73 subtorture->results = talloc_reference(subtorture, parent->results);
75 return subtorture;
78 /**
79 create a temporary directory under the output dir
81 _PUBLIC_ NTSTATUS torture_temp_dir(struct torture_context *tctx,
82 const char *prefix, char **tempdir)
84 SMB_ASSERT(tctx->outputdir != NULL);
86 *tempdir = talloc_asprintf(tctx, "%s/%s.XXXXXX", tctx->outputdir,
87 prefix);
88 NT_STATUS_HAVE_NO_MEMORY(*tempdir);
90 if (mkdtemp(*tempdir) == NULL) {
91 return map_nt_error_from_unix_common(errno);
94 return NT_STATUS_OK;
97 static int local_deltree(const char *path)
99 int ret = 0;
100 struct dirent *dirent;
101 DIR *dir = opendir(path);
102 if (!dir) {
103 char *error = talloc_asprintf(NULL, "Could not open directory %s", path);
104 perror(error);
105 talloc_free(error);
106 return -1;
108 while ((dirent = readdir(dir))) {
109 char *name;
110 if ((strcmp(dirent->d_name, ".") == 0) || (strcmp(dirent->d_name, "..") == 0)) {
111 continue;
113 name = talloc_asprintf(NULL, "%s/%s", path,
114 dirent->d_name);
115 if (name == NULL) {
116 closedir(dir);
117 return -1;
119 DEBUG(0, ("About to remove %s\n", name));
120 ret = remove(name);
121 if (ret == 0) {
122 talloc_free(name);
123 continue;
126 if (errno == ENOTEMPTY) {
127 ret = local_deltree(name);
128 if (ret == 0) {
129 ret = remove(name);
132 talloc_free(name);
133 if (ret != 0) {
134 char *error = talloc_asprintf(NULL, "Could not remove %s", path);
135 perror(error);
136 talloc_free(error);
137 break;
140 closedir(dir);
141 rmdir(path);
142 return ret;
145 _PUBLIC_ NTSTATUS torture_deltree_outputdir(struct torture_context *tctx)
147 if (tctx->outputdir == NULL) {
148 return NT_STATUS_OK;
150 if ((strcmp(tctx->outputdir, "/") == 0)
151 || (strcmp(tctx->outputdir, "") == 0)) {
152 return NT_STATUS_INVALID_PARAMETER;
155 if (local_deltree(tctx->outputdir) == -1) {
156 if (errno != 0) {
157 return map_nt_error_from_unix_common(errno);
159 return NT_STATUS_UNSUCCESSFUL;
161 return NT_STATUS_OK;
165 * Comment on the status/progress of a test
167 void torture_comment(struct torture_context *context, const char *comment, ...)
169 va_list ap;
170 char *tmp;
172 if (!context->results->ui_ops->comment)
173 return;
175 va_start(ap, comment);
176 tmp = talloc_vasprintf(context, comment, ap);
177 va_end(ap);
179 context->results->ui_ops->comment(context, tmp);
181 talloc_free(tmp);
185 * Print a warning about the current test
187 void torture_warning(struct torture_context *context, const char *comment, ...)
189 va_list ap;
190 char *tmp;
192 if (!context->results->ui_ops->warning)
193 return;
195 va_start(ap, comment);
196 tmp = talloc_vasprintf(context, comment, ap);
197 va_end(ap);
199 context->results->ui_ops->warning(context, tmp);
201 talloc_free(tmp);
205 * Store the result of a torture test.
207 void torture_result(struct torture_context *context,
208 enum torture_result result, const char *fmt, ...)
210 va_list ap;
212 va_start(ap, fmt);
214 if (context->last_reason) {
215 torture_warning(context, "%s", context->last_reason);
216 talloc_free(context->last_reason);
219 context->last_result = result;
220 context->last_reason = talloc_vasprintf(context, fmt, ap);
221 va_end(ap);
225 * Create a new torture suite
227 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
229 struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
231 suite->name = talloc_strdup(suite, name);
232 suite->testcases = NULL;
233 suite->children = NULL;
235 return suite;
239 * Set the setup() and teardown() functions for a testcase.
241 void torture_tcase_set_fixture(struct torture_tcase *tcase,
242 bool (*setup) (struct torture_context *, void **),
243 bool (*teardown) (struct torture_context *, void *))
245 tcase->setup = setup;
246 tcase->teardown = teardown;
249 static bool wrap_test_with_testcase_const(struct torture_context *torture_ctx,
250 struct torture_tcase *tcase,
251 struct torture_test *test)
253 bool (*fn) (struct torture_context *,
254 const void *tcase_data,
255 const void *test_data);
257 fn = test->fn;
259 return fn(torture_ctx, tcase->data, test->data);
263 * Add a test that uses const data to a testcase
265 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
266 const char *name,
267 bool (*run) (struct torture_context *, const void *tcase_data,
268 const void *test_data),
269 const void *data)
271 struct torture_test *test = talloc(tcase, struct torture_test);
273 test->name = talloc_strdup(test, name);
274 test->description = NULL;
275 test->run = wrap_test_with_testcase_const;
276 test->fn = run;
277 test->dangerous = false;
278 test->data = data;
280 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
282 return test;
286 * Add a new testcase
288 bool torture_suite_init_tcase(struct torture_suite *suite,
289 struct torture_tcase *tcase,
290 const char *name)
292 tcase->name = talloc_strdup(tcase, name);
293 tcase->description = NULL;
294 tcase->setup = NULL;
295 tcase->teardown = NULL;
296 tcase->fixture_persistent = true;
297 tcase->tests = NULL;
299 DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
301 return true;
305 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
306 const char *name)
308 struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
310 if (!torture_suite_init_tcase(suite, tcase, name))
311 return NULL;
313 return tcase;
316 int torture_suite_children_count(const struct torture_suite *suite)
318 int ret = 0;
319 struct torture_tcase *tcase;
320 struct torture_test *test;
321 struct torture_suite *tsuite;
322 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
323 for (test = tcase->tests; test; test = test->next) {
324 ret++;
327 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
328 ret ++;
330 return ret;
334 * Run a torture test suite.
336 bool torture_run_suite(struct torture_context *context,
337 struct torture_suite *suite)
339 return torture_run_suite_restricted(context, suite, NULL);
342 bool torture_run_suite_restricted(struct torture_context *context,
343 struct torture_suite *suite, const char **restricted)
345 bool ret = true;
346 struct torture_tcase *tcase;
347 struct torture_suite *tsuite;
349 if (context->results->ui_ops->suite_start)
350 context->results->ui_ops->suite_start(context, suite);
352 /* FIXME: Adjust torture_suite_children_count if restricted != NULL */
353 context->results->ui_ops->progress(context,
354 torture_suite_children_count(suite), TORTURE_PROGRESS_SET);
356 for (tcase = suite->testcases; tcase; tcase = tcase->next) {
357 ret &= torture_run_tcase_restricted(context, tcase, restricted);
360 for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
361 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_PUSH);
362 ret &= torture_run_suite_restricted(context, tsuite, restricted);
363 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_POP);
366 if (context->results->ui_ops->suite_finish)
367 context->results->ui_ops->suite_finish(context, suite);
369 return ret;
372 void torture_ui_test_start(struct torture_context *context,
373 struct torture_tcase *tcase,
374 struct torture_test *test)
376 if (context->results->ui_ops->test_start)
377 context->results->ui_ops->test_start(context, tcase, test);
380 void torture_ui_test_result(struct torture_context *context,
381 enum torture_result result,
382 const char *comment)
384 if (context->results->ui_ops->test_result)
385 context->results->ui_ops->test_result(context, result, comment);
387 if (result == TORTURE_ERROR || result == TORTURE_FAIL)
388 context->results->returncode = false;
391 static bool test_needs_running(const char *name, const char **restricted)
393 int i;
394 if (restricted == NULL)
395 return true;
396 for (i = 0; restricted[i]; i++) {
397 if (!strcmp(name, restricted[i]))
398 return true;
400 return false;
403 static bool internal_torture_run_test(struct torture_context *context,
404 struct torture_tcase *tcase,
405 struct torture_test *test,
406 bool already_setup,
407 const char **restricted)
409 bool success;
410 char *subunit_testname = NULL;
412 if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
413 subunit_testname = talloc_asprintf(context, "%s.%s", tcase->name, test->name);
414 } else {
415 subunit_testname = talloc_strdup(context, test->name);
418 if (!test_needs_running(subunit_testname, restricted))
419 return true;
421 context->active_tcase = tcase;
422 context->active_test = test;
424 torture_ui_test_start(context, tcase, test);
426 context->last_reason = NULL;
427 context->last_result = TORTURE_OK;
429 if (!already_setup && tcase->setup &&
430 !tcase->setup(context, &(tcase->data))) {
431 if (context->last_reason == NULL)
432 context->last_reason = talloc_strdup(context, "Setup failure");
433 context->last_result = TORTURE_ERROR;
434 success = false;
435 } else if (test->dangerous &&
436 !torture_setting_bool(context, "dangerous", false)) {
437 context->last_result = TORTURE_SKIP;
438 context->last_reason = talloc_asprintf(context,
439 "disabled %s - enable dangerous tests to use", test->name);
440 success = true;
441 } else {
442 success = test->run(context, tcase, test);
444 if (!success && context->last_result == TORTURE_OK) {
445 if (context->last_reason == NULL)
446 context->last_reason = talloc_strdup(context,
447 "Unknown error/failure. Missing torture_fail() or torture_assert_*() call?");
448 context->last_result = TORTURE_ERROR;
452 if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data)) {
453 if (context->last_reason == NULL)
454 context->last_reason = talloc_strdup(context, "Setup failure");
455 context->last_result = TORTURE_ERROR;
456 success = false;
459 torture_ui_test_result(context, context->last_result,
460 context->last_reason);
462 talloc_free(context->last_reason);
464 context->active_test = NULL;
465 context->active_tcase = NULL;
467 return success;
470 bool torture_run_tcase(struct torture_context *context,
471 struct torture_tcase *tcase)
473 return torture_run_tcase_restricted(context, tcase, NULL);
476 bool torture_run_tcase_restricted(struct torture_context *context,
477 struct torture_tcase *tcase, const char **restricted)
479 bool ret = true;
480 struct torture_test *test;
481 bool setup_succeeded = true;
482 const char * setup_reason = "Setup failed";
484 context->active_tcase = tcase;
485 if (context->results->ui_ops->tcase_start)
486 context->results->ui_ops->tcase_start(context, tcase);
488 if (tcase->fixture_persistent && tcase->setup) {
489 setup_succeeded = tcase->setup(context, &tcase->data);
492 if (!setup_succeeded) {
493 /* Uh-oh. The setup failed, so we can't run any of the tests
494 * in this testcase. The subunit format doesn't specify what
495 * to do here, so we keep the failure reason, and manually
496 * use it to fail every test.
498 if (context->last_reason != NULL) {
499 setup_reason = talloc_asprintf(context,
500 "Setup failed: %s", context->last_reason);
504 for (test = tcase->tests; test; test = test->next) {
505 if (setup_succeeded) {
506 ret &= internal_torture_run_test(context, tcase, test,
507 tcase->fixture_persistent, restricted);
508 } else {
509 context->active_tcase = tcase;
510 context->active_test = test;
511 torture_ui_test_start(context, tcase, test);
512 torture_ui_test_result(context, TORTURE_FAIL, setup_reason);
516 if (setup_succeeded && tcase->fixture_persistent && tcase->teardown &&
517 !tcase->teardown(context, tcase->data)) {
518 ret = false;
521 context->active_tcase = NULL;
522 context->active_test = NULL;
524 if (context->results->ui_ops->tcase_finish)
525 context->results->ui_ops->tcase_finish(context, tcase);
527 return (!setup_succeeded) ? false : ret;
530 bool torture_run_test(struct torture_context *context,
531 struct torture_tcase *tcase,
532 struct torture_test *test)
534 return internal_torture_run_test(context, tcase, test, false, NULL);
537 bool torture_run_test_restricted(struct torture_context *context,
538 struct torture_tcase *tcase,
539 struct torture_test *test,
540 const char **restricted)
542 return internal_torture_run_test(context, tcase, test, false, restricted);
545 int torture_setting_int(struct torture_context *test, const char *name,
546 int default_value)
548 return lpcfg_parm_int(test->lp_ctx, NULL, "torture", name, default_value);
551 unsigned long torture_setting_ulong(struct torture_context *test,
552 const char *name,
553 unsigned long default_value)
555 return lpcfg_parm_ulong(test->lp_ctx, NULL, "torture", name,
556 default_value);
559 double torture_setting_double(struct torture_context *test, const char *name,
560 double default_value)
562 return lpcfg_parm_double(test->lp_ctx, NULL, "torture", name, default_value);
565 bool torture_setting_bool(struct torture_context *test, const char *name,
566 bool default_value)
568 return lpcfg_parm_bool(test->lp_ctx, NULL, "torture", name, default_value);
571 const char *torture_setting_string(struct torture_context *test,
572 const char *name,
573 const char *default_value)
575 const char *ret;
577 SMB_ASSERT(test != NULL);
578 SMB_ASSERT(test->lp_ctx != NULL);
580 ret = lpcfg_parm_string(test->lp_ctx, NULL, "torture", name);
582 if (ret == NULL)
583 return default_value;
585 return ret;
588 static bool wrap_test_with_simple_tcase_const (
589 struct torture_context *torture_ctx,
590 struct torture_tcase *tcase,
591 struct torture_test *test)
593 bool (*fn) (struct torture_context *, const void *tcase_data);
595 fn = test->fn;
597 return fn(torture_ctx, test->data);
600 struct torture_tcase *torture_suite_add_simple_tcase_const(
601 struct torture_suite *suite, const char *name,
602 bool (*run) (struct torture_context *test, const void *),
603 const void *data)
605 struct torture_tcase *tcase;
606 struct torture_test *test;
608 tcase = torture_suite_add_tcase(suite, name);
610 test = talloc(tcase, struct torture_test);
612 test->name = talloc_strdup(test, name);
613 test->description = NULL;
614 test->run = wrap_test_with_simple_tcase_const;
615 test->fn = run;
616 test->data = data;
617 test->dangerous = false;
619 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
621 return tcase;
624 static bool wrap_simple_test(struct torture_context *torture_ctx,
625 struct torture_tcase *tcase,
626 struct torture_test *test)
628 bool (*fn) (struct torture_context *);
630 fn = test->fn;
632 return fn(torture_ctx);
635 struct torture_tcase *torture_suite_add_simple_test(
636 struct torture_suite *suite,
637 const char *name,
638 bool (*run) (struct torture_context *test))
640 struct torture_test *test;
641 struct torture_tcase *tcase;
643 tcase = torture_suite_add_tcase(suite, name);
645 test = talloc(tcase, struct torture_test);
647 test->name = talloc_strdup(test, name);
648 test->description = NULL;
649 test->run = wrap_simple_test;
650 test->fn = run;
651 test->dangerous = false;
653 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
655 return tcase;
659 * Add a child testsuite to a testsuite.
661 bool torture_suite_add_suite(struct torture_suite *suite,
662 struct torture_suite *child)
664 if (child == NULL)
665 return false;
667 DLIST_ADD_END(suite->children, child, struct torture_suite *);
669 /* FIXME: Check for duplicates and return false if the
670 * added suite already exists as a child */
672 return true;
676 * Find the child testsuite with the specified name.
678 struct torture_suite *torture_find_suite(struct torture_suite *parent,
679 const char *name)
681 struct torture_suite *child;
683 for (child = parent->children; child; child = child->next)
684 if (!strcmp(child->name, name))
685 return child;
687 return NULL;
690 static bool wrap_test_with_simple_test_const(struct torture_context *torture_ctx,
691 struct torture_tcase *tcase,
692 struct torture_test *test)
694 bool (*fn) (struct torture_context *, const void *tcase_data);
696 fn = test->fn;
698 return fn(torture_ctx, tcase->data);
701 struct torture_test *torture_tcase_add_simple_test_const(
702 struct torture_tcase *tcase,
703 const char *name,
704 bool (*run) (struct torture_context *test,
705 const void *tcase_data))
707 struct torture_test *test;
709 test = talloc(tcase, struct torture_test);
711 test->name = talloc_strdup(test, name);
712 test->description = NULL;
713 test->run = wrap_test_with_simple_test_const;
714 test->fn = run;
715 test->data = NULL;
716 test->dangerous = false;
718 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
720 return test;
723 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
724 struct torture_tcase *tcase,
725 struct torture_test *test)
727 bool (*fn) (struct torture_context *, void *tcase_data);
729 fn = test->fn;
731 return fn(torture_ctx, tcase->data);
734 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
735 const char *name,
736 bool (*run) (struct torture_context *test, void *tcase_data))
738 struct torture_test *test;
740 test = talloc(tcase, struct torture_test);
742 test->name = talloc_strdup(test, name);
743 test->description = NULL;
744 test->run = wrap_test_with_simple_test;
745 test->fn = run;
746 test->data = NULL;
747 test->dangerous = false;
749 DLIST_ADD_END(tcase->tests, test, struct torture_test *);
751 return test;
754 void torture_ui_report_time(struct torture_context *context)
756 if (context->results->ui_ops->report_time)
757 context->results->ui_ops->report_time(context);