CDRIVER-1419 metadata functions now log errors

# Conflicts:
#	doc/mongoc_client_set_appname.page
#	doc/mongoc_metadata_append.page
#	tests/test-mongoc-metadata.c

Author: ian boros

src/mongoc/mongoc-client.c

@@ -1928,6 +1928,7 @@ mongoc_client_set_appname (mongoc_client_t *client,
                            const char      *appname)
 {
    if (!client->topology->single_threaded) {
+      MONGOC_ERROR ("Cannot call set_appname on a client from a pool");
       return false;
    }
 

src/mongoc/mongoc-metadata.c

@@ -287,6 +287,7 @@ mongoc_handshake_data_append (const char *driver_name,
    int max_size = 0;
 
    if (gMongocMetadata.frozen) {
+      MONGOC_ERROR ("Cannot set metadata more than once");
       return false;
    }
 

src/mongoc/mongoc-topology-scanner.c

@@ -764,11 +764,12 @@ _mongoc_topology_scanner_set_appname (mongoc_topology_scanner_t *ts,
                                       const char                *appname)
 {
    if (!_mongoc_metadata_appname_is_valid (appname)) {
+      MONGOC_ERROR ("Cannot set appname: %s is invalid", appname);
       return false;
    }
 
    if (ts->appname != NULL) {
-      /* We've already set it */
+      MONGOC_ERROR ("Cannot set appname more than once");
       return false;
    }
 

src/mongoc/mongoc-topology.c

@@ -22,6 +22,7 @@
 #endif
 
 #include "mongoc-error.h"
+#include "mongoc-log.h"
 #include "mongoc-topology-private.h"
 #include "mongoc-client-private.h"
 #include "mongoc-util-private.h"
@@ -963,6 +964,8 @@ _mongoc_topology_set_appname (mongoc_topology_t *topology,
    if (topology->scanner_state == MONGOC_TOPOLOGY_SCANNER_OFF) {
       ret = _mongoc_topology_scanner_set_appname (topology->scanner,
                                                   appname);
+   } else {
+      MONGOC_ERROR ("Cannot set appname after handshake initiated");
    }
    mongoc_mutex_unlock (&topology->mutex);
    return ret;

src/mongoc/mongoc-uri.c

@@ -640,7 +640,7 @@ mongoc_uri_parse_option (mongoc_uri_t *uri,
 #ifdef MONGOC_EXPERIMENTAL_FEATURES
    } else if (!strcasecmp (key, "appname")) {
       if (!mongoc_uri_set_appname (uri, value)) {
-         MONGOC_WARNING ("appname is invalid [appname=%s]", value);
+         MONGOC_WARNING ("Cannot set appname: %s is invalid", value);
          goto CLEANUP;
       }
 #endif

tests/test-mongoc-client-pool.c

@@ -224,7 +224,13 @@ test_mongoc_client_pool_metadata (void)
 
    ASSERT (mongoc_client_pool_set_appname (pool, "some application"));
    /* Be sure we can't set it twice */
+   capture_logs (true);
    ASSERT (!mongoc_client_pool_set_appname (pool, "a"));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot set appname more than once");
+   capture_logs (false);
+
    mongoc_client_pool_destroy (pool);
 
    /* Make sure that after we pop a client we can't set metadata anymore */
@@ -233,13 +239,23 @@ test_mongoc_client_pool_metadata (void)
    client = mongoc_client_pool_pop (pool);
 
    /* Be sure a client can't set it now that we've popped them */
+   capture_logs (true);
    ASSERT (!mongoc_client_set_appname (client, "a"));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot call set_appname on a client from a pool");
+   capture_logs (false);
 
    mongoc_client_pool_push (pool, client);
 
    /* even now that we pushed the client back we shouldn't be able to set
-      the metadata */
+    * the metadata */
+   capture_logs (true);
    ASSERT (!mongoc_client_pool_set_appname (pool, "a"));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot set appname after handshake initiated");
+   capture_logs (false);
 
    mongoc_uri_destroy(uri);
    mongoc_client_pool_destroy(pool);

tests/test-mongoc-client.c

@@ -1805,13 +1805,22 @@ test_mongoc_client_application_metadata (void)
    big_string[BUFFER_SIZE - 1] = '\0';
 
    /* Check that setting too long a name causes failure */
+   capture_logs (true);
    ASSERT (!mongoc_client_set_appname (client, big_string));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "is invalid");
+   clear_captured_logs ();
 
    /* Success case */
    ASSERT (mongoc_client_set_appname (client, short_string));
 
    /* Make sure we can't set it twice */
    ASSERT (!mongoc_client_set_appname (client, "a"));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot set appname more than once");
+   capture_logs (false);
 
    mongoc_client_destroy (client);
    mongoc_uri_destroy (uri);

tests/test-mongoc-metadata.c

@@ -48,6 +48,7 @@ test_mongoc_metadata_appname_in_uri (void)
    const char *good_uri = "mongodb://host/?appname=mongodump";
    mongoc_uri_t *uri;
    const char *appname = "mongodump";
+   const char *value;
 
    memset (long_string, 'a', MONGOC_METADATA_APPNAME_MAX + 1);
    long_string[MONGOC_METADATA_APPNAME_MAX + 1] = '\0';
@@ -56,22 +57,25 @@ test_mongoc_metadata_appname_in_uri (void)
    capture_logs (true);
    uri_str = bson_strdup_printf ("mongodb://a/?appname=%s", long_string);
    ASSERT (!mongoc_client_new (uri_str));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_WARNING,
+                        "is invalid");
    capture_logs (false);
 
    uri = mongoc_uri_new (good_uri);
    ASSERT (uri);
-   appname = mongoc_uri_get_appname (uri);
-   ASSERT (appname);
-   ASSERT (!strcmp (appname, appname));
+   value = mongoc_uri_get_appname (uri);
+   ASSERT (value);
+   ASSERT_CMPSTR (appname, value);
    mongoc_uri_destroy (uri);
 
    uri = mongoc_uri_new (NULL);
    ASSERT (uri);
    ASSERT (!mongoc_uri_set_appname (uri, long_string));
    ASSERT (mongoc_uri_set_appname (uri, appname));
-   appname = mongoc_uri_get_appname (uri);
-   ASSERT (appname);
-   ASSERT (!strcmp (appname, appname));
+   value = mongoc_uri_get_appname (uri);
+   ASSERT (value);
+   ASSERT_CMPSTR (appname, value);
    mongoc_uri_destroy (uri);
 
    bson_free (uri_str);
@@ -86,7 +90,12 @@ test_mongoc_metadata_appname_frozen_single (void)
    client = mongoc_client_new (good_uri);
 
    /* Shouldn't be able to set appname again */
+   capture_logs (true);
    ASSERT (!mongoc_client_set_appname (client, "a"));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot set appname more than once");
+   capture_logs (false);
 
    mongoc_client_destroy (client);
 }
@@ -101,7 +110,12 @@ test_mongoc_metadata_appname_frozen_pooled (void)
    uri = mongoc_uri_new (good_uri);
 
    pool = mongoc_client_pool_new (uri);
+   capture_logs (true);
    ASSERT (!mongoc_client_pool_set_appname (pool, "test"));
+   ASSERT_CAPTURED_LOG ("_mongoc_topology_scanner_set_appname",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot set appname more than once");
+   capture_logs (false);
 
    mongoc_client_pool_destroy (pool);
    mongoc_uri_destroy (uri);
@@ -160,7 +174,7 @@ test_mongoc_handshake_data_append_success (void)
    ASSERT (bson_iter_find (&inner_iter, "name"));
    val = bson_iter_utf8 (&inner_iter, NULL);
    ASSERT (val);
-   ASSERT (!strcmp (val, "testapp"));
+   ASSERT_CMPSTR (val, "testapp");
 
    /* Make sure driver.name and driver.version and platform are all right */
    ASSERT (bson_iter_find (&md_iter, "driver"));
@@ -228,7 +242,12 @@ test_mongoc_handshake_data_append_after_cmd (void)
 
    client = mongoc_client_pool_pop (pool);
 
+   capture_logs (true);
    ASSERT (!mongoc_handshake_data_append ("a", "a", "a"));
+   ASSERT_CAPTURED_LOG ("mongoc_metadata_append",
+                        MONGOC_LOG_LEVEL_ERROR,
+                        "Cannot set metadata more than once");
+   capture_logs (false);
 
    mongoc_client_pool_push (pool, client);