Add uri options tests

source/uri-options/tests/README.rst

@@ -0,0 +1,52 @@
+=======================
+URI Options Tests
+=======================
+
+The YAML and JSON files in this directory tree are platform-independent tests
+that drivers can use to prove their conformance to the URI Options spec.
+
+These tests use the same format as the Connection String spec tests.
+
+Version
+-------
+
+Files in the "specifications" repository have no version scheme. They are not
+tied to a MongoDB server version.
+
+Format
+------
+
+Each YAML file contains an object with a single ``tests`` key. This key is an
+array of test case objects, each of which have the following keys:
+
+- ``description``: A string describing the test.
+- ``uri``: A string containing the URI to be parsed.
+- ``valid``: A boolean indicating if the URI should be considered valid. 
+  This will always be true, as the Connection String spec tests the validity of the structure, but 
+  it's still included to make it easier to reuse the connection string spec test runners that 
+  drivers already have.
+- ``warning``: A boolean indicating whether URI parsing should emit a warning.
+- ``hosts``: Included for compatibility with the Connection String spec tests. This will always be ``~``.
+- ``auth``: Included for compatibility with the Connection String spec tests. This will always be ``~``.
+- ``options``: An object containing key/value pairs for each parsed query string
+  option.
+
+If a test case includes a null value for one of these keys (e.g. ``auth: ~``,
+``hosts: ~``), no assertion is necessary. This both simplifies parsing of the
+test files (keys should always exist) and allows flexibility for drivers that
+might substitute default values *during* parsing (e.g. omitted ``hosts`` could be
+parsed as ``["localhost"]``).
+
+The ``valid`` and ``warning`` fields are boolean in order to keep the tests
+flexible. We are not concerned with asserting the format of specific error or
+warnings messages strings.
+
+Use as unit tests
+=================
+
+Testing whether a URI is valid or not requires testing whether URI parsing (or
+MongoClient construction) causes a warning due to a URI option being invalid and asserting that the
+options parsed from the URI match those listed in the ``options`` field.
+
+Note that there are tests for each of the options marked as optional; drivers will need to implement
+logic to skip over the optional tests that they don’t implement.

source/uri-options/tests/auth-options.json

@@ -0,0 +1,20 @@
+{
+  "tests": [
+    {
+      "description": "Valid auth options are parsed correctly",
+      "uri": "mongodb://foo:bar@example.com/?authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:other,CANONICALIZE_HOST_NAME:true&authSource=$external",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "authMechanism": "GSSAPI",
+        "authMechanismProperties": {
+          "SERVICE_NAME": "other",
+          "CANONICALIZE_HOST_NAME": true
+        },
+        "authSource": "$external"
+      }
+    }
+  ]
+}

source/uri-options/tests/auth-options.yml

@@ -0,0 +1,14 @@
+tests:
+    -
+        description: "Valid auth options are parsed correctly"
+        uri: "mongodb://foo:bar@example.com/?authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:other,CANONICALIZE_HOST_NAME:true&authSource=$external"
+        valid: true
+        warning: false
+        hosts: ~
+        auth: ~
+        options:
+            authMechanism: "GSSAPI"
+            authMechanismProperties:
+                SERVICE_NAME: "other"
+                CANONICALIZE_HOST_NAME: true
+            authSource: "$external"

source/uri-options/tests/ca.pem

@@ -0,0 +1 @@
+# This file exists solely for the purpose of facilitating drivers which check for the existence of files specified in the URI options at parse time.

source/uri-options/tests/cert.pem

@@ -0,0 +1 @@
+# This file exists solely for the purpose of facilitating drivers which check for the existence of files specified in the URI options at parse time.

source/uri-options/tests/client.pem

@@ -0,0 +1 @@
+# This file exists solely for the purpose of facilitating drivers which check for the existence of files specified in the URI options at parse time.

source/uri-options/tests/compression-options.json

@@ -0,0 +1,59 @@
+{
+  "tests": [
+    {
+      "description": "Valid compression options are parsed correctly",
+      "uri": "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=9",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "compressors": [
+          "zlib"
+        ],
+        "zlibCompressionLevel": 9
+      }
+    },
+    {
+      "description": "Multiple compressors are parsed correctly",
+      "uri": "mongodb://example.com/?compressors=snappy,zlib",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "compressors": [
+          "snappy",
+          "zlib"
+        ]
+      }
+    },
+    {
+      "description": "Non-numeric zlibCompressionLevel causes a warning",
+      "uri": "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=invalid",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "Too low zlibCompressionLevel causes a warning",
+      "uri": "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=-2",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "Too high zlibCompressionLevel causes a warning",
+      "uri": "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=10",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    }
+  ]
+}

source/uri-options/tests/compression-options.yml

@@ -0,0 +1,48 @@
+tests:
+    -
+        description: "Valid compression options are parsed correctly"
+        uri: "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=9"
+        valid: true
+        warning: false
+        hosts: ~
+        auth: ~
+        options:
+            compressors: 
+              - "zlib"
+            zlibCompressionLevel: 9
+    -
+        description: "Multiple compressors are parsed correctly"
+        uri: "mongodb://example.com/?compressors=snappy,zlib"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options:
+            compressors:
+              - "snappy"
+              - "zlib"
+    -
+        description: "Non-numeric zlibCompressionLevel causes a warning"
+        uri: "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options: {}
+    -
+        description: "Too low zlibCompressionLevel causes a warning"
+        uri: "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=-2"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options: {}
+    -
+        description: "Too high zlibCompressionLevel causes a warning"
+        uri: "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=10"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options: {}
+

source/uri-options/tests/concern-options.json

@@ -0,0 +1,76 @@
+{
+  "tests": [
+    {
+      "description": "Valid read and write concern are parsed correctly",
+      "uri": "mongodb://example.com/?readConcernLevel=majority&w=5&wTimeoutMS=30000&journal=false",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "readConcernLevel": "majority",
+        "w": 5,
+        "wTimeoutMS": 30000,
+        "journal": false
+      }
+    },
+    {
+      "description": "Arbitrary string readConcernLevel does not cause a warning",
+      "uri": "mongodb://example.com/?readConcernLevel=arbitraryButStillValid",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "readConcernLevel": "arbitraryButStillValid"
+      }
+    },
+    {
+      "description": "Arbitrary string w doesn't cause a warning",
+      "uri": "mongodb://example.com/?w=arbitraryButStillValid",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {
+        "w": "arbitraryButStillValid"
+      }
+    },
+    {
+      "description": "Too low w causes a warning",
+      "uri": "mongodb://example.com/?w=-2",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "Non-numeric wTimeoutMS causes a warning",
+      "uri": "mongodb://example.com/?wTimeoutMS=invalid",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "Too low wTimeoutMS causes a warning",
+      "uri": "mongodb://example.com/?wTimeoutMS=-2",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "Invalid journal causes a warning",
+      "uri": "mongodb://example.com/?journal=invalid",
+      "valid": true,
+      "warning": true,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    }
+  ]
+}

source/uri-options/tests/concern-options.yml

@@ -0,0 +1,55 @@
+tests:
+    -
+        description: "Valid read and write concern are parsed correctly"
+        uri: "mongodb://example.com/?readConcernLevel=majority&w=5&wTimeoutMS=30000&journal=false"
+        valid: true
+        warning: false
+        hosts: ~
+        auth: ~
+        options:
+            readConcernLevel: "majority"
+            w: 5
+            wTimeoutMS: 30000
+            journal: false
+    -
+        description: "Arbitrary string readConcernLevel does not cause a warning"
+        uri: "mongodb://example.com/?readConcernLevel=arbitraryButStillValid"
+        valid: true
+        warning: false
+        hosts: ~
+        auth: ~
+        options:
+            readConcernLevel: "arbitraryButStillValid"
+    -
+        description: "Arbitrary string w doesn't cause a warning"
+        uri: "mongodb://example.com/?w=arbitraryButStillValid"
+        valid: true
+        warning: false
+        hosts: ~
+        auth: ~
+        options:
+            w: "arbitraryButStillValid"
+    -
+        description: "Non-numeric wTimeoutMS causes a warning"
+        uri: "mongodb://example.com/?wTimeoutMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options: {}
+    -
+        description: "Too low wTimeoutMS causes a warning"
+        uri: "mongodb://example.com/?wTimeoutMS=-2"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options: {}
+    -
+        description: "Invalid journal causes a warning"
+        uri: "mongodb://example.com/?journal=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth: ~
+        options: {}