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 };
  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 *description;
 133         struct torture_tcase *testcases;
 134         struct torture_suite *children;
 135
 136         /* Pointers to siblings of this torture suite */
 137         struct torture_suite *prev, *next;
 138 };
 139
 140 /** Create a new torture suite */
 141 struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
 142                                                                                    const char *name);
 143
 144 /** Change the setup and teardown functions for a testcase */
 145 void torture_tcase_set_fixture(struct torture_tcase *tcase,
 146                 bool (*setup) (struct torture_context *, void **),
 147                 bool (*teardown) (struct torture_context *, void *));
 148
 149 /* Add another test to run for a particular testcase */
 150 struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
 151                 const char *name,
 152                 bool (*run) (struct torture_context *test, const void *tcase_data,
 153                                          const void *test_data),
 154                 const void *test_data);
 155
 156 /* Add a testcase to a testsuite */
 157 struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
 158                                                          const char *name);
 159
 160 /* Convenience wrapper that adds a testcase against only one
 161  * test will be run */
 162 struct torture_tcase *torture_suite_add_simple_tcase(
 163                 struct torture_suite *suite,
 164                 const char *name,
 165                 bool (*run) (struct torture_context *test, const void *test_data),
 166                 const void *data);
 167
 168 /* Convenience wrapper that adds a test that doesn't need any
 169  * testcase data */
 170 struct torture_tcase *torture_suite_add_simple_test(
 171                 struct torture_suite *suite,
 172                 const char *name,
 173                 bool (*run) (struct torture_context *test));
 174
 175 /* Add a child testsuite to an existing testsuite */
 176 bool torture_suite_add_suite(struct torture_suite *suite,
 177                                                          struct torture_suite *child);
 178
 179 /* Run the specified testsuite recursively */
 180 bool torture_run_suite(struct torture_context *context,
 181                                            struct torture_suite *suite);
 182
 183 /* Run the specified testcase */
 184 bool torture_run_tcase(struct torture_context *context,
 185                                            struct torture_tcase *tcase);
 186
 187 /* Run the specified test */
 188 bool torture_run_test(struct torture_context *context,
 189                                           struct torture_tcase *tcase,
 190                                           struct torture_test *test);
 191
 192 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 193 void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
 194 void torture_result(struct torture_context *test,
 195                         enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 196
 197 #define torture_assert(torture_ctx,expr,cmt) \
 198         if (!(expr)) { \
 199                 torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
 200                 return false; \
 201         }
 202
 203 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
 204         do { WERROR __got = got, __expected = expected; \
 205         if (!W_ERROR_EQUAL(__got, __expected)) { \
 206                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
 207                 return false; \
 208         } \
 209         } while (0)
 210
 211 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
 212         do { NTSTATUS __got = got, __expected = expected; \
 213         if (!NT_STATUS_EQUAL(__got, __expected)) { \
 214                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
 215                 return false; \
 216         }\
 217         } while(0)
 218
 219
 220 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
 221         do { const char *__got = (got), *__expected = (expected); \
 222         if (!strequal(__got, __expected)) { \
 223                 torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
 224                 return false; \
 225         } \
 226         } while(0)
 227
 228 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
 229         do { const char *__got = (got), *__expected = (expected); \
 230         if (strcmp_safe(__got, __expected) != 0) { \
 231                 torture_result(torture_ctx, TORTURE_FAIL, \
 232                                            __location__": "#got" was %s, expected %s: %s", \
 233                                            __got, __expected, cmt); \
 234                 return false; \
 235         } \
 236         } while(0)
 237
 238 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
 239         do { int __got = (got), __expected = (expected); \
 240         if (__got != __expected) { \
 241                 torture_result(torture_ctx, TORTURE_FAIL, \
 242                                          __location__": "#got" was %d, expected %d: %s", \
 243                                            __got, __expected, cmt); \
 244                 return false; \
 245         } \
 246         } while(0)
 247
 248 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
 249         do { int __expected = (expected); \
 250         if (errno != __expected) { \
 251                 torture_result(torture_ctx, TORTURE_FAIL, \
 252                         __location__": errno was %d (%s), expected %d: %s: %s", \
 253                                            errno, strerror(errno), __expected, \
 254                                            strerror(__expected), cmt); \
 255                 return false; \
 256         } \
 257         } while(0)
 258
 259
 260
 261 #define torture_skip(torture_ctx,cmt) do {\
 262                 torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
 263                 return true; \
 264         } while(0)
 265 #define torture_fail(torture_ctx,cmt) do {\
 266                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 267                 return false; \
 268         } while (0)
 269 #define torture_fail_goto(torture_ctx,label,cmt) do {\
 270                 torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
 271                 goto label; \
 272         } while (0)
 273
 274 #define torture_out stderr
 275
 276 /* Convenience macros */
 277 #define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
 278                 torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
 279
 280 #define torture_assert_werr_ok(torture_ctx,expr,cmt) \
 281                 torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
 282
 283 /* Getting settings */
 284 const char *torture_setting_string(struct torture_context *test, \
 285                                                                    const char *name,
 286                                                                    const char *default_value);
 287
 288 int torture_setting_int(struct torture_context *test,
 289                                                 const char *name,
 290                                                 int default_value);
 291
 292 bool torture_setting_bool(struct torture_context *test,
 293                                                   const char *name,
 294                                                   bool default_value);
 295
 296 struct torture_suite *torture_find_suite(struct torture_suite *parent,
 297                                                                                  const char *name);
 298
 299
 300 #endif /* __TORTURE_UI_H__ */