lib/torture/torture.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB torture UI functions
   4
   5    Copyright (C) Jelmer Vernooij 2006-2008
   6
   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.
  11
  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.
  16
  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/>.
  19 */
  20
  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
  27
  28 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops)
  29 {
  30         struct torture_results *results = talloc_zero(mem_ctx, struct torture_results);
  31
  32         results->ui_ops = ui_ops;
  33         results->returncode = true;
  34
  35         if (ui_ops->init)
  36                 ui_ops->init(results);
  37
  38         return results;
  39 }
  40
  41 /**
  42  * Initialize a torture context
  43  */
  44 struct torture_context *torture_context_init(struct tevent_context *event_ctx,
  45                                                                                          struct torture_results *results)
  46 {
  47         struct torture_context *torture = talloc_zero(event_ctx,
  48                                                       struct torture_context);
  49
  50         if (torture == NULL)
  51                 return NULL;
  52
  53         torture->ev = event_ctx;
  54         torture->results = talloc_reference(torture, results);
  55
  56         return torture;
  57 }
  58
  59 /**
  60  * Create a sub torture context
  61  */
  62 struct torture_context *torture_context_child(struct torture_context *parent)
  63 {
  64         struct torture_context *subtorture = talloc_zero(parent, struct torture_context);
  65
  66         if (subtorture == NULL)
  67                 return NULL;
  68
  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);
  73
  74         return subtorture;
  75 }
  76
  77 /**
  78  create a temporary directory.
  79 */
  80 _PUBLIC_ NTSTATUS torture_temp_dir(struct torture_context *tctx,
  81                                    const char *prefix, char **tempdir)
  82 {
  83         SMB_ASSERT(tctx->outputdir != NULL);
  84
  85         *tempdir = talloc_asprintf(tctx, "%s/%s.XXXXXX", tctx->outputdir,
  86                                    prefix);
  87         NT_STATUS_HAVE_NO_MEMORY(*tempdir);
  88
  89         if (mkdtemp(*tempdir) == NULL) {
  90                 return map_nt_error_from_unix(errno);
  91         }
  92
  93         return NT_STATUS_OK;
  94 }
  95
  96 /**
  97  * Comment on the status/progress of a test
  98  */
  99 void torture_comment(struct torture_context *context, const char *comment, ...)
 100 {
 101         va_list ap;
 102         char *tmp;
 103
 104         if (!context->results->ui_ops->comment)
 105                 return;
 106
 107         va_start(ap, comment);
 108         tmp = talloc_vasprintf(context, comment, ap);
 109         va_end(ap);
 110
 111         context->results->ui_ops->comment(context, tmp);
 112
 113         talloc_free(tmp);
 114 }
 115
 116 /**
 117  * Print a warning about the current test
 118  */
 119 void torture_warning(struct torture_context *context, const char *comment, ...)
 120 {
 121         va_list ap;
 122         char *tmp;
 123
 124         if (!context->results->ui_ops->warning)
 125                 return;
 126
 127         va_start(ap, comment);
 128         tmp = talloc_vasprintf(context, comment, ap);
 129         va_end(ap);
 130
 131         context->results->ui_ops->warning(context, tmp);
 132
 133         talloc_free(tmp);
 134 }
 135
 136 /**
 137  * Store the result of a torture test.
 138  */
 139 void torture_result(struct torture_context *context,
 140                     enum torture_result result, const char *fmt, ...)
 141 {
 142         va_list ap;
 143
 144         va_start(ap, fmt);
 145
 146         if (context->last_reason) {
 147                 torture_warning(context, "%s", context->last_reason);
 148                 talloc_free(context->last_reason);
 149         }
 150
 151         context->last_result = result;
 152         context->last_reason = talloc_vasprintf(context, fmt, ap);
 153         va_end(ap);
 154 }
 155
 156 /**
 157  * Create a new torture suite
 158  */
 159 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
 160 {
 161         struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
 162
 163         suite->name = talloc_strdup(suite, name);
 164         suite->testcases = NULL;
 165         suite->children = NULL;
 166
 167         return suite;
 168 }
 169
 170 /**
 171  * Set the setup() and teardown() functions for a testcase.
 172  */
 173 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 174                 bool (*setup) (struct torture_context *, void **),
 175                 bool (*teardown) (struct torture_context *, void *))
 176 {
 177         tcase->setup = setup;
 178         tcase->teardown = teardown;
 179 }
 180
 181 static bool wrap_test_with_testcase_const(struct torture_context *torture_ctx,
 182                                     struct torture_tcase *tcase,
 183                                     struct torture_test *test)
 184 {
 185         bool (*fn) (struct torture_context *,
 186                     const void *tcase_data,
 187                     const void *test_data);
 188
 189         fn = test->fn;
 190
 191         return fn(torture_ctx, tcase->data, test->data);
 192 }
 193
 194 /**
 195  * Add a test that uses const data to a testcase
 196  */
 197 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
 198                 const char *name,
 199                 bool (*run) (struct torture_context *, const void *tcase_data,
 200                         const void *test_data),
 201                 const void *data)
 202 {
 203         struct torture_test *test = talloc(tcase, struct torture_test);
 204
 205         test->name = talloc_strdup(test, name);
 206         test->description = NULL;
 207         test->run = wrap_test_with_testcase_const;
 208         test->fn = run;
 209         test->dangerous = false;
 210         test->data = data;
 211
 212         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 213
 214         return test;
 215 }
 216
 217 /**
 218  * Add a new testcase
 219  */
 220 bool torture_suite_init_tcase(struct torture_suite *suite,
 221                               struct torture_tcase *tcase,
 222                               const char *name)
 223 {
 224         tcase->name = talloc_strdup(tcase, name);
 225         tcase->description = NULL;
 226         tcase->setup = NULL;
 227         tcase->teardown = NULL;
 228         tcase->fixture_persistent = true;
 229         tcase->tests = NULL;
 230
 231         DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
 232
 233         return true;
 234 }
 235
 236
 237 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 238                                                          const char *name)
 239 {
 240         struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
 241
 242         if (!torture_suite_init_tcase(suite, tcase, name))
 243                 return NULL;
 244
 245         return tcase;
 246 }
 247
 248 int torture_suite_children_count(const struct torture_suite *suite)
 249 {
 250         int ret = 0;
 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) {
 256                         ret++;
 257                 }
 258         }
 259         for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
 260                 ret ++;
 261         }
 262         return ret;
 263 }
 264
 265 /**
 266  * Run a torture test suite.
 267  */
 268 bool torture_run_suite(struct torture_context *context,
 269                        struct torture_suite *suite)
 270 {
 271         return torture_run_suite_restricted(context, suite, NULL);
 272 }
 273
 274 bool torture_run_suite_restricted(struct torture_context *context,
 275                        struct torture_suite *suite, const char **restricted)
 276 {
 277         bool ret = true;
 278         struct torture_tcase *tcase;
 279         struct torture_suite *tsuite;
 280         char *old_testname;
 281
 282         if (context->results->ui_ops->suite_start)
 283                 context->results->ui_ops->suite_start(context, suite);
 284
 285         /* FIXME: Adjust torture_suite_children_count if restricted != NULL */
 286         context->results->ui_ops->progress(context,
 287                 torture_suite_children_count(suite), TORTURE_PROGRESS_SET);
 288
 289         for (tcase = suite->testcases; tcase; tcase = tcase->next) {
 290                 ret &= torture_run_tcase_restricted(context, tcase, restricted);
 291         }
 292
 293         for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
 294                 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_PUSH);
 295                 ret &= torture_run_suite_restricted(context, tsuite, restricted);
 296                 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_POP);
 297         }
 298
 299         if (context->results->ui_ops->suite_finish)
 300                 context->results->ui_ops->suite_finish(context, suite);
 301
 302         return ret;
 303 }
 304
 305 void torture_ui_test_start(struct torture_context *context,
 306                            struct torture_tcase *tcase,
 307                            struct torture_test *test)
 308 {
 309         if (context->results->ui_ops->test_start)
 310                 context->results->ui_ops->test_start(context, tcase, test);
 311 }
 312
 313 void torture_ui_test_result(struct torture_context *context,
 314                             enum torture_result result,
 315                             const char *comment)
 316 {
 317         if (context->results->ui_ops->test_result)
 318                 context->results->ui_ops->test_result(context, result, comment);
 319
 320         if (result == TORTURE_ERROR || result == TORTURE_FAIL)
 321                 context->results->returncode = false;
 322 }
 323
 324 static bool test_needs_running(const char *name, const char **restricted)
 325 {
 326         int i;
 327         if (restricted == NULL)
 328                 return true;
 329         for (i = 0; restricted[i]; i++) {
 330                 if (!strcmp(name, restricted[i]))
 331                         return true;
 332         }
 333         return false;
 334 }
 335
 336 static bool internal_torture_run_test(struct torture_context *context,
 337                                           struct torture_tcase *tcase,
 338                                           struct torture_test *test,
 339                                           bool already_setup,
 340                                           const char **restricted)
 341 {
 342         bool success;
 343         char *old_testname = NULL;
 344         char *subunit_testname = NULL;
 345
 346         if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
 347                 subunit_testname = talloc_asprintf(context, "%s.%s", tcase->name, test->name);
 348         } else {
 349                 subunit_testname = test->name;
 350         }
 351
 352         if (!test_needs_running(subunit_testname, restricted))
 353                 return true;
 354
 355         context->active_tcase = tcase;
 356         context->active_test = test;
 357
 358         torture_ui_test_start(context, tcase, test);
 359
 360         context->last_reason = NULL;
 361         context->last_result = TORTURE_OK;
 362
 363         if (!already_setup && tcase->setup &&
 364                 !tcase->setup(context, &(tcase->data))) {
 365                 if (context->last_reason == NULL)
 366                         context->last_reason = talloc_strdup(context, "Setup failure");
 367                 context->last_result = TORTURE_ERROR;
 368                 success = false;
 369         } else if (test->dangerous &&
 370             !torture_setting_bool(context, "dangerous", false)) {
 371             context->last_result = TORTURE_SKIP;
 372             context->last_reason = talloc_asprintf(context,
 373                 "disabled %s - enable dangerous tests to use", test->name);
 374             success = true;
 375         } else {
 376             success = test->run(context, tcase, test);
 377
 378             if (!success && context->last_result == TORTURE_OK) {
 379                     if (context->last_reason == NULL)
 380                             context->last_reason = talloc_strdup(context, "Unknown error/failure");
 381                     context->last_result = TORTURE_ERROR;
 382             }
 383         }
 384
 385         if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data)) {
 386                 if (context->last_reason == NULL)
 387                     context->last_reason = talloc_strdup(context, "Setup failure");
 388                 context->last_result = TORTURE_ERROR;
 389                 success = false;
 390         }
 391
 392         torture_ui_test_result(context, context->last_result,
 393                                context->last_reason);
 394
 395         talloc_free(context->last_reason);
 396
 397         context->active_test = NULL;
 398         context->active_tcase = NULL;
 399
 400         return success;
 401 }
 402
 403 bool torture_run_tcase(struct torture_context *context,
 404                        struct torture_tcase *tcase)
 405 {
 406         return torture_run_tcase_restricted(context, tcase, NULL);
 407 }
 408
 409 bool torture_run_tcase_restricted(struct torture_context *context,
 410                        struct torture_tcase *tcase, const char **restricted)
 411 {
 412         bool ret = true;
 413         char *old_testname;
 414         struct torture_test *test;
 415         bool setup_succeeded = true;
 416         const char * setup_reason = "Setup failed";
 417
 418         context->active_tcase = tcase;
 419         if (context->results->ui_ops->tcase_start)
 420                 context->results->ui_ops->tcase_start(context, tcase);
 421
 422         if (tcase->fixture_persistent && tcase->setup) {
 423                 setup_succeeded = tcase->setup(context, &tcase->data);
 424         }
 425
 426         if (!setup_succeeded) {
 427                 /* Uh-oh. The setup failed, so we can't run any of the tests
 428                  * in this testcase. The subunit format doesn't specify what
 429                  * to do here, so we keep the failure reason, and manually
 430                  * use it to fail every test.
 431                  */
 432                 if (context->last_reason != NULL) {
 433                         setup_reason = talloc_asprintf(context,
 434                                 "Setup failed: %s", context->last_reason);
 435                 }
 436         }
 437
 438         for (test = tcase->tests; test; test = test->next) {
 439                 if (setup_succeeded) {
 440                         ret &= internal_torture_run_test(context, tcase, test,
 441                                         tcase->fixture_persistent, restricted);
 442                 } else {
 443                         context->active_tcase = tcase;
 444                         context->active_test = test;
 445                         torture_ui_test_start(context, tcase, test);
 446                         torture_ui_test_result(context, TORTURE_FAIL, setup_reason);
 447                 }
 448         }
 449
 450         if (setup_succeeded && tcase->fixture_persistent && tcase->teardown &&
 451                 !tcase->teardown(context, tcase->data)) {
 452                 ret = false;
 453         }
 454
 455         context->active_tcase = NULL;
 456         context->active_test = NULL;
 457
 458         if (context->results->ui_ops->tcase_finish)
 459                 context->results->ui_ops->tcase_finish(context, tcase);
 460
 461         return (!setup_succeeded) ? false : ret;
 462 }
 463
 464 bool torture_run_test(struct torture_context *context,
 465                                           struct torture_tcase *tcase,
 466                                           struct torture_test *test)
 467 {
 468         return internal_torture_run_test(context, tcase, test, false, NULL);
 469 }
 470
 471 bool torture_run_test_restricted(struct torture_context *context,
 472                                           struct torture_tcase *tcase,
 473                                           struct torture_test *test,
 474                                           const char **restricted)
 475 {
 476         return internal_torture_run_test(context, tcase, test, false, restricted);
 477 }
 478
 479 int torture_setting_int(struct torture_context *test, const char *name,
 480                                                         int default_value)
 481 {
 482         return lpcfg_parm_int(test->lp_ctx, NULL, "torture", name, default_value);
 483 }
 484
 485 unsigned long torture_setting_ulong(struct torture_context *test,
 486                                     const char *name,
 487                                     unsigned long default_value)
 488 {
 489         return lpcfg_parm_ulong(test->lp_ctx, NULL, "torture", name,
 490                              default_value);
 491 }
 492
 493 double torture_setting_double(struct torture_context *test, const char *name,
 494                                                         double default_value)
 495 {
 496         return lpcfg_parm_double(test->lp_ctx, NULL, "torture", name, default_value);
 497 }
 498
 499 bool torture_setting_bool(struct torture_context *test, const char *name,
 500                                                         bool default_value)
 501 {
 502         return lpcfg_parm_bool(test->lp_ctx, NULL, "torture", name, default_value);
 503 }
 504
 505 const char *torture_setting_string(struct torture_context *test,
 506                                    const char *name,
 507                                    const char *default_value)
 508 {
 509         const char *ret;
 510
 511         SMB_ASSERT(test != NULL);
 512         SMB_ASSERT(test->lp_ctx != NULL);
 513
 514         ret = lpcfg_parm_string(test->lp_ctx, NULL, "torture", name);
 515
 516         if (ret == NULL)
 517                 return default_value;
 518
 519         return ret;
 520 }
 521
 522 static bool wrap_test_with_simple_tcase_const (
 523                 struct torture_context *torture_ctx,
 524                 struct torture_tcase *tcase,
 525                 struct torture_test *test)
 526 {
 527         bool (*fn) (struct torture_context *, const void *tcase_data);
 528
 529         fn = test->fn;
 530
 531         return fn(torture_ctx, test->data);
 532 }
 533
 534 struct torture_tcase *torture_suite_add_simple_tcase_const(
 535                 struct torture_suite *suite, const char *name,
 536                 bool (*run) (struct torture_context *test, const void *),
 537                 const void *data)
 538 {
 539         struct torture_tcase *tcase;
 540         struct torture_test *test;
 541
 542         tcase = torture_suite_add_tcase(suite, name);
 543
 544         test = talloc(tcase, struct torture_test);
 545
 546         test->name = talloc_strdup(test, name);
 547         test->description = NULL;
 548         test->run = wrap_test_with_simple_tcase_const;
 549         test->fn = run;
 550         test->data = data;
 551         test->dangerous = false;
 552
 553         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 554
 555         return tcase;
 556 }
 557
 558 static bool wrap_simple_test(struct torture_context *torture_ctx,
 559                              struct torture_tcase *tcase,
 560                              struct torture_test *test)
 561 {
 562         bool (*fn) (struct torture_context *);
 563
 564         fn = test->fn;
 565
 566         return fn(torture_ctx);
 567 }
 568
 569 struct torture_tcase *torture_suite_add_simple_test(
 570                                         struct torture_suite *suite,
 571                                         const char *name,
 572                                         bool (*run) (struct torture_context *test))
 573 {
 574         struct torture_test *test;
 575         struct torture_tcase *tcase;
 576
 577         tcase = torture_suite_add_tcase(suite, name);
 578
 579         test = talloc(tcase, struct torture_test);
 580
 581         test->name = talloc_strdup(test, name);
 582         test->description = NULL;
 583         test->run = wrap_simple_test;
 584         test->fn = run;
 585         test->dangerous = false;
 586
 587         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 588
 589         return tcase;
 590 }
 591
 592 /**
 593  * Add a child testsuite to a testsuite.
 594  */
 595 bool torture_suite_add_suite(struct torture_suite *suite,
 596                              struct torture_suite *child)
 597 {
 598         if (child == NULL)
 599                 return false;
 600
 601         DLIST_ADD_END(suite->children, child, struct torture_suite *);
 602
 603         /* FIXME: Check for duplicates and return false if the
 604          * added suite already exists as a child */
 605
 606         return true;
 607 }
 608
 609 /**
 610  * Find the child testsuite with the specified name.
 611  */
 612 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 613                                          const char *name)
 614 {
 615         struct torture_suite *child;
 616
 617         for (child = parent->children; child; child = child->next)
 618                 if (!strcmp(child->name, name))
 619                         return child;
 620
 621         return NULL;
 622 }
 623
 624 static bool wrap_test_with_simple_test_const(struct torture_context *torture_ctx,
 625                                        struct torture_tcase *tcase,
 626                                        struct torture_test *test)
 627 {
 628         bool (*fn) (struct torture_context *, const void *tcase_data);
 629
 630         fn = test->fn;
 631
 632         return fn(torture_ctx, tcase->data);
 633 }
 634
 635 struct torture_test *torture_tcase_add_simple_test_const(
 636                 struct torture_tcase *tcase,
 637                 const char *name,
 638                 bool (*run) (struct torture_context *test,
 639                         const void *tcase_data))
 640 {
 641         struct torture_test *test;
 642
 643         test = talloc(tcase, struct torture_test);
 644
 645         test->name = talloc_strdup(test, name);
 646         test->description = NULL;
 647         test->run = wrap_test_with_simple_test_const;
 648         test->fn = run;
 649         test->data = NULL;
 650         test->dangerous = false;
 651
 652         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 653
 654         return test;
 655 }
 656
 657 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
 658                                        struct torture_tcase *tcase,
 659                                        struct torture_test *test)
 660 {
 661         bool (*fn) (struct torture_context *, void *tcase_data);
 662
 663         fn = test->fn;
 664
 665         return fn(torture_ctx, tcase->data);
 666 }
 667
 668 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 669                 const char *name,
 670                 bool (*run) (struct torture_context *test, void *tcase_data))
 671 {
 672         struct torture_test *test;
 673
 674         test = talloc(tcase, struct torture_test);
 675
 676         test->name = talloc_strdup(test, name);
 677         test->description = NULL;
 678         test->run = wrap_test_with_simple_test;
 679         test->fn = run;
 680         test->data = NULL;
 681         test->dangerous = false;
 682
 683         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 684
 685         return test;
 686 }