source4/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
  29 enum torture_result {
  30         TORTURE_OK=0,
  31         TORTURE_FAIL=1,
  32         TORTURE_ERROR=2,
  33         TORTURE_SKIP=3
  34 };
  35
  36 /*
  37  * These callbacks should be implemented by any backend that wishes
  38  * to listen to reports from the torture tests.
  39  */
  40 struct torture_ui_ops
  41 {
  42         void (*init) (struct torture_context *);
  43         void (*comment) (struct torture_context *, const char *);
  44         void (*warning) (struct torture_context *, const char *);
  45         void (*suite_start) (struct torture_context *, struct torture_suite *);
  46         void (*suite_finish) (struct torture_context *, struct torture_suite *);
  47         void (*tcase_start) (struct torture_context *, struct torture_tcase *);
  48         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
  49         void (*test_start) (struct torture_context *,
  50                                                 struct torture_tcase *,
  51                                                 struct torture_test *);
  52         void (*test_result) (struct torture_context *,
  53                                                  enum torture_result, const char *reason);
  54 };
  55
  56 void torture_ui_test_start(struct torture_context *context,
  57                                                            struct torture_tcase *tcase,
  58                                                            struct torture_test *test);
  59
  60 void torture_ui_test_result(struct torture_context *context,
  61                                                                 enum torture_result result,
  62                                                                 const char *comment);
  63
  64 /*
  65  * Holds information about a specific run of the testsuite.
  66  * The data in this structure should be considered private to
  67  * the torture tests and should only be used directly by the torture
  68  * code and the ui backends.
  69  *
  70  * Torture tests should instead call the torture_*() macros and functions
  71  * specified below.
  72  */
  73
  74 struct torture_context
  75 {
  76         const struct torture_ui_ops *ui_ops;
  77         void *ui_data;
  78
  79         char *active_testname;
  80         struct torture_test *active_test;
  81         struct torture_tcase *active_tcase;
  82
  83         bool quiet; /* Whether tests should avoid writing output to stdout */
  84
  85         enum torture_result last_result;
  86         char *last_reason;
  87
  88         bool returncode;
  89
  90         const char *outputdir;
  91         int level;
  92         struct event_context *ev;
  93
  94         struct loadparm_context *lp_ctx;
  95 };
  96
  97 /*
  98  * Describes a particular torture test
  99  */
 100 struct torture_test {
 101         const char *name;
 102         const char *description;
 103         bool dangerous;
 104         /* Function to call to run this test */
 105         bool (*run) (struct torture_context *torture_ctx,
 106                                  struct torture_tcase *tcase,
 107                                  struct torture_test *test);
 108
 109         struct torture_test *prev, *next;
 110
 111         /* Pointer to the actual test function. This is run by the
 112          * run() function above. */
 113         void *fn;
 114         const void *data;
 115 };
 116
 117 /*
 118  * Describes a particular test case.
 119  */
 120 struct torture_tcase {
 121     const char *name;
 122         const char *description;
 123         bool (*setup) (struct torture_context *tcase, void **data);
 124         bool (*teardown) (struct torture_context *tcase, void *data);
 125         bool fixture_persistent;
 126         void *data;
 127         struct torture_test *tests;
 128         struct torture_tcase *prev, *next;
 129 };
 130
 131 struct torture_suite
 132 {
 133         const char *name;
 134         const char *description;
 135         struct torture_tcase *testcases;
 136         struct torture_suite *children;
 137
 138         /* Pointers to siblings of this torture suite */
 139         struct torture_suite *prev, *next;
 140 };
 141
 142 /** Create a new torture suite */
 143 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 144                 const char *name);
 145
 146 /** Change the setup and teardown functions for a testcase */
 147 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 148                 bool (*setup) (struct torture_context *, void **),
 149                 bool (*teardown) (struct torture_context *, void *));
 150
 151 /* Add another test to run for a particular testcase */
 152 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
 153                 const char *name,
 154                 bool (*run) (struct torture_context *test,
 155                         const void *tcase_data, const void *test_data),
 156                 const void *test_data);
 157
 158 /* Add a testcase to a testsuite */
 159 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 160                                                          const char *name);
 161
 162 /* Convenience wrapper that adds a testcase against only one
 163  * test will be run */
 164 struct torture_tcase *torture_suite_add_simple_tcase_const(
 165                 struct torture_suite *suite,
 166                 const char *name,
 167                 bool (*run) (struct torture_context *test,
 168                         const void *test_data),
 169                 const void *data);
 170
 171 /* Convenience function that adds a test which only
 172  * gets the test case data */
 173 struct torture_test *torture_tcase_add_simple_test_const(
 174                 struct torture_tcase *tcase,
 175                 const char *name,
 176                 bool (*run) (struct torture_context *test,
 177                         const void *tcase_data));
 178
 179 /* Convenience wrapper that adds a test that doesn't need any
 180  * testcase data */
 181 struct torture_tcase *torture_suite_add_simple_test(
 182                 struct torture_suite *suite,
 183                 const char *name,
 184                 bool (*run) (struct torture_context *test));
 185
 186 /* Add a child testsuite to an existing testsuite */
 187 bool torture_suite_add_suite(struct torture_suite *suite,
 188                 struct torture_suite *child);
 189
 190 /* Run the specified testsuite recursively */
 191 bool torture_run_suite(struct torture_context *context,
 192                                            struct torture_suite *suite);
 193
 194 /* Run the specified testcase */
 195 bool torture_run_tcase(struct torture_context *context,
 196                                            struct torture_tcase *tcase);
 197
 198 /* Run the specified test */
 199 bool torture_run_test(struct torture_context *context,
 200                                           struct torture_tcase *tcase,
 201                                           struct torture_test *test);
 202
 203 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 204 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 205 void torture_result(struct torture_context *test,
 206                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 207
 208 #define torture_assert(torture_ctx,expr,cmt) \
 209         if (!(expr)) { \
 210                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 211                 return false; \
 212         }
 213
 214 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
 215         do { WERROR __got = got, __expected = expected; \
 216         if (!W_ERROR_EQUAL(__got, __expected)) { \
 217                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
 218                 return false; \
 219         } \
 220         } while (0)
 221
 222 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 223         do { NTSTATUS __got = got, __expected = expected; \
 224         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 225                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 226                 return false; \
 227         }\
 228         } while(0)
 229
 230 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
 231         do { enum ndr_err_code __got = got, __expected = expected; \
 232         if (__got != __expected) { \
 233                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
 234                 return false; \
 235         }\
 236         } while(0)
 237
 238 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 239         do { const char *__got = (got), *__expected = (expected); \
 240         if (!strequal(__got, __expected)) { \
 241                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 242                 return false; \
 243         } \
 244         } while(0)
 245
 246 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 247         do { const char *__got = (got), *__expected = (expected); \
 248         if (strcmp_safe(__got, __expected) != 0) { \
 249                 torture_result(torture_ctx, TORTURE_FAIL, \
 250                                            __location__": "#got" was %s, expected %s: %s", \
 251                                            __got, __expected, cmt); \
 252                 return false; \
 253         } \
 254         } while(0)
 255
 256 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
 257         do { const void *__got = (got), *__expected = (expected); \
 258         if (memcmp(__got, __expected, len) != 0) { \
 259                 torture_result(torture_ctx, TORTURE_FAIL, \
 260                                            __location__": "#got" of len %d did not match"#expected": %s", len, cmt); \
 261                 return false; \
 262         } \
 263         } while(0)
 264
 265 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
 266         do { \
 267         char *__got; \
 268         const char *__expected = (expected); \
 269         size_t __size; \
 270         __got = file_load(filename, &__size, torture_ctx); \
 271         if (__got == NULL) { \
 272                 torture_result(torture_ctx, TORTURE_FAIL, \
 273                                __location__": unable to open %s: %s\n", \
 274                                filename, cmt); \
 275                 return false; \
 276         } \
 277         \
 278         if (strcmp_safe(__got, __expected) != 0) { \
 279                 torture_result(torture_ctx, TORTURE_FAIL, \
 280                         __location__": %s contained:\n%sExpected: %s%s\n", \
 281                         filename, __got, __expected, cmt); \
 282                 talloc_free(__got); \
 283                 return false; \
 284         } \
 285         talloc_free(__got); \
 286         } while(0)
 287
 288 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
 289         do { const char *__got, *__expected = (expected); \
 290         size_t __size; \
 291         __got = file_load(filename, *size, torture_ctx); \
 292         if (strcmp_safe(__got, __expected) != 0) { \
 293                 torture_result(torture_ctx, TORTURE_FAIL, \
 294                                            __location__": %s contained:\n%sExpected: %s%s\n", \
 295                                            __got, __expected, cmt); \
 296                 talloc_free(__got); \
 297                 return false; \
 298         } \
 299         talloc_free(__got); \
 300         } while(0)
 301
 302 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 303         do { int __got = (got), __expected = (expected); \
 304         if (__got != __expected) { \
 305                 torture_result(torture_ctx, TORTURE_FAIL, \
 306                         __location__": "#got" was %d, expected %d: %s", \
 307                         __got, __expected, cmt); \
 308                 return false; \
 309         } \
 310         } while(0)
 311
 312 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
 313         do { uint64_t __got = (got), __expected = (expected); \
 314         if (__got != __expected) { \
 315                 torture_result(torture_ctx, TORTURE_FAIL, \
 316                         __location__": "#got" was %llu, expected %llu: %s", \
 317                         (unsigned long long)__got, (unsigned long long)__expected, cmt); \
 318                 return false; \
 319         } \
 320         } while(0)
 321
 322 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 323         do { int __expected = (expected); \
 324         if (errno != __expected) { \
 325                 torture_result(torture_ctx, TORTURE_FAIL, \
 326                         __location__": errno was %d (%s), expected %d: %s: %s", \
 327                                            errno, strerror(errno), __expected, \
 328                                            strerror(__expected), cmt); \
 329                 return false; \
 330         } \
 331         } while(0)
 332
 333
 334
 335 #define torture_skip(torture_ctx,cmt) do {\
 336                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 337                 return true; \
 338         } while(0)
 339 #define torture_fail(torture_ctx,cmt) do {\
 340                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 341                 return false; \
 342         } while (0)
 343 #define torture_fail_goto(torture_ctx,label,cmt) do {\
 344                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 345                 goto label; \
 346         } while (0)
 347
 348 #define torture_out stderr
 349
 350 /* Convenience macros */
 351 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 352                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 353
 354 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 355                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 356
 357 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
 358                 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
 359
 360 /* Getting settings */
 361 const char *torture_setting_string(struct torture_context *test, \
 362                                                                    const char *name,
 363                                                                    const char *default_value);
 364
 365 int torture_setting_int(struct torture_context *test,
 366                                                 const char *name,
 367                                                 int default_value);
 368
 369 double torture_setting_double(struct torture_context *test,
 370                                                 const char *name,
 371                                                 double default_value);
 372
 373 bool torture_setting_bool(struct torture_context *test,
 374                                                   const char *name,
 375                                                   bool default_value);
 376
 377 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 378                                                                                  const char *name);
 379
 380 NTSTATUS torture_temp_dir(struct torture_context *tctx,
 381                                    const char *prefix,
 382                                    char **tempdir);
 383
 384 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 385                 const char *name,
 386                 bool (*run) (struct torture_context *test, void *tcase_data));
 387
 388
 389 bool torture_suite_init_tcase(struct torture_suite *suite,
 390                               struct torture_tcase *tcase,
 391                               const char *name);
 392
 393 struct torture_context *torture_context_init(struct event_context *event_ctx,
 394                                              const struct torture_ui_ops *ui_ops);
 395
 396 #endif /* __TORTURE_UI_H__ */