eal: add test assert macros
authorPavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Thu, 11 Jan 2018 10:21:46 +0000 (15:51 +0530)
committerJerin Jacob <jerin.jacob@caviumnetworks.com>
Fri, 19 Jan 2018 15:09:56 +0000 (16:09 +0100)
Adding common test assertion macros for unit testing.
Replaced common macros in test/test.h with new RTE_TEST_ASSERT_* macros.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
lib/librte_eal/common/Makefile
lib/librte_eal/common/include/rte_test.h [new file with mode: 0644]
test/test/test.h

index a0eaeed..96904de 100644 (file)
@@ -15,7 +15,7 @@ INC += rte_hexdump.h rte_devargs.h rte_bus.h rte_dev.h
 INC += rte_pci_dev_feature_defs.h rte_pci_dev_features.h
 INC += rte_malloc.h rte_keepalive.h rte_time.h
 INC += rte_service.h rte_service_component.h
-INC += rte_bitmap.h rte_vfio.h rte_hypervisor.h
+INC += rte_bitmap.h rte_vfio.h rte_hypervisor.h rte_test.h
 
 GENERIC_INC := rte_atomic.h rte_byteorder.h rte_cycles.h rte_prefetch.h
 GENERIC_INC += rte_spinlock.h rte_memcpy.h rte_cpuflags.h rte_rwlock.h
diff --git a/lib/librte_eal/common/include/rte_test.h b/lib/librte_eal/common/include/rte_test.h
new file mode 100644 (file)
index 0000000..89e47f4
--- /dev/null
@@ -0,0 +1,46 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015 Cavium, Inc
+ */
+
+#ifndef _RTE_TEST_H_
+#define _RTE_TEST_H_
+
+#include <rte_log.h>
+
+/* Before including rte_test.h file you can define
+ * RTE_TEST_TRACE_FAILURE(_file, _line, _func) macro to better trace/debug test
+ * failures. Mostly useful in development phase.
+ */
+#ifndef RTE_TEST_TRACE_FAILURE
+#define RTE_TEST_TRACE_FAILURE(_file, _line, _func)
+#endif
+
+
+#define RTE_TEST_ASSERT(cond, msg, ...) do {                                  \
+       if (!(cond)) {                                                        \
+               RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
+               RTE_TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);         \
+               return -1;                                                    \
+       }                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_EQUAL(a, b, msg, ...) \
+       RTE_TEST_ASSERT(a == b, msg, ##__VA_ARGS__)
+
+#define RTE_TEST_ASSERT_NOT_EQUAL(a, b, msg, ...) \
+       RTE_TEST_ASSERT(a != b, msg, ##__VA_ARGS__)
+
+#define RTE_TEST_ASSERT_SUCCESS(val, msg, ...) \
+       RTE_TEST_ASSERT(val == 0, msg, ##__VA_ARGS__)
+
+#define RTE_TEST_ASSERT_FAIL(val, msg, ...) \
+       RTE_TEST_ASSERT(val != 0, msg, ##__VA_ARGS__)
+
+#define RTE_TEST_ASSERT_NULL(val, msg, ...) \
+       RTE_TEST_ASSERT(val == NULL, msg, ##__VA_ARGS__)
+
+#define RTE_TEST_ASSERT_NOT_NULL(val, msg, ...) \
+       RTE_TEST_ASSERT(val != NULL, msg, ##__VA_ARGS__)
+
+#endif /* _RTE_TEST_H_ */
index 4540fb8..7c24432 100644 (file)
@@ -10,7 +10,6 @@
 
 #include <rte_hexdump.h>
 #include <rte_common.h>
-#include <rte_log.h>
 
 #define TEST_SUCCESS EXIT_SUCCESS
 #define TEST_FAILED  -1
 # define TEST_TRACE_FAILURE(_file, _line, _func)
 #endif
 
-#define TEST_ASSERT(cond, msg, ...) do {                         \
-               if (!(cond)) {                                           \
-                       printf("TestCase %s() line %d failed: "              \
-                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#define RTE_TEST_TRACE_FAILURE TEST_TRACE_FAILURE
 
-#define TEST_ASSERT_EQUAL(a, b, msg, ...) do {                   \
-               if (!(a == b)) {                                         \
-                       printf("TestCase %s() line %d failed: "              \
-                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#include <rte_test.h>
+
+#define TEST_ASSERT RTE_TEST_ASSERT
+
+#define TEST_ASSERT_EQUAL RTE_TEST_ASSERT_EQUAL
 
 /* Compare two buffers (length in bytes) */
 #define TEST_ASSERT_BUFFERS_ARE_EQUAL(a, b, len,  msg, ...) do {       \
        }                                                                     \
 } while (0)
 
-#define TEST_ASSERT_NOT_EQUAL(a, b, msg, ...) do {               \
-               if (!(a != b)) {                                         \
-                       printf("TestCase %s() line %d failed: "              \
-                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#define TEST_ASSERT_NOT_EQUAL RTE_TEST_ASSERT_NOT_EQUAL
 
-#define TEST_ASSERT_SUCCESS(val, msg, ...) do {                  \
-               typeof(val) _val = (val);                                \
-               if (!(_val == 0)) {                                      \
-                       printf("TestCase %s() line %d failed (err %d): "     \
-                               msg "\n", __func__, __LINE__, _val,              \
-                               ##__VA_ARGS__);                                  \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#define TEST_ASSERT_SUCCESS RTE_TEST_ASSERT_SUCCESS
 
-#define TEST_ASSERT_FAIL(val, msg, ...) do {                     \
-               if (!(val != 0)) {                                       \
-                       printf("TestCase %s() line %d failed: "              \
-                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#define TEST_ASSERT_FAIL RTE_TEST_ASSERT_FAIL
 
-#define TEST_ASSERT_NULL(val, msg, ...) do {                     \
-               if (!(val == NULL)) {                                    \
-                       printf("TestCase %s() line %d failed: "              \
-                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#define TEST_ASSERT_NULL RTE_TEST_ASSERT_NULL
 
-#define TEST_ASSERT_NOT_NULL(val, msg, ...) do {                 \
-               if (!(val != NULL)) {                                    \
-                       printf("TestCase %s() line %d failed: "              \
-                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
-                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
-                       return TEST_FAILED;                                  \
-               }                                                        \
-} while (0)
+#define TEST_ASSERT_NOT_NULL RTE_TEST_ASSERT_NOT_NULL
 
 struct unit_test_case {
        int (*setup)(void);