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_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 (*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         char *active_testname;
  79         struct torture_test *active_test;
  80         struct torture_tcase *active_tcase;
  81
  82         char **expected_failures;
  83
  84         struct torture_results {
  85                 int skipped;
  86                 int todo;
  87                 int success;
  88                 int failed;
  89                 int errors;
  90
  91                 const char **unexpected_failures;
  92                 const char **unexpected_successes;
  93                 const char **unexpected_errors;
  94
  95                 bool returncode;
  96         } results;
  97
  98         bool quiet; /* Whether tests should avoid writing output to stdout */
  99
 100         enum torture_result last_result;
 101         char *last_reason;
 102
 103         char *outputdir;
 104         int level;
 105 };
 106
 107 /*
 108  * Describes a particular torture test
 109  */
 110 struct torture_test {
 111         const char *name;
 112         const char *description;
 113         bool dangerous;
 114         /* Function to call to run this test */
 115         bool (*run) (struct torture_context *torture_ctx,
 116                                  struct torture_tcase *tcase,
 117                                  struct torture_test *test);
 118
 119         struct torture_test *prev, *next;
 120
 121         /* Pointer to the actual test function. This is run by the
 122          * run() function above. */
 123         void *fn;
 124         const void *data;
 125 };
 126
 127 /*
 128  * Describes a particular test case.
 129  */
 130 struct torture_tcase {
 131     const char *name;
 132         const char *description;
 133         bool (*setup) (struct torture_context *tcase, void **data);
 134         bool (*teardown) (struct torture_context *tcase, void *data);
 135         bool fixture_persistent;
 136         void *data;
 137         struct torture_test *tests;
 138         struct torture_tcase *prev, *next;
 139 };
 140
 141 struct torture_suite
 142 {
 143         const char *name;
 144         const char *description;
 145         struct torture_tcase *testcases;
 146         struct torture_suite *children;
 147
 148         /* Pointers to siblings of this torture suite */
 149         struct torture_suite *prev, *next;
 150 };
 151
 152 /** Create a new torture suite */
 153 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 154                                                                                    const char *name);
 155
 156 /** Change the setup and teardown functions for a testcase */
 157 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 158                 bool (*setup) (struct torture_context *, void **),
 159                 bool (*teardown) (struct torture_context *, void *));
 160
 161 /* Add another test to run for a particular testcase */
 162 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
 163                 const char *name,
 164                 bool (*run) (struct torture_context *test, const void *tcase_data,
 165                                          const void *test_data),
 166                 const void *test_data);
 167
 168 /* Add a testcase to a testsuite */
 169 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 170                                                          const char *name);
 171
 172 /* Convenience wrapper that adds a testcase against only one
 173  * test will be run */
 174 struct torture_tcase *torture_suite_add_simple_tcase(
 175                 struct torture_suite *suite,
 176                 const char *name,
 177                 bool (*run) (struct torture_context *test, const void *test_data),
 178                 const void *data);
 179
 180 /* Convenience wrapper that adds a test that doesn't need any
 181  * testcase data */
 182 struct torture_tcase *torture_suite_add_simple_test(
 183                 struct torture_suite *suite,
 184                 const char *name,
 185                 bool (*run) (struct torture_context *test));
 186
 187 /* Add a child testsuite to an existing testsuite */
 188 bool torture_suite_add_suite(struct torture_suite *suite,
 189                                                          struct torture_suite *child);
 190
 191 /* Run the specified testsuite recursively */
 192 bool torture_run_suite(struct torture_context *context,
 193                                            struct torture_suite *suite);
 194
 195 /* Run the specified testcase */
 196 bool torture_run_tcase(struct torture_context *context,
 197                                            struct torture_tcase *tcase);
 198
 199 /* Run the specified test */
 200 bool torture_run_test(struct torture_context *context,
 201                                           struct torture_tcase *tcase,
 202                                           struct torture_test *test);
 203
 204 void torture_comment(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
 231 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 232         do { const char *__got = (got), *__expected = (expected); \
 233         if (!strequal(__got, __expected)) { \
 234                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 235                 return false; \
 236         } \
 237         } while(0)
 238
 239 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 240         do { const char *__got = (got), *__expected = (expected); \
 241         if (strcmp_safe(__got, __expected) != 0) { \
 242                 torture_result(torture_ctx, TORTURE_FAIL, \
 243                                            __location__": "#got" was %s, expected %s: %s", \
 244                                            __got, __expected, cmt); \
 245                 return false; \
 246         } \
 247         } while(0)
 248
 249 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 250         do { int __got = (got), __expected = (expected); \
 251         if (__got != __expected) { \
 252                 torture_result(torture_ctx, TORTURE_FAIL, \
 253                                          __location__": "#got" was %d, expected %d: %s", \
 254                                            __got, __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
 281 #define torture_out stderr
 282
 283 /* Convenience macros */
 284 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 285                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 286
 287 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 288                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 289
 290 /* Getting settings */
 291 const char *torture_setting_string(struct torture_context *test, \
 292                                                                    const char *name,
 293                                                                    const char *default_value);
 294
 295 int torture_setting_int(struct torture_context *test,
 296                                                 const char *name,
 297                                                 int default_value);
 298
 299 bool torture_setting_bool(struct torture_context *test,
 300                                                   const char *name,
 301                                                   bool default_value);
 302
 303 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 304                                                                                  const char *name);
 305
 306
 307 #endif /* __TORTURE_UI_H__ */