lib/torture/torture.h

   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 #ifndef __TORTURE_UI_H__
  22 #define __TORTURE_UI_H__
  23
  24 struct torture_test;
  25 struct torture_context;
  26 struct torture_suite;
  27 struct torture_tcase;
  28 struct torture_results;
  29
  30 enum torture_result {
  31         TORTURE_OK=0,
  32         TORTURE_FAIL=1,
  33         TORTURE_ERROR=2,
  34         TORTURE_SKIP=3
  35 };
  36
  37 enum torture_progress_whence {
  38         TORTURE_PROGRESS_SET,
  39         TORTURE_PROGRESS_CUR,
  40         TORTURE_PROGRESS_POP,
  41         TORTURE_PROGRESS_PUSH,
  42 };
  43
  44 /*
  45  * These callbacks should be implemented by any backend that wishes
  46  * to listen to reports from the torture tests.
  47  */
  48 struct torture_ui_ops
  49 {
  50         void (*init) (struct torture_results *);
  51         void (*comment) (struct torture_context *, const char *);
  52         void (*warning) (struct torture_context *, const char *);
  53         void (*suite_start) (struct torture_context *, struct torture_suite *);
  54         void (*suite_finish) (struct torture_context *, struct torture_suite *);
  55         void (*tcase_start) (struct torture_context *, struct torture_tcase *);
  56         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
  57         void (*test_start) (struct torture_context *,
  58                                                 struct torture_tcase *,
  59                                                 struct torture_test *);
  60         void (*test_result) (struct torture_context *,
  61                                                  enum torture_result, const char *reason);
  62         void (*progress) (struct torture_context *, int offset, enum torture_progress_whence whence);
  63 };
  64
  65 void torture_ui_test_start(struct torture_context *context,
  66                                                            struct torture_tcase *tcase,
  67                                                            struct torture_test *test);
  68
  69 void torture_ui_test_result(struct torture_context *context,
  70                                                                 enum torture_result result,
  71                                                                 const char *comment);
  72
  73 /*
  74  * Holds information about a specific run of the testsuite.
  75  * The data in this structure should be considered private to
  76  * the torture tests and should only be used directly by the torture
  77  * code and the ui backends.
  78  *
  79  * Torture tests should instead call the torture_*() macros and functions
  80  * specified below.
  81  */
  82
  83 struct torture_context
  84 {
  85         struct torture_results *results;
  86
  87         char *active_testname;
  88         struct torture_test *active_test;
  89         struct torture_tcase *active_tcase;
  90
  91         enum torture_result last_result;
  92         char *last_reason;
  93
  94         /** Directory used for temporary test data */
  95         const char *outputdir;
  96
  97         /** Event context */
  98         struct tevent_context *ev;
  99
 100         /** Loadparm context (will go away in favor of torture_setting_ at some point) */
 101         struct loadparm_context *lp_ctx;
 102 };
 103
 104 struct torture_results
 105 {
 106         const struct torture_ui_ops *ui_ops;
 107         void *ui_data;
 108
 109         /** Whether tests should avoid writing output to stdout */
 110         bool quiet;
 111
 112         bool returncode;
 113 };
 114
 115 /*
 116  * Describes a particular torture test
 117  */
 118 struct torture_test {
 119         /** Short unique name for the test. */
 120         const char *name;
 121
 122         /** Long description for the test. */
 123         const char *description;
 124
 125         /** Whether this is a dangerous test
 126          * (can corrupt the remote servers data or bring it down). */
 127         bool dangerous;
 128
 129         /** Function to call to run this test */
 130         bool (*run) (struct torture_context *torture_ctx,
 131                                  struct torture_tcase *tcase,
 132                                  struct torture_test *test);
 133
 134         struct torture_test *prev, *next;
 135
 136         /** Pointer to the actual test function. This is run by the
 137           * run() function above. */
 138         void *fn;
 139
 140         /** Use data for this test */
 141         const void *data;
 142 };
 143
 144 /*
 145  * Describes a particular test case.
 146  */
 147 struct torture_tcase {
 148     const char *name;
 149         const char *description;
 150         bool (*setup) (struct torture_context *tcase, void **data);
 151         bool (*teardown) (struct torture_context *tcase, void *data);
 152         bool fixture_persistent;
 153         void *data;
 154         struct torture_test *tests;
 155         struct torture_tcase *prev, *next;
 156 };
 157
 158 struct torture_suite
 159 {
 160         const char *name;
 161         const char *description;
 162         struct torture_tcase *testcases;
 163         struct torture_suite *children;
 164
 165         /* Pointers to siblings of this torture suite */
 166         struct torture_suite *prev, *next;
 167 };
 168
 169 /** Create a new torture suite */
 170 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 171                 const char *name);
 172
 173 /** Change the setup and teardown functions for a testcase */
 174 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 175                 bool (*setup) (struct torture_context *, void **),
 176                 bool (*teardown) (struct torture_context *, void *));
 177
 178 /* Add another test to run for a particular testcase */
 179 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
 180                 const char *name,
 181                 bool (*run) (struct torture_context *test,
 182                         const void *tcase_data, const void *test_data),
 183                 const void *test_data);
 184
 185 /* Add a testcase to a testsuite */
 186 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 187                                                          const char *name);
 188
 189 /* Convenience wrapper that adds a testcase against only one
 190  * test will be run */
 191 struct torture_tcase *torture_suite_add_simple_tcase_const(
 192                 struct torture_suite *suite,
 193                 const char *name,
 194                 bool (*run) (struct torture_context *test,
 195                         const void *test_data),
 196                 const void *data);
 197
 198 /* Convenience function that adds a test which only
 199  * gets the test case data */
 200 struct torture_test *torture_tcase_add_simple_test_const(
 201                 struct torture_tcase *tcase,
 202                 const char *name,
 203                 bool (*run) (struct torture_context *test,
 204                         const void *tcase_data));
 205
 206 /* Convenience wrapper that adds a test that doesn't need any
 207  * testcase data */
 208 struct torture_tcase *torture_suite_add_simple_test(
 209                 struct torture_suite *suite,
 210                 const char *name,
 211                 bool (*run) (struct torture_context *test));
 212
 213 /* Add a child testsuite to an existing testsuite */
 214 bool torture_suite_add_suite(struct torture_suite *suite,
 215                 struct torture_suite *child);
 216
 217 /* Run the specified testsuite recursively */
 218 bool torture_run_suite(struct torture_context *context,
 219                                            struct torture_suite *suite);
 220
 221 /* Run the specified testsuite recursively, but only the specified
 222  * tests */
 223 bool torture_run_suite_restricted(struct torture_context *context,
 224                        struct torture_suite *suite, const char **restricted);
 225
 226 /* Run the specified testcase */
 227 bool torture_run_tcase(struct torture_context *context,
 228                                            struct torture_tcase *tcase);
 229
 230 /* Run the specified test */
 231 bool torture_run_test(struct torture_context *context,
 232                                           struct torture_tcase *tcase,
 233                                           struct torture_test *test);
 234
 235 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 236 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 237 void torture_result(struct torture_context *test,
 238                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 239
 240 #define torture_assert(torture_ctx,expr,cmt) \
 241         if (!(expr)) { \
 242                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 243                 return false; \
 244         }
 245
 246 #define torture_assert_goto(torture_ctx,expr,ret,label,cmt) \
 247         if (!(expr)) { \
 248                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 249                 ret = false; \
 250                 goto label; \
 251         }
 252
 253 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
 254         do { WERROR __got = got, __expected = expected; \
 255         if (!W_ERROR_EQUAL(__got, __expected)) { \
 256                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
 257                 return false; \
 258         } \
 259         } while (0)
 260
 261 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 262         do { NTSTATUS __got = got, __expected = expected; \
 263         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 264                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 265                 return false; \
 266         }\
 267         } while(0)
 268
 269 #define torture_assert_ntstatus_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
 270         do { NTSTATUS __got = got, __expected = expected; \
 271         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 272                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 273                 ret = false; \
 274                 goto label; \
 275         }\
 276         } while(0)
 277
 278 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
 279         do { enum ndr_err_code __got = got, __expected = expected; \
 280         if (__got != __expected) { \
 281                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
 282                 return false; \
 283         }\
 284         } while(0)
 285
 286 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 287         do { const char *__got = (got), *__expected = (expected); \
 288         if (!strequal(__got, __expected)) { \
 289                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 290                 return false; \
 291         } \
 292         } while(0)
 293
 294 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 295         do { const char *__got = (got), *__expected = (expected); \
 296         if (strcmp_safe(__got, __expected) != 0) { \
 297                 torture_result(torture_ctx, TORTURE_FAIL, \
 298                                            __location__": "#got" was %s, expected %s: %s", \
 299                                            __got, __expected, cmt); \
 300                 return false; \
 301         } \
 302         } while(0)
 303
 304 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
 305         do { const char *__got = (got), *__expected = (expected); \
 306         if (strcmp_safe(__got, __expected) != 0) { \
 307                 torture_result(torture_ctx, TORTURE_FAIL, \
 308                                            __location__": "#got" was %s, expected %s: %s", \
 309                                            __got, __expected, cmt); \
 310                 ret = false; \
 311                 goto label; \
 312         } \
 313         } while(0)
 314
 315 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
 316         do { const void *__got = (got), *__expected = (expected); \
 317         if (memcmp(__got, __expected, len) != 0) { \
 318                 torture_result(torture_ctx, TORTURE_FAIL, \
 319                                __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
 320                 return false; \
 321         } \
 322         } while(0)
 323
 324 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
 325         do { const DATA_BLOB __got = (got), __expected = (expected); \
 326         if (__got.length != __expected.length) { \
 327                 torture_result(torture_ctx, TORTURE_FAIL, \
 328                                __location__": "#got".len %d did not match "#expected" len %d: %s", \
 329                                (int)__got.length, (int)__expected.length, cmt); \
 330                 return false; \
 331         } \
 332         if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
 333                 torture_result(torture_ctx, TORTURE_FAIL, \
 334                                __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
 335                 return false; \
 336         } \
 337         } while(0)
 338
 339 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
 340         do { \
 341         char *__got; \
 342         const char *__expected = (expected); \
 343         size_t __size; \
 344         __got = file_load(filename, &__size, 0, torture_ctx); \
 345         if (__got == NULL) { \
 346                 torture_result(torture_ctx, TORTURE_FAIL, \
 347                                __location__": unable to open %s: %s\n", \
 348                                filename, cmt); \
 349                 return false; \
 350         } \
 351         \
 352         if (strcmp_safe(__got, __expected) != 0) { \
 353                 torture_result(torture_ctx, TORTURE_FAIL, \
 354                         __location__": %s contained:\n%sExpected: %s%s\n", \
 355                         filename, __got, __expected, cmt); \
 356                 talloc_free(__got); \
 357                 return false; \
 358         } \
 359         talloc_free(__got); \
 360         } while(0)
 361
 362 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
 363         do { const char *__got, *__expected = (expected); \
 364         size_t __size; \
 365         __got = file_load(filename, *size, 0, torture_ctx); \
 366         if (strcmp_safe(__got, __expected) != 0) { \
 367                 torture_result(torture_ctx, TORTURE_FAIL, \
 368                                            __location__": %s contained:\n%sExpected: %s%s\n", \
 369                                            __got, __expected, cmt); \
 370                 talloc_free(__got); \
 371                 return false; \
 372         } \
 373         talloc_free(__got); \
 374         } while(0)
 375
 376 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 377         do { int __got = (got), __expected = (expected); \
 378         if (__got != __expected) { \
 379                 torture_result(torture_ctx, TORTURE_FAIL, \
 380                         __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
 381                         __got, __got, __expected, __expected, cmt); \
 382                 return false; \
 383         } \
 384         } while(0)
 385
 386 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
 387         do { int __got = (got), __expected = (expected); \
 388         if (__got != __expected) { \
 389                 torture_result(torture_ctx, TORTURE_FAIL, \
 390                         __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
 391                         __got, __got, __expected, __expected, cmt); \
 392                 ret = false; \
 393                 goto label; \
 394         } \
 395         } while(0)
 396
 397 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
 398         do { uint64_t __got = (got), __expected = (expected); \
 399         if (__got != __expected) { \
 400                 torture_result(torture_ctx, TORTURE_FAIL, \
 401                         __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
 402                         (unsigned long long)__got, (unsigned long long)__got, \
 403                         (unsigned long long)__expected, (unsigned long long)__expected, \
 404                         cmt); \
 405                 return false; \
 406         } \
 407         } while(0)
 408
 409 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 410         do { int __expected = (expected); \
 411         if (errno != __expected) { \
 412                 torture_result(torture_ctx, TORTURE_FAIL, \
 413                         __location__": errno was %d (%s), expected %d: %s: %s", \
 414                                            errno, strerror(errno), __expected, \
 415                                            strerror(__expected), cmt); \
 416                 return false; \
 417         } \
 418         } while(0)
 419
 420
 421
 422 #define torture_skip(torture_ctx,cmt) do {\
 423                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 424                 return true; \
 425         } while(0)
 426 #define torture_skip_goto(torture_ctx,label,cmt) do {\
 427                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 428                 goto label; \
 429         } while(0)
 430 #define torture_fail(torture_ctx,cmt) do {\
 431                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 432                 return false; \
 433         } while (0)
 434 #define torture_fail_goto(torture_ctx,label,cmt) do {\
 435                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 436                 goto label; \
 437         } while (0)
 438
 439 #define torture_out stderr
 440
 441 /* Convenience macros */
 442 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 443                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 444
 445 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
 446                 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
 447
 448 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 449                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 450
 451 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
 452                 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
 453
 454 /* Getting settings */
 455 const char *torture_setting_string(struct torture_context *test, \
 456                                                                    const char *name,
 457                                                                    const char *default_value);
 458
 459 int torture_setting_int(struct torture_context *test,
 460                                                 const char *name,
 461                                                 int default_value);
 462
 463 double torture_setting_double(struct torture_context *test,
 464                                                 const char *name,
 465                                                 double default_value);
 466
 467 bool torture_setting_bool(struct torture_context *test,
 468                                                   const char *name,
 469                                                   bool default_value);
 470
 471 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 472                                                                                  const char *name);
 473
 474 unsigned long torture_setting_ulong(struct torture_context *test,
 475                                     const char *name,
 476                                     unsigned long default_value);
 477
 478 NTSTATUS torture_temp_dir(struct torture_context *tctx,
 479                                    const char *prefix,
 480                                    char **tempdir);
 481
 482 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 483                 const char *name,
 484                 bool (*run) (struct torture_context *test, void *tcase_data));
 485
 486
 487 bool torture_suite_init_tcase(struct torture_suite *suite,
 488                               struct torture_tcase *tcase,
 489                               const char *name);
 490 int torture_suite_children_count(const struct torture_suite *suite);
 491
 492 struct torture_context *torture_context_init(struct tevent_context *event_ctx, struct torture_results *results);
 493
 494 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
 495
 496 struct torture_context *torture_context_child(struct torture_context *tctx);
 497
 498 extern const struct torture_ui_ops torture_subunit_ui_ops;
 499
 500 #endif /* __TORTURE_UI_H__ */