From 83ff1e3f0b925910c0965490a26860a7c5efaa57 Mon Sep 17 00:00:00 2001
From: Matej Habrnal <mhabrnal@redhat.com>
Date: Tue, 22 Mar 2016 17:13:38 +0100
Subject: [PATCH] testsuite: add simple helper macros
I am tired of repeating the same constructions over and over again.
Signed-off-by: Jakub Filak <jfilak@redhat.com>
---
tests/Makefile.am | 2 +-
tests/atlocal.in | 2 +-
tests/helpers/testsuite.h | 297 ++++++++++++++++++++++++++++++++++++++++
tests/helpers/testsuite_tools.h | 67 +++++++++
4 files changed, 366 insertions(+), 2 deletions(-)
create mode 100644 tests/helpers/testsuite.h
create mode 100644 tests/helpers/testsuite_tools.h
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 9aa3a07..9bfc2b6 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -58,7 +58,7 @@ MAINTAINERCLEANFILES = Makefile.in $(TESTSUITE)
check_DATA = atconfig atlocal $(TESTSUITE)
DISTCLEANFILES = atconfig
EXTRA_DIST += atlocal.in conf ureport ureport-rhts-credentials \
- bugzilla_plugin.at.in
+ helpers/testsuite.h bugzilla_plugin.at.in
atconfig: $(top_builddir)/config.status
(cd ${top_builddir} && ./config.status ${subdir}/atconfig)
diff --git a/tests/atlocal.in b/tests/atlocal.in
index 1a82edb..3d6b04a 100644
--- a/tests/atlocal.in
+++ b/tests/atlocal.in
@@ -6,7 +6,7 @@ CC='@CC@'
LIBTOOL="$abs_top_builddir/libtool"
# We want no optimization.
-CFLAGS="@O0CFLAGS@ -I$abs_top_builddir/src/include -I$abs_top_builddir/src/lib -I$abs_top_builddir/src/gtk-helpers -D_GNU_SOURCE @GLIB_CFLAGS@ @GTK_CFLAGS@ -DDEFAULT_DUMP_DIR_MODE=@DEFAULT_DUMP_DIR_MODE@"
+CFLAGS="@O0CFLAGS@ -I$abs_top_builddir/tests/helpers -I$abs_top_builddir/src/include -I$abs_top_builddir/src/lib -I$abs_top_builddir/src/gtk-helpers -D_GNU_SOURCE @GLIB_CFLAGS@ @GTK_CFLAGS@ -DDEFAULT_DUMP_DIR_MODE=@DEFAULT_DUMP_DIR_MODE@"
# Are special link options needed?
LDFLAGS="@LDFLAGS@"
diff --git a/tests/helpers/testsuite.h b/tests/helpers/testsuite.h
new file mode 100644
index 0000000..28bfd3e
--- /dev/null
+++ b/tests/helpers/testsuite.h
@@ -0,0 +1,297 @@
+/*
+ Copyright (C) 2015 ABRT team <crash-catcher@lists.fedorahosted.org>
+ Copyright (C) 2015 RedHat inc.
+
+ 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
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ 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.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ ----
+
+ libreport testsuite helpers
+
+ Feel free to add whatever macro you need but please try to keep this file
+ short and useful.
+
+ Bare in mind usability and print as much accurate log messages as possible:
+
+ Example 1:
+
+ int actual = 0;
+ int expected = 1;
+ TS_ASSERT_SIGNED_EQ(actual, expected)
+
+ ----
+
+ [ FAILED ] 12: Assert (actual == expected)
+ Actual : 0
+ Expected: 1
+
+
+ Example 2:
+
+ int get_runtime_number() {
+ return 0;
+ }
+
+ TS_ASSERT_SIGNED_OP_MESSAGE(get_runtime_number(), 1, "Custom message")
+
+ ----
+
+ [ FAILED ] 3: Custom messages (get_runtime_number() >= 1)
+ Actual : 0
+ Expected: 1
+
+ Note: the number right behind [ FAILED ] is line number where the failed
+ assert is located.
+*/
+#ifndef LIBREPORT_TESTSUITE_H
+#define LIBREPORT_TESTSUITE_H
+
+/* For g_verbose */
+#include "internal_libreport.h"
+
+/* For convenience */
+#include <assert.h>
+
+
+/* Number of failed asserts and other failures. Can be used a return value of
+ * the main function. */
+long g_testsuite_fails = 0;
+
+/* Number of successful asserts. For debugging purpose. */
+long g_testsuite_ok = 0;
+
+/* Enables additional log messages. */
+int g_testsuite_debug = 0;
+
+/* Can be used to change log messages destination. */
+FILE *g_testsuite_output_stream = 0;
+
+
+/*
+ * Test case definition
+ */
+
+#define TS_MAIN \
+ int main(int argc, char *argv[]) { g_verbose = 3; do
+
+#define TS_RETURN_MAIN \
+ while (0) ;\
+ return g_testsuite_fails; }
+
+
+/*
+ * Logging
+ */
+
+#define TS_PRINTF(format, ...) \
+ fprintf(g_testsuite_output_stream != NULL ? g_testsuite_output_stream : stderr, format, __VA_ARGS__)
+
+#define TS_DEBUG_PRINTF(format, ...) \
+ do { if (g_testsuite_debug) { TS_PRINTF(format, __VA_ARGS__); } } while (0)
+
+
+/*
+ * Handling of test results
+ */
+
+#define TS_SUCCESS(format, ...) \
+ do { \
+ TS_DEBUG_PRINTF("[ OK ] %d: ", __LINE__); \
+ TS_DEBUG_PRINTF(format, __VA_ARGS__); \
+ ++g_testsuite_ok; \
+ } while (0)
+
+#define TS_FAILURE(format, ...) \
+ do { \
+ TS_PRINTF("[ FAILED ] %d: ", __LINE__); \
+ TS_PRINTF(format, __VA_ARGS__); \
+ ++g_testsuite_fails; \
+ } while (0)
+
+
+/*
+ * Logical conditions
+ */
+
+#define _TS_ASSERT_BOOLEAN(expression, expected, message) \
+ do { \
+ const int result = (expression); \
+ if (result == expected) { \
+ TS_SUCCESS("%s ("#expression" == %s)\n", message ? message : "Assert", expected ? "TRUE" : "FALSE"); \
+ }\
+ else { \
+ TS_FAILURE("%s ("#expression" == %s)\n", message ? message : "Assert", expected ? "TRUE" : "FALSE"); \
+ }\
+ } while(0)
+
+
+#define TS_ASSERT_TRUE_MESSAGE(expression, message) \
+ _TS_ASSERT_BOOLEAN(expression, 1, message)
+
+#define TS_ASSERT_TRUE(expression) \
+ TS_ASSERT_TRUE_MESSAGE(expression, NULL)
+
+#define TS_ASSERT_FALSE_MESSAGE(expression, message) \
+ _TS_ASSERT_BOOLEAN(expression, 0, message)
+
+#define TS_ASSERT_FALSE(expression) \
+ TS_ASSERT_FALSE_MESSAGE(expression, NULL)
+
+/*
+ * Testing of signed numbers
+ */
+
+#define TS_ASSERT_SIGNED_OP_MESSAGE(actual, operator, expected, message) \
+ do { \
+ long long l_ts_lhs = (actual); \
+ long long l_ts_rhs = (expected); \
+ if (l_ts_lhs operator l_ts_rhs) { \
+ TS_SUCCESS("%s ("#actual" "#operator" "#expected")\n\tActual : %lld\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else { \
+ TS_FAILURE("%s ("#actual" "#operator" "#expected")\n\tActual : %lld\n\tExpected: %lld\n", message ? message : "Assert", l_ts_lhs, l_ts_rhs); \
+ } \
+ } while(0)
+
+#define TS_ASSERT_SIGNED_EQ(actual, expected) \
+ TS_ASSERT_SIGNED_OP_MESSAGE(actual, ==, expected, NULL)
+
+#define TS_ASSERT_SIGNED_GE(actual, expected) \
+ TS_ASSERT_SIGNED_OP_MESSAGE(actual, >=, expected, NULL)
+
+
+/*
+ * Testing of chars
+ */
+
+#define TS_ASSERT_CHAR_OP_MESSAGE(actual, operator, expected, message) \
+ do { \
+ char l_ts_lhs = (actual); \
+ char l_ts_rhs = (expected); \
+ if (l_ts_lhs operator l_ts_rhs) { \
+ TS_SUCCESS("%s ("#actual" "#operator" "#expected")\n\tActual : %c\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else { \
+ TS_FAILURE("%s ("#actual" "#operator" "#expected")\n\tActual : %c\n\tExpected: %c\n", message ? message : "Assert", l_ts_lhs, l_ts_rhs); \
+ } \
+ } while(0)
+
+#define TS_ASSERT_CHAR_EQ_MESSAGE(actual, expected, message) \
+ TS_ASSERT_CHAR_OP_MESSAGE(actual, ==, expected, message)
+
+#define TS_ASSERT_CHAR_EQ(actual, expected) \
+ TS_ASSERT_CHAR_EQ_MESSAGE(actual, ==, expected, NULL)
+
+
+/*
+ * Testing of strings
+ */
+
+#define TS_ASSERT_STRING_EQ(actual, expected, message) \
+ do { \
+ const char *l_ts_lhs = (actual); \
+ const char *l_ts_rhs = (expected); \
+ if (l_ts_lhs == NULL && l_ts_rhs != NULL) { \
+ TS_FAILURE("%s ("#actual" == "#expected")\n\tActual : NULL\n\tExpected: %p\n", message ? message : "Assert", l_ts_rhs); \
+ } \
+ else if (l_ts_lhs != NULL && l_ts_rhs == NULL) { \
+ TS_FAILURE("%s ("#actual" == "#expected")\n\tActual : %s\n\tExpected: NULL\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else if ((l_ts_rhs == NULL && l_ts_rhs == NULL)) { \
+ TS_SUCCESS("%s ("#actual" == "#expected")\n\tActual : NULL\n", message ? message : "Assert"); \
+ } \
+ else if (strcmp(l_ts_lhs, l_ts_rhs) == 0) { \
+ TS_SUCCESS("%s ("#actual" == "#expected")\n\tActual : %s\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else { \
+ TS_FAILURE("%s ("#actual" == "#expected")\n\tActual : %s\n\tExpected: %s\n", message ? message : "Assert", l_ts_lhs, l_ts_rhs); \
+ } \
+ } while(0)
+
+#define TS_ASSERT_STRING_BEGINS_WITH(actual, prefix, message) \
+ do { \
+ const char *l_ts_lhs = (actual); \
+ const char *l_ts_rhs = (prefix); \
+ if (l_ts_lhs == NULL && l_ts_rhs != NULL) { \
+ TS_FAILURE("%s ("#actual" begins with "#prefix")\n\tActual : NULL\n\tExpected: %p\n", message ? message : "Assert", l_ts_rhs); \
+ } \
+ else if (l_ts_lhs != NULL && l_ts_rhs == NULL) { \
+ TS_FAILURE("%s ("#actual" begins with "#prefix")\n\tActual : %s\n\tExpected: NULL\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else if ((l_ts_rhs == NULL && l_ts_rhs == NULL)) { \
+ TS_SUCCESS("%s ("#actual" begins with "#prefix")\n\tActual : NULL\n", message ? message : "Assert"); \
+ } \
+ else if (strncmp(l_ts_lhs, l_ts_rhs, strlen(l_ts_rhs)) == 0) { \
+ TS_SUCCESS("%s ("#actual" begins with "#prefix")\n\tActual : %s\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else { \
+ TS_FAILURE("%s ("#actual" begins with "#prefix")\n\tActual : %s\n\tExpected: %s\n", message ? message : "Assert", l_ts_lhs, l_ts_rhs); \
+ } \
+ } while(0)
+
+#define TS_ASSERT_STRING_NULL_OR_EMPTY(actual, message) \
+ do { \
+ const char *l_ts_lhs = (actual); \
+ if (l_ts_lhs != NULL && l_ts_lhs[0] != '\0') { \
+ TS_FAILURE("%s ("#actual" is NULL or empty)\n\tActual : %s\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else if ((l_ts_lhs != NULL && l_ts_lhs[0] == '\0')) { \
+ TS_SUCCESS("%s ("#actual" is NULL or empty)\n\tActual : is empty\n", message ? message : "Assert"); \
+ } \
+ else if (l_ts_lhs == NULL) { \
+ TS_SUCCESS("%s ("#actual" is NULL or empty)\n\tActual : is NULL\n", message ? message : "Assert"); \
+ } \
+ else { \
+ TS_PRINTF("%s", "Invalid conditions in TS_ASSERT_STRING_NULL_OR_EMPTY"); \
+ abort(); \
+ } \
+ } while(0)
+
+/*
+ * Testing of pointers
+ */
+
+#define TS_ASSERT_PTR_OP_MESSAGE(actual, operator, expected, message) \
+ do { \
+ const void *l_ts_lhs = (actual); \
+ const void *l_ts_rhs = (expected); \
+ if (l_ts_lhs operator l_ts_rhs) { \
+ TS_SUCCESS("%s ("#actual" "#operator" "#expected")\n\tActual : %p\n", message ? message : "Assert", l_ts_lhs); \
+ } \
+ else { \
+ TS_FAILURE("%s ("#actual" "#operator" "#expected")\n\tActual : %p\n\tExpected: %p\n", message ? message : "Assert", l_ts_lhs, l_ts_rhs); \
+ } \
+ } while(0)
+
+
+#define TS_ASSERT_PTR_IS_NULL_MESSAGE(actual, message) \
+ TS_ASSERT_PTR_OP_MESSAGE(actual, ==, NULL, message);
+
+#define TS_ASSERT_PTR_IS_NULL(actual) \
+ TS_ASSERT_PTR_IS_NULL_MESSAGE(actual, NULL);
+
+
+#define TS_ASSERT_PTR_IS_NOT_NULL_MESSAGE(actual, message) \
+ TS_ASSERT_PTR_OP_MESSAGE(actual, !=, NULL, message);
+
+#define TS_ASSERT_PTR_IS_NOT_NULL(actual) \
+ TS_ASSERT_PTR_IS_NOT_NULL_MESSAGE(actual, NULL);
+
+
+#define TS_ASSERT_PTR_EQ(actual, expected) \
+ TS_ASSERT_PTR_OP_MESSAGE(actual, ==, expected, NULL);
+
+
+#endif/*LIBREPORT_TESTSUITE_H*/
diff --git a/tests/helpers/testsuite_tools.h b/tests/helpers/testsuite_tools.h
new file mode 100644
index 0000000..ed3a557
--- /dev/null
+++ b/tests/helpers/testsuite_tools.h
@@ -0,0 +1,67 @@
+/*
+ Copyright (C) 2015 ABRT team <crash-catcher@lists.fedorahosted.org>
+ Copyright (C) 2015 RedHat inc.
+
+ 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
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ 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.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ ----
+
+ Helper functions
+*/
+
+#include "testsuite.h"
+
+/* Creates a new dump directory in a new temporary directory
+ */
+static struct dump_dir *testsuite_dump_dir_create(uid_t uid, mode_t mode, int ts_flags)
+{
+ char dump_dir_name[] = "/tmp/XXXXXX/dump_dir";
+
+ char *last_slash = strrchr(dump_dir_name, '/');
+ *last_slash = '\0';
+
+ if (mkdtemp(dump_dir_name) == NULL) {
+ perror("mkdtemp()");
+ abort();
+ }
+
+ fprintf(stdout, "Test temp directory: %s\n", dump_dir_name);
+ fflush(stdout);
+
+ *last_slash = '/';
+
+ struct dump_dir *dd = dd_create(dump_dir_name, uid, mode == (mode_t)-1 ? 0640 : mode);
+ assert(dd != NULL);
+
+ return dd;
+}
+
+/* Removes the dump directory in and the temporary directory
+ *
+ * See testsuite_dump_dir_create()
+ */
+static void testsuite_dump_dir_delete(struct dump_dir *dd)
+{
+ char *tmp_dir = xstrndup(dd->dd_dirname, strrchr(dd->dd_dirname, '/') - dd->dd_dirname);
+ assert(dd_delete(dd) == 0);
+
+ if(rmdir(tmp_dir) != 0)
+ {
+ perror("rmdir()");
+ abort();
+ }
+
+ free(tmp_dir);
+}
--
1.8.3.1