New NUTS test framework (NNG Unit Test Support).

This is based on testutil/acutest, but is cleaner and fixes some
short-comings. We will be adding more support for additional
common paradigms to better facilitate transport tests.

While here we added some more test cases, and fixed a possible
symbol collision in the the stats framework (due to Linux use
of a macro definition of "si_value" in a standard OS header).

Test coverage may regress slightly as we are no longer using
some of the legacy APIs.

1 files changed, 128 insertions, 139 deletions

diff --git a/src/protocol/pubsub0/xsub_test.c b/src/protocol/pubsub0/xsub_test.c
index a05b893c..19815661 100644
--- a/src/protocol/pubsub0/xsub_test.c
+++ b/src/protocol/pubsub0/xsub_test.c
@@ -7,18 +7,7 @@
 // found online at https://opensource.org/licenses/MIT.
 //
 
-#include <string.h>
-
-#include <nng/nng.h>
-#include <nng/protocol/pubsub0/pub.h>
-#include <nng/protocol/pubsub0/sub.h>
-
-#include <acutest.h>
-#include <testutil.h>
-
-#ifndef NNI_PROTO
-#define NNI_PROTO(x, y) (((x) << 4u) | (y))
-#endif
+#include <nuts.h>
 
 static void
 test_xsub_identity(void)
@@ -27,18 +16,18 @@ test_xsub_identity(void)
 	int        p;
 	char *     n;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&s));
-	TEST_NNG_PASS(nng_getopt_int(s, NNG_OPT_PROTO, &p));
-	TEST_CHECK(p == NNI_PROTO(2u, 1u)); // 33
-	TEST_NNG_PASS(nng_getopt_int(s, NNG_OPT_PEER, &p));
-	TEST_CHECK(p == NNI_PROTO(2u, 0u)); // 32
-	TEST_NNG_PASS(nng_getopt_string(s, NNG_OPT_PROTONAME, &n));
-	TEST_CHECK(strcmp(n, "sub") == 0);
+	NUTS_PASS(nng_sub0_open_raw(&s));
+	NUTS_PASS(nng_socket_get_int(s, NNG_OPT_PROTO, &p));
+	NUTS_TRUE(p == NUTS_PROTO(2u, 1u)); // 33
+	NUTS_PASS(nng_socket_get_int(s, NNG_OPT_PEER, &p));
+	NUTS_TRUE(p == NUTS_PROTO(2u, 0u)); // 32
+	NUTS_PASS(nng_socket_get_string(s, NNG_OPT_PROTONAME, &n));
+	NUTS_MATCH(n, "sub");
 	nng_strfree(n);
-	TEST_NNG_PASS(nng_getopt_string(s, NNG_OPT_PEERNAME, &n));
-	TEST_CHECK(strcmp(n, "pub") == 0);
+	NUTS_PASS(nng_socket_get_string(s, NNG_OPT_PEERNAME, &n));
+	NUTS_MATCH(n, "pub");
 	nng_strfree(n);
-	TEST_NNG_PASS(nng_close(s));
+	NUTS_CLOSE(s);
 }
 
 static void
@@ -46,9 +35,9 @@ test_xsub_cannot_send(void)
 {
 	nng_socket sub;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_FAIL(nng_send(sub, "", 0, 0), NNG_ENOTSUP);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_FAIL(nng_send(sub, "", 0, 0), NNG_ENOTSUP);
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -57,9 +46,9 @@ test_xsub_not_writeable(void)
 	int        fd;
 	nng_socket sub;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_FAIL(nng_getopt_int(sub, NNG_OPT_SENDFD, &fd), NNG_ENOTSUP);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_FAIL(nng_socket_get_int(sub, NNG_OPT_SENDFD, &fd), NNG_ENOTSUP);
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -69,33 +58,33 @@ test_xsub_poll_readable(void)
 	nng_socket pub;
 	nng_socket sub;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_pub0_open(&pub));
-	TEST_NNG_PASS(nng_setopt_ms(sub, NNG_OPT_RECVTIMEO, 1000));
-	TEST_NNG_PASS(nng_setopt_ms(pub, NNG_OPT_SENDTIMEO, 1000));
-	TEST_NNG_PASS(nng_getopt_int(sub, NNG_OPT_RECVFD, &fd));
-	TEST_CHECK(fd >= 0);
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_pub0_open(&pub));
+	NUTS_PASS(nng_socket_set_ms(sub, NNG_OPT_RECVTIMEO, 1000));
+	NUTS_PASS(nng_socket_set_ms(pub, NNG_OPT_SENDTIMEO, 1000));
+	NUTS_PASS(nng_socket_get_int(sub, NNG_OPT_RECVFD, &fd));
+	NUTS_TRUE(fd >= 0);
 
 	// Not readable if not connected!
-	TEST_CHECK(testutil_pollfd(fd) == false);
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
 
 	// Even after connect (no message yet)
-	TEST_NNG_PASS(testutil_marry(pub, sub));
-	TEST_CHECK(testutil_pollfd(fd) == false);
+	NUTS_MARRY(pub, sub);
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
 
 	// But once we send messages, it is.
 	// We have to send a request, in order to send a reply.
-	TEST_NNG_SEND_STR(pub, "abc");
-	testutil_sleep(200);
+	NUTS_SEND(pub, "abc");
+	NUTS_SLEEP(200);
 
-	TEST_CHECK(testutil_pollfd(fd) == true);
+	NUTS_TRUE(nuts_poll_fd(fd));
 
 	// and receiving makes it no longer ready
-	TEST_NNG_RECV_STR(sub, "abc");
-	TEST_CHECK(testutil_pollfd(fd) == false);
+	NUTS_RECV(sub, "abc");
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
 
-	TEST_NNG_PASS(nng_close(pub));
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_CLOSE(pub);
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -107,40 +96,40 @@ test_xsub_recv_late(void)
 	nng_aio *  aio;
 	nng_msg *  msg;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_pub0_open(&pub));
-	TEST_NNG_PASS(nng_aio_alloc(&aio, NULL, NULL));
-	TEST_NNG_PASS(nng_setopt_ms(sub, NNG_OPT_RECVTIMEO, 1000));
-	TEST_NNG_PASS(nng_setopt_ms(pub, NNG_OPT_SENDTIMEO, 1000));
-	TEST_NNG_PASS(nng_getopt_int(sub, NNG_OPT_RECVFD, &fd));
-	TEST_CHECK(fd >= 0);
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_pub0_open(&pub));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
+	NUTS_PASS(nng_socket_set_ms(sub, NNG_OPT_RECVTIMEO, 1000));
+	NUTS_PASS(nng_socket_set_ms(pub, NNG_OPT_SENDTIMEO, 1000));
+	NUTS_PASS(nng_socket_get_int(sub, NNG_OPT_RECVFD, &fd));
+	NUTS_TRUE(fd >= 0);
 
 	// Not readable if not connected!
-	TEST_CHECK(testutil_pollfd(fd) == false);
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
 
 	// Even after connect (no message yet)
-	TEST_NNG_PASS(testutil_marry(pub, sub));
-	TEST_CHECK(testutil_pollfd(fd) == false);
+	NUTS_MARRY(pub, sub);
+	NUTS_TRUE(nuts_poll_fd(fd) == false);
 
 	nng_recv_aio(sub, aio);
 
 	// But once we send messages, it is.
 	// We have to send a request, in order to send a reply.
-	TEST_NNG_SEND_STR(pub, "abc");
-	testutil_sleep(200);
+	NUTS_SEND(pub, "abc");
+	NUTS_SLEEP(200);
 
 	nng_aio_wait(aio);
-	TEST_NNG_PASS(nng_aio_result(aio));
+	NUTS_PASS(nng_aio_result(aio));
 	msg = nng_aio_get_msg(aio);
 	nng_aio_set_msg(aio, NULL);
-	TEST_CHECK(nng_msg_len(msg) == 4);
-	TEST_CHECK(strcmp(nng_msg_body(msg), "abc") == 0);
+	NUTS_TRUE(nng_msg_len(msg) == 4);
+	NUTS_TRUE(strcmp(nng_msg_body(msg), "abc") == 0);
 
 	nng_msg_free(msg);
 	nng_aio_free(aio);
 
-	TEST_NNG_PASS(nng_close(pub));
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_CLOSE(pub);
+	NUTS_CLOSE(sub);
 }
 
 void
@@ -149,9 +138,9 @@ test_xsub_no_context(void)
 	nng_socket sub;
 	nng_ctx    ctx;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_FAIL(nng_ctx_open(&ctx, sub), NNG_ENOTSUP);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_FAIL(nng_ctx_open(&ctx, sub), NNG_ENOTSUP);
+	NUTS_CLOSE(sub);
 }
 
 void
@@ -160,28 +149,28 @@ test_xsub_validate_peer(void)
 	nng_socket s1, s2;
 	nng_stat * stats;
 	nng_stat * reject;
-	char       addr[64];
+	char *     addr;
 
-	testutil_scratch_addr("inproc", sizeof(addr), addr);
+	NUTS_ADDR(addr, "inproc");
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&s1));
-	TEST_NNG_PASS(nng_sub0_open_raw(&s2));
+	NUTS_PASS(nng_sub0_open_raw(&s1));
+	NUTS_PASS(nng_sub0_open_raw(&s2));
 
-	TEST_NNG_PASS(nng_listen(s1, addr, NULL, 0));
-	TEST_NNG_PASS(nng_dial(s2, addr, NULL, NNG_FLAG_NONBLOCK));
+	NUTS_PASS(nng_listen(s1, addr, NULL, 0));
+	NUTS_PASS(nng_dial(s2, addr, NULL, NNG_FLAG_NONBLOCK));
 
-	testutil_sleep(100);
-	TEST_NNG_PASS(nng_stats_get(&stats));
+	NUTS_SLEEP(100);
+	NUTS_PASS(nng_stats_get(&stats));
 
-	TEST_CHECK(stats != NULL);
-	TEST_CHECK((reject = nng_stat_find_socket(stats, s1)) != NULL);
-	TEST_CHECK((reject = nng_stat_find(reject, "reject")) != NULL);
+	NUTS_TRUE(stats != NULL);
+	NUTS_TRUE((reject = nng_stat_find_socket(stats, s1)) != NULL);
+	NUTS_TRUE((reject = nng_stat_find(reject, "reject")) != NULL);
 
-	TEST_CHECK(nng_stat_type(reject) == NNG_STAT_COUNTER);
-	TEST_CHECK(nng_stat_value(reject) > 0);
+	NUTS_TRUE(nng_stat_type(reject) == NNG_STAT_COUNTER);
+	NUTS_TRUE(nng_stat_value(reject) > 0);
 
-	TEST_NNG_PASS(nng_close(s1));
-	TEST_NNG_PASS(nng_close(s2));
+	NUTS_CLOSE(s1);
+	NUTS_CLOSE(s2);
 	nng_stats_free(stats);
 }
 
@@ -190,12 +179,12 @@ test_xsub_recv_closed(void)
 {
 	nng_socket sub;
 	nng_aio *  aio;
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_aio_alloc(&aio, NULL, NULL));
-	nng_close(sub);
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
+	NUTS_CLOSE(sub);
 	nng_recv_aio(sub, aio);
 	nng_aio_wait(aio);
-	TEST_NNG_FAIL(nng_aio_result(aio), NNG_ECLOSED);
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECLOSED);
 	nng_aio_free(aio);
 }
 
@@ -205,13 +194,13 @@ test_xsub_close_recv(void)
 	nng_socket sub;
 	nng_aio *  aio;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_aio_alloc(&aio, NULL, NULL));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
 	nng_aio_set_timeout(aio, 1000);
 	nng_recv_aio(sub, aio);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_CLOSE(sub);
 	nng_aio_wait(aio);
-	TEST_NNG_FAIL(nng_aio_result(aio), NNG_ECLOSED);
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECLOSED);
 
 	nng_aio_free(aio);
 }
@@ -222,15 +211,15 @@ test_xsub_recv_nonblock(void)
 	nng_socket sub;
 	nng_aio *  aio;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_aio_alloc(&aio, NULL, NULL));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
 
 	nng_aio_set_timeout(aio, 0); // Instant timeout
 	nng_recv_aio(sub, aio);
 
 	nng_aio_wait(aio);
-	TEST_NNG_FAIL(nng_aio_result(aio), NNG_ETIMEDOUT);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_FAIL(nng_aio_result(aio), NNG_ETIMEDOUT);
+	NUTS_CLOSE(sub);
 	nng_aio_free(aio);
 }
 
@@ -243,27 +232,27 @@ test_xsub_recv_buf_option(void)
 	size_t      sz;
 	const char *opt = NNG_OPT_RECVBUF;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
 
-	TEST_NNG_PASS(nng_setopt_int(sub, opt, 1));
-	TEST_NNG_FAIL(nng_setopt_int(sub, opt, -1), NNG_EINVAL);
-	TEST_NNG_FAIL(nng_setopt_int(sub, opt, 1000000), NNG_EINVAL);
-	TEST_NNG_PASS(nng_setopt_int(sub, opt, 3));
-	TEST_NNG_PASS(nng_getopt_int(sub, opt, &v));
-	TEST_CHECK(v == 3);
+	NUTS_PASS(nng_socket_set_int(sub, opt, 1));
+	NUTS_FAIL(nng_socket_set_int(sub, opt, -1), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_int(sub, opt, 1000000), NNG_EINVAL);
+	NUTS_PASS(nng_socket_set_int(sub, opt, 3));
+	NUTS_PASS(nng_socket_get_int(sub, opt, &v));
+	NUTS_TRUE(v == 3);
 	v  = 0;
 	sz = sizeof(v);
-	TEST_NNG_PASS(nng_getopt(sub, opt, &v, &sz));
-	TEST_CHECK(v == 3);
-	TEST_CHECK(sz == sizeof(v));
+	NUTS_PASS(nng_socket_get(sub, opt, &v, &sz));
+	NUTS_TRUE(v == 3);
+	NUTS_TRUE(sz == sizeof(v));
 
-	TEST_NNG_FAIL(nng_setopt(sub, opt, "", 1), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set(sub, opt, "", 1), NNG_EINVAL);
 	sz = 1;
-	TEST_NNG_FAIL(nng_getopt(sub, opt, &v, &sz), NNG_EINVAL);
-	TEST_NNG_FAIL(nng_setopt_bool(sub, opt, true), NNG_EBADTYPE);
-	TEST_NNG_FAIL(nng_getopt_bool(sub, opt, &b), NNG_EBADTYPE);
+	NUTS_FAIL(nng_socket_get(sub, opt, &v, &sz), NNG_EINVAL);
+	NUTS_FAIL(nng_socket_set_bool(sub, opt, true), NNG_EBADTYPE);
+	NUTS_FAIL(nng_socket_get_bool(sub, opt, &b), NNG_EBADTYPE);
 
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -272,9 +261,9 @@ test_xsub_subscribe_option(void)
 	nng_socket  sub;
 	const char *opt = NNG_OPT_SUB_SUBSCRIBE;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_FAIL(nng_setopt(sub, opt, "abc", 3), NNG_ENOTSUP);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_FAIL(nng_socket_set(sub, opt, "abc", 3), NNG_ENOTSUP);
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -283,9 +272,9 @@ test_xsub_unsubscribe_option(void)
 	nng_socket  sub;
 	const char *opt = NNG_OPT_SUB_UNSUBSCRIBE;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_FAIL(nng_setopt(sub, opt, "abc", 3), NNG_ENOTSUP);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_FAIL(nng_socket_set(sub, opt, "abc", 3), NNG_ENOTSUP);
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -294,10 +283,10 @@ test_xsub_raw(void)
 	nng_socket s;
 	bool       b;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&s));
-	TEST_NNG_PASS(nng_getopt_bool(s, NNG_OPT_RAW, &b));
-	TEST_CHECK(b);
-	TEST_NNG_PASS(nng_close(s));
+	NUTS_PASS(nng_sub0_open_raw(&s));
+	NUTS_PASS(nng_socket_get_bool(s, NNG_OPT_RAW, &b));
+	NUTS_TRUE(b);
+	NUTS_CLOSE(s);
 }
 
 static void
@@ -306,20 +295,20 @@ test_xsub_close_during_recv(void)
 	nng_socket sub;
 	nng_socket pub;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_pub0_open(&pub));
-	TEST_NNG_PASS(nng_setopt_ms(sub, NNG_OPT_RECVTIMEO, 1000));
-	TEST_NNG_PASS(nng_setopt_ms(pub, NNG_OPT_SENDTIMEO, 100));
-	TEST_NNG_PASS(nng_setopt_int(sub, NNG_OPT_RECVBUF, 5));
-	TEST_NNG_PASS(nng_setopt_int(pub, NNG_OPT_SENDBUF, 20));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_pub0_open(&pub));
+	NUTS_PASS(nng_socket_set_ms(sub, NNG_OPT_RECVTIMEO, 1000));
+	NUTS_PASS(nng_socket_set_ms(pub, NNG_OPT_SENDTIMEO, 100));
+	NUTS_PASS(nng_socket_set_int(sub, NNG_OPT_RECVBUF, 5));
+	NUTS_PASS(nng_socket_set_int(pub, NNG_OPT_SENDBUF, 20));
 
-	TEST_NNG_PASS(testutil_marry(pub, sub));
+	NUTS_MARRY(pub, sub);
 
 	for (unsigned i = 0; i < 100; i++) {
-		TEST_NNG_PASS(nng_send(pub, "abc", 3, 0));
+		NUTS_PASS(nng_send(pub, "abc", 3, 0));
 	}
-	TEST_NNG_PASS(nng_close(pub));
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_CLOSE(pub);
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -328,14 +317,14 @@ test_xsub_close_during_pipe_recv(void)
 	nng_socket sub;
 	nng_socket pub;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_pub0_open(&pub));
-	TEST_NNG_PASS(nng_setopt_ms(sub, NNG_OPT_RECVTIMEO, 1000));
-	TEST_NNG_PASS(nng_setopt_ms(pub, NNG_OPT_SENDTIMEO, 100));
-	TEST_NNG_PASS(nng_setopt_int(sub, NNG_OPT_RECVBUF, 5));
-	TEST_NNG_PASS(nng_setopt_int(pub, NNG_OPT_SENDBUF, 20));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_pub0_open(&pub));
+	NUTS_PASS(nng_socket_set_ms(sub, NNG_OPT_RECVTIMEO, 1000));
+	NUTS_PASS(nng_socket_set_ms(pub, NNG_OPT_SENDTIMEO, 100));
+	NUTS_PASS(nng_socket_set_int(sub, NNG_OPT_RECVBUF, 5));
+	NUTS_PASS(nng_socket_set_int(pub, NNG_OPT_SENDBUF, 20));
 
-	TEST_NNG_PASS(testutil_marry(pub, sub));
+	NUTS_MARRY(pub, sub);
 
 	for (unsigned i = 0; i < 100; i++) {
 		int rv;
@@ -343,9 +332,9 @@ test_xsub_close_during_pipe_recv(void)
 		if (rv == NNG_ETIMEDOUT) {
 			break;
 		}
-		testutil_sleep(1);
+		NUTS_SLEEP(1);
 	}
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_CLOSE(sub);
 }
 
 static void
@@ -354,14 +343,14 @@ test_xsub_recv_aio_stopped(void)
 	nng_socket sub;
 	nng_aio *  aio;
 
-	TEST_NNG_PASS(nng_sub0_open_raw(&sub));
-	TEST_NNG_PASS(nng_aio_alloc(&aio, NULL, NULL));
+	NUTS_PASS(nng_sub0_open_raw(&sub));
+	NUTS_PASS(nng_aio_alloc(&aio, NULL, NULL));
 
 	nng_aio_stop(aio);
 	nng_recv_aio(sub, aio);
 	nng_aio_wait(aio);
-	TEST_NNG_FAIL(nng_aio_result(aio), NNG_ECANCELED);
-	TEST_NNG_PASS(nng_close(sub));
+	NUTS_FAIL(nng_aio_result(aio), NNG_ECANCELED);
+	NUTS_CLOSE(sub);
 	nng_aio_free(aio);
 }