Problem: extensive duplication between test_use_fd_tcp and test_use_fd_ipc

Solution: merge into a single test_use_fd and reduce code duplication by extracting common functions

Makefile.am

@@ -764,8 +764,7 @@ test_apps += \
 	tests/test_pair_ipc \
 	tests/test_rebind_ipc \
 	tests/test_reqrep_ipc \
-	tests/test_use_fd_ipc \
-	tests/test_use_fd_tcp \
+	tests/test_use_fd \
 	tests/test_zmq_poll_fd \
 	tests/test_timeo \
 	tests/test_filter_ipc
@@ -796,15 +795,10 @@ tests_test_filter_ipc_SOURCES = tests/test_filter_ipc.cpp
 tests_test_filter_ipc_LDADD = src/libzmq.la ${UNITY_LIBS}
 tests_test_filter_ipc_CPPFLAGS = ${UNITY_CPPFLAGS}
 
-tests_test_use_fd_ipc_SOURCES = \
-	tests/test_use_fd_ipc.cpp \
+tests_test_use_fd_SOURCES = \
+	tests/test_use_fd.cpp \
 	tests/testutil.hpp
-tests_test_use_fd_ipc_LDADD = src/libzmq.la
-
-tests_test_use_fd_tcp_SOURCES = \
-	tests/test_use_fd_tcp.cpp \
-	tests/testutil.hpp
-tests_test_use_fd_tcp_LDADD = src/libzmq.la
+tests_test_use_fd_LDADD = src/libzmq.la
 
 tests_test_zmq_poll_fd_SOURCES = tests/test_zmq_poll_fd.cpp
 tests_test_zmq_poll_fd_LDADD = src/libzmq.la

tests/CMakeLists.txt

@@ -90,8 +90,7 @@ if(NOT WIN32)
           test_filter_ipc
           test_stream_exceeds_buffer
           test_router_mandatory_hwm
-          test_use_fd_ipc
-          test_use_fd_tcp
+          test_use_fd
           test_zmq_poll_fd
   )
   if(HAVE_FORK)

tests/test_use_fd_tcp.cpp → tests/test_use_fd.cpp

@@ -30,32 +30,27 @@
 #include "testutil.hpp"
 
 #if !defined(ZMQ_HAVE_WINDOWS)
+#include <sys/socket.h>
+#include <sys/un.h>
 #include <netdb.h>
 
-uint16_t
-pre_allocate_sock (void *zmq_socket_, const char *address_, const char *port_)
+int setup_socket_and_set_fd (void *zmq_socket_,
+                             int af_,
+                             int protocol_,
+                             const sockaddr *addr_,
+                             size_t addr_len_)
 {
-    struct addrinfo *addr, hint;
-    hint.ai_flags = 0;
-    hint.ai_family = AF_INET;
-    hint.ai_socktype = SOCK_STREAM;
-    hint.ai_protocol = IPPROTO_TCP;
-    hint.ai_addrlen = 0;
-    hint.ai_canonname = NULL;
-    hint.ai_addr = NULL;
-    hint.ai_next = NULL;
-
-    int rc = getaddrinfo (address_, port_, &hint, &addr);
-    assert (rc == 0);
-
-    int s_pre = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
+    int s_pre = socket (af_, SOCK_STREAM, protocol_);
     assert (s_pre != -1);
 
+    if (af_ == AF_INET) {
         int flag = 1;
-    rc = setsockopt (s_pre, SOL_SOCKET, SO_REUSEADDR, &flag, sizeof (int));
+        int rc =
+          setsockopt (s_pre, SOL_SOCKET, SO_REUSEADDR, &flag, sizeof (int));
         assert (rc == 0);
+    }
 
-    rc = bind (s_pre, addr->ai_addr, addr->ai_addrlen);
+    int rc = bind (s_pre, addr_, addr_len_);
     assert (rc == 0);
 
     rc = listen (s_pre, SOMAXCONN);
@@ -64,71 +59,47 @@ pre_allocate_sock (void *zmq_socket_, const char *address_, const char *port_)
     rc = zmq_setsockopt (zmq_socket_, ZMQ_USE_FD, &s_pre, sizeof (s_pre));
     assert (rc == 0);
 
-    struct sockaddr_in sin;
-    socklen_t len = sizeof (sin);
-    rc = getsockname (s_pre, (struct sockaddr *) &sin, &len);
-    assert (rc != -1);
-
-    freeaddrinfo (addr);
-
-    return ntohs (sin.sin_port);
+    return s_pre;
 }
 
-void test_req_rep ()
-{
-    char my_endpoint[MAX_SOCKET_STRING];
-    void *ctx = zmq_ctx_new ();
-    assert (ctx);
-
-    void *sb = zmq_socket (ctx, ZMQ_REP);
-    assert (sb);
-
-    uint16_t port = pre_allocate_sock (sb, "127.0.0.1", "0");
-    sprintf (my_endpoint, "tcp://127.0.0.1:%u", port);
-
-    int rc = zmq_bind (sb, my_endpoint);
-    assert (rc == 0);
-
-    void *sc = zmq_socket (ctx, ZMQ_REQ);
-    assert (sc);
-    rc = zmq_connect (sc, my_endpoint);
-    assert (rc == 0);
+typedef void (*pre_allocate_sock_fun_t) (void *, char *);
 
-    bounce (sb, sc);
+void setup_socket_pair (void *ctx_,
+                        pre_allocate_sock_fun_t pre_allocate_sock_fun_,
+                        int bind_socket_type_,
+                        int connect_socket_type_,
+                        void **out_sb_,
+                        void **out_sc_)
+{
+    *out_sb_ = zmq_socket (ctx_, bind_socket_type_);
+    assert (out_sb_);
 
-    rc = zmq_close (sc);
-    assert (rc == 0);
+    char my_endpoint[MAX_SOCKET_STRING];
+    pre_allocate_sock_fun_ (out_sb_, my_endpoint);
 
-    rc = zmq_close (sb);
+    int rc = zmq_bind (out_sb_, my_endpoint);
     assert (rc == 0);
 
-    rc = zmq_ctx_term (ctx);
+    *out_sc_ = zmq_socket (ctx_, connect_socket_type_);
+    assert (out_sc_);
+    rc = zmq_connect (out_sc_, my_endpoint);
     assert (rc == 0);
 }
 
-void test_pair ()
+void test_socket_pair (pre_allocate_sock_fun_t pre_allocate_sock_fun_,
+                       int bind_socket_type_,
+                       int connect_socket_type_)
 {
-    char my_endpoint[MAX_SOCKET_STRING];
     void *ctx = zmq_ctx_new ();
     assert (ctx);
 
-    void *sb = zmq_socket (ctx, ZMQ_PAIR);
-    assert (sb);
-
-    uint16_t port = pre_allocate_sock (sb, "127.0.0.1", "0");
-    sprintf (my_endpoint, "tcp://127.0.0.1:%u", port);
-
-    int rc = zmq_bind (sb, my_endpoint);
-    assert (rc == 0);
-
-    void *sc = zmq_socket (ctx, ZMQ_PAIR);
-    assert (sc);
-    rc = zmq_connect (sc, my_endpoint);
-    assert (rc == 0);
+    void *sb, *sc;
+    setup_socket_pair (ctx, pre_allocate_sock_fun_, bind_socket_type_,
+                       connect_socket_type_, &sb, &sc);
 
     bounce (sb, sc);
 
-    rc = zmq_close (sc);
+    int rc = zmq_close (sc);
     assert (rc == 0);
 
     rc = zmq_close (sb);
@@ -138,29 +109,28 @@ void test_pair ()
     assert (rc == 0);
 }
 
-void test_client_server ()
+void test_req_rep (pre_allocate_sock_fun_t pre_allocate_sock_fun_)
+{
+    test_socket_pair (pre_allocate_sock_fun_, ZMQ_REP, ZMQ_REQ);
+}
+
+void test_pair (pre_allocate_sock_fun_t pre_allocate_sock_fun_)
+{
+    test_socket_pair (pre_allocate_sock_fun_, ZMQ_PAIR, ZMQ_PAIR);
+}
+
+void test_client_server (pre_allocate_sock_fun_t pre_allocate_sock_fun_)
 {
 #if defined(ZMQ_SERVER) && defined(ZMQ_CLIENT)
-    char my_endpoint[MAX_SOCKET_STRING];
     void *ctx = zmq_ctx_new ();
     assert (ctx);
 
-    void *sb = zmq_socket (ctx, ZMQ_SERVER);
-    assert (sb);
-
-    uint16_t port = pre_allocate_sock (sb, "127.0.0.1", "0");
-    sprintf (my_endpoint, "tcp://127.0.0.1:%u", port);
-
-    int rc = zmq_bind (sb, my_endpoint);
-    assert (rc == 0);
-
-    void *sc = zmq_socket (ctx, ZMQ_CLIENT);
-    assert (sc);
-    rc = zmq_connect (sc, my_endpoint);
-    assert (rc == 0);
+    void *sb, *sc;
+    setup_socket_pair (ctx, pre_allocate_sock_fun_, ZMQ_SERVER, ZMQ_CLIENT, &sb,
+                       &sc);
 
     zmq_msg_t msg;
-    rc = zmq_msg_init_size (&msg, 1);
+    int rc = zmq_msg_init_size (&msg, 1);
     assert (rc == 0);
 
     char *data = (char *) zmq_msg_data (&msg);
@@ -219,18 +189,120 @@ void test_client_server ()
 #endif
 }
 
-int main (void)
+uint16_t pre_allocate_sock_tcp_int (void *zmq_socket_,
+                                    const char *address_,
+                                    const char *port_)
+{
+    struct addrinfo *addr, hint;
+    hint.ai_flags = 0;
+    hint.ai_family = AF_INET;
+    hint.ai_socktype = SOCK_STREAM;
+    hint.ai_protocol = IPPROTO_TCP;
+    hint.ai_addrlen = 0;
+    hint.ai_canonname = NULL;
+    hint.ai_addr = NULL;
+    hint.ai_next = NULL;
+
+    int rc = getaddrinfo (address_, port_, &hint, &addr);
+    assert (rc == 0);
+
+    const int s_pre = setup_socket_and_set_fd (
+      zmq_socket_, AF_INET, IPPROTO_TCP, addr->ai_addr, addr->ai_addrlen);
+
+    struct sockaddr_in sin;
+    socklen_t len = sizeof (sin);
+    rc = getsockname (s_pre, (struct sockaddr *) &sin, &len);
+    assert (rc != -1);
+
+    freeaddrinfo (addr);
+
+    return ntohs (sin.sin_port);
+}
+
+void pre_allocate_sock_tcp (void *socket_, char *my_endpoint_)
+{
+    const uint16_t port = pre_allocate_sock_tcp_int (socket_, "127.0.0.1", "0");
+    sprintf (my_endpoint_, "tcp://127.0.0.1:%u", port);
+}
+
+void test_req_rep_tcp ()
+{
+    test_req_rep (pre_allocate_sock_tcp);
+}
+
+void test_pair_tcp ()
+{
+    test_pair (pre_allocate_sock_tcp);
+}
+
+void test_client_server_tcp ()
+{
+#if defined(ZMQ_SERVER) && defined(ZMQ_CLIENT)
+    test_client_server (pre_allocate_sock_tcp);
+#endif
+}
+
+void pre_allocate_sock_ipc_int (void *zmq_socket_, const char *path_)
+{
+    struct sockaddr_un addr;
+    addr.sun_family = AF_UNIX;
+    strcpy (addr.sun_path, path_);
+
+    // TODO check return value of unlink
+    unlink (path_);
+
+    setup_socket_and_set_fd (zmq_socket_, AF_UNIX, 0, (struct sockaddr *) &addr,
+                             sizeof (struct sockaddr_un));
+}
+
+void pre_allocate_sock_ipc (void *sb_, char *my_endpoint_)
+{
+    pre_allocate_sock_ipc_int (sb_, "/tmp/test_use_fd_ipc");
+    strcpy (my_endpoint_, "ipc:///tmp/test_use_fd_ipc");
+}
+
+void test_req_rep_ipc ()
+{
+    test_req_rep (pre_allocate_sock_ipc);
+
+    int rc = unlink ("/tmp/test_use_fd_ipc");
+    assert (rc == 0);
+}
+
+void test_pair_ipc ()
+{
+    test_pair (pre_allocate_sock_ipc);
+
+    int rc = unlink ("/tmp/test_use_fd_ipc");
+    assert (rc == 0);
+}
+
+void test_client_server_ipc ()
+{
+#if defined(ZMQ_SERVER) && defined(ZMQ_CLIENT)
+    test_client_server (pre_allocate_sock_ipc);
+
+    int rc = unlink ("/tmp/test_use_fd_ipc");
+    assert (rc == 0);
+#endif
+}
+
+int main ()
 {
     setup_test_environment ();
 
-    test_req_rep ();
-    test_pair ();
-    test_client_server ();
+    test_req_rep_tcp ();
+    test_pair_tcp ();
+    test_client_server_tcp ();
+
+    test_req_rep_ipc ();
+    test_pair_ipc ();
+    test_client_server_ipc ();
 
     return 0;
 }
 #else
-int main (void)
+int main ()
 {
     return 0;
 }

tests/test_use_fd_ipc.cpp

-/*
-    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
-
-    This file is part of libzmq, the ZeroMQ core engine in C++.
-
-    libzmq is free software; you can redistribute it and/or modify it under
-    the terms of the GNU Lesser General Public License (LGPL) as published
-    by the Free Software Foundation; either version 3 of the License, or
-    (at your option) any later version.
-
-    As a special exception, the Contributors give you permission to link
-    this library with independent modules to produce an executable,
-    regardless of the license terms of these independent modules, and to
-    copy and distribute the resulting executable under terms of your choice,
-    provided that you also meet, for each linked independent module, the
-    terms and conditions of the license of that module. An independent
-    module is a module which is not derived from or based on this library.
-    If you modify this library, you must extend this exception to your
-    version of the library.
-
-    libzmq 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 Lesser General Public
-    License for more details.
-
-    You should have received a copy of the GNU Lesser General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-#include "testutil.hpp"
-
-#if !defined(ZMQ_HAVE_WINDOWS)
-#include <sys/socket.h>
-#include <sys/un.h>
-
-void pre_allocate_sock (void *zmq_socket_, const char *path_)
-{
-    struct sockaddr_un addr;
-    addr.sun_family = AF_UNIX;
-    strcpy (addr.sun_path, path_);
-
-    unlink (path_);
-
-    int s_pre = socket (AF_UNIX, SOCK_STREAM, 0);
-    assert (s_pre != -1);
-
-    int rc =
-      bind (s_pre, (struct sockaddr *) &addr, sizeof (struct sockaddr_un));
-    assert (rc == 0);
-
-    rc = listen (s_pre, SOMAXCONN);
-    assert (rc == 0);
-
-    rc = zmq_setsockopt (zmq_socket_, ZMQ_USE_FD, &s_pre, sizeof (s_pre));
-    assert (rc == 0);
-}
-
-void test_req_rep ()
-{
-    void *ctx = zmq_ctx_new ();
-    assert (ctx);
-
-    void *sb = zmq_socket (ctx, ZMQ_REP);
-    assert (sb);
-
-    pre_allocate_sock (sb, "/tmp/test_use_fd_ipc");
-
-    int rc = zmq_bind (sb, "ipc:///tmp/test_use_fd_ipc");
-    assert (rc == 0);
-
-    void *sc = zmq_socket (ctx, ZMQ_REQ);
-    assert (sc);
-    rc = zmq_connect (sc, "ipc:///tmp/test_use_fd_ipc");
-    assert (rc == 0);
-
-    bounce (sb, sc);
-
-    rc = zmq_close (sc);
-    assert (rc == 0);
-
-    rc = zmq_close (sb);
-    assert (rc == 0);
-
-    rc = zmq_ctx_term (ctx);
-    assert (rc == 0);
-
-    rc = unlink ("/tmp/test_use_fd_ipc");
-    assert (rc == 0);
-}
-
-void test_pair ()
-{
-    void *ctx = zmq_ctx_new ();
-    assert (ctx);
-
-    void *sb = zmq_socket (ctx, ZMQ_PAIR);
-    assert (sb);
-
-    pre_allocate_sock (sb, "/tmp/test_use_fd_ipc");
-
-    int rc = zmq_bind (sb, "ipc:///tmp/test_use_fd_ipc");
-    assert (rc == 0);
-
-    void *sc = zmq_socket (ctx, ZMQ_PAIR);
-    assert (sc);
-    rc = zmq_connect (sc, "ipc:///tmp/test_use_fd_ipc");
-    assert (rc == 0);
-
-    bounce (sb, sc);
-
-    rc = zmq_close (sc);
-    assert (rc == 0);
-
-    rc = zmq_close (sb);
-    assert (rc == 0);
-
-    rc = zmq_ctx_term (ctx);
-    assert (rc == 0);
-
-    rc = unlink ("/tmp/test_use_fd_ipc");
-    assert (rc == 0);
-}
-
-void test_client_server ()
-{
-#if defined(ZMQ_SERVER) && defined(ZMQ_CLIENT)
-    void *ctx = zmq_ctx_new ();
-    assert (ctx);
-
-    void *sb = zmq_socket (ctx, ZMQ_SERVER);
-    assert (sb);
-
-    pre_allocate_sock (sb, "/tmp/test_use_fd_ipc");
-
-    int rc = zmq_bind (sb, "ipc:///tmp/test_use_fd_ipc");
-    assert (rc == 0);
-
-    void *sc = zmq_socket (ctx, ZMQ_CLIENT);
-    assert (sc);
-    rc = zmq_connect (sc, "ipc:///tmp/test_use_fd_ipc");
-    assert (rc == 0);
-
-    zmq_msg_t msg;
-    rc = zmq_msg_init_size (&msg, 1);
-    assert (rc == 0);
-
-    char *data = (char *) zmq_msg_data (&msg);
-    data[0] = 1;
-
-    rc = zmq_msg_send (&msg, sc, ZMQ_SNDMORE);
-    assert (rc == -1);
-
-    rc = zmq_msg_send (&msg, sc, 0);
-    assert (rc == 1);
-
-    rc = zmq_msg_init (&msg);
-    assert (rc == 0);
-
-    rc = zmq_msg_recv (&msg, sb, 0);
-    assert (rc == 1);
-
-    uint32_t routing_id = zmq_msg_routing_id (&msg);
-    assert (routing_id != 0);
-
-    rc = zmq_msg_close (&msg);
-    assert (rc == 0);
-
-    rc = zmq_msg_init_size (&msg, 1);
-    assert (rc == 0);
-
-    data = (char *) zmq_msg_data (&msg);
-    data[0] = 2;
-
-    rc = zmq_msg_set_routing_id (&msg, routing_id);
-    assert (rc == 0);
-
-    rc = zmq_msg_send (&msg, sb, ZMQ_SNDMORE);
-    assert (rc == -1);
-
-    rc = zmq_msg_send (&msg, sb, 0);
-    assert (rc == 1);
-
-    rc = zmq_msg_recv (&msg, sc, 0);
-    assert (rc == 1);
-
-    routing_id = zmq_msg_routing_id (&msg);
-    assert (routing_id == 0);
-
-    rc = zmq_msg_close (&msg);
-    assert (rc == 0);
-
-    rc = zmq_close (sc);
-    assert (rc == 0);
-
-    rc = zmq_close (sb);
-    assert (rc == 0);
-
-    rc = zmq_ctx_term (ctx);
-    assert (rc == 0);
-
-    rc = unlink ("/tmp/test_use_fd_ipc");
-    assert (rc == 0);
-#endif
-}
-
-int main (void)
-{
-    setup_test_environment ();
-
-    test_req_rep ();
-    test_pair ();
-    test_client_server ();
-
-    return 0;
-}
-
-#else
-int main (void)
-{
-    return 0;
-}
-#endif