Fix socket bind collisions in manager_tests

Author: pcmoritz

src/plasma/test/manager_tests.c

@@ -9,6 +9,7 @@
 #include "common.h"
 #include "event_loop.h"
 #include "io.h"
+#include "utstring.h"
 
 #include "plasma.h"
 #include "plasma_client.h"
@@ -17,9 +18,6 @@
 SUITE(plasma_manager_tests);
 
 const char *manager_addr = "127.0.0.1";
-int manager_port = 12345;
-const char *store_socket_name = "/tmp/store12345";
-const char *manager_socket_name = "/tmp/manager12345";
 object_id oid;
 
 void wait_for_pollin(int fd) {
@@ -30,6 +28,38 @@ void wait_for_pollin(int fd) {
   CHECK(retval > 0);
 }
 
+UT_string *bind_ipc_sock_retry(int *fd) {
+  UT_string *socket_name = NULL;
+  for (int num_retries = 0; num_retries < 5; ++num_retries) {
+    LOG_INFO("trying to find plasma socket (attempt %d)", num_retries);
+    utstring_renew(socket_name);
+    utstring_printf(socket_name, "/tmp/plasma_socket_%d", rand());
+    *fd = bind_ipc_sock(utstring_body(socket_name));
+    if (*fd < 0) {
+      /* Sleep for 100ms. */
+      usleep(100000);
+      continue;
+    }
+    break;
+  }
+  return socket_name;
+}
+
+int bind_inet_sock_retry(int *fd) {
+  int port = -1;
+  for (int num_retries = 0; num_retries < 5; ++num_retries) {
+    port = 10000 + rand() % 40000;
+    *fd = bind_inet_sock(port);
+    if (*fd < 0) {
+      /* Sleep for 100ms. */
+      usleep(100000);
+      continue;
+    }
+    break;
+  }
+  return port;
+}
+
 int test_done_handler(event_loop *loop, timer_id id, void *context) {
   event_loop_stop(loop);
   return AE_NOMORE;
@@ -54,20 +84,22 @@ typedef struct {
   client_connection *client_conn;
 } plasma_mock;
 
-plasma_mock *init_plasma_mock(int port, plasma_mock *remote_mock) {
+plasma_mock *init_plasma_mock(plasma_mock *remote_mock) {
   plasma_mock *mock = malloc(sizeof(plasma_mock));
   /* Start listening on all the ports and initiate the local plasma manager. */
-  mock->port = port;
-  mock->manager_remote_fd = bind_inet_sock(port);
-  mock->manager_local_fd = bind_ipc_sock(manager_socket_name);
-  mock->local_store = bind_ipc_sock(store_socket_name);
-  mock->state =
-      init_plasma_manager_state(store_socket_name, manager_addr, port, NULL, 0);
+  mock->port = bind_inet_sock_retry(&mock->manager_remote_fd);
+  UT_string *store_socket_name = bind_ipc_sock_retry(&mock->local_store);
+  UT_string *manager_socket_name = bind_ipc_sock_retry(&mock->manager_local_fd);
+
+  CHECK(mock->manager_local_fd >= 0 && mock->local_store >= 0);
+
+  mock->state = init_plasma_manager_state(utstring_body(store_socket_name),
+                                          manager_addr, mock->port, NULL, 0);
   mock->loop = get_event_loop(mock->state);
   /* Accept a connection from the local manager on the remote manager. */
   if (remote_mock != NULL) {
     mock->write_conn =
-        get_manager_connection(remote_mock->state, manager_addr, port);
+        get_manager_connection(remote_mock->state, manager_addr, mock->port);
     wait_for_pollin(mock->manager_remote_fd);
     mock->read_conn = new_client_connection(mock->loop, mock->manager_remote_fd,
                                             mock->state, 0);
@@ -77,10 +109,13 @@ plasma_mock *init_plasma_mock(int port, plasma_mock *remote_mock) {
   }
   /* Connect a new client to the local plasma manager and mock a request to an
    * object. */
-  mock->plasma_conn = plasma_connect(store_socket_name, manager_socket_name);
+  mock->plasma_conn = plasma_connect(utstring_body(store_socket_name),
+                                     utstring_body(manager_socket_name));
   wait_for_pollin(mock->manager_local_fd);
   mock->client_conn =
       new_client_connection(mock->loop, mock->manager_local_fd, mock->state, 0);
+  utstring_free(store_socket_name);
+  utstring_free(manager_socket_name);
   return mock;
 }
 
@@ -109,10 +144,13 @@ void destroy_plasma_mock(plasma_mock *mock) {
  *   correct object ID.
  */
 TEST request_transfer_test(void) {
-  plasma_mock *local_mock = init_plasma_mock(manager_port, NULL);
-  plasma_mock *remote_mock = init_plasma_mock(12346, local_mock);
+  plasma_mock *local_mock = init_plasma_mock(NULL);
+  plasma_mock *remote_mock = init_plasma_mock(local_mock);
   const char **manager_vector = malloc(sizeof(char *));
-  manager_vector[0] = "127.0.0.1:12346";
+  UT_string *addr = NULL;
+  utstring_new(addr);
+  utstring_printf(addr, "127.0.0.1:%d", remote_mock->port);
+  manager_vector[0] = utstring_body(addr);
   request_transfer(oid, 1, manager_vector, local_mock->client_conn);
   event_loop_add_timer(local_mock->loop, MANAGER_TIMEOUT, test_done_handler,
                        local_mock->state);
@@ -126,6 +164,7 @@ TEST request_transfer_test(void) {
   ASSERT(req->num_object_ids == 1);
   ASSERT(memcmp(&oid, &req->object_ids[0], sizeof(object_id)) == 0);
   /* Clean up. */
+  utstring_free(addr);
   free(req);
   destroy_plasma_mock(remote_mock);
   destroy_plasma_mock(local_mock);
@@ -145,12 +184,18 @@ TEST request_transfer_test(void) {
  *   with the correct object ID.
  */
 TEST request_transfer_retry_test(void) {
-  plasma_mock *local_mock = init_plasma_mock(manager_port, NULL);
-  plasma_mock *remote_mock1 = init_plasma_mock(12346, local_mock);
-  plasma_mock *remote_mock2 = init_plasma_mock(12347, local_mock);
+  plasma_mock *local_mock = init_plasma_mock(NULL);
+  plasma_mock *remote_mock1 = init_plasma_mock(local_mock);
+  plasma_mock *remote_mock2 = init_plasma_mock(local_mock);
   const char **manager_vector = malloc(sizeof(char *) * 2);
-  manager_vector[0] = "127.0.0.1:12346";
-  manager_vector[1] = "127.0.0.1:12347";
+  UT_string *addr0 = NULL;
+  utstring_new(addr0);
+  utstring_printf(addr0, "127.0.0.1:%d", remote_mock1->port);
+  manager_vector[0] = utstring_body(addr0);
+  UT_string *addr1 = NULL;
+  utstring_new(addr1);
+  utstring_printf(addr1, "127.0.0.1:%d", remote_mock2->port);
+  manager_vector[1] = utstring_body(addr1);
   request_transfer(oid, 2, manager_vector, local_mock->client_conn);
   event_loop_add_timer(local_mock->loop, MANAGER_TIMEOUT * 2, test_done_handler,
                        local_mock->state);
@@ -165,6 +210,8 @@ TEST request_transfer_retry_test(void) {
   ASSERT(req->num_object_ids == 1);
   ASSERT(memcmp(&oid, &req->object_ids[0], sizeof(object_id)) == 0);
   /* Clean up. */
+  utstring_free(addr0);
+  utstring_free(addr1);
   free(req);
   destroy_plasma_mock(remote_mock2);
   destroy_plasma_mock(remote_mock1);
@@ -184,10 +231,13 @@ TEST request_transfer_retry_test(void) {
  *   wasn't fetched.
  */
 TEST request_transfer_timeout_test(void) {
-  plasma_mock *local_mock = init_plasma_mock(manager_port, NULL);
-  plasma_mock *remote_mock = init_plasma_mock(12346, local_mock);
+  plasma_mock *local_mock = init_plasma_mock(NULL);
+  plasma_mock *remote_mock = init_plasma_mock(local_mock);
   const char **manager_vector = malloc(sizeof(char *));
-  manager_vector[0] = "127.0.0.1:12346";
+  UT_string *addr = NULL;
+  utstring_new(addr);
+  utstring_printf(addr, "127.0.0.1:%d", remote_mock->port);
+  manager_vector[0] = utstring_body(addr);
   request_transfer(oid, 1, manager_vector, local_mock->client_conn);
   event_loop_add_timer(local_mock->loop, MANAGER_TIMEOUT * (NUM_RETRIES + 2),
                        test_done_handler, local_mock->state);
@@ -201,6 +251,7 @@ TEST request_transfer_timeout_test(void) {
   ASSERT_EQ(memcmp(&oid, &reply.object_ids, sizeof(object_id)), 0);
   ASSERT_EQ(reply.has_object, 0);
   /* Clean up. */
+  utstring_free(addr);
   destroy_plasma_mock(remote_mock);
   destroy_plasma_mock(local_mock);
   PASS();
@@ -214,8 +265,8 @@ TEST request_transfer_timeout_test(void) {
  * - Expect to see the same data.
  */
 TEST read_write_object_chunk_test(void) {
-  plasma_mock *local_mock = init_plasma_mock(manager_port, NULL);
-  plasma_mock *remote_mock = init_plasma_mock(12346, local_mock);
+  plasma_mock *local_mock = init_plasma_mock(NULL);
+  plasma_mock *remote_mock = init_plasma_mock(local_mock);
   /* Create a mock object buffer to transfer. */
   const char *data = "Hello world!";
   const int data_size = strlen(data) + 1;