source/torture/ui.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 2 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, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23 #include "torture/ui.h"
  24 #include "torture/torture.h"
  25 #include "lib/util/dlinklist.h"
  26
  27 void torture_comment(struct torture_context *context, const char *comment, ...)
  28 {
  29         va_list ap;
  30         char *tmp;
  31
  32         if (!context->ui_ops->comment)
  33                 return;
  34
  35         va_start(ap, comment);
  36         tmp = talloc_vasprintf(context, comment, ap);
  37
  38         context->ui_ops->comment(context, tmp);
  39
  40         talloc_free(tmp);
  41 }
  42
  43 void torture_result(struct torture_context *context,
  44                                         enum torture_result result, const char *fmt, ...)
  45 {
  46         va_list ap;
  47
  48         va_start(ap, fmt);
  49
  50         context->last_result = result;
  51         context->last_reason = talloc_vasprintf(context, fmt, ap);
  52         va_end(ap);
  53 }
  54
  55 struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name)
  56 {
  57         struct torture_suite *suite = talloc_zero(ctx, struct torture_suite);
  58
  59         suite->name = talloc_strdup(suite, name);
  60         suite->testcases = NULL;
  61         suite->children = NULL;
  62
  63         return suite;
  64 }
  65
  66 void torture_tcase_set_fixture(struct torture_tcase *tcase,
  67                 BOOL (*setup) (struct torture_context *, void **),
  68                 BOOL (*teardown) (struct torture_context *, void *))
  69 {
  70         tcase->setup = setup;
  71         tcase->teardown = teardown;
  72 }
  73
  74 static bool wrap_test_with_testcase(struct torture_context *torture_ctx,
  75                                                                         struct torture_tcase *tcase,
  76                                                                         struct torture_test *test)
  77 {
  78         bool (*fn) (struct torture_context *,
  79                                  const void *tcase_data,
  80                                  const void *test_data);
  81
  82         fn = test->fn;
  83
  84         return fn(torture_ctx, tcase->data, test->data);
  85 }
  86
  87 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
  88                                                 const char *name,
  89                                                 bool (*run) (struct torture_context *,
  90                                                                          const void *tcase_data,
  91                                                                          const void *test_data),
  92                                                 const void *data)
  93 {
  94         struct torture_test *test = talloc(tcase, struct torture_test);
  95
  96         test->name = talloc_strdup(test, name);
  97         test->description = NULL;
  98         test->run = wrap_test_with_testcase;
  99         test->fn = run;
 100         test->dangerous = False;
 101         test->data = data;
 102
 103         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 104
 105         return test;
 106 }
 107
 108 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 109                                                          const char *name)
 110 {
 111         struct torture_tcase *tcase = talloc(suite, struct torture_tcase);
 112
 113         tcase->name = talloc_strdup(tcase, name);
 114         tcase->description = NULL;
 115         tcase->setup = NULL;
 116         tcase->teardown = NULL;
 117         tcase->fixture_persistent = True;
 118         tcase->tests = NULL;
 119
 120         DLIST_ADD_END(suite->testcases, tcase, struct torture_tcase *);
 121
 122         return tcase;
 123 }
 124
 125 BOOL torture_run_suite(struct torture_context *context,
 126                                            struct torture_suite *suite)
 127 {
 128         BOOL ret = True;
 129         struct torture_tcase *tcase;
 130         struct torture_suite *tsuite;
 131         char *old_testname;
 132
 133         context->level++;
 134         if (context->ui_ops->suite_start)
 135                 context->ui_ops->suite_start(context, suite);
 136
 137         old_testname = context->active_testname;
 138         if (old_testname != NULL)
 139                 context->active_testname = talloc_asprintf(context, "%s-%s",
 140                                                                                            old_testname, suite->name);
 141         else
 142                 context->active_testname = talloc_strdup(context, suite->name);
 143
 144         for (tcase = suite->testcases; tcase; tcase = tcase->next) {
 145                 ret &= torture_run_tcase(context, tcase);
 146         }
 147
 148         for (tsuite = suite->children; tsuite; tsuite = tsuite->next) {
 149                 ret &= torture_run_suite(context, tsuite);
 150         }
 151
 152         talloc_free(context->active_testname);
 153         context->active_testname = old_testname;
 154
 155         if (context->ui_ops->suite_finish)
 156                 context->ui_ops->suite_finish(context, suite);
 157
 158         context->level--;
 159
 160         return ret;
 161 }
 162
 163 void torture_ui_test_start(struct torture_context *context,
 164                                                            struct torture_tcase *tcase,
 165                                                            struct torture_test *test)
 166 {
 167         if (context->ui_ops->test_start)
 168                 context->ui_ops->test_start(context, tcase, test);
 169 }
 170
 171 int str_list_match(const char *name, char **list)
 172 {
 173         int i, ret = 0;
 174         if (list == NULL)
 175                 return 0;
 176
 177         for (i = 0; list[i]; i++) {
 178                 if (gen_fnmatch(list[i], name) == 0)
 179                         ret++;
 180         }
 181         return ret;
 182 }
 183
 184 void torture_ui_test_result(struct torture_context *context,
 185                                                                 enum torture_result result,
 186                                                                 const char *comment)
 187 {
 188         if (context->ui_ops->test_result)
 189                 context->ui_ops->test_result(context, result, comment);
 190
 191         if (result == TORTURE_SKIP) {
 192                 context->results.skipped++;
 193         } else if (result == TORTURE_OK) {
 194                 if (str_list_match(context->active_testname,
 195                                                    context->expected_failures)) {
 196                         context->results.unexpected_successes = str_list_add(
 197                                         context->results.unexpected_successes,
 198                                         talloc_reference(context, context->active_testname));
 199                 }
 200                 context->results.success++;
 201         } else if (result == TORTURE_ERROR) {
 202                 context->results.unexpected_errors = str_list_add(
 203                                         context->results.unexpected_errors,
 204                                         talloc_reference(context, context->active_testname));
 205                 context->results.errors++;
 206                 context->results.returncode = false;
 207         } else if (result == TORTURE_FAIL) {
 208                 if (0 == str_list_match(context->active_testname,
 209                                                    context->expected_failures)) {
 210                         context->results.unexpected_failures = str_list_add(
 211                                         context->results.unexpected_failures,
 212                                         talloc_reference(context, context->active_testname));
 213                         context->results.returncode = false;
 214                 }
 215                 context->results.failed++;
 216         }
 217 }
 218
 219 static BOOL internal_torture_run_test(struct torture_context *context,
 220                                           struct torture_tcase *tcase,
 221                                           struct torture_test *test,
 222                                           BOOL already_setup)
 223 {
 224         BOOL ret;
 225         char *old_testname;
 226
 227         if (test->dangerous && !torture_setting_bool(context, "dangerous", False)) {
 228                 torture_result(context, TORTURE_SKIP,
 229                                 "disabled %s - enable dangerous tests to use", test->name);
 230                 return True;
 231         }
 232
 233         if (!already_setup && tcase->setup &&
 234                 !tcase->setup(context, &(tcase->data)))
 235                 return False;
 236
 237         if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
 238                 old_testname = context->active_testname;
 239                 context->active_testname = talloc_asprintf(context, "%s-%s",
 240                                                                                            old_testname, test->name);
 241         }
 242         context->active_tcase = tcase;
 243         context->active_test = test;
 244
 245         torture_ui_test_start(context, tcase, test);
 246
 247
 248         context->last_reason = NULL;
 249         context->last_result = TORTURE_OK;
 250
 251         ret = test->run(context, tcase, test);
 252         if (!ret && context->last_result == TORTURE_OK) {
 253                 if (context->last_reason == NULL)
 254                         context->last_reason = talloc_strdup(context, "Unknown error/failure");
 255                 context->last_result = TORTURE_ERROR;
 256         }
 257
 258         torture_ui_test_result(context, context->last_result, context->last_reason);
 259
 260         talloc_free(context->last_reason);
 261
 262         if (tcase == NULL || strcmp(test->name, tcase->name) != 0) {
 263                 talloc_free(context->active_testname);
 264                 context->active_testname = old_testname;
 265         }
 266         context->active_test = NULL;
 267         context->active_tcase = NULL;
 268
 269         if (!already_setup && tcase->teardown && !tcase->teardown(context, tcase->data))
 270                 return False;
 271
 272         return ret;
 273 }
 274
 275 BOOL torture_run_tcase(struct torture_context *context,
 276                                            struct torture_tcase *tcase)
 277 {
 278         BOOL ret = True;
 279         char *old_testname;
 280         struct torture_test *test;
 281
 282         context->level++;
 283
 284         context->active_tcase = tcase;
 285         if (context->ui_ops->tcase_start)
 286                 context->ui_ops->tcase_start(context, tcase);
 287
 288         if (tcase->fixture_persistent && tcase->setup
 289                 && !tcase->setup(context, &tcase->data)) {
 290                 ret = False;
 291                 goto done;
 292         }
 293
 294         old_testname = context->active_testname;
 295         context->active_testname = talloc_asprintf(context, "%s-%s",
 296                                                                                            old_testname, tcase->name);
 297         for (test = tcase->tests; test; test = test->next) {
 298                 ret &= internal_torture_run_test(context, tcase, test,
 299                                 tcase->fixture_persistent);
 300         }
 301         talloc_free(context->active_testname);
 302         context->active_testname = old_testname;
 303
 304         if (tcase->fixture_persistent && tcase->teardown &&
 305                 !tcase->teardown(context, tcase->data))
 306                 ret = False;
 307
 308 done:
 309         context->active_tcase = NULL;
 310
 311         if (context->ui_ops->tcase_finish)
 312                 context->ui_ops->tcase_finish(context, tcase);
 313
 314         context->level--;
 315
 316         return ret;
 317 }
 318
 319 BOOL torture_run_test(struct torture_context *context,
 320                                           struct torture_tcase *tcase,
 321                                           struct torture_test *test)
 322 {
 323         return internal_torture_run_test(context, tcase, test, False);
 324 }
 325
 326 int torture_setting_int(struct torture_context *test, const char *name,
 327                                                         int default_value)
 328 {
 329         return lp_parm_int(-1, "torture", name, default_value);
 330 }
 331
 332 bool torture_setting_bool(struct torture_context *test, const char *name,
 333                                                         bool default_value)
 334 {
 335         return lp_parm_bool(-1, "torture", name, default_value);
 336 }
 337
 338 const char *torture_setting_string(struct torture_context *test, const char *name,
 339                                                         const char *default_value)
 340 {
 341         const char *ret = lp_parm_string(-1, "torture", name);
 342
 343         if (ret == NULL)
 344                 return default_value;
 345
 346         return ret;
 347 }
 348
 349 static bool wrap_test_with_simple_tcase(struct torture_context *torture_ctx,
 350                                                                         struct torture_tcase *tcase,
 351                                                                         struct torture_test *test)
 352 {
 353         bool (*fn) (struct torture_context *, const void *tcase_data);
 354
 355         fn = test->fn;
 356
 357         return fn(torture_ctx, test->data);
 358 }
 359
 360 struct torture_tcase *torture_suite_add_simple_tcase(
 361                                         struct torture_suite *suite,
 362                                         const char *name,
 363                                         bool (*run) (struct torture_context *test, const void *),
 364                                         const void *data)
 365 {
 366         struct torture_tcase *tcase;
 367         struct torture_test *test;
 368
 369         tcase = torture_suite_add_tcase(suite, name);
 370
 371         test = talloc(tcase, struct torture_test);
 372
 373         test->name = talloc_strdup(test, name);
 374         test->description = NULL;
 375         test->run = wrap_test_with_simple_tcase;
 376         test->fn = run;
 377         test->data = data;
 378         test->dangerous = False;
 379
 380         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 381
 382         return tcase;
 383 }
 384
 385 static bool wrap_simple_test(struct torture_context *torture_ctx,
 386                                                                         struct torture_tcase *tcase,
 387                                                                         struct torture_test *test)
 388 {
 389         bool (*fn) (struct torture_context *);
 390
 391         fn = test->fn;
 392
 393         return fn(torture_ctx);
 394 }
 395
 396 struct torture_tcase *torture_suite_add_simple_test(
 397                                         struct torture_suite *suite,
 398                                         const char *name,
 399                                         bool (*run) (struct torture_context *test))
 400 {
 401         struct torture_test *test;
 402         struct torture_tcase *tcase;
 403
 404         tcase = torture_suite_add_tcase(suite, name);
 405
 406         test = talloc(tcase, struct torture_test);
 407
 408         test->name = talloc_strdup(test, name);
 409         test->description = NULL;
 410         test->run = wrap_simple_test;
 411         test->fn = run;
 412         test->dangerous = false;
 413
 414         DLIST_ADD_END(tcase->tests, test, struct torture_test *);
 415
 416         return tcase;
 417 }
 418
 419 bool torture_suite_add_suite(struct torture_suite *suite,
 420                                                          struct torture_suite *child)
 421 {
 422         if (child == NULL)
 423                 return false;
 424
 425         DLIST_ADD_END(suite->children, child, struct torture_suite *);
 426
 427         /* FIXME: Check for duplicates and return false if the
 428          * added suite already exists as a child */
 429
 430         return true;
 431 }
 432
 433
 434 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 435                                                                                  const char *name)
 436 {
 437         struct torture_suite *child;
 438
 439         for (child = parent->children; child; child = child->next)
 440                 if (!strcmp(child->name, name))
 441                         return child;
 442
 443         return NULL;
 444 }