source4/lib/torture/torture.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB torture UI functions
   4
   5    Copyright (C) Jelmer Vernooij 2006
   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 "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_context *torture_context_init(struct event_context *event_ctx,
  28                                              const struct torture_ui_ops *ui_ops)
  29 {
  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;
  35
  36         if (ui_ops->init)
  37                 ui_ops->init(torture);
  38
  39         return torture;
  40 }
  41
  42 /**
  43  create a temporary directory.
  44 */
  45 _PUBLIC_ NTSTATUS torture_temp_dir(struct torture_context *tctx,
  46                                    const char *prefix,
  47                                    char **tempdir)
  48 {
  49         SMB_ASSERT(tctx->outputdir != NULL);
  50
  51         *tempdir = talloc_asprintf(tctx, "%s/%s.XXXXXX", tctx->outputdir,
  52                                    prefix);
  53         NT_STATUS_HAVE_NO_MEMORY(*tempdir);
  54
  55         if (mkdtemp(*tempdir) == NULL) {
  56                 return map_nt_error_from_unix(errno);
  57         }
  58
  59         return NT_STATUS_OK;
  60 }
  61
  62 void torture_comment(struct torture_context *context, const char *comment, ...)
  63 {
  64         va_list ap;
  65         char *tmp;
  66
  67         if (!context->ui_ops->comment)
  68                 return;
  69
  70         va_start(ap, comment);
  71         tmp = talloc_vasprintf(context, comment, ap);
  72
  73         context->ui_ops->comment(context, tmp);
  74
  75         talloc_free(tmp);
  76 }
  77
  78 void torture_warning(struct torture_context *context, const char *comment, ...)
  79 {
  80         va_list ap;
  81         char *tmp;
  82
  83         if (!context->ui_ops->warning)
  84                 return;
  85
  86         va_start(ap, comment);
  87         tmp = talloc_vasprintf(context, comment, ap);
  88
  89         context->ui_ops->warning(context, tmp);
  90
  91         talloc_free(tmp);
  92 }
  93
  94 void torture_result(struct torture_context *context,
  95                     enum torture_result result, const char *fmt, ...)
  96 {
  97         va_list ap;
  98
  99         va_start(ap, fmt);
 100
 101         if (context->last_reason) {
 102                 torture_warning(context, "%s", context->last_reason);
 103                 talloc_free(context->last_reason);
 104         }
 105
 106         context->last_result = result;
 107         context->last_reason = talloc_vasprintf(context, fmt, ap);
 108         va_end(ap);
 109 }
 110
 111 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
 112 {
 113         struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
 114
 115         suite->name = talloc_strdup(suite, name);
 116         suite->testcases = NULL;
 117         suite->children = NULL;
 118
 119         return suite;
 120 }
 121
 122 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 123                 bool (*setup) (struct torture_context *, void **),
 124                 bool (*teardown) (struct torture_context *, void *))
 125 {
 126         tcase->setup = setup;
 127         tcase->teardown = teardown;
 128 }
 129
 130 static bool wrap_test_with_testcase_const(struct torture_context *torture_ctx,
 131                                     struct torture_tcase *tcase,
 132                                     struct torture_test *test)
 133 {
 134         bool (*fn) (struct torture_context *,
 135                     const void *tcase_data,
 136                     const void *test_data);
 137
 138         fn = test->fn;
 139
 140         return fn(torture_ctx, tcase->data, test->data);
 141 }
 142
 143 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
 144                 const char *name,
 145                 bool (*run) (struct torture_context *, const void *tcase_data,
 146                         const void *test_data),
 147                 const void *data)
 148 {
 149         struct torture_test *test = talloc(tcase, struct torture_test);
 150
 151         test->name = talloc_strdup(test, name);
 152         test->description = NULL;
 153         test->run = wrap_test_with_testcase_const;
 154         test->fn = run;
 155         test->dangerous = false;
 156         test->data = data;
 157
 158         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 159
 160         return test;
 161 }
 162
 163
 164 bool torture_suite_init_tcase(struct torture_suite *suite,
 165                               struct torture_tcase *tcase,
 166                               const char *name)
 167 {
 168         tcase->name = talloc_strdup(tcase, name);
 169         tcase->description = NULL;
 170         tcase->setup = NULL;
 171         tcase->teardown = NULL;
 172         tcase->fixture_persistent = true;
 173         tcase->tests = NULL;
 174
 175         DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
 176
 177         return true;
 178 }
 179
 180
 181 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 182                                                          const char *name)
 183 {
 184         struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
 185
 186         if (!torture_suite_init_tcase(suite, tcase, name))
 187                 return NULL;
 188
 189         return tcase;
 190 }
 191
 192 bool torture_run_suite(struct torture_context *context,
 193                        struct torture_suite *suite)
 194 {
 195         bool ret = true;
 196         struct torture_tcase *tcase;
 197         struct torture_suite *tsuite;
 198         char *old_testname;
 199
 200         context->level++;
 201         if (context->ui_ops->suite_start)
 202                 context->ui_ops->suite_start(context, suite);
 203
 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);
 208         else
 209                 context->active_testname = talloc_strdup(context, suite->name);
 210
 211         for (tcase = suite->testcases; tcase; tcase = tcase->next) {
 212                 ret &= torture_run_tcase(context, tcase);
 213         }
 214
 215         for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
 216                 ret &= torture_run_suite(context, tsuite);
 217         }
 218
 219         talloc_free(context->active_testname);
 220         context->active_testname = old_testname;
 221
 222         if (context->ui_ops->suite_finish)
 223                 context->ui_ops->suite_finish(context, suite);
 224
 225         context->level--;
 226
 227         return ret;
 228 }
 229
 230 void torture_ui_test_start(struct torture_context *context,
 231                            struct torture_tcase *tcase,
 232                            struct torture_test *test)
 233 {
 234         if (context->ui_ops->test_start)
 235                 context->ui_ops->test_start(context, tcase, test);
 236 }
 237
 238 void torture_ui_test_result(struct torture_context *context,
 239                             enum torture_result result,
 240                             const char *comment)
 241 {
 242         if (context->ui_ops->test_result)
 243                 context->ui_ops->test_result(context, result, comment);
 244
 245         if (result == TORTURE_ERROR || result == TORTURE_FAIL)
 246                 context->returncode = false;
 247 }
 248
 249 static bool internal_torture_run_test(struct torture_context *context,
 250                                           struct torture_tcase *tcase,
 251                                           struct torture_test *test,
 252                                           bool already_setup)
 253 {
 254         bool success;
 255         char *old_testname;
 256
 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);
 260         }
 261
 262         context->active_tcase = tcase;
 263         context->active_test = test;
 264
 265         torture_ui_test_start(context, tcase, test);
 266
 267         context->last_reason = NULL;
 268         context->last_result = TORTURE_OK;
 269
 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;
 275                 success = false;
 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);
 281             success = true;
 282         } else {
 283             success = test->run(context, tcase, test);
 284
 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;
 289             }
 290         }
 291
 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;
 296                 success = false;
 297         }
 298
 299         torture_ui_test_result(context, context->last_result,
 300                                context->last_reason);
 301
 302         talloc_free(context->last_reason);
 303
 304         if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
 305                 talloc_free(context->active_testname);
 306                 context->active_testname = old_testname;
 307         }
 308         context->active_test = NULL;
 309         context->active_tcase = NULL;
 310
 311         return success;
 312 }
 313
 314 bool torture_run_tcase(struct torture_context *context,
 315                        struct torture_tcase *tcase)
 316 {
 317         bool ret = true;
 318         char *old_testname;
 319         struct torture_test *test;
 320
 321         context->level++;
 322
 323         context->active_tcase = tcase;
 324         if (context->ui_ops->tcase_start)
 325                 context->ui_ops->tcase_start(context, tcase);
 326
 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");
 334                 ret = false;
 335                 goto done;
 336         }
 337
 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);
 344         }
 345         talloc_free(context->active_testname);
 346         context->active_testname = old_testname;
 347
 348         if (tcase->fixture_persistent && tcase->teardown &&
 349                 !tcase->teardown(context, tcase->data))
 350                 ret = false;
 351
 352 done:
 353         context->active_tcase = NULL;
 354
 355         if (context->ui_ops->tcase_finish)
 356                 context->ui_ops->tcase_finish(context, tcase);
 357
 358         context->level--;
 359
 360         return ret;
 361 }
 362
 363 bool torture_run_test(struct torture_context *context,
 364                                           struct torture_tcase *tcase,
 365                                           struct torture_test *test)
 366 {
 367         return internal_torture_run_test(context, tcase, test, false);
 368 }
 369
 370 int torture_setting_int(struct torture_context *test, const char *name,
 371                                                         int default_value)
 372 {
 373         return lp_parm_int(test->lp_ctx, NULL, "torture", name, default_value);
 374 }
 375
 376 double torture_setting_double(struct torture_context *test, const char *name,
 377                                                         double default_value)
 378 {
 379         return lp_parm_double(test->lp_ctx, NULL, "torture", name, default_value);
 380 }
 381
 382 bool torture_setting_bool(struct torture_context *test, const char *name,
 383                                                         bool default_value)
 384 {
 385         return lp_parm_bool(test->lp_ctx, NULL, "torture", name, default_value);
 386 }
 387
 388 const char *torture_setting_string(struct torture_context *test,
 389                                    const char *name,
 390                                    const char *default_value)
 391 {
 392         const char *ret;
 393
 394         SMB_ASSERT(test != NULL);
 395         SMB_ASSERT(test->lp_ctx != NULL);
 396
 397         ret = lp_parm_string(test->lp_ctx, NULL, "torture", name);
 398
 399         if (ret == NULL)
 400                 return default_value;
 401
 402         return ret;
 403 }
 404
 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)
 409 {
 410         bool (*fn) (struct torture_context *, const void *tcase_data);
 411
 412         fn = test->fn;
 413
 414         return fn(torture_ctx, test->data);
 415 }
 416
 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 *),
 420                 const void *data)
 421 {
 422         struct torture_tcase *tcase;
 423         struct torture_test *test;
 424
 425         tcase = torture_suite_add_tcase(suite, name);
 426
 427         test = talloc(tcase, struct torture_test);
 428
 429         test->name = talloc_strdup(test, name);
 430         test->description = NULL;
 431         test->run = wrap_test_with_simple_tcase_const;
 432         test->fn = run;
 433         test->data = data;
 434         test->dangerous = false;
 435
 436         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 437
 438         return tcase;
 439 }
 440
 441 static bool wrap_simple_test(struct torture_context *torture_ctx,
 442                              struct torture_tcase *tcase,
 443                              struct torture_test *test)
 444 {
 445         bool (*fn) (struct torture_context *);
 446
 447         fn = test->fn;
 448
 449         return fn(torture_ctx);
 450 }
 451
 452 struct torture_tcase *torture_suite_add_simple_test(
 453                                         struct torture_suite *suite,
 454                                         const char *name,
 455                                         bool (*run) (struct torture_context *test))
 456 {
 457         struct torture_test *test;
 458         struct torture_tcase *tcase;
 459
 460         tcase = torture_suite_add_tcase(suite, name);
 461
 462         test = talloc(tcase, struct torture_test);
 463
 464         test->name = talloc_strdup(test, name);
 465         test->description = NULL;
 466         test->run = wrap_simple_test;
 467         test->fn = run;
 468         test->dangerous = false;
 469
 470         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 471
 472         return tcase;
 473 }
 474
 475 bool torture_suite_add_suite(struct torture_suite *suite,
 476                              struct torture_suite *child)
 477 {
 478         if (child == NULL)
 479                 return false;
 480
 481         DLIST_ADD_END(suite->children, child, struct torture_suite *);
 482
 483         /* FIXME: Check for duplicates and return false if the
 484          * added suite already exists as a child */
 485
 486         return true;
 487 }
 488
 489
 490 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 491                                          const char *name)
 492 {
 493         struct torture_suite *child;
 494
 495         for (child = parent->children; child; child = child->next)
 496                 if (!strcmp(child->name, name))
 497                         return child;
 498
 499         return NULL;
 500 }
 501
 502 static bool wrap_test_with_simple_test_const(struct torture_context *torture_ctx,
 503                                        struct torture_tcase *tcase,
 504                                        struct torture_test *test)
 505 {
 506         bool (*fn) (struct torture_context *, const void *tcase_data);
 507
 508         fn = test->fn;
 509
 510         return fn(torture_ctx, tcase->data);
 511 }
 512
 513 struct torture_test *torture_tcase_add_simple_test_const(
 514                 struct torture_tcase *tcase,
 515                 const char *name,
 516                 bool (*run) (struct torture_context *test,
 517                         const void *tcase_data))
 518 {
 519         struct torture_test *test;
 520
 521         test = talloc(tcase, struct torture_test);
 522
 523         test->name = talloc_strdup(test, name);
 524         test->description = NULL;
 525         test->run = wrap_test_with_simple_test_const;
 526         test->fn = run;
 527         test->data = NULL;
 528         test->dangerous = false;
 529
 530         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 531
 532         return test;
 533 }
 534
 535 static bool wrap_test_with_simple_test(struct torture_context *torture_ctx,
 536                                        struct torture_tcase *tcase,
 537                                        struct torture_test *test)
 538 {
 539         bool (*fn) (struct torture_context *, void *tcase_data);
 540
 541         fn = test->fn;
 542
 543         return fn(torture_ctx, tcase->data);
 544 }
 545
 546 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 547                 const char *name,
 548                 bool (*run) (struct torture_context *test, void *tcase_data))
 549 {
 550         struct torture_test *test;
 551
 552         test = talloc(tcase, struct torture_test);
 553
 554         test->name = talloc_strdup(test, name);
 555         test->description = NULL;
 556         test->run = wrap_test_with_simple_test;
 557         test->fn = run;
 558         test->data = NULL;
 559         test->dangerous = false;
 560
 561         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 562
 563         return test;
 564 }