MONGOC_TEST_FUTURE_TIMEOUT_MS environment variable

Prevents mock server test framework from timing
out when you are stopped at a breakpoint.

Author: ajdavis

build/future_function_templates/future.c.template

@@ -3,10 +3,18 @@
 #include "mongoc-array-private.h"
 #include "mongoc-thread-private.h"
 #include "future.h"
+#include "../test-libmongoc.h"
 
 {{ header_comment }}
 
-#define FUTURE_TIMEOUT_MS 10 * 1000
+#define DEFAULT_FUTURE_TIMEOUT_MS 10 * 1000
+
+static int64_t
+get_future_timeout_ms ()
+{
+    return test_framework_getenv_int64 ("MONGOC_TEST_FUTURE_TIMEOUT_MS",
+                                        DEFAULT_FUTURE_TIMEOUT_MS);
+}
 
 void
 future_get_void (future_t *future)
@@ -79,13 +87,14 @@ future_resolve (future_t *future, future_value_t return_value)
 bool
 future_wait (future_t *future)
 {
-   /* TODO: configurable timeout */
-   int64_t deadline = bson_get_monotonic_time () + FUTURE_TIMEOUT_MS * 1000;
+   int64_t deadline = bson_get_monotonic_time () + get_future_timeout_ms ();
    bool resolved;
 
    mongoc_mutex_lock (&future->mutex);
    while (!future->resolved && bson_get_monotonic_time () <= deadline) {
-      mongoc_cond_timedwait (&future->cond, &future->mutex, FUTURE_TIMEOUT_MS);
+      mongoc_cond_timedwait (&future->cond,
+                             &future->mutex,
+                             get_future_timeout_ms ());
    }
    resolved = future->resolved;
    mongoc_mutex_unlock (&future->mutex);

tests/mock_server/future.c

@@ -3,6 +3,7 @@
 #include "mongoc-array-private.h"
 #include "mongoc-thread-private.h"
 #include "future.h"
+#include "../test-libmongoc.h"
 
 /**************************************************
  *
@@ -12,7 +13,14 @@
  *
  *************************************************/
 
-#define FUTURE_TIMEOUT_MS 10 * 1000
+#define DEFAULT_FUTURE_TIMEOUT_MS 10 * 1000
+
+static int64_t
+get_future_timeout_ms ()
+{
+    return test_framework_getenv_int64 ("MONGOC_TEST_FUTURE_TIMEOUT_MS",
+                                        DEFAULT_FUTURE_TIMEOUT_MS);
+}
 
 void
 future_get_void (future_t *future)
@@ -316,13 +324,14 @@ future_resolve (future_t *future, future_value_t return_value)
 bool
 future_wait (future_t *future)
 {
-   /* TODO: configurable timeout */
-   int64_t deadline = bson_get_monotonic_time () + FUTURE_TIMEOUT_MS * 1000;
+   int64_t deadline = bson_get_monotonic_time () + get_future_timeout_ms ();
    bool resolved;
 
    mongoc_mutex_lock (&future->mutex);
    while (!future->resolved && bson_get_monotonic_time () <= deadline) {
-      mongoc_cond_timedwait (&future->cond, &future->mutex, FUTURE_TIMEOUT_MS);
+      mongoc_cond_timedwait (&future->cond,
+                             &future->mutex,
+                             get_future_timeout_ms ());
    }
    resolved = future->resolved;
    mongoc_mutex_unlock (&future->mutex);

tests/test-libmongoc.c

@@ -191,6 +191,45 @@ test_framework_getenv_bool (const char *name)
    return ret;
 }
 
+
+/*
+ *--------------------------------------------------------------------------
+ *
+ * test_framework_getenv_int64 --
+ *
+ *       Get a number from an environment variable.
+ *
+ * Returns:
+ *       The number, or default.
+ *
+ * Side effects:
+ *       Logs and aborts if there is a non-numeric value.
+ *
+ *--------------------------------------------------------------------------
+ */
+int64_t
+test_framework_getenv_int64 (const char *name,
+                             int64_t default_value)
+{
+   char *value = test_framework_getenv (name);
+   char *endptr;
+   int64_t ret;
+
+   if (value) {
+      errno = 0;
+      ret = bson_ascii_strtoll (value, &endptr, 10);
+      if (errno) {
+         perror (bson_strdup_printf ("Parsing %s from environment", name));
+         abort ();
+      }
+
+      bson_free (value);
+      return ret;
+   }
+
+   return default_value;
+}
+
 /*
  *--------------------------------------------------------------------------
  *

tests/test-libmongoc.h

@@ -23,6 +23,8 @@ char *gen_collection_name (const char *prefix);
 void suppress_one_message (void);
 char *test_framework_getenv (const char *name);
 bool test_framework_getenv_bool (const char *name);
+int64_t test_framework_getenv_int64 (const char *name,
+                                     int64_t default_value);
 char *test_framework_get_host (void);
 uint16_t test_framework_get_port (void);
 char *test_framework_get_admin_user (void);