source4/torture/ui.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 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #ifndef __TORTURE_UI_H__
  23 #define __TORTURE_UI_H__
  24
  25 struct torture_test;
  26 struct torture_context;
  27 struct torture_suite;
  28 struct torture_tcase;
  29
  30 enum torture_result {
  31         TORTURE_OK=0,
  32         TORTURE_FAIL=1,
  33         TORTURE_ERROR=2,
  34         TORTURE_SKIP=3
  35 };
  36
  37 /*
  38  * These callbacks should be implemented by any backend that wishes
  39  * to listen to reports from the torture tests.
  40  */
  41 struct torture_ui_ops
  42 {
  43         void (*init) (struct torture_context *);
  44         void (*comment) (struct torture_context *, const char *);
  45         void (*warning) (struct torture_context *, const char *);
  46         void (*suite_start) (struct torture_context *, struct torture_suite *);
  47         void (*suite_finish) (struct torture_context *, struct torture_suite *);
  48         void (*tcase_start) (struct torture_context *, struct torture_tcase *);
  49         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
  50         void (*test_start) (struct torture_context *,
  51                                                 struct torture_tcase *,
  52                                                 struct torture_test *);
  53         void (*test_result) (struct torture_context *,
  54                                                  enum torture_result, const char *reason);
  55 };
  56
  57 void torture_ui_test_start(struct torture_context *context,
  58                                                            struct torture_tcase *tcase,
  59                                                            struct torture_test *test);
  60
  61 void torture_ui_test_result(struct torture_context *context,
  62                                                                 enum torture_result result,
  63                                                                 const char *comment);
  64
  65 /*
  66  * Holds information about a specific run of the testsuite.
  67  * The data in this structure should be considered private to
  68  * the torture tests and should only be used directly by the torture
  69  * code and the ui backends.
  70  *
  71  * Torture tests should instead call the torture_*() macros and functions
  72  * specified below.
  73  */
  74
  75 struct torture_context
  76 {
  77         const struct torture_ui_ops *ui_ops;
  78         void *ui_data;
  79
  80         char *active_testname;
  81         struct torture_test *active_test;
  82         struct torture_tcase *active_tcase;
  83
  84         bool quiet; /* Whether tests should avoid writing output to stdout */
  85
  86         enum torture_result last_result;
  87         char *last_reason;
  88
  89         bool returncode;
  90
  91         char *outputdir;
  92         int level;
  93         struct event_context *ev;
  94 };
  95
  96 /*
  97  * Describes a particular torture test
  98  */
  99 struct torture_test {
 100         const char *name;
 101         const char *description;
 102         bool dangerous;
 103         /* Function to call to run this test */
 104         bool (*run) (struct torture_context *torture_ctx,
 105                                  struct torture_tcase *tcase,
 106                                  struct torture_test *test);
 107
 108         struct torture_test *prev, *next;
 109
 110         /* Pointer to the actual test function. This is run by the
 111          * run() function above. */
 112         void *fn;
 113         const void *data;
 114 };
 115
 116 /*
 117  * Describes a particular test case.
 118  */
 119 struct torture_tcase {
 120     const char *name;
 121         const char *description;
 122         bool (*setup) (struct torture_context *tcase, void **data);
 123         bool (*teardown) (struct torture_context *tcase, void *data);
 124         bool fixture_persistent;
 125         void *data;
 126         struct torture_test *tests;
 127         struct torture_tcase *prev, *next;
 128 };
 129
 130 struct torture_suite
 131 {
 132         const char *name;
 133         const char *description;
 134         struct torture_tcase *testcases;
 135         struct torture_suite *children;
 136
 137         /* Pointers to siblings of this torture suite */
 138         struct torture_suite *prev, *next;
 139 };
 140
 141 /** Create a new torture suite */
 142 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 143                                                                                    const char *name);
 144
 145 /** Change the setup and teardown functions for a testcase */
 146 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 147                 bool (*setup) (struct torture_context *, void **),
 148                 bool (*teardown) (struct torture_context *, void *));
 149
 150 /* Add another test to run for a particular testcase */
 151 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
 152                 const char *name,
 153                 bool (*run) (struct torture_context *test, const void *tcase_data,
 154                                          const void *test_data),
 155                 const void *test_data);
 156
 157 /* Add a testcase to a testsuite */
 158 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 159                                                          const char *name);
 160
 161 /* Convenience wrapper that adds a testcase against only one
 162  * test will be run */
 163 struct torture_tcase *torture_suite_add_simple_tcase(
 164                 struct torture_suite *suite,
 165                 const char *name,
 166                 bool (*run) (struct torture_context *test, const void *test_data),
 167                 const void *data);
 168
 169 /* Convenience wrapper that adds a test that doesn't need any
 170  * testcase data */
 171 struct torture_tcase *torture_suite_add_simple_test(
 172                 struct torture_suite *suite,
 173                 const char *name,
 174                 bool (*run) (struct torture_context *test));
 175
 176 /* Add a child testsuite to an existing testsuite */
 177 bool torture_suite_add_suite(struct torture_suite *suite,
 178                                                          struct torture_suite *child);
 179
 180 /* Run the specified testsuite recursively */
 181 bool torture_run_suite(struct torture_context *context,
 182                                            struct torture_suite *suite);
 183
 184 /* Run the specified testcase */
 185 bool torture_run_tcase(struct torture_context *context,
 186                                            struct torture_tcase *tcase);
 187
 188 /* Run the specified test */
 189 bool torture_run_test(struct torture_context *context,
 190                                           struct torture_tcase *tcase,
 191                                           struct torture_test *test);
 192
 193 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 194 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 195 void torture_result(struct torture_context *test,
 196                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 197
 198 #define torture_assert(torture_ctx,expr,cmt) \
 199         if (!(expr)) { \
 200                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 201                 return false; \
 202         }
 203
 204 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
 205         do { WERROR __got = got, __expected = expected; \
 206         if (!W_ERROR_EQUAL(__got, __expected)) { \
 207                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
 208                 return false; \
 209         } \
 210         } while (0)
 211
 212 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 213         do { NTSTATUS __got = got, __expected = expected; \
 214         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 215                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 216                 return false; \
 217         }\
 218         } while(0)
 219
 220
 221 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 222         do { const char *__got = (got), *__expected = (expected); \
 223         if (!strequal(__got, __expected)) { \
 224                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 225                 return false; \
 226         } \
 227         } while(0)
 228
 229 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 230         do { const char *__got = (got), *__expected = (expected); \
 231         if (strcmp_safe(__got, __expected) != 0) { \
 232                 torture_result(torture_ctx, TORTURE_FAIL, \
 233                                            __location__": "#got" was %s, expected %s: %s", \
 234                                            __got, __expected, cmt); \
 235                 return false; \
 236         } \
 237         } while(0)
 238
 239 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 240         do { int __got = (got), __expected = (expected); \
 241         if (__got != __expected) { \
 242                 torture_result(torture_ctx, TORTURE_FAIL, \
 243                                          __location__": "#got" was %d, expected %d: %s", \
 244                                            __got, __expected, cmt); \
 245                 return false; \
 246         } \
 247         } while(0)
 248
 249 #define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
 250         do { uint64_t __got = (got), __expected = (expected); \
 251         if (__got != __expected) { \
 252                 torture_result(torture_ctx, TORTURE_FAIL, \
 253                         __location__": "#got" was %llu, expected %llu: %s", \
 254                         (unsigned long long)__got, (unsigned long long)__expected, cmt); \
 255                 return false; \
 256         } \
 257         } while(0)
 258
 259 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 260         do { int __expected = (expected); \
 261         if (errno != __expected) { \
 262                 torture_result(torture_ctx, TORTURE_FAIL, \
 263                         __location__": errno was %d (%s), expected %d: %s: %s", \
 264                                            errno, strerror(errno), __expected, \
 265                                            strerror(__expected), cmt); \
 266                 return false; \
 267         } \
 268         } while(0)
 269
 270
 271
 272 #define torture_skip(torture_ctx,cmt) do {\
 273                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 274                 return true; \
 275         } while(0)
 276 #define torture_fail(torture_ctx,cmt) do {\
 277                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 278                 return false; \
 279         } while (0)
 280 #define torture_fail_goto(torture_ctx,label,cmt) do {\
 281                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 282                 goto label; \
 283         } while (0)
 284
 285 #define torture_out stderr
 286
 287 /* Convenience macros */
 288 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 289                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 290
 291 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 292                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 293
 294 /* Getting settings */
 295 const char *torture_setting_string(struct torture_context *test, \
 296                                                                    const char *name,
 297                                                                    const char *default_value);
 298
 299 int torture_setting_int(struct torture_context *test,
 300                                                 const char *name,
 301                                                 int default_value);
 302
 303 bool torture_setting_bool(struct torture_context *test,
 304                                                   const char *name,
 305                                                   bool default_value);
 306
 307 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 308                                                                                  const char *name);
 309
 310
 311 #endif /* __TORTURE_UI_H__ */