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         /** Whether tests should avoid writing output to stdout */
  84         bool quiet;
  85
  86         enum torture_result last_result;
  87         char *last_reason;
  88
  89         bool returncode;
  90
  91         /** Directory used for temporary test data */
  92         const char *outputdir;
  93
  94         /** Indentation level */
  95         int level;
  96
  97         /** Event context */
  98         struct event_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 /*
 105  * Describes a particular torture test
 106  */
 107 struct torture_test {
 108         /** Short unique name for the test. */
 109         const char *name;
 110
 111         /** Long description for the test. */
 112         const char *description;
 113
 114         /** Whether this is a dangerous test
 115          * (can corrupt the remote servers data or bring it down). */
 116         bool dangerous;
 117
 118         /** Function to call to run this test */
 119         bool (*run) (struct torture_context *torture_ctx,
 120                                  struct torture_tcase *tcase,
 121                                  struct torture_test *test);
 122
 123         struct torture_test *prev, *next;
 124
 125         /** Pointer to the actual test function. This is run by the
 126           * run() function above. */
 127         void *fn;
 128
 129         /** Use data for this test */
 130         const void *data;
 131 };
 132
 133 /*
 134  * Describes a particular test case.
 135  */
 136 struct torture_tcase {
 137     const char *name;
 138         const char *description;
 139         bool (*setup) (struct torture_context *tcase, void **data);
 140         bool (*teardown) (struct torture_context *tcase, void *data);
 141         bool fixture_persistent;
 142         void *data;
 143         struct torture_test *tests;
 144         struct torture_tcase *prev, *next;
 145 };
 146
 147 struct torture_suite
 148 {
 149         const char *name;
 150         const char *description;
 151         struct torture_tcase *testcases;
 152         struct torture_suite *children;
 153
 154         /* Pointers to siblings of this torture suite */
 155         struct torture_suite *prev, *next;
 156 };
 157
 158 /** Create a new torture suite */
 159 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 160                 const char *name);
 161
 162 /** Change the setup and teardown functions for a testcase */
 163 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 164                 bool (*setup) (struct torture_context *, void **),
 165                 bool (*teardown) (struct torture_context *, void *));
 166
 167 /* Add another test to run for a particular testcase */
 168 struct torture_test *torture_tcase_add_test_const(struct torture_tcase *tcase,
 169                 const char *name,
 170                 bool (*run) (struct torture_context *test,
 171                         const void *tcase_data, const void *test_data),
 172                 const void *test_data);
 173
 174 /* Add a testcase to a testsuite */
 175 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 176                                                          const char *name);
 177
 178 /* Convenience wrapper that adds a testcase against only one
 179  * test will be run */
 180 struct torture_tcase *torture_suite_add_simple_tcase_const(
 181                 struct torture_suite *suite,
 182                 const char *name,
 183                 bool (*run) (struct torture_context *test,
 184                         const void *test_data),
 185                 const void *data);
 186
 187 /* Convenience function that adds a test which only
 188  * gets the test case data */
 189 struct torture_test *torture_tcase_add_simple_test_const(
 190                 struct torture_tcase *tcase,
 191                 const char *name,
 192                 bool (*run) (struct torture_context *test,
 193                         const void *tcase_data));
 194
 195 /* Convenience wrapper that adds a test that doesn't need any
 196  * testcase data */
 197 struct torture_tcase *torture_suite_add_simple_test(
 198                 struct torture_suite *suite,
 199                 const char *name,
 200                 bool (*run) (struct torture_context *test));
 201
 202 /* Add a child testsuite to an existing testsuite */
 203 bool torture_suite_add_suite(struct torture_suite *suite,
 204                 struct torture_suite *child);
 205
 206 /* Run the specified testsuite recursively */
 207 bool torture_run_suite(struct torture_context *context,
 208                                            struct torture_suite *suite);
 209
 210 /* Run the specified testcase */
 211 bool torture_run_tcase(struct torture_context *context,
 212                                            struct torture_tcase *tcase);
 213
 214 /* Run the specified test */
 215 bool torture_run_test(struct torture_context *context,
 216                                           struct torture_tcase *tcase,
 217                                           struct torture_test *test);
 218
 219 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 220 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 221 void torture_result(struct torture_context *test,
 222                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 223
 224 #define torture_assert(torture_ctx,expr,cmt) \
 225         if (!(expr)) { \
 226                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 227                 return false; \
 228         }
 229
 230 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
 231         do { WERROR __got = got, __expected = expected; \
 232         if (!W_ERROR_EQUAL(__got, __expected)) { \
 233                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
 234                 return false; \
 235         } \
 236         } while (0)
 237
 238 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 239         do { NTSTATUS __got = got, __expected = expected; \
 240         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 241                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 242                 return false; \
 243         }\
 244         } while(0)
 245
 246 #define torture_assert_ndr_err_equal(torture_ctx,got,expected,cmt) \
 247         do { enum ndr_err_code __got = got, __expected = expected; \
 248         if (__got != __expected) { \
 249                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %d, expected %d (%s): %s", __got, __expected, __STRING(expected), cmt); \
 250                 return false; \
 251         }\
 252         } while(0)
 253
 254 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 255         do { const char *__got = (got), *__expected = (expected); \
 256         if (!strequal(__got, __expected)) { \
 257                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 258                 return false; \
 259         } \
 260         } while(0)
 261
 262 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 263         do { const char *__got = (got), *__expected = (expected); \
 264         if (strcmp_safe(__got, __expected) != 0) { \
 265                 torture_result(torture_ctx, TORTURE_FAIL, \
 266                                            __location__": "#got" was %s, expected %s: %s", \
 267                                            __got, __expected, cmt); \
 268                 return false; \
 269         } \
 270         } while(0)
 271
 272 #define torture_assert_mem_equal(torture_ctx,got,expected,len,cmt)\
 273         do { const void *__got = (got), *__expected = (expected); \
 274         if (memcmp(__got, __expected, len) != 0) { \
 275                 torture_result(torture_ctx, TORTURE_FAIL, \
 276                                __location__": "#got" of len %d did not match"#expected": %s", (int)len, cmt); \
 277                 return false; \
 278         } \
 279         } while(0)
 280
 281 #define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
 282         do { \
 283         char *__got; \
 284         const char *__expected = (expected); \
 285         size_t __size; \
 286         __got = file_load(filename, &__size, 0, torture_ctx); \
 287         if (__got == NULL) { \
 288                 torture_result(torture_ctx, TORTURE_FAIL, \
 289                                __location__": unable to open %s: %s\n", \
 290                                filename, cmt); \
 291                 return false; \
 292         } \
 293         \
 294         if (strcmp_safe(__got, __expected) != 0) { \
 295                 torture_result(torture_ctx, TORTURE_FAIL, \
 296                         __location__": %s contained:\n%sExpected: %s%s\n", \
 297                         filename, __got, __expected, cmt); \
 298                 talloc_free(__got); \
 299                 return false; \
 300         } \
 301         talloc_free(__got); \
 302         } while(0)
 303
 304 #define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
 305         do { const char *__got, *__expected = (expected); \
 306         size_t __size; \
 307         __got = file_load(filename, *size, 0, torture_ctx); \
 308         if (strcmp_safe(__got, __expected) != 0) { \
 309                 torture_result(torture_ctx, TORTURE_FAIL, \
 310                                            __location__": %s contained:\n%sExpected: %s%s\n", \
 311                                            __got, __expected, cmt); \
 312                 talloc_free(__got); \
 313                 return false; \
 314         } \
 315         talloc_free(__got); \
 316         } while(0)
 317
 318 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 319         do { int __got = (got), __expected = (expected); \
 320         if (__got != __expected) { \
 321                 torture_result(torture_ctx, TORTURE_FAIL, \
 322                         __location__": "#got" was %d, expected %d: %s", \
 323                         __got, __expected, cmt); \
 324                 return false; \
 325         } \
 326         } while(0)
 327
 328 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
 329         do { uint64_t __got = (got), __expected = (expected); \
 330         if (__got != __expected) { \
 331                 torture_result(torture_ctx, TORTURE_FAIL, \
 332                         __location__": "#got" was %llu, expected %llu: %s", \
 333                         (unsigned long long)__got, (unsigned long long)__expected, cmt); \
 334                 return false; \
 335         } \
 336         } while(0)
 337
 338 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 339         do { int __expected = (expected); \
 340         if (errno != __expected) { \
 341                 torture_result(torture_ctx, TORTURE_FAIL, \
 342                         __location__": errno was %d (%s), expected %d: %s: %s", \
 343                                            errno, strerror(errno), __expected, \
 344                                            strerror(__expected), cmt); \
 345                 return false; \
 346         } \
 347         } while(0)
 348
 349
 350
 351 #define torture_skip(torture_ctx,cmt) do {\
 352                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 353                 return true; \
 354         } while(0)
 355 #define torture_fail(torture_ctx,cmt) do {\
 356                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 357                 return false; \
 358         } while (0)
 359 #define torture_fail_goto(torture_ctx,label,cmt) do {\
 360                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 361                 goto label; \
 362         } while (0)
 363
 364 #define torture_out stderr
 365
 366 /* Convenience macros */
 367 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 368                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 369
 370 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 371                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 372
 373 #define torture_assert_ndr_success(torture_ctx,expr,cmt) \
 374                 torture_assert_ndr_err_equal(torture_ctx,expr,NDR_ERR_SUCCESS,cmt)
 375
 376 /* Getting settings */
 377 const char *torture_setting_string(struct torture_context *test, \
 378                                                                    const char *name,
 379                                                                    const char *default_value);
 380
 381 int torture_setting_int(struct torture_context *test,
 382                                                 const char *name,
 383                                                 int default_value);
 384
 385 double torture_setting_double(struct torture_context *test,
 386                                                 const char *name,
 387                                                 double default_value);
 388
 389 bool torture_setting_bool(struct torture_context *test,
 390                                                   const char *name,
 391                                                   bool default_value);
 392
 393 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 394                                                                                  const char *name);
 395
 396 NTSTATUS torture_temp_dir(struct torture_context *tctx,
 397                                    const char *prefix,
 398                                    char **tempdir);
 399
 400 struct torture_test *torture_tcase_add_simple_test(struct torture_tcase *tcase,
 401                 const char *name,
 402                 bool (*run) (struct torture_context *test, void *tcase_data));
 403
 404
 405 bool torture_suite_init_tcase(struct torture_suite *suite,
 406                               struct torture_tcase *tcase,
 407                               const char *name);
 408
 409 struct torture_context *torture_context_init(struct event_context *event_ctx,
 410                                              const struct torture_ui_ops *ui_ops);
 411
 412 struct torture_context *torture_context_child(struct torture_context *tctx);
 413
 414 extern const struct torture_ui_ops torture_subunit_ui_ops;
 415
 416 #endif /* __TORTURE_UI_H__ */