[dpdk-dev,v4,01/11] eal: add common test assert macros

Message ID 20180108134742.30857-1-pbhagavatula@caviumnetworks.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation fail apply patch file failure

Commit Message

Pavan Nikhilesh Jan. 8, 2018, 1:47 p.m. UTC
  Adding common test assertion macros for unit testing.
Taken from test/test.h.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---
 v4 Changes:
  - add SPDX licence tags.
  - change octeontx selftest name to 'ssovf_evdev_selftest'

 v3 Changes:
  - add eventdev driver specific selftest to test/test

 v2 Changes:
  - remove duplications of test macros.
  - add selftest to test/test.
  - remove selftest devargs from sw eventdev.

 lib/librte_eal/common/Makefile           |  2 +-
 lib/librte_eal/common/include/rte_test.h | 69 ++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 lib/librte_eal/common/include/rte_test.h

--
2.15.1
  

Comments

Thomas Monjalon Jan. 10, 2018, 8:20 p.m. UTC | #1
08/01/2018 14:47, Pavan Nikhilesh:
> Adding common test assertion macros for unit testing.
> Taken from test/test.h.
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> ---
>  lib/librte_eal/common/Makefile           |  2 +-
>  lib/librte_eal/common/include/rte_test.h | 69 ++++++++++++++++++++++++++++++++
>  2 files changed, 70 insertions(+), 1 deletion(-)
>  create mode 100644 lib/librte_eal/common/include/rte_test.h

Is the original file still needed?
Can we always use rte_test.h from EAL?

> +#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__); \
> +		return -1;                                                    \
> +	}                                                                     \
> +} while (0)
> +
> +#define RTE_TEST_ASSERT_EQUAL(a, b, msg, ...) do {                            \
> +	if (!(a == b)) {                                                      \
> +		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
> +				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
> +		return -1;                                                    \
> +	}                                                                     \
> +} while (0)

Why not call RTE_TEST_ASSERT in all derived macros?
  
Pavan Nikhilesh Jan. 11, 2018, 7:11 a.m. UTC | #2
On Wed, Jan 10, 2018 at 09:20:06PM +0100, Thomas Monjalon wrote:
> 08/01/2018 14:47, Pavan Nikhilesh:
> > Adding common test assertion macros for unit testing.
> > Taken from test/test.h.
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > ---
> >  lib/librte_eal/common/Makefile           |  2 +-
> >  lib/librte_eal/common/include/rte_test.h | 69 ++++++++++++++++++++++++++++++++
> >  2 files changed, 70 insertions(+), 1 deletion(-)
> >  create mode 100644 lib/librte_eal/common/include/rte_test.h
>
> Is the original file still needed?

The original file still contains macros and structs related to unit test suite,
I think everything should be gradually ported to rte_test.h

> Can we always use rte_test.h from EAL?

I will link the test assert macros rte test assert macros and not remove them
for now as it would break other tests.

>
> > +#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__); \
> > +		return -1;                                                    \
> > +	}                                                                     \
> > +} while (0)
> > +
> > +#define RTE_TEST_ASSERT_EQUAL(a, b, msg, ...) do {                            \
> > +	if (!(a == b)) {                                                      \
> > +		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
> > +				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
> > +		return -1;                                                    \
> > +	}                                                                     \
> > +} while (0)
>
> Why not call RTE_TEST_ASSERT in all derived macros?

Agreed, that would reduce code duplication will send a v5 with the changes.
  

Patch

diff --git a/lib/librte_eal/common/Makefile b/lib/librte_eal/common/Makefile
index 9effd0d45..eba1059f2 100644
--- a/lib/librte_eal/common/Makefile
+++ b/lib/librte_eal/common/Makefile
@@ -43,7 +43,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
+INC += rte_bitmap.h rte_vfio.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
index 000000000..741dd6191
--- /dev/null
+++ b/lib/librte_eal/common/include/rte_test.h
@@ -0,0 +1,69 @@ 
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015 Cavium, Inc
+ */
+
+#ifndef _RTE_TEST_H_
+#define _RTE_TEST_H_
+
+#include <rte_log.h>
+
+#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__); \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_EQUAL(a, b, msg, ...) do {                            \
+	if (!(a == b)) {                                                      \
+		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
+				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_NOT_EQUAL(a, b, msg, ...) do {                        \
+	if (!(a != b)) {                                                      \
+		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
+				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_SUCCESS(val, msg, ...) do {                           \
+	typeof(val) _val = (val);                                             \
+	if (!(_val == 0)) {                                                   \
+		RTE_LOG(DEBUG, EAL,                                           \
+				"Test assert %s line %d failed (err %d): "    \
+				msg "\n", __func__, __LINE__, _val,           \
+				##__VA_ARGS__);                               \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_FAIL(val, msg, ...) do {                              \
+	if (!(val != 0)) {                                                    \
+		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
+				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_NULL(val, msg, ...) do {                              \
+	if (!(val == NULL)) {                                                 \
+		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
+				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#define RTE_TEST_ASSERT_NOT_NULL(val, msg, ...) do {                          \
+	if (!(val != NULL)) {                                                 \
+		RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: "         \
+				msg "\n", __func__, __LINE__, ##__VA_ARGS__); \
+		return -1;                                                    \
+	}                                                                     \
+} while (0)
+
+#endif /* _RTE_TEST_H_ */