RUST-1186 Convert sessions tests to unified test format (#583)

Author: isabelatkinson

src/client/mod.rs

@@ -250,7 +250,11 @@ impl Client {
     }
 
     /// Starts a new `ClientSession`.
-    pub async fn start_session(&self, options: Option<SessionOptions>) -> Result<ClientSession> {
+    pub async fn start_session(
+        &self,
+        options: impl Into<Option<SessionOptions>>,
+    ) -> Result<ClientSession> {
+        let options = options.into();
         if let Some(ref options) = options {
             options.validate()?;
         }

src/test/spec/json/sessions/README.rst

@@ -9,76 +9,14 @@ Driver Session Tests
 Introduction
 ============
 
-The YAML and JSON files in the ``legacy`` and ``unified`` sub-directories are platform-independent tests
-that drivers can use to prove their conformance to the Driver Sessions Spec. They are
-designed with the intention of sharing most test-runner code with the
-`Transactions Spec tests <../../transactions/tests/README.rst#test-format>`_.. Tests in the
-``unified`` directory are written using the `Unified Test Format <../../unified-test-format/unified-test-format.rst>`_.
+The YAML and JSON files in this directory are platform-independent tests
+meant to exercise a driver's implementation of sessions. These tests utilize the
+`Unified Test Format <../../unified-test-format/unified-test-format.rst>`__.
 
 Several prose tests, which are not easily expressed in YAML, are also presented
 in the Driver Sessions Spec. Those tests will need to be manually implemented
 by each driver.
 
-Test Format
-===========
-
-The same as the `Transactions Spec Test format
-<../../transactions/tests/README.rst#test-format>`_.
-
-Special Test Operations
-```````````````````````
-
-Certain operations that appear in the "operations" array do not correspond to
-API methods but instead represent special test operations. Such operations are
-defined on the "testRunner" object and are documented in the
-`Transactions Spec Test
-<../../transactions/tests/README.rst#special-test-operations>`_.
-Additional, session test specific operations are documented here:
-
-assertDifferentLsidOnLastTwoCommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The "assertDifferentLsidOnLastTwoCommands" operation instructs the test runner
-to assert that the last two command started events from the test's MongoClient
-have different "lsid" fields. This assertion is used to ensure that dirty
-server sessions are discarded from the pool::
-
-      - name: assertDifferentLsidOnLastTwoCommands
-        object: testRunner
-
-assertSameLsidOnLastTwoCommands
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The "assertSameLsidOnLastTwoCommands" operation instructs the test runner
-to assert that the last two command started events from the test's MongoClient
-have the same "lsid" field. This assertion is used to ensure that non-dirty
-server sessions are not discarded from the pool::
-
-      - name: assertSameLsidOnLastTwoCommands
-        object: testRunner
-
-assertSessionDirty
-~~~~~~~~~~~~~~~~~~
-
-The "assertSessionDirty" operation instructs the test runner to assert that
-the given session is marked dirty::
-
-      - name: assertSessionDirty
-        object: testRunner
-        arguments:
-          session: session0
-
-assertSessionNotDirty
-~~~~~~~~~~~~~~~~~~~~~
-
-The "assertSessionNotDirty" operation instructs the test runner to assert that
-the given session is *not* marked dirty::
-
-      - name: assertSessionNotDirty
-        object: testRunner
-        arguments:
-          session: session0
-
 Snapshot session tests
 ======================
 Snapshot sessions tests require server of version 5.0 or higher and 
@@ -92,13 +30,17 @@ may lead to `SnapshotTooOld` errors. Drivers can work around this issue by incre
 
 Prose tests
 ```````````
--  Setting both ``snapshot`` and ``causalConsistency`` is not allowed
 
-    * ``client.startSession(snapshot = true, causalConsistency = true)``
-    * Assert that an error was raised by driver
+1. Setting both ``snapshot`` and ``causalConsistency`` to true is not allowed
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ``client.startSession(snapshot = true, causalConsistency = true)``
+* Assert that an error was raised by driver
 
 Changelog
 =========
 
 :2019-05-15: Initial version.
 :2021-06-15: Added snapshot-session tests. Introduced legacy and unified folders.
+:2021-07-30: Use numbering for prose test
+:2022-02-11: Convert legacy tests to unified format