RUST-1636 Add RunCommand Test Specification (#901)

Add runCommand specification and remove readConcern and writeConcern options from unified test runCommand operation

Author: drshika

src/concern/test.rs

@@ -114,18 +114,6 @@ async fn inconsistent_write_concern_rejected() {
 
     let client = TestClient::new().await;
     let db = client.database(function_name!());
-    let error = db
-        .run_command(
-            doc! {
-                "insert": function_name!(),
-                "documents": [ {} ],
-                "writeConcern": { "w": 0, "j": true }
-            },
-            None,
-        )
-        .await
-        .expect_err("insert should fail");
-    assert!(matches!(*error.kind, ErrorKind::InvalidArgument { .. }));
 
     let coll = db.collection(function_name!());
     let wc = WriteConcern {
@@ -149,15 +137,15 @@ async fn unacknowledged_write_concern_rejected() {
 
     let client = TestClient::new().await;
     let db = client.database(function_name!());
-    let error = db
-        .run_command(
-            doc! {
-                "insert": function_name!(),
-                "documents": [ {} ],
-                "writeConcern": { "w": 0 }
-            },
-            None,
-        )
+    let coll = db.collection(function_name!());
+    let wc = WriteConcern {
+        w: Acknowledgment::Nodes(0).into(),
+        journal: false.into(),
+        w_timeout: None,
+    };
+    let options = InsertOneOptions::builder().write_concern(wc).build();
+    let error = coll
+        .insert_one(doc! {}, options)
         .await
         .expect_err("insert should fail");
     assert!(matches!(*error.kind, ErrorKind::InvalidArgument { .. }));

src/db/mod.rs

@@ -458,6 +458,8 @@ impl Database {
     /// Note that no inspection is done on `doc`, so the command will not use the database's default
     /// read concern or write concern. If specific read concern or write concern is desired, it must
     /// be specified manually.
+    /// Please note that run_command doesn't validate WriteConcerns passed into the body of the
+    /// command document.
     pub async fn run_command(
         &self,
         command: Document,

src/operation/run_command/mod.rs

@@ -11,7 +11,6 @@ use crate::{
     client::SESSIONS_UNSUPPORTED_COMMANDS,
     cmap::{conn::PinnedConnectionHandle, Command, RawCommandResponse, StreamDescription},
     error::{ErrorKind, Result},
-    options::WriteConcern,
     selection_criteria::SelectionCriteria,
 };
 
@@ -20,7 +19,6 @@ pub(crate) struct RunCommand<'conn> {
     db: String,
     command: RawDocumentBuf,
     selection_criteria: Option<SelectionCriteria>,
-    write_concern: Option<WriteConcern>,
     pinned_connection: Option<&'conn PinnedConnectionHandle>,
 }
 
@@ -31,16 +29,10 @@ impl<'conn> RunCommand<'conn> {
         selection_criteria: Option<SelectionCriteria>,
         pinned_connection: Option<&'conn PinnedConnectionHandle>,
     ) -> Result<Self> {
-        let write_concern = command
-            .get("writeConcern")
-            .map(|doc| bson::from_bson::<WriteConcern>(doc.clone()))
-            .transpose()?;
-
         Ok(Self {
             db,
             command: RawDocumentBuf::from_document(&command)?,
             selection_criteria,
-            write_concern,
             pinned_connection,
         })
     }
@@ -52,17 +44,10 @@ impl<'conn> RunCommand<'conn> {
         selection_criteria: Option<SelectionCriteria>,
         pinned_connection: Option<&'conn PinnedConnectionHandle>,
     ) -> Result<Self> {
-        let write_concern = command
-            .get("writeConcern")?
-            .and_then(|b| b.as_document())
-            .map(|doc| bson::from_slice::<WriteConcern>(doc.as_bytes()))
-            .transpose()?;
-
         Ok(Self {
             db,
             command,
             selection_criteria,
-            write_concern,
             pinned_connection,
         })
     }
@@ -121,10 +106,6 @@ impl<'conn> OperationWithDefaults for RunCommand<'conn> {
         self.selection_criteria.as_ref()
     }
 
-    fn write_concern(&self) -> Option<&WriteConcern> {
-        self.write_concern.as_ref()
-    }
-
     fn supports_sessions(&self) -> bool {
         self.command_name()
             .map(|command_name| {

src/sdam/description/topology/mod.rs

@@ -228,8 +228,9 @@ impl TopologyDescription {
                     },
                     Some(other) => other,
                 };
-
-                command.set_read_preference(resolved_read_pref)
+                if resolved_read_pref != ReadPreference::Primary {
+                    command.set_read_preference(resolved_read_pref)
+                }
             }
             _ => {
                 let read_pref = match criteria {
@@ -239,7 +240,9 @@ impl TopologyDescription {
                     },
                     None => ReadPreference::Primary,
                 };
-                command.set_read_preference(read_pref)
+                if read_pref != ReadPreference::Primary {
+                    command.set_read_preference(read_pref)
+                }
             }
         }
     }

src/selection_criteria.rs

@@ -186,9 +186,8 @@ impl<'de> Deserialize<'de> for ReadPreference {
             options: ReadPreferenceOptions,
         }
         let preference = ReadPreferenceHelper::deserialize(deserializer)?;
-
-        match preference.mode.as_str() {
-            "Primary" => {
+        match preference.mode.to_ascii_lowercase().as_str() {
+            "primary" => {
                 if !preference.options.is_default() {
                     return Err(D::Error::custom(&format!(
                         "no options can be specified with read preference mode = primary, but got \
@@ -198,16 +197,16 @@ impl<'de> Deserialize<'de> for ReadPreference {
                 }
                 Ok(ReadPreference::Primary)
             }
-            "Secondary" => Ok(ReadPreference::Secondary {
+            "secondary" => Ok(ReadPreference::Secondary {
                 options: preference.options,
             }),
-            "PrimaryPreferred" => Ok(ReadPreference::PrimaryPreferred {
+            "primarypreferred" => Ok(ReadPreference::PrimaryPreferred {
                 options: preference.options,
             }),
-            "SecondaryPreferred" | "secondaryPreferred" => Ok(ReadPreference::SecondaryPreferred {
+            "secondarypreferred" => Ok(ReadPreference::SecondaryPreferred {
                 options: preference.options,
             }),
-            "Nearest" => Ok(ReadPreference::Nearest {
+            "nearest" => Ok(ReadPreference::Nearest {
                 options: preference.options,
             }),
             other => Err(D::Error::custom(format!(
@@ -231,7 +230,6 @@ impl Serialize for ReadPreference {
             #[serde(flatten)]
             options: Option<&'a ReadPreferenceOptions>,
         }
-
         let helper = match self {
             ReadPreference::Primary => ReadPreferenceHelper {
                 mode: "primary",

src/test/spec/json/run-command/README.rst

@@ -0,0 +1,14 @@
+=================
+Run Command Tests
+=================
+
+.. contents::
+
+----
+
+Introduction
+============
+
+The YAML and JSON files in the ``unified`` sub-directories are platform-independent tests
+that drivers can use to prove their conformance to the RunCommand spec. Tests in the
+``unified`` directory are written using the `Unified Test Format <../../unified-test-format/unified-test-format.rst>`_.