source/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_TODO=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 (*comment) (struct torture_context *, const char *);
  44         void (*suite_start) (struct torture_context *, struct torture_suite *);
  45         void (*suite_finish) (struct torture_context *, struct torture_suite *);
  46         void (*tcase_start) (struct torture_context *, struct torture_tcase *);
  47         void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
  48         void (*test_start) (struct torture_context *,
  49                                                 struct torture_tcase *,
  50                                                 struct torture_test *);
  51         void (*test_result) (struct torture_context *,
  52                                                  enum torture_result, const char *reason);
  53 };
  54
  55 void torture_ui_test_start(struct torture_context *context,
  56                                                            struct torture_tcase *tcase,
  57                                                            struct torture_test *test);
  58
  59 void torture_ui_test_result(struct torture_context *context,
  60                                                                 enum torture_result result,
  61                                                                 const char *comment);
  62
  63 /*
  64  * Holds information about a specific run of the testsuite.
  65  * The data in this structure should be considered private to
  66  * the torture tests and should only be used directly by the torture
  67  * code and the ui backends.
  68  *
  69  * Torture tests should instead call the torture_*() macros and functions
  70  * specified below.
  71  */
  72
  73 struct torture_context
  74 {
  75         const struct torture_ui_ops *ui_ops;
  76         void *ui_data;
  77
  78         struct torture_test *active_test;
  79         struct torture_tcase *active_tcase;
  80
  81         int skipped;
  82         int todo;
  83         int success;
  84         int failed;
  85
  86         bool quiet; /* Whether tests should avoid writing output to stdout */
  87
  88         enum torture_result last_result;
  89         char *last_reason;
  90
  91         char *outputdir;
  92         int level;
  93 };
  94
  95 /*
  96  * Describes a particular torture test
  97  */
  98 struct torture_test {
  99         const char *name;
 100         const char *description;
 101         bool dangerous;
 102         /* Function to call to run this test */
 103         bool (*run) (struct torture_context *torture_ctx,
 104                                  struct torture_tcase *tcase,
 105                                  struct torture_test *test);
 106
 107         struct torture_test *prev, *next;
 108
 109         /* Pointer to the actual test function. This is run by the
 110          * run() function above. */
 111         void *fn;
 112         const void *data;
 113 };
 114
 115 /*
 116  * Describes a particular test case.
 117  */
 118 struct torture_tcase {
 119     const char *name;
 120         const char *description;
 121         bool (*setup) (struct torture_context *tcase, void **data);
 122         bool (*teardown) (struct torture_context *tcase, void *data);
 123         bool fixture_persistent;
 124         void *data;
 125         struct torture_test *tests;
 126         struct torture_tcase *prev, *next;
 127 };
 128
 129 struct torture_suite
 130 {
 131         const char *name;
 132         const char *path; /* Used by subunit tests only */
 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_fail_ext(struct torture_context *test, const char *reason, ...) PRINTF_ATTRIBUTE(2,3);
 194 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 195 void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PRINTF_ATTRIBUTE(2,3);
 196
 197 #define torture_assert(torture_ctx,expr,cmt) \
 198         if (!(expr)) { \
 199                 torture_comment(torture_ctx, __location__": Expression `%s' failed\n", __STRING(expr)); \
 200                 _torture_fail_ext(torture_ctx, __location__": %s", 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_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", \
 208                                                 win_errstr(__got), win_errstr(__expected)); \
 209                 _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
 210                 return false; \
 211         } \
 212         } while (0)
 213
 214 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 215         do { NTSTATUS __got = got, __expected = expected; \
 216         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 217                 torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", \
 218                                                 nt_errstr(__got), nt_errstr(__expected)); \
 219                 _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
 220                 return false; \
 221         }\
 222         } while(0)
 223
 224
 225 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 226         do { const char *__got = (got), *__expected = (expected); \
 227         if (!strequal(__got, __expected)) { \
 228                 torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", __got, __expected); \
 229                 _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
 230                 return false; \
 231         } \
 232         } while(0)
 233
 234 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 235         do { const char *__got = (got), *__expected = (expected); \
 236         if (strcmp_safe(__got, __expected) != 0) { \
 237                 torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", __got, __expected); \
 238                 _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
 239                 return false; \
 240         } \
 241         } while(0)
 242
 243 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 244         do { int __got = (got), __expected = (expected); \
 245         if (__got != __expected) { \
 246                 torture_comment(torture_ctx, __location__": "#got" was %d, expected %d\n", __got, __expected); \
 247                 _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
 248                 return false; \
 249         } \
 250         } while(0)
 251
 252 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 253         do { int __expected = (expected); \
 254         if (errno != __expected) { \
 255                 torture_comment(torture_ctx, __location__": errno was %d, expected %s\n", errno, strerror(__expected)); \
 256                 _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
 257                 return false; \
 258         } \
 259         } while(0)
 260
 261
 262
 263 #define torture_skip(torture_ctx,cmt) do {\
 264                 _torture_skip_ext(torture_ctx, __location__": %s", cmt);\
 265                 return true; \
 266         } while(0)
 267 #define torture_fail(torture_ctx,cmt) do {\
 268                 _torture_fail_ext(torture_ctx, __location__": %s", cmt);\
 269                 return false; \
 270         } while (0)
 271
 272 #define torture_out stderr
 273
 274 /* Convenience macros */
 275 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 276                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 277
 278 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 279                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 280
 281 /* Getting settings */
 282 const char *torture_setting_string(struct torture_context *test, \
 283                                                                    const char *name,
 284                                                                    const char *default_value);
 285
 286 int torture_setting_int(struct torture_context *test,
 287                                                 const char *name,
 288                                                 int default_value);
 289
 290 bool torture_setting_bool(struct torture_context *test,
 291                                                   const char *name,
 292                                                   bool default_value);
 293
 294 /* Helper function commonly used */
 295 bool torture_teardown_free(struct torture_context *torture, void *data);
 296
 297 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 298                                                                                  const char *name);
 299
 300
 301 #endif /* __TORTURE_UI_H__ */