r24667: Finally merge the registry improvements that Wilco Baan Hofman and I have
[sfrench/samba-autobuild/.git] / source4 / torture / ui.h
index b4e3585031851e05bb4b4f2e7785b845cca44069..c3b0092d48909e1119d1e726fa7bebaed946f1cf 100644 (file)
@@ -6,7 +6,7 @@
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
@@ -15,8 +15,7 @@
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef __TORTURE_UI_H__
@@ -29,8 +28,8 @@ struct torture_tcase;
 
 enum torture_result { 
        TORTURE_OK=0, 
-       TORTURE_FAIL=1, 
-       TORTURE_TODO=2, 
+       TORTURE_FAIL=1,
+       TORTURE_ERROR=2,
        TORTURE_SKIP=3
 };
 
@@ -40,7 +39,9 @@ enum torture_result {
  */
 struct torture_ui_ops
 {
+       void (*init) (struct torture_context *);
        void (*comment) (struct torture_context *, const char *);
+       void (*warning) (struct torture_context *, const char *);
        void (*suite_start) (struct torture_context *, struct torture_suite *);
        void (*suite_finish) (struct torture_context *, struct torture_suite *);
        void (*tcase_start) (struct torture_context *, struct torture_tcase *); 
@@ -75,21 +76,20 @@ struct torture_context
        const struct torture_ui_ops *ui_ops;
        void *ui_data;
 
+       char *active_testname;
        struct torture_test *active_test;
        struct torture_tcase *active_tcase;
 
-       int skipped;
-       int todo;
-       int success;
-       int failed;
-
        bool quiet; /* Whether tests should avoid writing output to stdout */
 
        enum torture_result last_result;
        char *last_reason;
 
+       bool returncode;
+
        char *outputdir;
        int level;
+       struct event_context *ev;
 };
 
 /* 
@@ -129,7 +129,6 @@ struct torture_tcase {
 struct torture_suite
 {
        const char *name;
-       const char *path; /* Used by subunit tests only */
        const char *description;
        struct torture_tcase *testcases;
        struct torture_suite *children;
@@ -166,6 +165,13 @@ struct torture_tcase *torture_suite_add_simple_tcase(
                bool (*run) (struct torture_context *test, const void *test_data),
                const void *data);
 
+/* Convenience function that adds a test which only 
+ * gets the test case data */
+struct torture_test *torture_tcase_add_simple_test(
+               struct torture_tcase *tcase,
+               const char *name,
+               bool (*run) (struct torture_context *test, const void *tcase_data));
+
 /* Convenience wrapper that adds a test that doesn't need any 
  * testcase data */
 struct torture_tcase *torture_suite_add_simple_test(
@@ -190,23 +196,21 @@ bool torture_run_test(struct torture_context *context,
                                          struct torture_tcase *tcase,
                                          struct torture_test *test);
 
-void _torture_fail_ext(struct torture_context *test, const char *reason, ...) PRINTF_ATTRIBUTE(2,3);
 void torture_comment(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
-void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PRINTF_ATTRIBUTE(2,3);
+void torture_warning(struct torture_context *test, const char *comment, ...) PRINTF_ATTRIBUTE(2,3);
+void torture_result(struct torture_context *test, 
+                       enum torture_result, const char *reason, ...) PRINTF_ATTRIBUTE(3,4);
 
 #define torture_assert(torture_ctx,expr,cmt) \
        if (!(expr)) { \
-               torture_comment(torture_ctx, __location__": Expression `%s' failed\n", __STRING(expr)); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
                return false; \
        }
 
 #define torture_assert_werr_equal(torture_ctx, got, expected, cmt) \
        do { WERROR __got = got, __expected = expected; \
        if (!W_ERROR_EQUAL(__got, __expected)) { \
-               torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", \
-                                               win_errstr(__got), win_errstr(__expected)); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
                return false; \
        } \
        } while (0)
@@ -214,9 +218,7 @@ void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PR
 #define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
        do { NTSTATUS __got = got, __expected = expected; \
        if (!NT_STATUS_EQUAL(__got, __expected)) { \
-               torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", \
-                                               nt_errstr(__got), nt_errstr(__expected)); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
                return false; \
        }\
        } while(0)
@@ -225,8 +227,7 @@ void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PR
 #define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
        do { const char *__got = (got), *__expected = (expected); \
        if (!strequal(__got, __expected)) { \
-               torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", __got, __expected); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
                return false; \
        } \
        } while(0)
@@ -234,17 +235,66 @@ void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PR
 #define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
        do { const char *__got = (got), *__expected = (expected); \
        if (strcmp_safe(__got, __expected) != 0) { \
-               torture_comment(torture_ctx, __location__": "#got" was %s, expected %s\n", __got, __expected); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                                          __location__": "#got" was %s, expected %s: %s", \
+                                          __got, __expected, cmt); \
+               return false; \
+       } \
+       } while(0)
+
+#define torture_assert_file_contains_text(torture_ctx,filename,expected,cmt)\
+       do { \
+       char *__got; \
+       const char *__expected = (expected); \
+       size_t __size; \
+       __got = file_load(filename, &__size, torture_ctx); \
+       if (__got == NULL) { \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                              __location__": unable to open %s: %s\n", \
+                              filename, cmt); \
+               return false; \
+       } \
+       \
+       if (strcmp_safe(__got, __expected) != 0) { \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                       __location__": %s contained:\n%sExpected: %s%s\n", \
+                       filename, __got, __expected, cmt); \
+               talloc_free(__got); \
                return false; \
        } \
+       talloc_free(__got); \
+       } while(0)
+
+#define torture_assert_file_contains(torture_ctx,filename,expected,cmt)\
+       do { const char *__got, *__expected = (expected); \
+       size_t __size; \
+       __got = file_load(filename, *size, torture_ctx); \
+       if (strcmp_safe(__got, __expected) != 0) { \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                                          __location__": %s contained:\n%sExpected: %s%s\n", \
+                                          __got, __expected, cmt); \
+               talloc_free(__got); \
+               return false; \
+       } \
+       talloc_free(__got); \
        } while(0)
 
 #define torture_assert_int_equal(torture_ctx,got,expected,cmt)\
        do { int __got = (got), __expected = (expected); \
        if (__got != __expected) { \
-               torture_comment(torture_ctx, __location__": "#got" was %d, expected %d\n", __got, __expected); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                       __location__": "#got" was %d, expected %d: %s", \
+                       __got, __expected, cmt); \
+               return false; \
+       } \
+       } while(0)
+
+#define torture_assert_u64_equal(torture_ctx,got,expected,cmt)\
+       do { uint64_t __got = (got), __expected = (expected); \
+       if (__got != __expected) { \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                       __location__": "#got" was %llu, expected %llu: %s", \
+                       (unsigned long long)__got, (unsigned long long)__expected, cmt); \
                return false; \
        } \
        } while(0)
@@ -252,8 +302,10 @@ void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PR
 #define torture_assert_errno_equal(torture_ctx,expected,cmt)\
        do { int __expected = (expected); \
        if (errno != __expected) { \
-               torture_comment(torture_ctx, __location__": errno was %d, expected %s\n", errno, strerror(__expected)); \
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt); \
+               torture_result(torture_ctx, TORTURE_FAIL, \
+                       __location__": errno was %d (%s), expected %d: %s: %s", \
+                                          errno, strerror(errno), __expected, \
+                                          strerror(__expected), cmt); \
                return false; \
        } \
        } while(0)
@@ -261,13 +313,17 @@ void _torture_skip_ext(struct torture_context *test, const char *reason, ...) PR
 
 
 #define torture_skip(torture_ctx,cmt) do {\
-               _torture_skip_ext(torture_ctx, __location__": %s", cmt);\
+               torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
                return true; \
        } while(0)
 #define torture_fail(torture_ctx,cmt) do {\
-               _torture_fail_ext(torture_ctx, __location__": %s", cmt);\
+               torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
                return false; \
        } while (0)
+#define torture_fail_goto(torture_ctx,label,cmt) do {\
+               torture_result(torture_ctx, TORTURE_FAIL, __location__": %s", cmt);\
+               goto label; \
+       } while (0)
 
 #define torture_out stderr
 
@@ -291,7 +347,8 @@ bool torture_setting_bool(struct torture_context *test,
                                                  const char *name, 
                                                  bool default_value);
 
-/* Helper function commonly used */
-bool torture_teardown_free(struct torture_context *torture, void *data);
+struct torture_suite *torture_find_suite(struct torture_suite *parent, 
+                                                                                const char *name);
+
 
 #endif /* __TORTURE_UI_H__ */