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         void (*report_time) (struct torture_context *);
  64 };
  65
  66 void torture_ui_test_start(struct torture_context *context,
  67                                                            struct torture_tcase *tcase,
  68                                                            struct torture_test *test);
  69
  70 void torture_ui_test_result(struct torture_context *context,
  71                                                                 enum torture_result result,
  72                                                                 const char *comment);
  73
  74 void torture_ui_report_time(struct torture_context *context);
  75
  76 /*
  77  * Holds information about a specific run of the testsuite.
  78  * The data in this structure should be considered private to
  79  * the torture tests and should only be used directly by the torture
  80  * code and the ui backends.
  81  *
  82  * Torture tests should instead call the torture_*() macros and functions
  83  * specified below.
  84  */
  85
  86 struct torture_context
  87 {
  88         struct torture_results *results;
  89
  90         struct torture_test *active_test;
  91         struct torture_tcase *active_tcase;
  92
  93         enum torture_result last_result;
  94         char *last_reason;
  95
  96         /** Directory used for temporary test data */
  97         const char *outputdir;
  98
  99         /** Event context */
 100         struct tevent_context *ev;
 101
 102         /** Loadparm context (will go away in favor of torture_setting_ at some point) */
 103         struct loadparm_context *lp_ctx;
 104 };
 105
 106 struct torture_results
 107 {
 108         const struct torture_ui_ops *ui_ops;
 109         void *ui_data;
 110
 111         /** Whether tests should avoid writing output to stdout */
 112         bool quiet;
 113
 114         bool returncode;
 115 };
 116
 117 /*
 118  * Describes a particular torture test
 119  */
 120 struct torture_test {
 121         /** Short unique name for the test. */
 122         const char *name;
 123
 124         /** Long description for the test. */
 125         const char *description;
 126
 127         /** Whether this is a dangerous test
 128          * (can corrupt the remote servers data or bring it down). */
 129         bool dangerous;
 130
 131         /** Function to call to run this test */
 132         bool (*run) (struct torture_context *torture_ctx,
 133                                  struct torture_tcase *tcase,
 134                                  struct torture_test *test);
 135
 136         struct torture_test *prev, *next;
 137
 138         /** Pointer to the actual test function. This is run by the
 139           * run() function above. */
 140         void *fn;
 141
 142         /** Use data for this test */
 143         const void *data;
 144 };
 145
 146 /*
 147  * Describes a particular test case.
 148  */
 149 struct torture_tcase {
 150     const char *name;
 151         const char *description;
 152         bool (*setup) (struct torture_context *tcase, void **data);
 153         bool (*teardown) (struct torture_context *tcase, void *data);
 154         bool fixture_persistent;
 155         void *data;
 156         struct torture_test *tests;
 157         struct torture_tcase *prev, *next;
 158 };
 159
 160 struct torture_suite
 161 {
 162         const char *name;
 163         const char *description;
 164         struct torture_tcase *testcases;
 165         struct torture_suite *children;
 166
 167         /* Pointers to siblings of this torture suite */
 168         struct torture_suite *prev, *next;
 169 };
 170
 171 /** Create a new torture suite */
 172 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 173                 const char *name);
 174
 175 /** Change the setup and teardown functions for a testcase */
 176 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 177                 bool (*setup) (struct torture_context *, void **),
 178                 bool (*teardown) (struct torture_context *, void *));
 179
 180 /* Add another test to run for a particular testcase */
 181 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
 182                 const char *name,
 183                 bool (*run) (struct torture_context *test,
 184                         const void *tcase_data, const void *test_data),
 185                 const void *test_data);
 186
 187 /* Add a testcase to a testsuite */
 188 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 189                                                          const char *name);
 190
 191 /* Convenience wrapper that adds a testcase against only one
 192  * test will be run */
 193 struct torture_tcase *torture_suite_add_simple_tcase_const(
 194                 struct torture_suite *suite,
 195                 const char *name,
 196                 bool (*run) (struct torture_context *test,
 197                         const void *test_data),
 198                 const void *data);
 199
 200 /* Convenience function that adds a test which only
 201  * gets the test case data */
 202 struct torture_test *torture_tcase_add_simple_test_const(
 203                 struct torture_tcase *tcase,
 204                 const char *name,
 205                 bool (*run) (struct torture_context *test,
 206                         const void *tcase_data));
 207
 208 /* Convenience wrapper that adds a test that doesn't need any
 209  * testcase data */
 210 struct torture_tcase *torture_suite_add_simple_test(
 211                 struct torture_suite *suite,
 212                 const char *name,
 213                 bool (*run) (struct torture_context *test));
 214
 215 /* Add a child testsuite to an existing testsuite */
 216 bool torture_suite_add_suite(struct torture_suite *suite,
 217                 struct torture_suite *child);
 218
 219 /* Run the specified testsuite recursively */
 220 bool torture_run_suite(struct torture_context *context,
 221                                            struct torture_suite *suite);
 222
 223 /* Run the specified testsuite recursively, but only the specified
 224  * tests */
 225 bool torture_run_suite_restricted(struct torture_context *context,
 226                        struct torture_suite *suite, const char **restricted);
 227
 228 /* Run the specified testcase */
 229 bool torture_run_tcase(struct torture_context *context,
 230                                            struct torture_tcase *tcase);
 231
 232 bool torture_run_tcase_restricted(struct torture_context *context,
 233                        struct torture_tcase *tcase, const char **restricted);
 234
 235 /* Run the specified test */
 236 bool torture_run_test(struct torture_context *context,
 237                                           struct torture_tcase *tcase,
 238                                           struct torture_test *test);
 239
 240 bool torture_run_test_restricted(struct torture_context *context,
 241                                           struct torture_tcase *tcase,
 242                                           struct torture_test *test,
 243                                           const char **restricted);
 244
 245 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 246 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 247 void torture_result(struct torture_context *test,
 248                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 249
 250 #define torture_assert(torture_ctx,expr,cmt) \
 251         if (!(expr)) { \
 252                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 253                 return false; \
 254         }
 255
 256 #define torture_assert_goto(torture_ctx,expr,ret,label,cmt) \
 257         if (!(expr)) { \
 258                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 259                 ret = false; \
 260                 goto label; \
 261         }
 262
 263 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
 264         do { WERROR __got = got, __expected = expected; \
 265         if (!W_ERROR_EQUAL(__got, __expected)) { \
 266                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
 267                 return false; \
 268         } \
 269         } while (0)
 270
 271 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 272         do { NTSTATUS __got = got, __expected = expected; \
 273         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 274                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 275                 return false; \
 276         }\
 277         } while(0)
 278
 279 #define torture_assert_ntstatus_equal_goto(torture_ctx,got,expected,ret,label,cmt) \
 280         do { NTSTATUS __got = got, __expected = expected; \
 281         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 282                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 283                 ret = false; \
 284                 goto label; \
 285         }\
 286         } while(0)
 287
 288 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
 289         do { enum ndr_err_code __got = got, __expected = expected; \
 290         if (__got != __expected) { \
 291                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, ndr_errstr(__got), __expected, __STRING(expected), cmt); \
 292                 return false; \
 293         }\
 294         } while(0)
 295
 296 #define torture_assert_hresult_equal(torture_ctx, got, expected, cmt) \
 297         do { HRESULT __got = got, __expected = expected; \
 298         if (!HRES_IS_EQUAL(__got, __expected)) { \
 299                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", hresult_errstr(__got), hresult_errstr(__expected), cmt); \
 300                 return false; \
 301         } \
 302         } while (0)
 303
 304 #define torture_assert_krb5_error_equal(torture_ctx, got, expected, cmt) \
 305         do { krb5_error_code __got = got, __expected = expected; \
 306         if (__got != __expected) { \
 307                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d (%s), expected %d (%s): %s", __got, error_message(__got), __expected, error_message(__expected), cmt); \
 308                 return false; \
 309         } \
 310         } while (0)
 311
 312 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 313         do { const char *__got = (got), *__expected = (expected); \
 314         if (!strequal(__got, __expected)) { \
 315                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 316                 return false; \
 317         } \
 318         } while(0)
 319
 320 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 321         do { const char *__got = (got), *__expected = (expected); \
 322         if (strcmp_safe(__got, __expected) != 0) { \
 323                 torture_result(torture_ctx, TORTURE_FAIL, \
 324                                            __location__": "#got" was %s, expected %s: %s", \
 325                                            __got, __expected, cmt); \
 326                 return false; \
 327         } \
 328         } while(0)
 329
 330 #define torture_assert_strn_equal(torture_ctx,got,expected,len,cmt)\
 331         do { const char *__got = (got), *__expected = (expected); \
 332         if (strncmp(__got, __expected, len) != 0) { \
 333                 torture_result(torture_ctx, TORTURE_FAIL, \
 334                                            __location__": "#got" %s of len %d did not match "#expected" %s: %s", \
 335                                            __got, (int)len, __expected, cmt); \
 336                 return false; \
 337         } \
 338         } while(0)
 339
 340 #define torture_assert_str_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
 341         do { const char *__got = (got), *__expected = (expected); \
 342         if (strcmp_safe(__got, __expected) != 0) { \
 343                 torture_result(torture_ctx, TORTURE_FAIL, \
 344                                            __location__": "#got" was %s, expected %s: %s", \
 345                                            __got, __expected, cmt); \
 346                 ret = false; \
 347                 goto label; \
 348         } \
 349         } while(0)
 350
 351 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
 352         do { const void *__got = (got), *__expected = (expected); \
 353         if (memcmp(__got, __expected, len) != 0) { \
 354                 torture_result(torture_ctx, TORTURE_FAIL, \
 355                                __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
 356                 return false; \
 357         } \
 358         } while(0)
 359
 360 #define torture_assert_mem_equal_goto(torture_ctx,got,expected,len,ret,label,cmt) \
 361         do { const void *__got = (got), *__expected = (expected); \
 362         if (memcmp(__got, __expected, len) != 0) { \
 363                 torture_result(torture_ctx, TORTURE_FAIL, \
 364                                __location__": "#got" of len %d did not match "#expected": %s", (int)len, cmt); \
 365                 ret = false; \
 366                 goto label; \
 367         } \
 368         } while(0)
 369
 370 #define torture_assert_mem_not_equal_goto(torture_ctx,got,expected,len,ret,label,cmt) \
 371         do { const void *__got = (got), *__expected = (expected); \
 372         if (memcmp(__got, __expected, len) == 0) { \
 373                 torture_result(torture_ctx, TORTURE_FAIL, \
 374                                __location__": "#got" of len %d unexpectedly matches "#expected": %s", (int)len, cmt); \
 375                 ret = false; \
 376                 goto label; \
 377         } \
 378         } while(0)
 379
 380 static inline void torture_dump_data_str_cb(const char *buf, void *private_data)
 381 {
 382         char **dump = (char **)private_data;
 383         *dump = talloc_strdup_append_buffer(*dump, buf);
 384 }
 385
 386 #define torture_assert_data_blob_equal(torture_ctx,got,expected,cmt)\
 387         do { const DATA_BLOB __got = (got), __expected = (expected); \
 388         if (__got.length != __expected.length) { \
 389                 torture_result(torture_ctx, TORTURE_FAIL, \
 390                                __location__": "#got".len %d did not match "#expected" len %d: %s", \
 391                                (int)__got.length, (int)__expected.length, cmt); \
 392                 return false; \
 393         } \
 394         if (memcmp(__got.data, __expected.data, __got.length) != 0) { \
 395                 char *__dump = NULL; \
 396                 uint8_t __byte_a = 0x00;\
 397                 uint8_t __byte_b = 0x00;\
 398                 int __i;\
 399                 for (__i=0; __i < __expected.length; __i++) {\
 400                         __byte_a = __expected.data[__i];\
 401                         if (__i == __got.length) {\
 402                                 __byte_b = 0x00;\
 403                                 break;\
 404                         }\
 405                         __byte_b = __got.data[__i];\
 406                         if (__byte_a != __byte_b) {\
 407                                 break;\
 408                         }\
 409                 }\
 410                 torture_warning(torture_ctx, "blobs differ at byte 0x%02X (%u)", __i, __i);\
 411                 torture_warning(torture_ctx, "expected byte[0x%02X] = 0x%02X got byte[0x%02X] = 0x%02X",\
 412                                 __i, __byte_a, __i, __byte_b);\
 413                 __dump = talloc_strdup(torture_ctx, ""); \
 414                 dump_data_cb(__got.data, __got.length, true, \
 415                              torture_dump_data_str_cb, &__dump); \
 416                 torture_warning(torture_ctx, "got[0x%02X]: \n%s", \
 417                                 (int)__got.length, __dump); \
 418                 TALLOC_FREE(__dump); \
 419                 __dump = talloc_strdup(torture_ctx, ""); \
 420                 dump_data_cb(__expected.data, __expected.length, true, \
 421                              torture_dump_data_str_cb, &__dump); \
 422                 torture_warning(torture_ctx, "expected[0x%02X]: \n%s", \
 423                                 (int)__expected.length, __dump); \
 424                 TALLOC_FREE(__dump); \
 425                 torture_result(torture_ctx, TORTURE_FAIL, \
 426                                __location__": "#got" of len %d did not match "#expected": %s", (int)__got.length, cmt); \
 427                 return false; \
 428         } \
 429         } while(0)
 430
 431 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
 432         do { \
 433         char *__got; \
 434         const char *__expected = (expected); \
 435         size_t __size; \
 436         __got = file_load(filename, &__size, 0, torture_ctx); \
 437         if (__got == NULL) { \
 438                 torture_result(torture_ctx, TORTURE_FAIL, \
 439                                __location__": unable to open %s: %s\n", \
 440                                filename, cmt); \
 441                 return false; \
 442         } \
 443         \
 444         if (strcmp_safe(__got, __expected) != 0) { \
 445                 torture_result(torture_ctx, TORTURE_FAIL, \
 446                         __location__": %s contained:\n%sExpected: %s%s\n", \
 447                         filename, __got, __expected, cmt); \
 448                 talloc_free(__got); \
 449                 return false; \
 450         } \
 451         talloc_free(__got); \
 452         } while(0)
 453
 454 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
 455         do { const char *__got, *__expected = (expected); \
 456         size_t __size; \
 457         __got = file_load(filename, *size, 0, torture_ctx); \
 458         if (strcmp_safe(__got, __expected) != 0) { \
 459                 torture_result(torture_ctx, TORTURE_FAIL, \
 460                                            __location__": %s contained:\n%sExpected: %s%s\n", \
 461                                            __got, __expected, cmt); \
 462                 talloc_free(__got); \
 463                 return false; \
 464         } \
 465         talloc_free(__got); \
 466         } while(0)
 467
 468 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 469         do { int __got = (got), __expected = (expected); \
 470         if (__got != __expected) { \
 471                 torture_result(torture_ctx, TORTURE_FAIL, \
 472                         __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
 473                         __got, __got, __expected, __expected, cmt); \
 474                 return false; \
 475         } \
 476         } while(0)
 477
 478 #define torture_assert_int_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
 479         do { int __got = (got), __expected = (expected); \
 480         if (__got != __expected) { \
 481                 torture_result(torture_ctx, TORTURE_FAIL, \
 482                         __location__": "#got" was %d (0x%X), expected %d (0x%X): %s", \
 483                         __got, __got, __expected, __expected, cmt); \
 484                 ret = false; \
 485                 goto label; \
 486         } \
 487         } while(0)
 488
 489 #define torture_assert_int_not_equal(torture_ctx,got,not_expected,cmt)\
 490         do { int __got = (got), __not_expected = (not_expected); \
 491         if (__got == __not_expected) { \
 492                 torture_result(torture_ctx, TORTURE_FAIL, \
 493                         __location__": "#got" was %d (0x%X), expected a different number: %s", \
 494                         __got, __got, cmt); \
 495                 return false; \
 496         } \
 497         } while(0)
 498
 499 #define torture_assert_int_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
 500         do { int __got = (got), __not_expected = (not_expected); \
 501         if (__got == __not_expected) { \
 502                 torture_result(torture_ctx, TORTURE_FAIL, \
 503                         __location__": "#got" was %d (0x%X), expected a different number: %s", \
 504                         __got, __got, cmt); \
 505                 ret = false; \
 506                 goto label; \
 507         } \
 508         } while(0)
 509
 510 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
 511         do { uint64_t __got = (got), __expected = (expected); \
 512         if (__got != __expected) { \
 513                 torture_result(torture_ctx, TORTURE_FAIL, \
 514                         __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
 515                         (unsigned long long)__got, (unsigned long long)__got, \
 516                         (unsigned long long)__expected, (unsigned long long)__expected, \
 517                         cmt); \
 518                 return false; \
 519         } \
 520         } while(0)
 521
 522 #define torture_assert_u64_equal_goto(torture_ctx,got,expected,ret,label,cmt)\
 523         do { uint64_t __got = (got), __expected = (expected); \
 524         if (__got != __expected) { \
 525                 torture_result(torture_ctx, TORTURE_FAIL, \
 526                         __location__": "#got" was %llu (0x%llX), expected %llu (0x%llX): %s", \
 527                         (unsigned long long)__got, (unsigned long long)__got, \
 528                         (unsigned long long)__expected, (unsigned long long)__expected, \
 529                         cmt); \
 530                 ret = false; \
 531                 goto label; \
 532         } \
 533         } while(0)
 534
 535 #define torture_assert_u64_not_equal(torture_ctx,got,not_expected,cmt)\
 536         do { uint64_t __got = (got), __not_expected = (not_expected); \
 537         if (__got == __not_expected) { \
 538                 torture_result(torture_ctx, TORTURE_FAIL, \
 539                         __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
 540                         (unsigned long long)__got, (unsigned long long)__got, \
 541                         cmt); \
 542                 return false; \
 543         } \
 544         } while(0)
 545
 546 #define torture_assert_u64_not_equal_goto(torture_ctx,got,not_expected,ret,label,cmt)\
 547         do { uint64_t __got = (got), __not_expected = (not_expected); \
 548         if (__got == __not_expected) { \
 549                 torture_result(torture_ctx, TORTURE_FAIL, \
 550                         __location__": "#got" was %llu (0x%llX), expected a different number: %s", \
 551                         (unsigned long long)__got, (unsigned long long)__got, \
 552                         cmt); \
 553                 ret = false; \
 554                 goto label; \
 555         } \
 556         } while(0)
 557
 558 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 559         do { int __expected = (expected); \
 560         if (errno != __expected) { \
 561                 torture_result(torture_ctx, TORTURE_FAIL, \
 562                         __location__": errno was %d (%s), expected %d: %s: %s", \
 563                                            errno, strerror(errno), __expected, \
 564                                            strerror(__expected), cmt); \
 565                 return false; \
 566         } \
 567         } while(0)
 568
 569 #define torture_assert_guid_equal(torture_ctx,got,expected,cmt)\
 570         do {const struct GUID __got = (got), __expected = (expected); \
 571         if (!GUID_equal(&__got, &__expected)) { \
 572                 torture_result(torture_ctx, TORTURE_FAIL, \
 573                         __location__": "#got" was %s, expected %s: %s", \
 574                         GUID_string(torture_ctx, &__got), GUID_string(torture_ctx, &__expected), cmt); \
 575                 return false; \
 576         } \
 577         } while(0)
 578
 579 #define torture_assert_nttime_equal(torture_ctx,got,expected,cmt) \
 580         do { NTTIME __got = got, __expected = expected; \
 581         if (!nt_time_equal(&__got, &__expected)) { \
 582                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_time_string(tctx, __got), nt_time_string(tctx, __expected), cmt); \
 583                 return false; \
 584         }\
 585         } while(0)
 586
 587 #define torture_assert_sid_equal(torture_ctx,got,expected,cmt)\
 588         do {const struct dom_sid *__got = (got), *__expected = (expected); \
 589         if (!dom_sid_equal(__got, __expected)) { \
 590                 torture_result(torture_ctx, TORTURE_FAIL, \
 591                                            __location__": "#got" was %s, expected %s: %s", \
 592                                            dom_sid_string(torture_ctx, __got), dom_sid_string(torture_ctx, __expected), cmt); \
 593                 return false; \
 594         } \
 595         } while(0)
 596
 597 #define torture_assert_not_null(torture_ctx,got,cmt)\
 598         do {const void *__got = (got); \
 599         if (__got == NULL) { \
 600                 torture_result(torture_ctx, TORTURE_FAIL, \
 601                         __location__": "#got" was NULL, expected != NULL: %s", \
 602                         cmt); \
 603                 return false; \
 604         } \
 605         } while(0)
 606
 607 #define torture_assert_not_null_goto(torture_ctx,got,ret,label,cmt)\
 608         do {const void *__got = (got); \
 609         if (__got == NULL) { \
 610                 torture_result(torture_ctx, TORTURE_FAIL, \
 611                         __location__": "#got" was NULL, expected != NULL: %s", \
 612                         cmt); \
 613                 ret = false; \
 614                 goto label; \
 615         } \
 616         } while(0)
 617
 618 #define torture_skip(torture_ctx,cmt) do {\
 619                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 620                 return true; \
 621         } while(0)
 622 #define torture_skip_goto(torture_ctx,label,cmt) do {\
 623                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 624                 goto label; \
 625         } while(0)
 626 #define torture_fail(torture_ctx,cmt) do {\
 627                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 628                 return false; \
 629         } while (0)
 630 #define torture_fail_goto(torture_ctx,label,cmt) do {\
 631                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 632                 goto label; \
 633         } while (0)
 634
 635 #define torture_out stderr
 636
 637 /* Convenience macros */
 638 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 639                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 640
 641 #define torture_assert_ntstatus_ok_goto(torture_ctx,expr,ret,label,cmt) \
 642                 torture_assert_ntstatus_equal_goto(torture_ctx,expr,NT_STATUS_OK,ret,label,cmt)
 643
 644 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 645                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 646
 647 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
 648                 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
 649
 650 #define torture_assert_hresult_ok(torture_ctx,expr,cmt) \
 651                 torture_assert_hresult_equal(torture_ctx,expr,HRES_ERROR(0), cmt)
 652
 653 /* Getting settings */
 654 const char *torture_setting_string(struct torture_context *test, \
 655                                                                    const char *name,
 656                                                                    const char *default_value);
 657
 658 int torture_setting_int(struct torture_context *test,
 659                                                 const char *name,
 660                                                 int default_value);
 661
 662 double torture_setting_double(struct torture_context *test,
 663                                                 const char *name,
 664                                                 double default_value);
 665
 666 bool torture_setting_bool(struct torture_context *test,
 667                                                   const char *name,
 668                                                   bool default_value);
 669
 670 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 671                                                                                  const char *name);
 672
 673 unsigned long torture_setting_ulong(struct torture_context *test,
 674                                     const char *name,
 675                                     unsigned long default_value);
 676
 677 NTSTATUS torture_temp_dir(struct torture_context *tctx,
 678                                    const char *prefix,
 679                                    char **tempdir);
 680 NTSTATUS torture_deltree_outputdir(struct torture_context *tctx);
 681
 682 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 683                 const char *name,
 684                 bool (*run) (struct torture_context *test, void *tcase_data));
 685
 686
 687 bool torture_suite_init_tcase(struct torture_suite *suite,
 688                               struct torture_tcase *tcase,
 689                               const char *name);
 690 int torture_suite_children_count(const struct torture_suite *suite);
 691
 692 struct torture_context *torture_context_init(struct tevent_context *event_ctx, struct torture_results *results);
 693
 694 struct torture_results *torture_results_init(TALLOC_CTX *mem_ctx, const struct torture_ui_ops *ui_ops);
 695
 696 struct torture_context *torture_context_child(struct torture_context *tctx);
 697
 698 extern const struct torture_ui_ops torture_subunit_ui_ops;
 699 extern const struct torture_ui_ops torture_simple_ui_ops;
 700
 701 #endif /* __TORTURE_UI_H__ */