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,
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__
struct torture_test;
struct torture_context;
+struct torture_suite;
struct torture_tcase;
enum torture_result {
TORTURE_OK=0,
- TORTURE_FAIL=1,
- TORTURE_TODO=2,
+ TORTURE_FAIL=1,
+ TORTURE_ERROR=2,
TORTURE_SKIP=3
};
+/*
+ * These callbacks should be implemented by any backend that wishes
+ * to listen to reports from the torture tests.
+ */
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 *);
void (*tcase_finish) (struct torture_context *, struct torture_tcase *);
void (*test_start) (struct torture_context *,
struct torture_tcase *,
struct torture_test *);
- void (*test_result) (struct torture_context *, enum torture_result,
- const char *reason);
+ void (*test_result) (struct torture_context *,
+ enum torture_result, const char *reason);
};
+void torture_ui_test_start(struct torture_context *context,
+ struct torture_tcase *tcase,
+ struct torture_test *test);
+
+void torture_ui_test_result(struct torture_context *context,
+ enum torture_result result,
+ const char *comment);
+
+/*
+ * Holds information about a specific run of the testsuite.
+ * The data in this structure should be considered private to
+ * the torture tests and should only be used directly by the torture
+ * code and the ui backends.
+ *
+ * Torture tests should instead call the torture_*() macros and functions
+ * specified below.
+ */
+
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;
+
+ const char *outputdir;
+ int level;
+ struct event_context *ev;
+};
+
+/*
+ * Describes a particular torture test
+ */
+struct torture_test {
+ const char *name;
+ const char *description;
+ bool dangerous;
+ /* Function to call to run this test */
+ bool (*run) (struct torture_context *torture_ctx,
+ struct torture_tcase *tcase,
+ struct torture_test *test);
+
+ struct torture_test *prev, *next;
+
+ /* Pointer to the actual test function. This is run by the
+ * run() function above. */
+ void *fn;
+ const void *data;
+};
+
+/*
+ * Describes a particular test case.
+ */
+struct torture_tcase {
+ const char *name;
+ const char *description;
+ bool (*setup) (struct torture_context *tcase, void **data);
+ bool (*teardown) (struct torture_context *tcase, void *data);
+ bool fixture_persistent;
+ void *data;
+ struct torture_test *tests;
+ struct torture_tcase *prev, *next;
};
struct torture_suite
{
const char *name;
const char *description;
- struct torture_tcase {
- const char *name;
- const char *description;
- BOOL (*setup) (struct torture_context *tcase, void **data);
- BOOL (*teardown) (struct torture_context *tcase, void *data);
- BOOL fixture_persistent;
- const void *data;
- struct torture_test {
- const char *name;
- const char *description;
- const void *data;
- BOOL (*run) (struct torture_context *test,
- const void *tcase_data,
- const void *test_data);
- struct torture_test *prev, *next;
- } *tests;
- struct torture_tcase *prev, *next;
- } *testcases;
+ struct torture_tcase *testcases;
+ struct torture_suite *children;
+
+ /* Pointers to siblings of this torture suite */
+ struct torture_suite *prev, *next;
};
-void torture_register_suite(struct torture_suite *suite);
-struct torture_suite *torture_suite_create(TALLOC_CTX *ctx, const char *name);
+/** Create a new torture suite */
+struct torture_suite *torture_suite_create(TALLOC_CTX *mem_ctx,
+ const char *name);
+
+/** Change the setup and teardown functions for a testcase */
void torture_tcase_set_fixture(struct torture_tcase *tcase,
- BOOL (*setup) (struct torture_context *, void **),
- BOOL (*teardown) (struct torture_context *, void *));
+ bool (*setup) (struct torture_context *, void **),
+ bool (*teardown) (struct torture_context *, void *));
+
+/* Add another test to run for a particular testcase */
struct torture_test *torture_tcase_add_test(struct torture_tcase *tcase,
const char *name,
- BOOL (*run) (struct torture_context *test, const void *tcase_data,
+ bool (*run) (struct torture_context *test, const void *tcase_data,
const void *test_data),
const void *test_data);
+
+/* Add a testcase to a testsuite */
struct torture_tcase *torture_suite_add_tcase(struct torture_suite *suite,
const char *name);
+
+/* Convenience wrapper that adds a testcase against only one
+ * test will be run */
struct torture_tcase *torture_suite_add_simple_tcase(
struct torture_suite *suite,
const char *name,
- BOOL (*run) (struct torture_context *test, const void *test_data),
+ bool (*run) (struct torture_context *test, const void *test_data),
const void *data);
-BOOL torture_run_suite(struct torture_context *context,
+/* 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(
+ struct torture_suite *suite,
+ const char *name,
+ bool (*run) (struct torture_context *test));
+
+/* Add a child testsuite to an existing testsuite */
+bool torture_suite_add_suite(struct torture_suite *suite,
+ struct torture_suite *child);
+
+/* Run the specified testsuite recursively */
+bool torture_run_suite(struct torture_context *context,
struct torture_suite *suite);
-BOOL torture_run_tcase(struct torture_context *context,
+/* Run the specified testcase */
+bool torture_run_tcase(struct torture_context *context,
struct torture_tcase *tcase);
-BOOL torture_run_test(struct torture_context *context,
+/* Run the specified test */
+bool torture_run_test(struct torture_context *context,
struct torture_tcase *tcase,
struct torture_test *test);
-#define torture_assert(ctx,expr,string) \
+void torture_comment(struct torture_context *test, const char *comment, ...) 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_fail(ctx, "%s:%d (%s): %s", __FILE__, __LINE__, string, \
- __STRING(expr)); \
- return False; \
+ torture_result(torture_ctx, TORTURE_FAIL, __location__": Expression `%s' failed: %s", __STRING(expr), cmt); \
+ return false; \
}
-#define torture_assert_werr_equal(ctx,got,expected,string) \
- if (!W_ERROR_EQUAL(got, expected)) { \
- torture_fail(ctx, "%s:%d (%s): got %s, expected %s", __FILE__, \
- __LINE__, string, win_errstr(got), win_errstr(expected)); \
- 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_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", win_errstr(__got), win_errstr(__expected), cmt); \
+ return false; \
+ } \
+ } while (0)
-#define torture_assert_ntstatus_equal(ctx,got,expected,string) \
- if (!NT_STATUS_EQUAL(got, expected)) { \
- torture_fail(ctx, "%s:%d (%s): got %s, expected %s", __FILE__, \
- __LINE__, string, nt_errstr(got), nt_errstr(expected)); \
- return False; \
- }
+#define torture_assert_ntstatus_equal(torture_ctx,got,expected,cmt) \
+ do { NTSTATUS __got = got, __expected = expected; \
+ if (!NT_STATUS_EQUAL(__got, __expected)) { \
+ torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", nt_errstr(__got), nt_errstr(__expected), cmt); \
+ return false; \
+ }\
+ } while(0)
-#define torture_assert_casestr_equal(ctx,got,expected,string) \
- if (strcasecmp(got, expected) != 0) { \
- torture_fail(ctx, "%s:%d (%s): got %s, expected %s", __FILE__, \
- __LINE__, string, got, expected); \
- return False; \
- }
-#define torture_assert_str_equal(ctx,got,expected,string) \
- if (strcmp(got, expected) != 0) { \
- torture_fail(ctx, "%s:%d (%s): got %s, expected %s", __FILE__, \
- __LINE__, string, got, expected); \
- return False; \
- }
+#define torture_assert_casestr_equal(torture_ctx,got,expected,cmt) \
+ do { const char *__got = (got), *__expected = (expected); \
+ if (!strequal(__got, __expected)) { \
+ torture_result(torture_ctx, TORTURE_FAIL, __location__": "#got" was %s, expected %s: %s", __got, __expected, cmt); \
+ return false; \
+ } \
+ } while(0)
+
+#define torture_assert_str_equal(torture_ctx,got,expected,cmt)\
+ do { const char *__got = (got), *__expected = (expected); \
+ if (strcmp_safe(__got, __expected) != 0) { \
+ 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_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)
+
+#define torture_assert_errno_equal(torture_ctx,expected,cmt)\
+ do { int __expected = (expected); \
+ if (errno != __expected) { \
+ 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)
+
+
+
+#define torture_skip(torture_ctx,cmt) do {\
+ torture_result(torture_ctx, TORTURE_SKIP, __location__": %s", cmt);\
+ return true; \
+ } while(0)
+#define torture_fail(torture_ctx,cmt) do {\
+ 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
/* Convenience macros */
+#define torture_assert_ntstatus_ok(torture_ctx,expr,cmt) \
+ torture_assert_ntstatus_equal(torture_ctx,expr,NT_STATUS_OK,cmt)
+
+#define torture_assert_werr_ok(torture_ctx,expr,cmt) \
+ torture_assert_werr_equal(torture_ctx,expr,WERR_OK,cmt)
+
+/* Getting settings */
+const char *torture_setting_string(struct torture_context *test, \
+ const char *name,
+ const char *default_value);
+
+int torture_setting_int(struct torture_context *test,
+ const char *name,
+ int default_value);
-#define torture_assert_ntstatus_ok(ctx,expr,string) \
- torture_assert_ntstatus_equal(ctx,expr,NT_STATUS_OK,string)
+double torture_setting_double(struct torture_context *test,
+ const char *name,
+ double default_value);
-#define torture_assert_werr_ok(ctx,expr,string) \
- torture_assert_werr_equal(ctx,expr,WERR_OK,string)
+bool torture_setting_bool(struct torture_context *test,
+ const char *name,
+ bool default_value);
-void torture_comment(struct torture_context *test, const char *comment, ...) _PRINTF_ATTRIBUTE(2,3);
-void torture_ok(struct torture_context *test);
-void torture_fail(struct torture_context *test, const char *reason, ...) _PRINTF_ATTRIBUTE(2,3);
-void torture_skip(struct torture_context *test, const char *reason, ...) _PRINTF_ATTRIBUTE(2,3);
-const char *torture_setting(struct torture_context *test, const char *name,
- const char *default_value);
+struct torture_suite *torture_find_suite(struct torture_suite *parent,
+ const char *name);
-/* Helper function commonly used */
-BOOL torture_teardown_free(struct torture_context *torture, void *data);
#endif /* __TORTURE_UI_H__ */
git.samba.org / kai / samba.git / blobdiff