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 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops)
  28 {
  29         struct torture_results *results = talloc_zero(mem_ctx, struct torture_results);
  30
  31         results->ui_ops = ui_ops;
  32         results->returncode = true;
  33
  34         if (ui_ops->init)
  35                 ui_ops->init(results);
  36
  37         return results;
  38 }
  39
  40 /**
  41  * Initialize a torture context
  42  */
  43 struct torture_context *torture_context_init(struct tevent_context *event_ctx,
  44                                                                                          struct torture_results *results)
  45 {
  46         struct torture_context *torture = talloc_zero(event_ctx,
  47                                                       struct torture_context);
  48
  49         if (torture == NULL)
  50                 return NULL;
  51
  52         torture->ev = event_ctx;
  53         torture->results = talloc_reference(torture, results);
  54
  55         return torture;
  56 }
  57
  58 /**
  59  * Create a sub torture context
  60  */
  61 struct torture_context *torture_context_child(struct torture_context *parent)
  62 {
  63         struct torture_context *subtorture = talloc_zero(parent, struct torture_context);
  64
  65         if (subtorture == NULL)
  66                 return NULL;
  67
  68         subtorture->ev = talloc_reference(subtorture, parent->ev);
  69         subtorture->lp_ctx = talloc_reference(subtorture, parent->lp_ctx);
  70         subtorture->outputdir = talloc_reference(subtorture, parent->outputdir);
  71         subtorture->results = talloc_reference(subtorture, parent->results);
  72
  73         return subtorture;
  74 }
  75
  76 /**
  77  create a temporary directory.
  78 */
  79 _PUBLIC_ NTSTATUS torture_temp_dir(struct torture_context *tctx,
  80                                    const char *prefix,
  81                                    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         bool ret = true;
 272         struct torture_tcase *tcase;
 273         struct torture_suite *tsuite;
 274         char *old_testname;
 275
 276         if (context->results->ui_ops->suite_start)
 277                 context->results->ui_ops->suite_start(context, suite);
 278
 279         context->results->ui_ops->progress(context,
 280                 torture_suite_children_count(suite), TORTURE_PROGRESS_SET);
 281         old_testname = context->active_testname;
 282         if (old_testname != NULL)
 283                 context->active_testname = talloc_asprintf(context, "%s-%s",
 284                                                            old_testname, suite->name);
 285         else
 286                 context->active_testname = talloc_strdup(context, suite->name);
 287
 288         for (tcase = suite->testcases; tcase; tcase = tcase->next) {
 289                 ret &= torture_run_tcase(context, tcase);
 290         }
 291
 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(context, tsuite);
 295                 context->results->ui_ops->progress(context, 0, TORTURE_PROGRESS_POP);
 296         }
 297
 298         talloc_free(context->active_testname);
 299         context->active_testname = old_testname;
 300
 301         if (context->results->ui_ops->suite_finish)
 302                 context->results->ui_ops->suite_finish(context, suite);
 303
 304         return ret;
 305 }
 306
 307 void torture_ui_test_start(struct torture_context *context,
 308                            struct torture_tcase *tcase,
 309                            struct torture_test *test)
 310 {
 311         if (context->results->ui_ops->test_start)
 312                 context->results->ui_ops->test_start(context, tcase, test);
 313 }
 314
 315 void torture_ui_test_result(struct torture_context *context,
 316                             enum torture_result result,
 317                             const char *comment)
 318 {
 319         if (context->results->ui_ops->test_result)
 320                 context->results->ui_ops->test_result(context, result, comment);
 321
 322         if (result == TORTURE_ERROR || result == TORTURE_FAIL)
 323                 context->results->returncode = false;
 324 }
 325
 326 static bool internal_torture_run_test(struct torture_context *context,
 327                                           struct torture_tcase *tcase,
 328                                           struct torture_test *test,
 329                                           bool already_setup)
 330 {
 331         bool success;
 332         char *old_testname = NULL;
 333
 334         if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
 335                 old_testname = context->active_testname;
 336                 context->active_testname = talloc_asprintf(context, "%s-%s", old_testname, test->name);
 337         }
 338
 339         context->active_tcase = tcase;
 340         context->active_test = test;
 341
 342         torture_ui_test_start(context, tcase, test);
 343
 344         context->last_reason = NULL;
 345         context->last_result = TORTURE_OK;
 346
 347         if (!already_setup && tcase->setup &&
 348                 !tcase->setup(context, &(tcase->data))) {
 349                 if (context->last_reason == NULL)
 350                         context->last_reason = talloc_strdup(context, "Setup failure");
 351                 context->last_result = TORTURE_ERROR;
 352                 success = false;
 353         } else if (test->dangerous &&
 354             !torture_setting_bool(context, "dangerous", false)) {
 355             context->last_result = TORTURE_SKIP;
 356             context->last_reason = talloc_asprintf(context,
 357                 "disabled %s - enable dangerous tests to use", test->name);
 358             success = true;
 359         } else {
 360             success = test->run(context, tcase, test);
 361
 362             if (!success && context->last_result == TORTURE_OK) {
 363                     if (context->last_reason == NULL)
 364                             context->last_reason = talloc_strdup(context, "Unknown error/failure");
 365                     context->last_result = TORTURE_ERROR;
 366             }
 367         }
 368
 369         if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data)) {
 370                 if (context->last_reason == NULL)
 371                     context->last_reason = talloc_strdup(context, "Setup failure");
 372                 context->last_result = TORTURE_ERROR;
 373                 success = false;
 374         }
 375
 376         torture_ui_test_result(context, context->last_result,
 377                                context->last_reason);
 378
 379         talloc_free(context->last_reason);
 380
 381         if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
 382                 talloc_free(context->active_testname);
 383                 context->active_testname = old_testname;
 384         }
 385         context->active_test = NULL;
 386         context->active_tcase = NULL;
 387
 388         return success;
 389 }
 390
 391 bool torture_run_tcase(struct torture_context *context,
 392                        struct torture_tcase *tcase)
 393 {
 394         bool ret = true;
 395         char *old_testname;
 396         struct torture_test *test;
 397
 398         context->active_tcase = tcase;
 399         if (context->results->ui_ops->tcase_start)
 400                 context->results->ui_ops->tcase_start(context, tcase);
 401
 402         if (tcase->fixture_persistent && tcase->setup
 403                 && !tcase->setup(context, &tcase->data)) {
 404                 /* FIXME: Use torture ui ops for reporting this error */
 405                 fprintf(stderr, "Setup failed: ");
 406                 if (context->last_reason != NULL)
 407                         fprintf(stderr, "%s", context->last_reason);
 408                 fprintf(stderr, "\n");
 409                 ret = false;
 410                 goto done;
 411         }
 412
 413         old_testname = context->active_testname;
 414         context->active_testname = talloc_asprintf(context, "%s-%s",
 415                                                    old_testname, tcase->name);
 416         for (test = tcase->tests; test; test = test->next) {
 417                 ret &= internal_torture_run_test(context, tcase, test,
 418                                 tcase->fixture_persistent);
 419         }
 420         talloc_free(context->active_testname);
 421         context->active_testname = old_testname;
 422
 423         if (tcase->fixture_persistent && tcase->teardown &&
 424                 !tcase->teardown(context, tcase->data))
 425                 ret = false;
 426
 427 done:
 428         context->active_tcase = NULL;
 429
 430         if (context->results->ui_ops->tcase_finish)
 431                 context->results->ui_ops->tcase_finish(context, tcase);
 432
 433         return ret;
 434 }
 435
 436 bool torture_run_test(struct torture_context *context,
 437                                           struct torture_tcase *tcase,
 438                                           struct torture_test *test)
 439 {
 440         return internal_torture_run_test(context, tcase, test, false);
 441 }
 442
 443 int torture_setting_int(struct torture_context *test, const char *name,
 444                                                         int default_value)
 445 {
 446         return lp_parm_int(test->lp_ctx, NULL, "torture", name, default_value);
 447 }
 448
 449 unsigned long torture_setting_ulong(struct torture_context *test,
 450                                     const char *name,
 451                                     unsigned long default_value)
 452 {
 453         return lp_parm_ulong(test->lp_ctx, NULL, "torture", name,
 454                              default_value);
 455 }
 456
 457 double torture_setting_double(struct torture_context *test, const char *name,
 458                                                         double default_value)
 459 {
 460         return lp_parm_double(test->lp_ctx, NULL, "torture", name, default_value);
 461 }
 462
 463 bool torture_setting_bool(struct torture_context *test, const char *name,
 464                                                         bool default_value)
 465 {
 466         return lp_parm_bool(test->lp_ctx, NULL, "torture", name, default_value);
 467 }
 468
 469 const char *torture_setting_string(struct torture_context *test,
 470                                    const char *name,
 471                                    const char *default_value)
 472 {
 473         const char *ret;
 474
 475         SMB_ASSERT(test != NULL);
 476         SMB_ASSERT(test->lp_ctx != NULL);
 477
 478         ret = lp_parm_string(test->lp_ctx, NULL, "torture", name);
 479
 480         if (ret == NULL)
 481                 return default_value;
 482
 483         return ret;
 484 }
 485
 486 static bool wrap_test_with_simple_tcase_const (
 487                 struct torture_context *torture_ctx,
 488                 struct torture_tcase *tcase,
 489                 struct torture_test *test)
 490 {
 491         bool (*fn) (struct torture_context *, const void *tcase_data);
 492
 493         fn = test->fn;
 494
 495         return fn(torture_ctx, test->data);
 496 }
 497
 498 struct torture_tcase *torture_suite_add_simple_tcase_const(
 499                 struct torture_suite *suite, const char *name,
 500                 bool (*run) (struct torture_context *test, const void *),
 501                 const void *data)
 502 {
 503         struct torture_tcase *tcase;
 504         struct torture_test *test;
 505
 506         tcase = torture_suite_add_tcase(suite, name);
 507
 508         test = talloc(tcase, struct torture_test);
 509
 510         test->name = talloc_strdup(test, name);
 511         test->description = NULL;
 512         test->run = wrap_test_with_simple_tcase_const;
 513         test->fn = run;
 514         test->data = data;
 515         test->dangerous = false;
 516
 517         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 518
 519         return tcase;
 520 }
 521
 522 static bool wrap_simple_test(struct torture_context *torture_ctx,
 523                              struct torture_tcase *tcase,
 524                              struct torture_test *test)
 525 {
 526         bool (*fn) (struct torture_context *);
 527
 528         fn = test->fn;
 529
 530         return fn(torture_ctx);
 531 }
 532
 533 struct torture_tcase *torture_suite_add_simple_test(
 534                                         struct torture_suite *suite,
 535                                         const char *name,
 536                                         bool (*run) (struct torture_context *test))
 537 {
 538         struct torture_test *test;
 539         struct torture_tcase *tcase;
 540
 541         tcase = torture_suite_add_tcase(suite, name);
 542
 543         test = talloc(tcase, struct torture_test);
 544
 545         test->name = talloc_strdup(test, name);
 546         test->description = NULL;
 547         test->run = wrap_simple_test;
 548         test->fn = run;
 549         test->dangerous = false;
 550
 551         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 552
 553         return tcase;
 554 }
 555
 556 /**
 557  * Add a child testsuite to a testsuite.
 558  */
 559 bool torture_suite_add_suite(struct torture_suite *suite,
 560                              struct torture_suite *child)
 561 {
 562         if (child == NULL)
 563                 return false;
 564
 565         DLIST_ADD_END(suite->children, child, struct torture_suite *);
 566
 567         /* FIXME: Check for duplicates and return false if the
 568          * added suite already exists as a child */
 569
 570         return true;
 571 }
 572
 573 /**
 574  * Find the child testsuite with the specified name.
 575  */
 576 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 577                                          const char *name)
 578 {
 579         struct torture_suite *child;
 580
 581         for (child = parent->children; child; child = child->next)
 582                 if (!strcmp(child->name, name))
 583                         return child;
 584
 585         return NULL;
 586 }
 587
 588 static bool wrap_test_with_simple_test_const(struct torture_context *torture_ctx,
 589                                        struct torture_tcase *tcase,
 590                                        struct torture_test *test)
 591 {
 592         bool (*fn) (struct torture_context *, const void *tcase_data);
 593
 594         fn = test->fn;
 595
 596         return fn(torture_ctx, tcase->data);
 597 }
 598
 599 struct torture_test *torture_tcase_add_simple_test_const(
 600                 struct torture_tcase *tcase,
 601                 const char *name,
 602                 bool (*run) (struct torture_context *test,
 603                         const void *tcase_data))
 604 {
 605         struct torture_test *test;
 606
 607         test = talloc(tcase, struct torture_test);
 608
 609         test->name = talloc_strdup(test, name);
 610         test->description = NULL;
 611         test->run = wrap_test_with_simple_test_const;
 612         test->fn = run;
 613         test->data = NULL;
 614         test->dangerous = false;
 615
 616         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 617
 618         return test;
 619 }
 620
 621 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
 622                                        struct torture_tcase *tcase,
 623                                        struct torture_test *test)
 624 {
 625         bool (*fn) (struct torture_context *, void *tcase_data);
 626
 627         fn = test->fn;
 628
 629         return fn(torture_ctx, tcase->data);
 630 }
 631
 632 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 633                 const char *name,
 634                 bool (*run) (struct torture_context *test, void *tcase_data))
 635 {
 636         struct torture_test *test;
 637
 638         test = talloc(tcase, struct torture_test);
 639
 640         test->name = talloc_strdup(test, name);
 641         test->description = NULL;
 642         test->run = wrap_test_with_simple_test;
 643         test->fn = run;
 644         test->data = NULL;
 645         test->dangerous = false;
 646
 647         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 648
 649         return test;
 650 }