RUST-302 Implement v2 spec test runner (#208)

Author: isabelatkinson

src/client/auth/mod.rs

@@ -8,6 +8,7 @@ mod test;
 use std::{borrow::Cow, str::FromStr};
 
 use rand::Rng;
+use serde::Deserialize;
 use typed_builder::TypedBuilder;
 
 use self::scram::ScramVersion;
@@ -27,7 +28,7 @@ const PLAIN_STR: &str = "PLAIN";
 /// The authentication mechanisms supported by MongoDB.
 ///
 /// Note: not all of these mechanisms are currently supported by the driver.
-#[derive(Clone, PartialEq, Debug)]
+#[derive(Clone, Deserialize, PartialEq, Debug)]
 pub enum AuthMechanism {
     /// MongoDB Challenge Response nonce and MD5 based authentication system. It is currently
     /// deprecated and will never be supported by this driver.
@@ -177,7 +178,7 @@ impl FromStr for AuthMechanism {
 ///
 /// Some fields (mechanism and source) may be omitted and will either be negotiated or assigned a
 /// default value, depending on the values of other fields in the credential.
-#[derive(Clone, Debug, Default, TypedBuilder, PartialEq)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder, PartialEq)]
 pub struct Credential {
     /// The username to authenticate with. This applies to all mechanisms but may be omitted when
     /// authenticating via MONGODB-X509.

src/client/options/mod.rs

@@ -22,6 +22,7 @@ use rustls::{
     ServerCertVerifier,
     TLSError,
 };
+use serde::Deserialize;
 use strsim::jaro_winkler;
 use typed_builder::TypedBuilder;
 use webpki_roots::TLS_SERVER_ROOTS;
@@ -89,7 +90,7 @@ lazy_static! {
 }
 
 /// A hostname:port address pair.
-#[derive(Clone, Debug, Eq)]
+#[derive(Clone, Debug, Deserialize, Eq)]
 pub struct StreamAddress {
     /// The hostname of the address.
     pub hostname: String,
@@ -191,8 +192,9 @@ impl fmt::Display for StreamAddress {
 }
 
 /// Contains the options that can be used to create a new [`Client`](../struct.Client.html).
-#[derive(Clone, Derivative, TypedBuilder)]
+#[derive(Clone, Derivative, Deserialize, TypedBuilder)]
 #[derivative(Debug, PartialEq)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct ClientOptions {
     /// The initial list of seeds that the Client should connect to.
@@ -204,6 +206,7 @@ pub struct ClientOptions {
         hostname: \"localhost\".to_string(),
         port: Some(27017),
     }]")]
+    #[serde(default = "default_hosts")]
     pub hosts: Vec<StreamAddress>,
 
     /// The application name that the Client will send to the server as part of the handshake. This
@@ -219,12 +222,14 @@ pub struct ClientOptions {
     /// CmapEventHandler type documentation for more details.
     #[derivative(Debug = "ignore", PartialEq = "ignore")]
     #[builder(default)]
+    #[serde(skip)]
     pub cmap_event_handler: Option<Arc<dyn CmapEventHandler>>,
 
     /// The handler that should process all command-related events. See the CommandEventHandler
     /// type documentation for more details.
     #[derivative(Debug = "ignore", PartialEq = "ignore")]
     #[builder(default)]
+    #[serde(skip)]
     pub command_event_handler: Option<Arc<dyn CommandEventHandler>>,
 
     /// The connect timeout passed to each underlying TcpStream when attemtping to connect to the
@@ -351,10 +356,17 @@ pub struct ClientOptions {
     pub(crate) zlib_compression: Option<i32>,
 
     #[builder(default)]
-    original_srv_hostname: Option<String>,
+    pub(crate) original_srv_hostname: Option<String>,
 
     #[builder(default)]
-    original_uri: Option<String>,
+    pub(crate) original_uri: Option<String>,
+}
+
+fn default_hosts() -> Vec<StreamAddress> {
+    vec![StreamAddress {
+        hostname: "localhost".to_string(),
+        port: Some(27017),
+    }]
 }
 
 impl Default for ClientOptions {
@@ -400,7 +412,7 @@ struct ClientOptionsParser {
 
 /// Specifies whether TLS configuration should be used with the operations that the
 /// [`Client`](../struct.Client.html) performs.
-#[derive(Clone, Debug, PartialEq)]
+#[derive(Clone, Debug, Deserialize, PartialEq)]
 pub enum Tls {
     Enabled(TlsOptions),
     Disabled,
@@ -419,7 +431,7 @@ impl From<TlsOptions> for Option<Tls> {
 }
 
 /// Specifies the TLS configuration that the [`Client`](../struct.Client.html) should use.
-#[derive(Clone, Debug, Default, PartialEq, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, PartialEq, TypedBuilder)]
 #[non_exhaustive]
 pub struct TlsOptions {
     /// Whether or not the [`Client`](../struct.Client.html) should return an error if the server
@@ -517,7 +529,7 @@ impl TlsOptions {
 
 /// Extra information to append to the driver version in the metadata of the handshake with the
 /// server. This should be used by libraries wrapping the driver, e.g. ODMs.
-#[derive(Clone, Debug, TypedBuilder, PartialEq)]
+#[derive(Clone, Debug, Deserialize, TypedBuilder, PartialEq)]
 #[non_exhaustive]
 pub struct DriverInfo {
     /// The name of the library wrapping the driver.

src/coll/options.rs

@@ -6,15 +6,21 @@ use typed_builder::TypedBuilder;
 
 use crate::{
     bson::{doc, Bson, Document},
-    bson_util::{serialize_batch_size, serialize_duration_as_int_millis, serialize_u32_as_i32},
+    bson_util::{
+        deserialize_duration_from_u64_millis,
+        serialize_batch_size,
+        serialize_duration_as_int_millis,
+        serialize_u32_as_i32,
+    },
     concern::{ReadConcern, WriteConcern},
     options::Collation,
     selection_criteria::SelectionCriteria,
 };
 
 /// These are the valid options for creating a [`Collection`](../struct.Collection.html) with
 /// [`Database::collection_with_options`](../struct.Database.html#method.collection_with_options).
-#[derive(Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct CollectionOptions {
     /// The default read preference for operations.
@@ -34,7 +40,7 @@ pub struct CollectionOptions {
 /// [`Collection::find_one_and_replace`](../struct.Collection.html#method.find_one_and_replace) and
 /// [`Collection::find_one_and_update`](../struct.Collection.html#method.find_one_and_update)
 /// operation should return the document before or after modification.
-#[derive(Debug)]
+#[derive(Clone, Debug, Deserialize)]
 #[non_exhaustive]
 pub enum ReturnDocument {
     /// Return the document after modification.
@@ -81,7 +87,8 @@ pub enum CursorType {
 
 /// Specifies the options to a
 /// [`Collection::insert_one`](../struct.Collection.html#method.insert_one) operation.
-#[derive(Clone, Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct InsertOneOptions {
     /// Opt out of document-level validation.
@@ -130,7 +137,7 @@ impl InsertManyOptions {
 /// Enum modeling the modifications to apply during an update.
 /// For details, see the official MongoDB
 /// [documentation](https://docs.mongodb.com/manual/reference/command/update/#update-command-behaviors)
-#[derive(Clone, Debug, Serialize)]
+#[derive(Clone, Debug, Deserialize, Serialize)]
 #[serde(untagged)]
 #[non_exhaustive]
 pub enum UpdateModifications {
@@ -168,7 +175,8 @@ impl From<Vec<Document>> for UpdateModifications {
 /// Specifies the options to a
 /// [`Collection::update_one`](../struct.Collection.html#method.update_one) or
 /// [`Collection::update_many`](../struct.Collection.html#method.update_many) operation.
-#[derive(Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct UpdateOptions {
     /// A set of filters specifying to which array elements an update should apply.
@@ -220,7 +228,8 @@ impl UpdateOptions {
 
 /// Specifies the options to a
 /// [`Collection::replace_one`](../struct.Collection.html#method.replace_one) operation.
-#[derive(Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct ReplaceOptions {
     /// Opt out of document-level validation.
@@ -254,7 +263,7 @@ pub struct ReplaceOptions {
 /// [`Collection::delete_one`](../struct.Collection.html#method.delete_one) or
 /// [`Collection::delete_many`](../struct.Collection.html#method.delete_many) operation.
 #[serde_with::skip_serializing_none]
-#[derive(Clone, Debug, Default, TypedBuilder, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct DeleteOptions {
@@ -366,7 +375,7 @@ pub struct FindOneAndReplaceOptions {
 /// Specifies the options to a
 /// [`Collection::find_one_and_update`](../struct.Collection.html#method.find_one_and_update)
 /// operation.
-#[derive(Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
 #[non_exhaustive]
 pub struct FindOneAndUpdateOptions {
     /// A set of filters specifying to which array elements an update should apply.
@@ -424,7 +433,7 @@ pub struct FindOneAndUpdateOptions {
 /// operation.
 #[skip_serializing_none]
 #[serde(rename_all = "camelCase")]
-#[derive(Clone, Debug, Default, TypedBuilder, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder, Serialize)]
 #[non_exhaustive]
 pub struct AggregateOptions {
     /// Enables writing to temporary files. When set to true, aggregation stages can write data to
@@ -439,7 +448,7 @@ pub struct AggregateOptions {
     /// number of round trips needed to return the entire set of documents returned by the
     /// query).
     #[builder(default)]
-    #[serde(serialize_with = "serialize_batch_size", rename = "cursor")]
+    #[serde(serialize_with = "serialize_batch_size", rename(serialize = "cursor"))]
     pub batch_size: Option<u32>,
 
     /// Opt out of document-level validation.
@@ -467,7 +476,10 @@ pub struct AggregateOptions {
     ///
     /// This option will have no effect on non-tailable cursors that result from this operation.
     #[builder(default)]
-    #[serde(skip)]
+    #[serde(
+        skip_serializing,
+        deserialize_with = "deserialize_duration_from_u64_millis"
+    )]
     pub max_await_time: Option<Duration>,
 
     /// The maximum amount of time to allow the query to run.
@@ -477,7 +489,8 @@ pub struct AggregateOptions {
     #[builder(default)]
     #[serde(
         serialize_with = "serialize_duration_as_int_millis",
-        rename = "maxTimeMS"
+        rename = "maxTimeMS",
+        deserialize_with = "deserialize_duration_from_u64_millis"
     )]
     pub max_time: Option<Duration>,
 
@@ -493,7 +506,8 @@ pub struct AggregateOptions {
     /// If none is specified, the selection criteria defined on the object executing this operation
     /// will be used.
     #[builder(default)]
-    #[serde(skip)]
+    #[serde(skip_serializing)]
+    #[serde(rename = "readPreference")]
     pub selection_criteria: Option<SelectionCriteria>,
 
     /// The write concern to use for the operation.
@@ -506,7 +520,8 @@ pub struct AggregateOptions {
 
 /// Specifies the options to a
 /// [`Collection::count_documents`](../struct.Collection.html#method.count_documents) operation.
-#[derive(Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct CountOptions {
     /// The index to use for the operation.
@@ -522,6 +537,7 @@ pub struct CountOptions {
     /// This options maps to the `maxTimeMS` MongoDB query option, so the duration will be sent
     /// across the wire as an integer number of milliseconds.
     #[builder(default)]
+    #[serde(deserialize_with = "deserialize_duration_from_u64_millis")]
     pub max_time: Option<Duration>,
 
     /// The number of documents to skip before counting.
@@ -544,7 +560,7 @@ pub struct CountOptions {
 ///  `Collection::estimated_document_count`
 /// ](../struct.Collection.html#method.estimated_document_count) operation.
 #[serde_with::skip_serializing_none]
-#[derive(Debug, Default, TypedBuilder, Serialize, Clone)]
+#[derive(Debug, Default, Deserialize, TypedBuilder, Serialize, Clone)]
 #[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct EstimatedDocumentCountOptions {
@@ -555,7 +571,8 @@ pub struct EstimatedDocumentCountOptions {
     #[builder(default)]
     #[serde(
         serialize_with = "serialize_duration_as_int_millis",
-        rename = "maxTimeMS"
+        rename = "maxTimeMS",
+        deserialize_with = "deserialize_duration_from_u64_millis"
     )]
     pub max_time: Option<Duration>,
 
@@ -574,7 +591,7 @@ pub struct EstimatedDocumentCountOptions {
 /// Specifies the options to a [`Collection::distinct`](../struct.Collection.html#method.distinct)
 /// operation.
 #[serde_with::skip_serializing_none]
-#[derive(Debug, Default, TypedBuilder, Serialize, Clone)]
+#[derive(Debug, Default, Deserialize, TypedBuilder, Serialize, Clone)]
 #[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct DistinctOptions {
@@ -585,7 +602,8 @@ pub struct DistinctOptions {
     #[builder(default)]
     #[serde(
         serialize_with = "serialize_duration_as_int_millis",
-        rename = "maxTimeMS"
+        rename = "maxTimeMS",
+        deserialize_with = "deserialize_duration_from_u64_millis"
     )]
     pub max_time: Option<Duration>,
 
@@ -611,7 +629,7 @@ pub struct DistinctOptions {
 /// Specifies the options to a [`Collection::find`](../struct.Collection.html#method.find)
 /// operation.
 #[skip_serializing_none]
-#[derive(Debug, Default, TypedBuilder, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder, Serialize)]
 #[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct FindOptions {
@@ -778,7 +796,8 @@ where
 
 /// Specifies the options to a [`Collection::find_one`](../struct.Collection.html#method.find_one)
 /// operation.
-#[derive(Debug, Default, TypedBuilder)]
+#[derive(Clone, Debug, Default, Deserialize, TypedBuilder)]
+#[serde(rename_all = "camelCase")]
 #[non_exhaustive]
 pub struct FindOneOptions {
     /// If true, partial results will be returned from a mongos rather than an error being
@@ -818,6 +837,7 @@ pub struct FindOneOptions {
     /// This options maps to the `maxTimeMS` MongoDB query option, so the duration will be sent
     /// across the wire as an integer number of milliseconds.
     #[builder(default)]
+    #[serde(deserialize_with = "deserialize_duration_from_u64_millis")]
     pub max_time: Option<Duration>,
 
     /// The inclusive lower bound for a specific index.

src/concern/mod.rs

@@ -20,7 +20,7 @@ use crate::{
 ///
 /// See the documentation [here](https://docs.mongodb.com/manual/reference/read-concern/) for more
 /// information about read concerns.
-#[derive(Clone, Debug, Serialize, PartialEq)]
+#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
 #[non_exhaustive]
 pub struct ReadConcern {
     /// The level of the read concern.
@@ -70,7 +70,7 @@ impl From<ReadConcernLevel> for ReadConcern {
 ///
 /// See the documentation [here](https://docs.mongodb.com/manual/reference/read-concern/) for more
 /// information about read concerns.
-#[derive(Debug, Clone, PartialEq)]
+#[derive(Clone, Debug, PartialEq)]
 #[non_exhaustive]
 pub enum ReadConcernLevel {
     /// See the specific documentation for this read concern level [here](https://docs.mongodb.com/manual/reference/read-concern-local/).
@@ -113,6 +113,13 @@ impl ReadConcernLevel {
     }
 }
 
+impl<'de> Deserialize<'de> for ReadConcernLevel {
+    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> std::result::Result<Self, D::Error> {
+        let s = String::deserialize(deserializer)?;
+        Ok(ReadConcernLevel::from_str(&s))
+    }
+}
+
 impl Serialize for ReadConcernLevel {
     fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
     where