CDRIVER-4352 unskip /Samples tests (#1692)

* use `MONGOC_DEBUG` instead of `MONGOC_INFO`

Fixes test failure in `test_sample_txn_commands` expecting no captured logs. Debug logs are not captured.

* unskip `/Samples` tests

* skip snapshot sessions tests if server too old

Snapshot sessions require server 5.0. Addresses driver error "Snapshot reads require MongoDB 5.0 or later".

* insert with majority write concern

Resolves two observed errors:
- On server 5.0 and 6.0, `aggregate` sometimes returns the error SnapshotUnavailable(246) with message "Unable to read from a snapshot due to pending collection catalog changes; please retry the operation".
- On server 7.0 and 8.0, `aggregate` sometimes returns no error but does not return the just-inserted document.

* fix typo

* stop capturing logs after asserting

To restore the default behavior (print to stdout).

* rename snapshot query examples

The numbers 1-58 are associated with the examples added for DRIVERS-356. 59 and 60 have no such reference.

* describe rationale for reordering

* reduce scope of captured logs

---------

Co-authored-by: Ezra Chung <[email protected]>

Author: kevinAlbs

.evergreen/etc/skip-tests.txt

@@ -28,6 +28,5 @@
 
 /transactions/legacy/mongos-recovery-token/"commitTransaction retry fails on new mongos" # fails with server selection timeout (CDRIVER-4268)
 /transactions/legacy/pin-mongos/"unpin after transient error within a transaction and commit" # (CDRIVER-4351) server selection timeout (on ASAN Tests Ubuntu 18.04 build variant)
-/Samples # (CDRIVER-4352) strange "heartbeat failed" error
 
 /client_side_encryption/bypass_spawning_mongocryptd/mongocryptdBypassSpawn  # Fails if crypt_shared is visible

src/libmongoc/tests/test-mongoc-sample-commands.c

@@ -47,10 +47,10 @@ test_sample_command (sample_command_fn_t fn,
                      bool drop_collection)
 {
    char *example_name = bson_strdup_printf ("example %d", exampleno);
-   capture_logs (true);
 
+   capture_logs (true);
    fn (db);
-
+   capture_logs (false);
    ASSERT_NO_CAPTURED_LOGS (example_name);
 
    if (drop_collection) {
@@ -2483,13 +2483,23 @@ insert_pet (mongoc_collection_t *collection, bool is_adoptable)
 
    doc = BCON_NEW ("adoptable", BCON_BOOL (is_adoptable));
 
-   rc = mongoc_collection_insert_one (collection, doc, NULL, NULL, &error);
+   // Insert with majority write concern. Snapshot read concern reads from majority committed data.
+   bson_t opts = BSON_INITIALIZER;
+   {
+      mongoc_write_concern_t *wc = mongoc_write_concern_new ();
+      mongoc_write_concern_set_w (wc, MONGOC_WRITE_CONCERN_W_MAJORITY);
+      mongoc_write_concern_append (wc, &opts);
+      mongoc_write_concern_destroy (wc);
+   }
+
+   rc = mongoc_collection_insert_one (collection, doc, &opts, NULL, &error);
    if (!rc) {
       MONGOC_ERROR ("insert into pets.%s failed: %s", mongoc_collection_get_name (collection), error.message);
       goto cleanup;
    }
 
 cleanup:
+   bson_destroy (&opts);
    bson_destroy (doc);
    return rc;
 }
@@ -2590,18 +2600,18 @@ accumulate_adoptable_count (const mongoc_client_session_t *cs,
    return rc;
 }
 
-/*
- * JIRA: https://jira.mongodb.org/browse/DRIVERS-2181
- */
 static void
-test_example_59 (mongoc_database_t *db)
+test_snapshot_query_example_1 (void)
 {
-   BSON_UNUSED (db);
-
    if (!test_framework_skip_if_no_txns ()) {
       return;
    }
 
+   if (!test_framework_max_wire_version_at_least (WIRE_VERSION_SNAPSHOT_READS)) {
+      MONGOC_DEBUG ("Skipping test. Server does not support snapshot reads\n");
+      return;
+   }
+
    mongoc_client_t *client = NULL;
    client = test_framework_new_default_client ();
 
@@ -2661,7 +2671,7 @@ test_example_59 (mongoc_database_t *db)
    /* End Snapshot Query Example 1 */
 
    if (adoptable_pets_count != 2) {
-      MONGOC_ERROR ("there should be exatly 2 adoptable_pets_count, found: %" PRId64, adoptable_pets_count);
+      MONGOC_ERROR ("there should be exactly 2 adoptable_pets_count, found: %" PRId64, adoptable_pets_count);
    }
 
    /* Start Snapshot Query Example 1 Post */
@@ -2681,6 +2691,7 @@ retail_setup (mongoc_collection_t *sales_collection)
    bson_error_t error;
    struct timeval tv;
    int64_t unix_time_now = 0;
+   bson_t opts = BSON_INITIALIZER;
 
    if (bson_gettimeofday (&tv)) {
       MONGOC_ERROR ("could not get time of day");
@@ -2693,27 +2704,39 @@ retail_setup (mongoc_collection_t *sales_collection)
    doc =
       BCON_NEW ("shoeType", BCON_UTF8 ("boot"), "price", BCON_INT64 (30), "saleDate", BCON_DATE_TIME (unix_time_now));
 
-   ok = mongoc_collection_insert_one (sales_collection, doc, NULL, NULL, &error);
+   // Insert with majority write concern. Snapshot read concern reads from majority committed data.
+   {
+      mongoc_write_concern_t *wc = mongoc_write_concern_new ();
+      mongoc_write_concern_set_w (wc, MONGOC_WRITE_CONCERN_W_MAJORITY);
+      mongoc_write_concern_append (wc, &opts);
+      mongoc_write_concern_destroy (wc);
+   }
+
+   ok = mongoc_collection_insert_one (sales_collection, doc, &opts, NULL, &error);
    if (!ok) {
       MONGOC_ERROR ("insert into retail.sales failed: %s", error.message);
       goto cleanup;
    }
 
 cleanup:
+   bson_destroy (&opts);
    bson_destroy (doc);
    return ok;
 }
 
 
 static void
-test_example_60 (mongoc_database_t *db)
+test_snapshot_query_example_2 (void)
 {
-   BSON_UNUSED (db);
-
    if (!test_framework_skip_if_no_txns ()) {
       return;
    }
 
+   if (!test_framework_max_wire_version_at_least (WIRE_VERSION_SNAPSHOT_READS)) {
+      MONGOC_DEBUG ("Skipping test. Server does not support snapshot reads\n");
+      return;
+   }
+
    mongoc_client_t *client = NULL;
    client = test_framework_new_default_client ();
 
@@ -2822,6 +2845,21 @@ test_example_60 (mongoc_database_t *db)
    /* End Snapshot Query Example 2 Post */
 }
 
+// `test_snapshot_query_examples` examples for DRIVERS-2181.
+static void
+test_snapshot_query_examples (void)
+{
+   capture_logs (true);
+   test_snapshot_query_example_1 ();
+   capture_logs (false);
+   ASSERT_NO_CAPTURED_LOGS ("test_snapshot_query_example_1");
+
+   capture_logs (true);
+   test_snapshot_query_example_2 ();
+   capture_logs (false);
+   ASSERT_NO_CAPTURED_LOGS ("test_snapshot_query_example_2");
+}
+
 /* clang-format off */
 
 typedef struct {
@@ -2883,6 +2921,7 @@ test_sample_change_stream_command (sample_command_fn_t fn,
       capture_logs (true);
       fn (db);
       ASSERT_NO_CAPTURED_LOGS ("change stream examples");
+      capture_logs (false);
 
       bson_mutex_lock (&ctx.lock);
       ctx.done = true;
@@ -3678,7 +3717,7 @@ commit_with_retry (mongoc_client_session_t *cs, bson_error_t *error)
        * mongoc_transaction_opts_set_write_concern */
       r = mongoc_client_session_commit_transaction (cs, &reply, error);
       if (r) {
-         MONGOC_INFO ("Transaction committed");
+         MONGOC_DEBUG ("Transaction committed");
          break;
       }
 
@@ -3826,6 +3865,7 @@ test_sample_txn_commands (mongoc_client_t *client)
    /* test transactions retry example 3 */
    example_func (client);
    ASSERT_NO_CAPTURED_LOGS ("transactions retry example 3");
+   capture_logs (false);
    find_and_match (employees, "{'employee': 3}", "{'status': 'Inactive'}");
 
    mongoc_collection_destroy (employees);
@@ -4383,16 +4423,16 @@ test_sample_commands (void)
    test_sample_command (test_example_55, 55, db, collection, false);
    test_sample_command (test_example_57, 57, db, collection, false);
    test_sample_command (test_example_58, 58, db, collection, false);
+   // Run 56 after 57 and 58. 56 deletes all data. 57 and 58 expect data present.
    test_sample_command (test_example_56, 56, db, collection, true);
-   test_sample_command (test_example_59, 59, db, collection, true);
-   test_sample_command (test_example_60, 60, db, collection, true);
    test_sample_change_stream_command (test_example_change_stream, db);
    test_sample_causal_consistency (client);
    test_sample_aggregation (db);
    test_sample_projection_with_aggregation_expressions (db);
    test_sample_indexes (db);
    test_sample_run_command (db);
    test_sample_txn_commands (client);
+   test_snapshot_query_examples ();
 
    if (test_framework_max_wire_version_at_least (WIRE_VERSION_4_9)) {
       test_sample_versioned_api ();