#include <mongoc/mongoc-cursor-private.h>
#include "mongoc/mongoc.h"
#include "mongoc/mongoc-util-private.h"
#include "mongoc/mongoc-change-stream-private.h"
#include "mongoc/mongoc-collection-private.h"
#include "mongoc/utlist.h"
#include "TestSuite.h"
#include "test-conveniences.h"
#include "test-libmongoc.h"
#include "mock_server/mock-server.h"
#include "mock_server/future-functions.h"

#undef MONGOC_LOG_DOMAIN
#define MONGOC_LOG_DOMAIN "session-test"


static void
test_session_opts_clone (void)
{
   mongoc_session_opt_t *opts;
   mongoc_session_opt_t *clone;

   opts = mongoc_session_opts_new ();
   clone = mongoc_session_opts_clone (opts);
   /* causal is enabled by default */
   BSON_ASSERT (mongoc_session_opts_get_causal_consistency (clone));
   mongoc_session_opts_destroy (clone);

   mongoc_session_opts_set_causal_consistency (opts, false);
   clone = mongoc_session_opts_clone (opts);
   BSON_ASSERT (!mongoc_session_opts_get_causal_consistency (clone));

   mongoc_session_opts_destroy (clone);
   mongoc_session_opts_destroy (opts);
}


static void
test_session_no_crypto (void *ctx)
{
   mongoc_client_t *client;
   bson_error_t error;

   client = test_framework_client_new ();
   BSON_ASSERT (!mongoc_client_start_session (client, NULL, &error));
   ASSERT_ERROR_CONTAINS (error,
                          MONGOC_ERROR_CLIENT,
                          MONGOC_ERROR_CLIENT_SESSION_FAILURE,
                          "need a cryptography library");

   mongoc_client_destroy (client);
}


#define ASSERT_SESSIONS_MATCH(_lsid_a, _lsid_b)               \
   do {                                                       \
      BSON_ASSERT (match_bson ((_lsid_a), (_lsid_b), false)); \
   } while (0)


#define ASSERT_SESSIONS_DIFFER(_lsid_a, _lsid_b)                               \
   do {                                                                        \
      /* need a match context when checking that lsids DON'T match */          \
      char errmsg[1000];                                                       \
      match_ctx_t _ctx = {0};                                                  \
      _ctx.errmsg = errmsg;                                                    \
      _ctx.errmsg_len = sizeof (errmsg);                                       \
      BSON_ASSERT (!match_bson_with_ctx ((_lsid_a), (_lsid_b), false, &_ctx)); \
   } while (0)


/* "Pool is LIFO" test from Driver Sessions Spec */
static void
_test_session_pool_lifo (bool pooled)
{
   mongoc_client_pool_t *pool = NULL;
   mongoc_client_t *client;
   mongoc_client_session_t *a, *b, *c, *d;
   bson_t lsid_a, lsid_b;
   bson_error_t error;

   if (pooled) {
      pool = test_framework_client_pool_new ();
      client = mongoc_client_pool_pop (pool);
   } else {
      client = test_framework_client_new ();
   }

   a = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (a, error);
   a->server_session->last_used_usec = bson_get_monotonic_time ();
   bson_copy_to (mongoc_client_session_get_lsid (a), &lsid_a);

   b = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (b, error);
   b->server_session->last_used_usec = bson_get_monotonic_time ();
   bson_copy_to (mongoc_client_session_get_lsid (b), &lsid_b);

   /* return server sessions to pool: first "a", then "b" */
   mongoc_client_session_destroy (a);
   mongoc_client_session_destroy (b);

   /* first pop returns last push */
   c = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (c, error);
   ASSERT_SESSIONS_MATCH (&lsid_b, mongoc_client_session_get_lsid (c));

   /* second pop returns previous push */
   d = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (d, error);
   ASSERT_SESSIONS_MATCH (&lsid_a, mongoc_client_session_get_lsid (d));

   mongoc_client_session_destroy (c);
   mongoc_client_session_destroy (d);

   if (pooled) {
      /* the pooled client never needed to connect, so it warns that
       * it isn't connecting in order to send endSessions */
      capture_logs (true);
      mongoc_client_pool_push (pool, client);
      mongoc_client_pool_destroy (pool);
   } else {
      mongoc_client_destroy (client);
   }

   bson_destroy (&lsid_a);
   bson_destroy (&lsid_b);
}


static void
test_session_pool_lifo_single (void *ctx)
{
   _test_session_pool_lifo (false);
}


static void
test_session_pool_lifo_pooled (void *ctx)
{
   _test_session_pool_lifo (true);
}


/* test that a session that is timed out is not added to the pool,
 * and a session that times out while it's in the pool is destroyed
 */
static void
_test_session_pool_timeout (bool pooled)
{
   mongoc_client_pool_t *pool = NULL;
   mongoc_client_t *client;
   uint32_t server_id;
   mongoc_client_session_t *s;
   bson_error_t error;
   bson_t lsid;
   int64_t almost_timeout_usec;

   almost_timeout_usec =
      (test_framework_session_timeout_minutes () - 1) * 60 * 1000 * 1000;

   if (pooled) {
      pool = test_framework_client_pool_new ();
      client = mongoc_client_pool_pop (pool);
   } else {
      client = test_framework_client_new ();
   }

   /*
    * trigger discovery
    */
   server_id = mongoc_topology_select_server_id (
      client->topology, MONGOC_SS_READ, NULL, &error);
   ASSERT_OR_PRINT (server_id, error);

   /*
    * get a session, set last_used_date more than 29 minutes ago and return to
    * the pool. it's timed out & freed.
    */
   BSON_ASSERT (!client->topology->session_pool);
   s = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (s, error);
   bson_copy_to (mongoc_client_session_get_lsid (s), &lsid);

   s->server_session->last_used_usec =
      (bson_get_monotonic_time () - almost_timeout_usec - 100);

   mongoc_client_session_destroy (s);
   BSON_ASSERT (!client->topology->session_pool);

   /*
    * get a new session, set last_used_date so it has one second left to live,
    * return to the pool, wait 1.5 seconds. it's timed out & freed.
    */
   s = mongoc_client_start_session (client, NULL, &error);
   ASSERT_SESSIONS_DIFFER (&lsid, mongoc_client_session_get_lsid (s));

   bson_destroy (&lsid);
   bson_copy_to (mongoc_client_session_get_lsid (s), &lsid);

   s->server_session->last_used_usec =
      (bson_get_monotonic_time () + 1000 * 1000 - almost_timeout_usec);

   mongoc_client_session_destroy (s);
   BSON_ASSERT (client->topology->session_pool);
   ASSERT_SESSIONS_MATCH (&lsid, &client->topology->session_pool->lsid);

   _mongoc_usleep (1500 * 1000);

   /* getting a new client session must start a new server session */
   s = mongoc_client_start_session (client, NULL, &error);
   ASSERT_SESSIONS_DIFFER (&lsid, mongoc_client_session_get_lsid (s));
   BSON_ASSERT (!client->topology->session_pool);
   mongoc_client_session_destroy (s);

   if (pooled) {
      /* the pooled client never needed to connect, so it warns that
       * it isn't connecting in order to send endSessions */
      capture_logs (true);
      mongoc_client_pool_push (pool, client);
      mongoc_client_pool_destroy (pool);
   } else {
      mongoc_client_destroy (client);
   }

   bson_destroy (&lsid);
}


static void
test_session_pool_timeout_single (void *ctx)
{
   _test_session_pool_timeout (false);
}


static void
test_session_pool_timeout_pooled (void *ctx)
{
   _test_session_pool_timeout (true);
}


/* test that a session that times out while it's in the pool is reaped when
 * another session is added
 */
static void
_test_session_pool_reap (bool pooled)
{
   mongoc_client_pool_t *pool = NULL;
   mongoc_client_t *client;
   mongoc_client_session_t *a, *b;
   bool r;
   bson_error_t error;
   bson_t lsid_a, lsid_b;
   int64_t almost_timeout_usec;
   mongoc_server_session_t *session_pool;

   almost_timeout_usec =
      (test_framework_session_timeout_minutes () - 1) * 60 * 1000 * 1000;

   if (pooled) {
      pool = test_framework_client_pool_new ();
      client = mongoc_client_pool_pop (pool);
   } else {
      client = test_framework_client_new ();
   }

   /*
    * trigger discovery
    */
   r = mongoc_client_command_simple (
      client, "admin", tmp_bson ("{'ping': 1}"), NULL, NULL, &error);
   ASSERT_OR_PRINT (r, error);

   /*
    * get a new session, set last_used_date so it has one second left to live,
    * return to the pool, wait 1.5 seconds.
    */
   a = mongoc_client_start_session (client, NULL, &error);
   b = mongoc_client_start_session (client, NULL, &error);
   bson_copy_to (mongoc_client_session_get_lsid (a), &lsid_a);
   bson_copy_to (mongoc_client_session_get_lsid (b), &lsid_b);

   a->server_session->last_used_usec =
      (bson_get_monotonic_time () + 1000 * 1000 - almost_timeout_usec);

   mongoc_client_session_destroy (a);
   BSON_ASSERT (client->topology->session_pool); /* session is pooled */

   _mongoc_usleep (1500 * 1000);

   /*
    * returning session B causes session A to be reaped
    */
   b->server_session->last_used_usec = bson_get_monotonic_time ();
   mongoc_client_session_destroy (b);
   BSON_ASSERT (client->topology->session_pool);
   ASSERT_SESSIONS_MATCH (&lsid_b, &client->topology->session_pool->lsid);
   /* session B is the only session in the pool */
   session_pool = client->topology->session_pool;
   BSON_ASSERT (session_pool == session_pool->prev);
   BSON_ASSERT (session_pool == session_pool->next);

   if (pooled) {
      mongoc_client_pool_push (pool, client);
      mongoc_client_pool_destroy (pool);
   } else {
      mongoc_client_destroy (client);
   }

   bson_destroy (&lsid_a);
   bson_destroy (&lsid_b);
}


static void
test_session_pool_reap_single (void *ctx)
{
   _test_session_pool_reap (false);
}


static void
test_session_pool_reap_pooled (void *ctx)
{
   _test_session_pool_reap (true);
}


static void
test_session_id_bad (void *ctx)
{
   const char *bad_opts[] = {
      "{'sessionId': null}",
      "{'sessionId': 'foo'}",
      "{'sessionId': {'$numberInt': '1'}}",
      "{'sessionId': {'$numberDouble': '1'}}",
      /* doesn't fit in uint32 */
      "{'sessionId': {'$numberLong': '5000000000'}}",
      /* doesn't match existing mongoc_client_session_t */
      "{'sessionId': {'$numberLong': '123'}}",
      NULL,
   };

   const char **bad_opt;
   mongoc_client_t *client;
   bson_error_t error;
   bool r;

   client = test_framework_client_new ();
   for (bad_opt = bad_opts; *bad_opt; bad_opt++) {
      r = mongoc_client_read_command_with_opts (client,
                                                "admin",
                                                tmp_bson ("{'ping': 1}"),
                                                NULL,
                                                tmp_bson (*bad_opt),
                                                NULL,
                                                &error);

      BSON_ASSERT (!r);
      ASSERT_ERROR_CONTAINS (error,
                             MONGOC_ERROR_COMMAND,
                             MONGOC_ERROR_COMMAND_INVALID_ARG,
                             "Invalid sessionId");

      memset (&error, 0, sizeof (bson_error_t));
   }

   mongoc_client_destroy (client);
}

static void
_test_session_supported (bool pooled)
{
   mongoc_client_pool_t *pool = NULL;
   mongoc_client_t *client;
   bson_error_t error;
   mongoc_client_session_t *session;

   if (pooled) {
      pool = test_framework_client_pool_new ();
      client = mongoc_client_pool_pop (pool);
   } else {
      client = test_framework_client_new ();
   }

   if (test_framework_session_timeout_minutes () == -1) {
      BSON_ASSERT (!mongoc_client_start_session (client, NULL, &error));
      ASSERT_ERROR_CONTAINS (error,
                             MONGOC_ERROR_CLIENT,
                             MONGOC_ERROR_CLIENT_SESSION_FAILURE,
                             "Server does not support sessions");
   } else {
      session = mongoc_client_start_session (client, NULL, &error);
      ASSERT_OR_PRINT (session, error);
      mongoc_client_session_destroy (session);
   }

   if (pooled) {
      /* the pooled client never needed to connect, so it warns that
       * it isn't connecting in order to send endSessions */
      capture_logs (true);
      mongoc_client_pool_push (pool, client);
      mongoc_client_pool_destroy (pool);
   } else {
      mongoc_client_destroy (client);
   }
}

static void
test_session_supported_single (void *ctx)
{
   _test_session_supported (false);
}

static void
test_session_supported_pooled (void *ctx)
{
   _test_session_supported (true);
}

static void
_test_mock_end_sessions (bool pooled)
{
   mock_server_t *server;
   mongoc_client_pool_t *pool = NULL;
   mongoc_client_t *client;
   bson_error_t error;
   mongoc_client_session_t *session;
   bson_t lsid;
   bson_t opts = BSON_INITIALIZER;
   bson_t *expected_cmd;
   future_t *future;
   request_t *request;
   bool r;

   server = mock_mongos_new (WIRE_VERSION_OP_MSG);
   mock_server_run (server);

   if (pooled) {
      pool = mongoc_client_pool_new (mock_server_get_uri (server));
      client = mongoc_client_pool_pop (pool);
   } else {
      client = mongoc_client_new_from_uri (mock_server_get_uri (server));
   }

   session = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (session, error);
   bson_copy_to (mongoc_client_session_get_lsid (session), &lsid);
   r = mongoc_client_session_append (session, &opts, &error);
   ASSERT_OR_PRINT (r, error);

   future = future_client_command_with_opts (
      client, "admin", tmp_bson ("{'ping': 1}"), NULL, &opts, NULL, &error);

   request = mock_server_receives_msg (
      server, 0, tmp_bson ("{'ping': 1, 'lsid': {'$exists': true}}"));
   mock_server_replies_ok_and_destroys (request);

   BSON_ASSERT (future_get_bool (future));
   future_destroy (future);

   /* before destroying the session, construct the expected endSessions cmd */
   expected_cmd =
      BCON_NEW ("endSessions",
                "[",
                BCON_DOCUMENT (mongoc_client_session_get_lsid (session)),
                "]");

   mongoc_client_session_destroy (session);

   if (pooled) {
      mongoc_client_pool_push (pool, client);
      future = future_client_pool_destroy (pool);
   } else {
      future = future_client_destroy (client);
   }

   /* check that we got the expected endSessions cmd */
   request = mock_server_receives_msg (server, 0, expected_cmd);
   mock_server_replies_ok_and_destroys (request);
   future_wait (future);
   future_destroy (future);

   mock_server_destroy (server);
   bson_destroy (expected_cmd);
   bson_destroy (&lsid);
   bson_destroy (&opts);
}

static void
test_mock_end_sessions_single (void)
{
   _test_mock_end_sessions (false);
}

static void
test_mock_end_sessions_pooled (void)
{
   _test_mock_end_sessions (true);
}

typedef struct {
   int started_calls;
   int succeeded_calls;
   mongoc_array_t cmds;
   mongoc_client_pool_t *pool;
   mongoc_client_t *client;
} endsessions_test_t;

static void
endsessions_started_cb (const mongoc_apm_command_started_t *event)
{
   endsessions_test_t *test;
   bson_t *cmd;

   if (strcmp (mongoc_apm_command_started_get_command_name (event),
               "endSessions") != 0) {
      return;
   }

   test = (endsessions_test_t *) mongoc_apm_command_started_get_context (event);
   test->started_calls++;
   cmd = bson_copy (mongoc_apm_command_started_get_command (event));
   _mongoc_array_append_vals (&test->cmds, &cmd, 1);
}

static void
endsessions_succeeded_cb (const mongoc_apm_command_succeeded_t *event)
{
   endsessions_test_t *test;

   if (strcmp (mongoc_apm_command_succeeded_get_command_name (event),
               "endSessions") != 0) {
      return;
   }

   test =
      (endsessions_test_t *) mongoc_apm_command_succeeded_get_context (event);
   test->succeeded_calls++;
}

static void
endsessions_test_init (endsessions_test_t *test, bool pooled)
{
   mongoc_apm_callbacks_t *callbacks;

   test->started_calls = test->succeeded_calls = 0;
   _mongoc_array_init (&test->cmds, sizeof (bson_t *));

   callbacks = mongoc_apm_callbacks_new ();
   mongoc_apm_set_command_started_cb (callbacks, endsessions_started_cb);
   mongoc_apm_set_command_succeeded_cb (callbacks, endsessions_succeeded_cb);

   if (pooled) {
      test->pool = test_framework_client_pool_new ();
      ASSERT (
         mongoc_client_pool_set_apm_callbacks (test->pool, callbacks, test));
      test->client = mongoc_client_pool_pop (test->pool);
   } else {
      test->pool = NULL;
      test->client = test_framework_client_new ();
      ASSERT (mongoc_client_set_apm_callbacks (test->client, callbacks, test));
   }

   mongoc_apm_callbacks_destroy (callbacks);
}

static void
endsessions_test_destroy_client (endsessions_test_t *test)
{
   if (test->pool) {
      mongoc_client_pool_push (test->pool, test->client);
      mongoc_client_pool_destroy (test->pool);
   } else {
      mongoc_client_destroy (test->client);
   }
}

static void
endsessions_test_get_ended_lsids (endsessions_test_t *test,
                                  size_t index,
                                  bson_t *ended_lsids)
{
   bson_iter_t iter;

   ASSERT_CMPINT (test->started_calls, >, (int) index);

   BSON_ASSERT (
      bson_iter_init_find (&iter,
                           _mongoc_array_index (&test->cmds, bson_t *, index),
                           "endSessions"));

   BSON_ASSERT (BSON_ITER_HOLDS_ARRAY (&iter));
   bson_iter_bson (&iter, ended_lsids);
}

static void
endsessions_test_cleanup (endsessions_test_t *test)
{
   size_t i;

   for (i = 0; i < test->cmds.len; i++) {
      bson_destroy (_mongoc_array_index (&test->cmds, bson_t *, i));
   }

   _mongoc_array_destroy (&test->cmds);
}

static void
_test_end_sessions (bool pooled)
{
   endsessions_test_t test;
   mongoc_client_t *client;
   bson_error_t error;
   mongoc_client_session_t *cs1;
   mongoc_client_session_t *cs2;
   bson_t lsid1;
   bson_t lsid2;
   bson_t opts1 = BSON_INITIALIZER;
   bson_t opts2 = BSON_INITIALIZER;
   bool lsid1_ended = false;
   bool lsid2_ended = false;
   bson_t ended_lsids;
   bson_iter_t iter;
   bson_t ended_lsid;
   char errmsg[1000];
   match_ctx_t ctx = {0};
   bool r;

   endsessions_test_init (&test, pooled);
   client = test.client;

   /*
    * create and use sessions 1 and 2
    */
   cs1 = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (cs1, error);
   bson_copy_to (mongoc_client_session_get_lsid (cs1), &lsid1);
   r = mongoc_client_session_append (cs1, &opts1, &error);
   ASSERT_OR_PRINT (r, error);
   r = mongoc_client_command_with_opts (
      client, "admin", tmp_bson ("{'count': 'c'}"), NULL, &opts1, NULL, &error);
   ASSERT_OR_PRINT (r, error);

   cs2 = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (cs2, error);
   bson_copy_to (mongoc_client_session_get_lsid (cs2), &lsid2);
   r = mongoc_client_session_append (cs2, &opts2, &error);
   ASSERT_OR_PRINT (r, error);
   r = mongoc_client_command_with_opts (
      client, "admin", tmp_bson ("{'count': 'c'}"), NULL, &opts2, NULL, &error);
   ASSERT_OR_PRINT (r, error);

   /*
    * return server sessions to the pool
    */
   mongoc_client_session_destroy (cs1);
   mongoc_client_session_destroy (cs2);
   endsessions_test_destroy_client (&test);

   /*
    * sessions were ended on server
    */
   ASSERT_CMPINT (test.started_calls, ==, 1);
   ASSERT_CMPINT (test.succeeded_calls, ==, 1);

   endsessions_test_get_ended_lsids (&test, 0, &ended_lsids);

   ctx.errmsg = errmsg;
   ctx.errmsg_len = sizeof errmsg;

   BSON_ASSERT (bson_iter_init (&iter, &ended_lsids));
   while (bson_iter_next (&iter)) {
      BSON_ASSERT (BSON_ITER_HOLDS_DOCUMENT (&iter));
      bson_iter_bson (&iter, &ended_lsid);
      if (match_bson_with_ctx (&ended_lsid, &lsid1, false, &ctx)) {
         lsid1_ended = true;
      } else if (match_bson_with_ctx (&ended_lsid, &lsid2, false, &ctx)) {
         lsid2_ended = true;
      }
   }

   BSON_ASSERT (lsid1_ended);
   BSON_ASSERT (lsid2_ended);

   bson_destroy (&lsid1);
   bson_destroy (&opts1);
   bson_destroy (&lsid2);
   bson_destroy (&opts2);
   endsessions_test_cleanup (&test);
}

static void
test_end_sessions_single (void *ctx)
{
   _test_end_sessions (false);
}

static void
test_end_sessions_pooled (void *ctx)
{
   _test_end_sessions (true);
}


static void
_test_end_sessions_many (bool pooled)
{
   endsessions_test_t test;
   mongoc_client_t *client;
   int i;
   mongoc_client_session_t *sessions[10001];
   bson_error_t error;
   bson_t ended_lsids;

   endsessions_test_init (&test, pooled);
   client = test.client;
   /* connect */
   ASSERT_OR_PRINT (
      mongoc_client_command_simple (
         client, "admin", tmp_bson ("{'ping': 1}"), NULL, NULL, &error),
      error);

   /*
    * create and destroy 10,001 sessions
    */
   for (i = 0; i < sizeof sessions / sizeof (mongoc_client_session_t *); i++) {
      sessions[i] = mongoc_client_start_session (client, NULL, &error);
      ASSERT_OR_PRINT (sessions[i], error);
   }

   for (i = 0; i < sizeof sessions / sizeof (mongoc_client_session_t *); i++) {
      mongoc_client_session_destroy (sessions[i]);
   }

   endsessions_test_destroy_client (&test);

   /*
    * sessions were ended on the server, ten thousand at a time
    */
   ASSERT_CMPINT (test.started_calls, ==, 2);
   ASSERT_CMPINT (test.succeeded_calls, ==, 2);

   endsessions_test_get_ended_lsids (&test, 0, &ended_lsids);
   ASSERT_CMPINT (bson_count_keys (&ended_lsids), ==, 10000);
   endsessions_test_get_ended_lsids (&test, 1, &ended_lsids);
   ASSERT_CMPINT (bson_count_keys (&ended_lsids), ==, 1);

   endsessions_test_cleanup (&test);
}

static void
test_end_sessions_many_single (void *ctx)
{
   _test_end_sessions_many (false);
}

static void
test_end_sessions_many_pooled (void *ctx)
{
   _test_end_sessions_many (true);
}

static void
_test_advance_cluster_time (mongoc_client_session_t *cs,
                            int new_timestamp,
                            int new_increment,
                            bool should_advance)
{
   bson_t *old_cluster_time;
   bson_t *new_cluster_time;

   old_cluster_time = bson_copy (mongoc_client_session_get_cluster_time (cs));
   new_cluster_time =
      tmp_bson ("{'clusterTime': {'$timestamp': {'t': %d, 'i': %d}}}",
                new_timestamp,
                new_increment);

   mongoc_client_session_advance_cluster_time (cs, new_cluster_time);

   if (should_advance) {
      BSON_ASSERT (match_bson (
         mongoc_client_session_get_cluster_time (cs), new_cluster_time, false));
   } else {
      BSON_ASSERT (match_bson (
         mongoc_client_session_get_cluster_time (cs), old_cluster_time, false));
   }

   bson_destroy (old_cluster_time);
}

static void
test_session_advance_cluster_time (void *ctx)
{
   mongoc_client_t *client;
   bson_error_t error;
   mongoc_client_session_t *cs;

   client = test_framework_client_new ();
   cs = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (cs, error);
   BSON_ASSERT (!mongoc_client_session_get_cluster_time (cs));

   capture_logs (true);
   mongoc_client_session_advance_cluster_time (cs, tmp_bson ("{'foo': 1}"));
   ASSERT_CAPTURED_LOG ("mongoc_client_session_advance_cluster_time",
                        MONGOC_LOG_LEVEL_ERROR,
                        "Cannot parse cluster time");

   capture_logs (true);
   mongoc_client_session_advance_cluster_time (cs,
                                               tmp_bson ("{'clusterTime': 1}"));
   ASSERT_CAPTURED_LOG ("mongoc_client_session_advance_cluster_time",
                        MONGOC_LOG_LEVEL_ERROR,
                        "Cannot parse cluster time");

   mongoc_client_session_advance_cluster_time (
      cs, tmp_bson ("{'clusterTime': {'$timestamp': {'t': 1, 'i': 1}}}"));

   _test_advance_cluster_time (cs, 1, 0, false);
   _test_advance_cluster_time (cs, 2, 2, true);
   _test_advance_cluster_time (cs, 2, 1, false);
   _test_advance_cluster_time (cs, 3, 1, true);

   mongoc_client_session_destroy (cs);
   mongoc_client_destroy (client);
}


static void
_test_advance_operation_time (mongoc_client_session_t *cs,
                              uint32_t t,
                              uint32_t i,
                              bool should_advance)
{
   uint32_t old_t, old_i;
   uint32_t new_t, new_i;

   mongoc_client_session_get_operation_time (cs, &old_t, &old_i);
   mongoc_client_session_advance_operation_time (cs, t, i);
   mongoc_client_session_get_operation_time (cs, &new_t, &new_i);

   if (should_advance) {
      ASSERT_CMPUINT32 (new_t, ==, t);
      ASSERT_CMPUINT32 (new_i, ==, i);
   } else if (new_t == t && new_i == i) {
      fprintf (stderr,
               "Shouldn't have advanced from operationTime %" PRIu32
               ", %" PRIu32 " to %" PRIu32 ", %" PRIu32 "\n",
               old_t,
               old_i,
               t,
               i);
      abort ();
   }
}


static void
test_session_advance_operation_time (void *ctx)
{
   mongoc_client_t *client;
   bson_error_t error;
   mongoc_client_session_t *cs;
   uint32_t t, i;

   client = test_framework_client_new ();
   cs = mongoc_client_start_session (client, NULL, &error);
   ASSERT_OR_PRINT (cs, error);
   mongoc_client_session_get_operation_time (cs, &t, &i);

   ASSERT_CMPUINT32 (t, ==, 0);
   ASSERT_CMPUINT32 (t, ==, 0);

   mongoc_client_session_advance_operation_time (cs, 1, 1);

   _test_advance_operation_time (cs, 1, 0, false);
   _test_advance_operation_time (cs, 2, 2, true);
   _test_advance_operation_time (cs, 2, 1, false);
   _test_advance_operation_time (cs, 3, 1, true);

   mongoc_client_session_destroy (cs);
   mongoc_client_destroy (client);
}


typedef enum {
   CORRECT_CLIENT,
   INCORRECT_CLIENT,
} session_test_correct_t;


typedef enum {
   CAUSAL,
   NOT_CAUSAL,
} session_test_causal_t;

typedef struct {
   bool verbose;
   mongoc_client_t *session_client, *client;
   mongoc_database_t *session_db, *db;
   mongoc_collection_t *session_collection, *collection;
   mongoc_client_session_t *cs;
   mongoc_client_session_t *wrong_cs;
   bson_t opts;
   bson_error_t error;
   int n_started;
   int n_succeeded;
   bool expect_explicit_lsid;
   bool acknowledged;
   bool succeeded;
   mongoc_array_t cmds;
   mongoc_array_t replies;
   bson_t sent_lsid;
   bson_t sent_cluster_time;
   bson_t received_cluster_time;
} session_test_t;


static void
started (const mongoc_apm_command_started_t *event)
{
   char errmsg[1000];
   match_ctx_t ctx = {errmsg, sizeof (errmsg), false /* strict numbers */};
   bson_iter_t iter;
   bool has_cluster_time;
   bson_t cluster_time;
   bson_t lsid;
   const bson_t *client_session_lsid;
   bson_t *cmd = bson_copy (mongoc_apm_command_started_get_command (event));
   const char *cmd_name = mongoc_apm_command_started_get_command_name (event);
   session_test_t *test =
      (session_test_t *) mongoc_apm_command_started_get_context (event);

   if (test->verbose) {
      char *s = bson_as_json (cmd, NULL);
      printf ("%s\n", s);
      bson_free (s);
   }

   if (!strcmp (cmd_name, "endSessions")) {
      BSON_ASSERT (!bson_has_field (cmd, "lsid"));
      bson_destroy (cmd);
      return;
   }

   if (test->acknowledged) {
      if (!bson_iter_init_find (&iter, cmd, "lsid")) {
         fprintf (stderr, "no lsid sent with command %s\n", cmd_name);
         abort ();
      }

      bson_iter_bson (&iter, &lsid);
      client_session_lsid = &test->cs->server_session->lsid;

      if (test->expect_explicit_lsid) {
         if (!match_bson_with_ctx (&lsid, client_session_lsid, false, &ctx)) {
            fprintf (stderr,
                     "command %s should have used client session's lsid\n",
                     cmd_name);
            abort ();
         }
      } else {
         if (match_bson_with_ctx (&lsid, client_session_lsid, false, &ctx)) {
            fprintf (stderr,
                     "command %s should not have used client session's lsid\n",
                     cmd_name);
            abort ();
         }
      }

      if (bson_empty (&test->sent_lsid)) {
         bson_destroy (&test->sent_lsid);
         bson_copy_to (&lsid, &test->sent_lsid);
      } else {
         if (!match_bson_with_ctx (&lsid, &test->sent_lsid, false, &ctx)) {
            fprintf (stderr,
                     "command %s used different lsid than previous command\n",
                     cmd_name);
            abort ();
         }
      }
   } else {
      /* unacknowledged commands should never include lsid */
      BSON_ASSERT (!bson_has_field (cmd, "lsid"));
   }

   has_cluster_time = bson_iter_init_find (&iter, cmd, "$clusterTime");
   if (test->acknowledged && !has_cluster_time) {
      fprintf (stderr, "no $clusterTime sent with command %s\n", cmd_name);
      abort ();
   }

   if (has_cluster_time) {
      /* like $clusterTime: {clusterTime: <timestamp>} */
      bson_iter_bson (&iter, &cluster_time);
      bson_destroy (&test->sent_cluster_time);
      bson_copy_to (&cluster_time, &test->sent_cluster_time);
   }

   _mongoc_array_append_vals (&test->cmds, &cmd, 1);

   test->n_started++;
}


static void
succeeded (const mongoc_apm_command_succeeded_t *event)
{
   bson_iter_t iter;
   bool has_cluster_time;
   bson_t cluster_time;
   bson_t *reply = bson_copy (mongoc_apm_command_succeeded_get_reply (event));
   const char *cmd_name = mongoc_apm_command_succeeded_get_command_name (event);
   session_test_t *test =
      (session_test_t *) mongoc_apm_command_succeeded_get_context (event);

   if (test->verbose) {
      char *s = bson_as_json (reply, NULL);
      printf ("<--  %s\n", s);
      bson_free (s);
   }

   has_cluster_time = bson_iter_init_find (&iter, reply, "$clusterTime");
   if (test->acknowledged && !has_cluster_time) {
      fprintf (stderr, "no $clusterTime in reply to command %s\n", cmd_name);
      abort ();
   }

   if (strcmp (cmd_name, "endSessions") == 0) {
      bson_destroy (reply);
      return;
   }

   if (has_cluster_time) {
      /* like $clusterTime: {clusterTime: <timestamp>} */
      bson_iter_bson (&iter, &cluster_time);
      bson_destroy (&test->received_cluster_time);
      bson_copy_to (&cluster_time, &test->received_cluster_time);
   }

   _mongoc_array_append_vals (&test->replies, &reply, 1);

   test->n_succeeded++;
}


static void
failed (const mongoc_apm_command_failed_t *event)
{
   const char *cmd_name;
   bson_error_t error;

   session_test_t *test =
      (session_test_t *) mongoc_apm_command_failed_get_context (event);

   if (!test->verbose) {
      return;
   }

   cmd_name = mongoc_apm_command_failed_get_command_name (event);
   mongoc_apm_command_failed_get_error (event, &error);
   printf ("<--  %s: %s\n", cmd_name, error.message);
}


static void
set_session_test_callbacks (session_test_t *test)
{
   mongoc_apm_callbacks_t *callbacks;

   callbacks = mongoc_apm_callbacks_new ();
   mongoc_apm_set_command_started_cb (callbacks, started);
   mongoc_apm_set_command_succeeded_cb (callbacks, succeeded);
   mongoc_apm_set_command_failed_cb (callbacks, failed);
   mongoc_client_set_apm_callbacks (test->client, callbacks, test);

   mongoc_apm_callbacks_destroy (callbacks);
}


static session_test_t *
session_test_new (session_test_correct_t correct_client,
                  session_test_causal_t causal)
{
   session_test_t *test;
   mongoc_session_opt_t *cs_opts;
   bson_error_t error;

   test = bson_malloc0 (sizeof (session_test_t));

   test->verbose = test_framework_getenv_bool ("MONGOC_TEST_SESSION_VERBOSE");

   test->n_started = 0;
   test->expect_explicit_lsid = true;
   test->acknowledged = true;
   test->succeeded = false;
   _mongoc_array_init (&test->cmds, sizeof (bson_t *));
   _mongoc_array_init (&test->replies, sizeof (bson_t *));
   bson_init (&test->sent_cluster_time);
   bson_init (&test->received_cluster_time);
   bson_init (&test->sent_lsid);

   test->session_client = test_framework_client_new ();
   mongoc_client_set_error_api (test->session_client, 2);
   test->session_db = mongoc_client_get_database (test->session_client, "db");
   test->session_collection =
      mongoc_database_get_collection (test->session_db, "collection");

   bson_init (&test->opts);

   if (correct_client == CORRECT_CLIENT) {
      test->client = test->session_client;
      test->db = test->session_db;
      test->collection = test->session_collection;
   } else {
      /* test each function with a session from the correct client and a session
       * from the wrong client */
      test->client = test_framework_client_new ();
      mongoc_client_set_error_api (test->client, 2);
      test->wrong_cs = mongoc_client_start_session (test->client, NULL, &error);
      ASSERT_OR_PRINT (test->wrong_cs, error);
      test->db = mongoc_client_get_database (test->client, "db");
      test->collection =
         mongoc_database_get_collection (test->db, "collection");
   }

   set_session_test_callbacks (test);

   cs_opts = mongoc_session_opts_new ();
   mongoc_session_opts_set_causal_consistency (cs_opts, causal == CAUSAL);
   test->cs =
      mongoc_client_start_session (test->session_client, cs_opts, &error);
   ASSERT_OR_PRINT (test->cs, error);

   mongoc_session_opts_destroy (cs_opts);

   return test;
}


static void
check_session_returned (session_test_t *test, const bson_t *lsid)
{
   char errmsg[1000];
   match_ctx_t ctx = {errmsg, sizeof (errmsg), false /* strict numbers */};
   mongoc_server_session_t *ss;
   bool found;

   found = false;
   CDL_FOREACH (test->session_client->topology->session_pool, ss)
   {
      if (match_bson_with_ctx (&ss->lsid, lsid, false, &ctx)) {
         found = true;
         break;
      }
   }

   if (!found) {
      fprintf (stderr,
               "server session %s not returned to pool\n",
               bson_as_json (lsid, NULL));
      abort ();
   }
}

static const bson_t *
first_cmd (session_test_t *test)
{
   ASSERT_CMPSIZE_T (test->cmds.len, >, (size_t) 0);
   return _mongoc_array_index (&test->cmds, bson_t *, 0);
}


static const bson_t *
last_non_getmore_cmd (session_test_t *test)
{
   ssize_t i;
   const bson_t *cmd;

   ASSERT_CMPSIZE_T (test->cmds.len, >, (size_t) 0);

   for (i = test->replies.len - 1; i >= 0; i--) {
      cmd = _mongoc_array_index (&test->cmds, bson_t *, i);
      if (strcmp (_mongoc_get_command_name (cmd), "getMore") != 0) {
         return cmd;
      }
   }

   fprintf (stderr, "No commands besides getMore were recorded\n");
   abort ();
}


static const bson_t *
last_reply (session_test_t *test)
{
   ASSERT_CMPSIZE_T (test->replies.len, >, (size_t) 0);
   return _mongoc_array_index (&test->replies, bson_t *, test->replies.len - 1);
}


static void
clear_history (session_test_t *test)
{
   size_t i;

   for (i = 0; i < test->cmds.len; i++) {
      bson_destroy (_mongoc_array_index (&test->cmds, bson_t *, i));
   }

   for (i = 0; i < test->replies.len; i++) {
      bson_destroy (_mongoc_array_index (&test->replies, bson_t *, i));
   }

   test->cmds.len = 0;
   test->replies.len = 0;
}


static void
session_test_destroy (session_test_t *test)
{
   bson_t session_lsid;
   size_t i;

   bson_copy_to (mongoc_client_session_get_lsid (test->cs), &session_lsid);

   mongoc_client_session_destroy (test->cs);

   check_session_returned (test, &session_lsid);
   bson_destroy (&session_lsid);

   /* for implicit sessions, ensure the implicit session was returned */
   check_session_returned (test, &test->sent_lsid);

   if (test->client != test->session_client) {
      mongoc_client_session_destroy (test->wrong_cs);
      mongoc_collection_destroy (test->collection);
      mongoc_database_destroy (test->db);
      mongoc_client_destroy (test->client);
   }

   mongoc_collection_destroy (test->session_collection);
   mongoc_database_destroy (test->session_db);
   mongoc_client_destroy (test->session_client);
   bson_destroy (&test->opts);
   bson_destroy (&test->sent_cluster_time);
   bson_destroy (&test->received_cluster_time);
   bson_destroy (&test->sent_lsid);

   for (i = 0; i < test->cmds.len; i++) {
      bson_destroy (_mongoc_array_index (&test->cmds, bson_t *, i));
   }

   _mongoc_array_destroy (&test->cmds);

   for (i = 0; i < test->replies.len; i++) {
      bson_destroy (_mongoc_array_index (&test->replies, bson_t *, i));
   }

   _mongoc_array_destroy (&test->replies);

   bson_free (test);
}


static void
check_sessions_from_same_client_enforced (session_test_t *test)
{
   if (test->session_client != test->client) {
      BSON_ASSERT (!test->succeeded);
      ASSERT_ERROR_CONTAINS (test->error,
                             MONGOC_ERROR_COMMAND,
                             MONGOC_ERROR_COMMAND_INVALID_ARG,
                             "Invalid sessionId");
   }
}


static void
check_sessions_with_w0_prohibited (session_test_t *test)
{
   if (test->expect_explicit_lsid && !test->acknowledged) {
      BSON_ASSERT (!test->succeeded);
      ASSERT_ERROR_CONTAINS (test->error,
                             MONGOC_ERROR_COMMAND,
                             MONGOC_ERROR_COMMAND_INVALID_ARG,
                             "session with unacknowledged");
   }
}


static void
check_success (session_test_t *test)
{
   check_sessions_from_same_client_enforced (test);
   check_sessions_with_w0_prohibited (test);

   if (test->session_client == test->client &&
       test->expect_explicit_lsid == test->acknowledged) {
      ASSERT_OR_PRINT (test->succeeded, test->error);
   }

   if (test->succeeded) {
      ASSERT_CMPINT (test->n_started, >, 0);
      ASSERT_CMPINT (test->n_succeeded, >, 0);
   }
}


static void
check_cluster_time (session_test_t *test)
{
   const bson_t *session_time;

   session_time = mongoc_client_session_get_cluster_time (test->cs);
   BSON_ASSERT (session_time); /* should be set during handshake */

   /* fail if cluster_time_greater logs an error */
   capture_logs (true);
   if (_mongoc_cluster_time_greater (&test->received_cluster_time,
                                     session_time)) {
      fprintf (stderr, "client session's cluster time is outdated\n");
      abort ();
   }

   ASSERT_NO_CAPTURED_LOGS ("_mongoc_cluster_time_greater");
   capture_logs (false);
}


typedef void (*session_test_fn_t) (session_test_t *);


/*
 * the following tests check session logic for a variety of operations. most of
 * the asserts are in the APM started/succeeded/failed callbacks above
 */

/* use the same client for the session and the operation, expect success */
static void
_test_explicit_session_lsid (session_test_fn_t test_fn)
{
   session_test_t *test;
   bson_error_t error;
   int64_t start;

   test = session_test_new (CORRECT_CLIENT, NOT_CAUSAL);
   ASSERT_CMPINT64 (test->cs->server_session->last_used_usec, ==, (int64_t) -1);
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);

   start = bson_get_monotonic_time ();
   test_fn (test);
   check_success (test);
   ASSERT_CMPINT (test->n_started, >, 0);
   ASSERT_CMPINT (test->n_succeeded, >, 0);
   check_cluster_time (test);
   ASSERT_CMPINT64 (test->cs->server_session->last_used_usec, >=, start);
   session_test_destroy (test);
}


/* use a session from the wrong client, expect failure. this is the
 * "session argument is for right client" test from Driver Sessions Spec */
static void
_test_session_from_wrong_client (session_test_fn_t test_fn)
{
   session_test_t *test;
   bson_error_t error;

   test = session_test_new (INCORRECT_CLIENT, NOT_CAUSAL);
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);

   test_fn (test);
   check_success (test);
   mongoc_collection_drop_with_opts (test->session_collection, NULL, NULL);
   session_test_destroy (test);
}


/* implicit session - all commands should use an internally-acquired lsid */
static void
_test_implicit_session_lsid (session_test_fn_t test_fn)
{
   session_test_t *test;
   int64_t start;

   test = session_test_new (CORRECT_CLIENT, NOT_CAUSAL);
   test->expect_explicit_lsid = false;
   start = bson_get_monotonic_time ();
   test_fn (test);
   check_success (test);
   mongoc_collection_drop_with_opts (test->session_collection, NULL, NULL);
   BSON_ASSERT (test->client->topology->session_pool);
   ASSERT_CMPINT64 (
      test->client->topology->session_pool->last_used_usec, >=, start);
   session_test_destroy (test);
}


typedef struct {
   uint32_t t;
   uint32_t i;
} op_time_t;


static void
parse_read_concern_time (const bson_t *cmd, op_time_t *op_time)
{
   bson_iter_t iter;
   bson_iter_t rc;

   BSON_ASSERT (bson_iter_init_find (&iter, cmd, "readConcern"));
   BSON_ASSERT (bson_iter_recurse (&iter, &rc));
   BSON_ASSERT (bson_iter_find (&rc, "afterClusterTime"));
   BSON_ASSERT (BSON_ITER_HOLDS_TIMESTAMP (&rc));
   bson_iter_timestamp (&rc, &op_time->t, &op_time->i);
}


static void
parse_reply_time (const bson_t *reply, op_time_t *op_time)
{
   bson_iter_t iter;

   BSON_ASSERT (bson_iter_init_find (&iter, reply, "operationTime"));
   BSON_ASSERT (BSON_ITER_HOLDS_TIMESTAMP (&iter));
   bson_iter_timestamp (&iter, &op_time->t, &op_time->i);
}


#define ASSERT_OP_TIMES_EQUAL(_a, _b)                             \
   if ((_a).t != (_b).t || (_a).i != (_b).i) {                    \
      fprintf (stderr,                                            \
               #_a " (%d, %d) does not match " #_b " (%d, %d)\n", \
               (_a).t,                                            \
               (_a).i,                                            \
               (_b).t,                                            \
               (_b).i);                                           \
      abort ();                                                   \
   }


static void
_test_causal_consistency (session_test_fn_t test_fn, bool allow_read_concern)
{
   session_test_t *test;
   op_time_t session_time, read_concern_time, reply_time;
   bson_error_t error;
   const bson_t *cmd;
   size_t i;

   /*
    * first causal exchange: don't send readConcern, receive opTime
    */
   test = session_test_new (CORRECT_CLIENT, CAUSAL);
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);

   test_fn (test);
   check_success (test);
   BSON_ASSERT (!bson_has_field (first_cmd (test), "readConcern"));
   mongoc_client_session_get_operation_time (
      test->cs, &session_time.t, &session_time.i);
   BSON_ASSERT (session_time.t != 0);
   parse_reply_time (last_reply (test), &reply_time);
   ASSERT_OP_TIMES_EQUAL (session_time, reply_time);

   /*
    * second exchange: send previous opTime and receive an opTime.
    * send readConcern if this function supports readConcern, like
    * mongoc_collection_find_with_opts or mongoc_client_read_command_with_opts.
    * don't send readConcern for generic command helpers like
    * mongoc_client_command_with_opts or mongoc_client_command.
    */
   clear_history (test);
   test_fn (test);
   check_success (test);

   if (allow_read_concern) {
      parse_read_concern_time (first_cmd (test), &read_concern_time);
      ASSERT_OP_TIMES_EQUAL (reply_time, read_concern_time);
      mongoc_client_session_get_operation_time (
         test->cs, &session_time.t, &session_time.i);
      BSON_ASSERT (session_time.t != 0);
      parse_reply_time (last_reply (test), &reply_time);
      ASSERT_OP_TIMES_EQUAL (session_time, reply_time);
   } else {
      /* readConcern prohibited */
      for (i = 0; i < test->cmds.len; i++) {
         cmd = _mongoc_array_index (&test->cmds, bson_t *, i);
         if (bson_has_field (cmd, "readConcern")) {
            fprintf (stderr,
                     "Command should not have included readConcern: %s\n",
                     bson_as_json (cmd, NULL));
            abort ();
         }
      }
   }

   session_test_destroy (test);
}


static void
_run_session_test (session_test_fn_t test_fn, bool allow_read_concern)
{
   _test_explicit_session_lsid (test_fn);
   _test_session_from_wrong_client (test_fn);
   _test_implicit_session_lsid (test_fn);
   _test_causal_consistency (test_fn, allow_read_concern);
}


static void
run_session_test (void *ctx)
{
   _run_session_test ((session_test_fn_t) ctx, true);
}


/* test a command that doesn't allow readConcern, and therefore isn't causal */
static void
run_session_test_no_rc (void *ctx)
{
   _run_session_test ((session_test_fn_t) ctx, false);
}


/* skip _test_session_from_wrong_client, which would abort with bulk op */
static void
run_session_test_bulk_operation (void *ctx)
{
   _test_explicit_session_lsid ((session_test_fn_t) ctx);
   _test_implicit_session_lsid ((session_test_fn_t) ctx);
   _test_causal_consistency ((session_test_fn_t) ctx, false /* read concern */);
}


static void
insert_10_docs (session_test_t *test)
{
   mongoc_bulk_operation_t *bulk;
   bson_error_t error;
   int i;
   bool r;

   /* disable callbacks, we're not testing insert's lsid */
   mongoc_client_set_apm_callbacks (test->session_client, NULL, NULL);
   bulk = mongoc_collection_create_bulk_operation_with_opts (
      test->session_collection, NULL);

   for (i = 0; i < 10; i++) {
      mongoc_bulk_operation_insert (bulk, tmp_bson ("{}"));
   }

   r = (bool) mongoc_bulk_operation_execute (bulk, NULL, &error);
   ASSERT_OR_PRINT (r, error);

   mongoc_bulk_operation_destroy (bulk);

   set_session_test_callbacks (test);
}


static void
test_cmd (session_test_t *test)
{
   test->succeeded =
      mongoc_client_command_with_opts (test->client,
                                       "db",
                                       tmp_bson ("{'listCollections': 1}"),
                                       NULL,
                                       &test->opts,
                                       NULL,
                                       &test->error);
}


static void
test_read_cmd (session_test_t *test)
{
   test->succeeded =
      mongoc_client_read_command_with_opts (test->client,
                                            "db",
                                            tmp_bson ("{'listCollections': 1}"),
                                            NULL,
                                            &test->opts,
                                            NULL,
                                            &test->error);
}


static void
test_write_cmd (session_test_t *test)
{
   bson_t *cmd =
      tmp_bson ("{'delete': 'collection', 'deletes': [{'q': {}, 'limit': 1}]}");

   test->succeeded = mongoc_client_write_command_with_opts (
      test->client, "db", cmd, &test->opts, NULL, &test->error);
}


static void
test_read_write_cmd (session_test_t *test)
{
   bson_t *cmd = tmp_bson ("{"
                           "   'aggregate': 'collection',"
                           "   'cursor': {},"
                           "   'pipeline': [{'$out': 'collection2'}]"
                           "}");

   test->succeeded = mongoc_client_read_write_command_with_opts (
      test->client, "db", cmd, NULL, &test->opts, NULL, &test->error);
}


static void
test_db_cmd (session_test_t *test)
{
   test->succeeded =
      mongoc_database_command_with_opts (test->db,
                                         tmp_bson ("{'listCollections': 1}"),
                                         NULL,
                                         &test->opts,
                                         NULL,
                                         &test->error);
}


static void
test_count (session_test_t *test)
{
   test->succeeded =
      (-1 != mongoc_collection_count_with_opts (test->collection,
                                                MONGOC_QUERY_NONE,
                                                NULL,
                                                0,
                                                0,
                                                &test->opts,
                                                NULL,
                                                &test->error));
}


static void
test_cursor (session_test_t *test)
{
   mongoc_cursor_t *cursor;
   const bson_t *doc;

   /* ensure multiple batches */
   insert_10_docs (test);

   cursor = mongoc_collection_find_with_opts (
      test->collection, tmp_bson ("{}"), &test->opts, NULL);

   mongoc_cursor_set_batch_size (cursor, 2);
   while (mongoc_cursor_next (cursor, &doc)) {
   }

   test->succeeded = !mongoc_cursor_error (cursor, &test->error);

   mongoc_cursor_destroy (cursor);
}


static void
test_drop (session_test_t *test)
{
   /* create the collection so that "drop" can succeed */
   insert_10_docs (test);

   test->succeeded = mongoc_collection_drop_with_opts (
      test->collection, &test->opts, &test->error);
}


static void
test_drop_index (session_test_t *test)
{
   bson_error_t error;
   bool r;

   /* create the index so that "dropIndexes" can succeed */
   r = mongoc_database_write_command_with_opts (
      test->session_db,
      tmp_bson ("{'createIndexes': '%s',"
                " 'indexes': [{'key': {'a': 1}, 'name': 'foo'}]}",
                test->session_collection->collection),
      &test->opts,
      NULL,
      &error);

   ASSERT_OR_PRINT (r, error);

   test->succeeded = mongoc_collection_drop_index_with_opts (
      test->collection, "foo", &test->opts, &test->error);
}

static void
test_create_index (session_test_t *test)
{
   BEGIN_IGNORE_DEPRECATIONS
   test->succeeded =
      mongoc_collection_create_index_with_opts (test->collection,
                                                tmp_bson ("{'a': 1}"),
                                                NULL,
                                                &test->opts,
                                                NULL,
                                                &test->error);
   END_IGNORE_DEPRECATIONS
}

static void
test_replace_one (session_test_t *test)
{
   test->succeeded = mongoc_collection_replace_one (test->collection,
                                                    tmp_bson ("{}"),
                                                    tmp_bson ("{}"),
                                                    &test->opts,
                                                    NULL,
                                                    &test->error);
}

static void
test_update_one (session_test_t *test)
{
   test->succeeded =
      mongoc_collection_update_one (test->collection,
                                    tmp_bson ("{}"),
                                    tmp_bson ("{'$set': {'x': 1}}"),
                                    &test->opts,
                                    NULL,
                                    &test->error);
}

static void
test_update_many (session_test_t *test)
{
   test->succeeded =
      mongoc_collection_update_many (test->collection,
                                     tmp_bson ("{}"),
                                     tmp_bson ("{'$set': {'x': 1}}"),
                                     &test->opts,
                                     NULL,
                                     &test->error);
}

static void
test_insert_one (session_test_t *test)
{
   test->succeeded = mongoc_collection_insert_one (
      test->collection, tmp_bson ("{}"), &test->opts, NULL, &test->error);
}

static void
test_insert_many (session_test_t *test)
{
   bson_t *docs[2] = {tmp_bson ("{}"), tmp_bson ("{}")};
   test->succeeded = mongoc_collection_insert_many (test->collection,
                                                    (const bson_t **) docs,
                                                    2,
                                                    &test->opts,
                                                    NULL,
                                                    &test->error);
}

static void
test_delete_one (session_test_t *test)
{
   test->succeeded = mongoc_collection_delete_one (
      test->collection, tmp_bson ("{}"), &test->opts, NULL, &test->error);
}

static void
test_delete_many (session_test_t *test)
{
   test->succeeded = mongoc_collection_delete_many (
      test->collection, tmp_bson ("{}"), &test->opts, NULL, &test->error);
}

static void
test_rename (session_test_t *test)
{
   mongoc_collection_t *collection;

   /* ensure "rename" can succeed */
   insert_10_docs (test);

   /* mongoc_collection_rename_with_opts mutates the struct! */
   collection = mongoc_collection_copy (test->collection);
   test->succeeded = mongoc_collection_rename_with_opts (
      collection, "db", "newname", true, &test->opts, &test->error);

   mongoc_collection_destroy (collection);
}

static void
test_fam (session_test_t *test)
{
   mongoc_find_and_modify_opts_t *fam_opts;

   fam_opts = mongoc_find_and_modify_opts_new ();
   mongoc_find_and_modify_opts_set_update (fam_opts,
                                           tmp_bson ("{'$set': {'x': 1}}"));
   BSON_ASSERT (mongoc_find_and_modify_opts_append (fam_opts, &test->opts));
   test->succeeded = mongoc_collection_find_and_modify_with_opts (
      test->collection, tmp_bson ("{}"), fam_opts, NULL, &test->error);

   mongoc_find_and_modify_opts_destroy (fam_opts);
}

static void
test_db_drop (session_test_t *test)
{
   test->succeeded =
      mongoc_database_drop_with_opts (test->db, &test->opts, &test->error);
}

static void
test_gridfs_find (session_test_t *test)
{
   mongoc_gridfs_t *gfs;
   bson_error_t error;
   mongoc_gridfs_file_list_t *list;
   mongoc_gridfs_file_t *f;

   /* work around lack of mongoc_client_get_gridfs_with_opts for now, can't yet
    * include lsid with the GridFS createIndexes command */
   mongoc_client_set_apm_callbacks (test->client, NULL, NULL);
   gfs = mongoc_client_get_gridfs (test->client, "test", NULL, &error);
   ASSERT_OR_PRINT (gfs, error);
   set_session_test_callbacks (test);
   list = mongoc_gridfs_find_with_opts (gfs, tmp_bson ("{}"), &test->opts);
   f = mongoc_gridfs_file_list_next (list);
   test->succeeded = !mongoc_gridfs_file_list_error (list, &test->error);

   if (f) {
      mongoc_gridfs_file_destroy (f);
   }

   mongoc_gridfs_file_list_destroy (list);
   mongoc_gridfs_destroy (gfs);
}

static void
test_gridfs_find_one (session_test_t *test)
{
   mongoc_gridfs_t *gfs;
   bson_error_t error;
   mongoc_gridfs_file_t *f;

   /* work around lack of mongoc_client_get_gridfs_with_opts for now, can't yet
    * include lsid with the GridFS createIndexes command */
   mongoc_client_set_apm_callbacks (test->client, NULL, NULL);
   gfs = mongoc_client_get_gridfs (test->client, "test", NULL, &error);
   ASSERT_OR_PRINT (gfs, error);
   set_session_test_callbacks (test);
   f = mongoc_gridfs_find_one_with_opts (
      gfs, tmp_bson ("{}"), &test->opts, &test->error);

   test->succeeded = test->error.domain == 0;

   if (f) {
      mongoc_gridfs_file_destroy (f);
   }

   mongoc_gridfs_destroy (gfs);
}


static void
test_watch (session_test_t *test)
{
   mongoc_change_stream_t *change_stream;

   insert_10_docs (test);
   change_stream =
      mongoc_collection_watch (test->collection, tmp_bson ("{}"), &test->opts);

   test->succeeded =
      !mongoc_change_stream_error_document (change_stream, &test->error, NULL);
   mongoc_change_stream_destroy (change_stream);
}


static void
test_aggregate (session_test_t *test)
{
   bson_t opts;
   mongoc_cursor_t *cursor;
   const bson_t *doc;

   /* ensure multiple batches */
   insert_10_docs (test);

   bson_copy_to (&test->opts, &opts);
   BSON_APPEND_INT32 (&opts, "batchSize", 2);

   cursor = mongoc_collection_aggregate (
      test->collection, MONGOC_QUERY_NONE, tmp_bson ("{}"), &opts, NULL);

   while (mongoc_cursor_next (cursor, &doc)) {
   }

   test->succeeded = !mongoc_cursor_error (cursor, &test->error);

   mongoc_cursor_destroy (cursor);
   bson_destroy (&opts);
}


static void
test_create (session_test_t *test)
{
   mongoc_collection_t *collection;

   /* ensure "create" can succeed */
   mongoc_database_write_command_with_opts (test->session_db,
                                            tmp_bson ("{'drop': 'newname'}"),
                                            &test->opts,
                                            NULL,
                                            NULL);

   collection = mongoc_database_create_collection (
      test->db, "newname", &test->opts, &test->error);

   test->succeeded = (collection != NULL);

   if (collection) {
      mongoc_collection_destroy (collection);
   }
}


static void
test_database_names (session_test_t *test)
{
   char **names;

   names = mongoc_client_get_database_names_with_opts (
      test->client, &test->opts, &test->error);

   test->succeeded = (names != NULL);

   if (names) {
      bson_strfreev (names);
   }
}


static void
test_find_databases (session_test_t *test)
{
   mongoc_cursor_t *cursor;
   const bson_t *doc;

   cursor = mongoc_client_find_databases_with_opts (test->client, &test->opts);

   while (mongoc_cursor_next (cursor, &doc)) {
   }

   test->succeeded = !mongoc_cursor_error (cursor, &test->error);
   mongoc_cursor_destroy (cursor);
}


static void
test_find_collections (session_test_t *test)
{
   mongoc_cursor_t *cursor;
   const bson_t *doc;

   cursor = mongoc_database_find_collections_with_opts (test->db, &test->opts);

   while (mongoc_cursor_next (cursor, &doc)) {
   }

   test->succeeded = !mongoc_cursor_error (cursor, &test->error);
   mongoc_cursor_destroy (cursor);
}


static void
test_collection_names (session_test_t *test)
{
   char **strv;

   strv = mongoc_database_get_collection_names_with_opts (
      test->db, &test->opts, &test->error);
   test->succeeded = (strv != NULL);
   bson_strfreev (strv);
}


static void
test_find_indexes (session_test_t *test)
{
   mongoc_cursor_t *cursor;
   const bson_t *doc;

   /* ensure the collection exists so the listIndexes command succeeds */
   insert_10_docs (test);

   cursor =
      mongoc_collection_find_indexes_with_opts (test->collection, &test->opts);

   while (mongoc_cursor_next (cursor, &doc)) {
   }

   test->succeeded = !mongoc_cursor_error (cursor, &test->error);
   mongoc_cursor_destroy (cursor);
}


static void
_test_bulk (session_test_t *test, mongoc_bulk_operation_t *bulk)
{
   uint32_t i;

   test->succeeded = mongoc_bulk_operation_insert_with_opts (
      bulk, tmp_bson ("{}"), NULL, &test->error);

   check_sessions_from_same_client_enforced (test);

   test->succeeded = mongoc_bulk_operation_update_one_with_opts (
      bulk,
      tmp_bson ("{}"),
      tmp_bson ("{'$set': {'x': 1}}"),
      NULL,
      &test->error);
   check_sessions_from_same_client_enforced (test);

   test->succeeded = mongoc_bulk_operation_remove_one_with_opts (
      bulk, tmp_bson ("{}"), NULL, &test->error);
   check_sessions_from_same_client_enforced (test);

   i = mongoc_bulk_operation_execute (bulk, NULL, &test->error);
   test->succeeded = (i != 0);
   check_sessions_with_w0_prohibited (test);

   mongoc_bulk_operation_destroy (bulk);
}



/* test the standard mongoc_collection_create_bulk_operation_with_opts */
static void
test_bulk (session_test_t *test)
{
   mongoc_bulk_operation_t *bulk;

   bulk = mongoc_collection_create_bulk_operation_with_opts (test->collection,
                                                             &test->opts);

   _test_bulk (test, bulk);
}


/* instead of the standard mongoc_collection_create_bulk_operation_with_opts,
 * test a quirky way of setting the client session on an existing bulk */
static void
test_bulk_set_session (session_test_t *test)
{
   mongoc_bulk_operation_t *bulk;
   bson_iter_t iter;
   mongoc_client_session_t *cs;
   bson_error_t error;
   bool r;

   bulk = mongoc_bulk_operation_new (true /* ordered */);
   mongoc_bulk_operation_set_client (bulk, test->client);
   mongoc_bulk_operation_set_database (bulk,
                                       mongoc_database_get_name (test->db));

   mongoc_bulk_operation_set_collection (
      bulk, mongoc_collection_get_name (test->collection));

   if (bson_iter_init_find (&iter, &test->opts, "sessionId")) {
      r = _mongoc_client_session_from_iter (
         test->session_client, &iter, &cs, &error);

      ASSERT_OR_PRINT (r, error);
      mongoc_bulk_operation_set_client_session (bulk, cs);
   }

   _test_bulk (test, bulk);
}


/* like test_bulk_set_session, but set session first, then client */
static void
test_bulk_set_client (session_test_t *test)
{
   mongoc_bulk_operation_t *bulk;
   bson_iter_t iter;
   mongoc_client_session_t *cs;
   bson_error_t error;
   bool r;

   bulk = mongoc_bulk_operation_new (true /* ordered */);

   if (bson_iter_init_find (&iter, &test->opts, "sessionId")) {
      r = _mongoc_client_session_from_iter (
         test->session_client, &iter, &cs, &error);

      ASSERT_OR_PRINT (r, error);
      mongoc_bulk_operation_set_client_session (bulk, cs);
   }

   mongoc_bulk_operation_set_client (bulk, test->client);
   mongoc_bulk_operation_set_database (bulk,
                                       mongoc_database_get_name (test->db));

   mongoc_bulk_operation_set_collection (
      bulk, mongoc_collection_get_name (test->collection));

   _test_bulk (test, bulk);
}


#define ASSERT_POOL_SIZE(_topology, _expected_size)             \
   do {                                                         \
      const mongoc_server_session_t *_tmp;                      \
      int _n_sessions;                                          \
      CDL_COUNT ((_topology)->session_pool, _tmp, _n_sessions); \
      ASSERT_CMPINT (_n_sessions, ==, (int) (_expected_size));  \
   } while (0)


static void
test_cursor_implicit_session (void *ctx)
{
   session_test_t *test;
   mongoc_topology_t *topology;
   mongoc_cursor_t *cursor;
   const bson_t *doc;
   mongoc_client_session_t *cs;
   bson_t find_lsid;
   bson_error_t error;

   test = session_test_new (CORRECT_CLIENT, NOT_CAUSAL);
   test->expect_explicit_lsid = false;
   topology = test->client->topology;
   cs = mongoc_client_start_session (test->client, NULL, &error);
   ASSERT_OR_PRINT (cs, error);

   mongoc_collection_drop_with_opts (test->session_collection, NULL, NULL);
   insert_10_docs (test);
   cursor = mongoc_collection_find_with_opts (
      test->collection, tmp_bson ("{}"), &test->opts, NULL);

   BSON_ASSERT (!cursor->client_session);
   mongoc_cursor_set_batch_size (cursor, 2);

   /* start the cursor. it makes an implicit session & sends it with "find" */
   BSON_ASSERT (mongoc_cursor_next (cursor, &doc));
   BSON_ASSERT (cursor->client_session);
   BSON_ASSERT (!cursor->explicit_session);
   bson_copy_to (&cursor->client_session->server_session->lsid, &find_lsid);
   ASSERT_POOL_SIZE (topology, 0);
   ASSERT_SESSIONS_MATCH (&test->sent_lsid, &find_lsid);

   /* push a new server session into the pool */
   mongoc_client_session_destroy (cs);
   ASSERT_POOL_SIZE (topology, 1);
   ASSERT_SESSIONS_DIFFER (&find_lsid, &topology->session_pool->lsid);

   /* "getMore" uses the same lsid as "find" did */
   bson_reinit (&test->sent_lsid);
   ASSERT_CURSOR_COUNT (9, cursor);
   ASSERT_SESSIONS_MATCH (&test->sent_lsid, &find_lsid);
   ASSERT_OR_PRINT (!mongoc_cursor_error (cursor, &error), error);

   /* lsid returned after last batch, doesn't wait for mongoc_cursor_destroy */
   check_session_returned (test, &find_lsid);
   ASSERT_POOL_SIZE (topology, 2);

   bson_destroy (&find_lsid);
   mongoc_cursor_destroy (cursor);
   session_test_destroy (test);
}


static void
test_change_stream_implicit_session (void *ctx)
{
   session_test_t *test;
   mongoc_topology_t *topology;
   mongoc_client_session_t *cs;
   bson_error_t error;
   mongoc_change_stream_t *change_stream;
   bson_t pipeline = BSON_INITIALIZER;
   const bson_t *doc;
   bson_t aggregate_lsid;

   test = session_test_new (CORRECT_CLIENT, NOT_CAUSAL);
   test->expect_explicit_lsid = false;
   topology = test->client->topology;
   cs = mongoc_client_start_session (test->client, NULL, &error);
   ASSERT_OR_PRINT (cs, error);
   change_stream =
      mongoc_collection_watch (test->session_collection, &pipeline, NULL);
   bson_destroy (&pipeline);
   bson_copy_to (&test->sent_lsid, &aggregate_lsid);
   ASSERT_POOL_SIZE (topology, 0);
   BSON_ASSERT (change_stream->implicit_session);

   /* push a new server session into the pool */
   mongoc_client_session_destroy (cs);
   ASSERT_POOL_SIZE (topology, 1);
   ASSERT_SESSIONS_DIFFER (&aggregate_lsid, &topology->session_pool->lsid);

   /* "getMore" uses the same lsid as "aggregate" did */
   bson_reinit (&test->sent_lsid);
   mongoc_change_stream_next (change_stream, &doc);
   ASSERT_SESSIONS_MATCH (
      &test->sent_lsid, &change_stream->implicit_session->server_session->lsid);
   ASSERT_SESSIONS_MATCH (
      &test->sent_lsid,
      &change_stream->cursor->client_session->server_session->lsid);
   ASSERT_SESSIONS_MATCH (&test->sent_lsid, &aggregate_lsid);
   ASSERT_OR_PRINT (
      !mongoc_change_stream_error_document (change_stream, &error, NULL),
      error);
   bson_destroy (&aggregate_lsid);
   mongoc_change_stream_destroy (change_stream);
   session_test_destroy (test);
}


static void
test_cmd_error (void *ctx)
{
   session_test_t *test;
   bson_error_t error;

   test = session_test_new (CORRECT_CLIENT, CAUSAL);

   /*
    * explicit session. command error still updates operation time
    */
   test->expect_explicit_lsid = true;
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);

   BSON_ASSERT (test->cs->operation_timestamp == 0);
   BSON_ASSERT (!mongoc_client_command_with_opts (test->session_client,
                                                  "db",
                                                  tmp_bson ("{'bad': 1}"),
                                                  NULL,
                                                  &test->opts,
                                                  NULL,
                                                  NULL));

   BSON_ASSERT (test->cs->operation_timestamp != 0);

   session_test_destroy (test);
}


static void
test_read_concern (void *ctx)
{
   session_test_t *test;
   mongoc_read_concern_t *rc;
   mongoc_session_opt_t *cs_opts;
   bson_error_t error;

   test = session_test_new (CORRECT_CLIENT, CAUSAL);
   test->expect_explicit_lsid = true;
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);

   /* first exchange sets session's operationTime */
   test_read_cmd (test);
   check_success (test);
   BSON_ASSERT (!bson_has_field (last_non_getmore_cmd (test), "readConcern"));

   /*
    * default: no explicit read concern, driver sends afterClusterTime
    */
   test_read_cmd (test);
   check_success (test);
   ASSERT_MATCH (last_non_getmore_cmd (test),
                 "{"
                 "   'readConcern': {"
                 "      'level': {'$exists': false},"
                 "      'afterClusterTime': {'$exists': true}"
                 "   }"
                 "}");

   /*
    * explicit read concern
    */
   rc = mongoc_read_concern_new ();
   mongoc_read_concern_set_level (rc, MONGOC_READ_CONCERN_LEVEL_LOCAL);
   BSON_ASSERT (mongoc_read_concern_append (rc, &test->opts));
   test_read_cmd (test);
   check_success (test);
   ASSERT_MATCH (last_non_getmore_cmd (test),
                 "{"
                 "   'readConcern': {"
                 "      'level': 'local',"
                 "      'afterClusterTime': {'$exists': true}"
                 "   }"
                 "}");

   /*
    * explicit read concern, not causal
    */
   cs_opts = mongoc_session_opts_new ();
   mongoc_session_opts_set_causal_consistency (cs_opts, false);
   mongoc_client_session_destroy (test->cs);
   test->cs = mongoc_client_start_session (test->client, cs_opts, &error);
   ASSERT_OR_PRINT (test->cs, error);
   bson_reinit (&test->opts);
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);
   BSON_ASSERT (mongoc_read_concern_append (rc, &test->opts));
   /* set new session's operationTime */
   test_read_cmd (test);
   check_success (test);
   ASSERT_CMPUINT32 (test->cs->operation_timestamp, >, (uint32_t) 0);
   /* afterClusterTime is not sent */
   test_read_cmd (test);
   check_success (test);
   ASSERT_MATCH (last_non_getmore_cmd (test),
                 "{"
                 "   'readConcern': {"
                 "      'level': 'local',"
                 "      'afterClusterTime': {'$exists': false}"
                 "   }"
                 "}");

   /*
    * no read concern, not causal
    */
   bson_reinit (&test->opts);
   ASSERT_OR_PRINT (
      mongoc_client_session_append (test->cs, &test->opts, &error), error);
   /* afterClusterTime is not sent */
   test_read_cmd (test);
   check_success (test);
   ASSERT_MATCH (last_non_getmore_cmd (test),
                 "{'readConcern': {'$exists': false}}");

   mongoc_session_opts_destroy (cs_opts);
   mongoc_read_concern_destroy (rc);
   session_test_destroy (test);
}


static void
_test_unacknowledged (session_test_fn_t test_fn,
                      bool explicit_cs,
                      bool inherit_wc)
{
   session_test_t *test;
   mongoc_write_concern_t *wc;
   bson_error_t error;

   /* The following tests assert that unacknowledged command does not set the
    * operationTime. Additionally, the "started" APM callback asserts that the
    * command does not include an lsid. */
   test = session_test_new (CORRECT_CLIENT, CAUSAL);
   test->expect_explicit_lsid = explicit_cs;
   test->acknowledged = false;

   wc = mongoc_write_concern_new ();
   mongoc_write_concern_set_w (wc, 0);

   if (explicit_cs) {
      ASSERT_OR_PRINT (
         mongoc_client_session_append (test->cs, &test->opts, &error), error);
   }

   if (inherit_wc) {
      mongoc_client_set_write_concern (test->client, wc);
      mongoc_database_set_write_concern (test->db, wc);
      mongoc_collection_set_write_concern (test->collection, wc);
   } else {
      BSON_ASSERT (mongoc_write_concern_append_bad (wc, &test->opts));
   }

   test_fn (test);
   check_success (test);

   if (test->succeeded) {
      ASSERT_MATCH (last_non_getmore_cmd (test), "{'writeConcern': {'w': 0}}");
      ASSERT_CMPUINT32 (test->cs->operation_timestamp, ==, (uint32_t) 0);
   }

   mongoc_write_concern_destroy (wc);
   session_test_destroy (test);
}


static void
test_unacknowledged_explicit_cs_inherit_wc (void *ctx)
{
   _test_unacknowledged ((session_test_fn_t) ctx, true, true);
}


static void
test_unacknowledged_implicit_cs_explicit_wc (void *ctx)
{
   _test_unacknowledged ((session_test_fn_t) ctx, true, false);
}


static void
test_unacknowledged_implicit_cs_inherit_wc (void *ctx)
{
   _test_unacknowledged ((session_test_fn_t) ctx, false, true);
}


static void
test_unacknowledged_explicit_cs_explicit_wc (void *ctx)
{
   _test_unacknowledged ((session_test_fn_t) ctx, false, false);
}


#define add_session_test(_suite, _name, _test_fn, _allow_read_concern) \
   TestSuite_AddFull (_suite,                                          \
                      _name,                                           \
                      (_allow_read_concern) ? run_session_test         \
                                            : run_session_test_no_rc,  \
                      NULL,                                            \
                      (void *) (_test_fn),                             \
                      test_framework_skip_if_no_cluster_time,          \
                      test_framework_skip_if_no_crypto)

#define add_session_test_wc(_suite, _name, _test_fn, _allow_read_concern, ...) \
   TestSuite_AddFull (_suite,                                                  \
                      _name,                                                   \
                      (_allow_read_concern) ? run_session_test                 \
                                            : run_session_test_no_rc,          \
                      NULL,                                                    \
                      (void *) (_test_fn),                                     \
                      test_framework_skip_if_no_cluster_time,                  \
                      test_framework_skip_if_no_crypto,                        \
                      __VA_ARGS__)

#define add_unacknowledged_test(                                        \
   _suite, _name, _test_fn, _explicit_cs, _inherit_wc)                  \
   TestSuite_AddFull (                                                  \
      _suite,                                                           \
      _name,                                                            \
      (_explicit_cs)                                                    \
         ? (_inherit_wc ? test_unacknowledged_explicit_cs_inherit_wc    \
                        : test_unacknowledged_implicit_cs_explicit_wc)  \
         : (_inherit_wc ? test_unacknowledged_implicit_cs_inherit_wc    \
                        : test_unacknowledged_explicit_cs_explicit_wc), \
      NULL,                                                             \
      (void *) (_test_fn),                                              \
      test_framework_skip_if_no_cluster_time,                           \
      test_framework_skip_if_no_crypto)


void
test_session_install (TestSuite *suite)
{
   TestSuite_Add (suite, "/Session/opts/clone", test_session_opts_clone);
   TestSuite_AddFull (suite,
                      "/Session/no_crypto",
                      test_session_no_crypto,
                      NULL,
                      NULL,
                      TestSuite_CheckLive,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_crypto);
   TestSuite_AddFull (suite,
                      "/Session/lifo/single",
                      test_session_pool_lifo_single,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/lifo/pooled",
                      test_session_pool_lifo_pooled,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/timeout/single",
                      test_session_pool_timeout_single,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_slow);
   TestSuite_AddFull (suite,
                      "/Session/timeout/pooled",
                      test_session_pool_timeout_pooled,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_slow);
   TestSuite_AddFull (suite,
                      "/Session/reap/single",
                      test_session_pool_reap_single,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_slow);
   TestSuite_AddFull (suite,
                      "/Session/reap/pooled",
                      test_session_pool_reap_pooled,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_slow);
   TestSuite_AddFull (suite,
                      "/Session/id_bad",
                      test_session_id_bad,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_sessions,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/supported/single",
                      test_session_supported_single,
                      NULL,
                      NULL,
                      TestSuite_CheckLive,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/supported/pooled",
                      test_session_supported_pooled,
                      NULL,
                      NULL,
                      TestSuite_CheckLive,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddMockServerTest (suite,
                                "/Session/end/mock/single",
                                test_mock_end_sessions_single,
                                test_framework_skip_if_no_crypto);
   TestSuite_AddMockServerTest (suite,
                                "/Session/end/mock/pooled",
                                test_mock_end_sessions_pooled,
                                test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/end/single",
                      test_end_sessions_single,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_max_wire_version_less_than_6);
   TestSuite_AddFull (suite,
                      "/Session/end/pooled",
                      test_end_sessions_pooled,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_max_wire_version_less_than_6);
   TestSuite_AddFull (suite,
                      "/Session/end/many/single",
                      test_end_sessions_many_single,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_max_wire_version_less_than_6);
   TestSuite_AddFull (suite,
                      "/Session/end/many/pooled",
                      test_end_sessions_many_pooled,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_max_wire_version_less_than_6);
   TestSuite_AddFull (suite,
                      "/Session/advance_cluster_time",
                      test_session_advance_cluster_time,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_no_sessions);
   TestSuite_AddFull (suite,
                      "/Session/advance_operation_time",
                      test_session_advance_operation_time,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_crypto,
                      test_framework_skip_if_no_sessions);

   /* "true" is for tests that expect readConcern: afterClusterTime for causally
    * consistent sessions, "false" is for tests that prohibit readConcern */
   add_session_test (suite, "/Session/cmd", test_cmd, false);
   add_session_test (suite, "/Session/read_cmd", test_read_cmd, true);
   add_session_test (suite, "/Session/write_cmd", test_write_cmd, false);
   add_session_test (
      suite, "/Session/read_write_cmd", test_read_write_cmd, true);
   add_session_test (suite, "/Session/db_cmd", test_db_cmd, false);
   add_session_test (suite, "/Session/count", test_count, true);
   add_session_test (suite, "/Session/cursor", test_cursor, true);
   add_session_test (suite, "/Session/drop", test_drop, false);
   add_session_test (suite, "/Session/drop_index", test_drop_index, false);
   add_session_test (suite, "/Session/create_index", test_create_index, false);
   add_session_test (suite, "/Session/replace_one", test_replace_one, false);
   add_session_test (suite, "/Session/update_one", test_update_one, false);
   add_session_test (suite, "/Session/update_many", test_update_many, false);
   add_session_test (suite, "/Session/insert_one", test_insert_one, false);
   add_session_test (suite, "/Session/insert_many", test_insert_many, false);
   add_session_test (suite, "/Session/delete_one", test_delete_one, false);
   add_session_test (suite, "/Session/delete_many", test_delete_many, false);
   add_session_test (suite, "/Session/rename", test_rename, false);
   add_session_test (suite, "/Session/fam", test_fam, true);
   add_session_test (suite, "/Session/db_drop", test_db_drop, false);
   add_session_test (suite, "/Session/gridfs_find", test_gridfs_find, true);
   add_session_test (
      suite, "/Session/gridfs_find_one", test_gridfs_find_one, true);
   add_session_test_wc (suite,
                        "/Session/watch",
                        test_watch,
                        true,
                        test_framework_skip_if_not_rs_version_6);
   add_session_test (suite, "/Session/aggregate", test_aggregate, true);
   add_session_test (suite, "/Session/create", test_create, false);
   add_session_test (
      suite, "/Session/database_names", test_database_names, true);
   add_session_test (
      suite, "/Session/find_databases", test_find_databases, true);
   add_session_test (
      suite, "/Session/find_collections", test_find_collections, true);
   add_session_test (
      suite, "/Session/collection_names", test_collection_names, true);
   add_session_test (suite, "/Session/bulk", test_bulk, false);
   add_session_test (suite, "/Session/find_indexes", test_find_indexes, true);
   TestSuite_AddFull (suite,                                          
                      "/Session/bulk_set_session",
                      run_session_test_bulk_operation,
                      NULL,                                            
                      test_bulk_set_session,
                      test_framework_skip_if_no_cluster_time,          
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/bulk_set_client",
                      run_session_test_bulk_operation,
                      NULL,
                      test_bulk_set_client,
                      test_framework_skip_if_no_cluster_time,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/cursor_implicit_session",
                      test_cursor_implicit_session,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_cluster_time,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/change_stream_implicit_session",
                      test_change_stream_implicit_session,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_cluster_time,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/cmd_error",
                      test_cmd_error,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_cluster_time,
                      test_framework_skip_if_no_crypto);
   TestSuite_AddFull (suite,
                      "/Session/read_concern",
                      test_read_concern,
                      NULL,
                      NULL,
                      test_framework_skip_if_no_cluster_time,
                      test_framework_skip_if_no_crypto);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/insert_one/explicit_cs/inherit_wc",
      test_insert_one,
      true,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/insert_one/explicit_cs/explicit_wc",
      test_insert_one,
      true,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/insert_one/implicit_cs/inherit_wc",
      test_insert_one,
      false,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/insert_one/implicit_cs/explicit_wc",
      test_insert_one,
      false,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/bulk/explicit_cs/inherit_wc",
      test_bulk,
      true,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/bulk/explicit_cs/explicit_wc",
      test_bulk,
      true,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/bulk/implicit_cs/inherit_wc",
      test_bulk,
      false,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/bulk/implicit_cs/explicit_wc",
      test_bulk,
      false,
      false);
   /* find_and_modify_with_opts only inherits acknowledged write concerns, so
    * skip tests that inherit a write concern. Technically, an explicit
    * unacknowledged write concern doesn't make much sense with findAndModify,
    * but this is testing the common code path for command execution. */
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/find_and_modify/explicit_cs/explicit_wc",
      test_fam,
      true,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/find_and_modify/implicit_cs/explicit_wc",
      test_fam,
      false,
      false);
   /* command_with_opts also does not inherit write concerns, but we still want
    * to test the common code path for command execution. */
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/db_cmd/explicit_cs/explicit_wc",
      test_db_cmd,
      true,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/db_cmd/implicit_cs/explicit_wc",
      test_db_cmd,
      false,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/read_write_cmd/explicit_cs/inherit_wc",
      test_read_write_cmd,
      true,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/read_write_cmd/explicit_cs/explicit_wc",
      test_read_write_cmd,
      true,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/read_write_cmd/implicit_cs/inherit_wc",
      test_read_write_cmd,
      false,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/read_write_cmd/implicit_cs/explicit_wc",
      test_read_write_cmd,
      false,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/write_cmd/explicit_cs/inherit_wc",
      test_write_cmd,
      true,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/write_cmd/explicit_cs/explicit_wc",
      test_write_cmd,
      true,
      false);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/write_cmd/implicit_cs/inherit_wc",
      test_write_cmd,
      false,
      true);
   add_unacknowledged_test (
      suite,
      "/Session/unacknowledged/write_cmd/implicit_cs/explicit_wc",
      test_write_cmd,
      false,
      false);
}
