PYTHON-1714 Add c extension use to client metadata

- Fix tests
  - async

Author: aclark4life

test/asynchronous/test_client.py

@@ -341,76 +341,56 @@ async def test_read_preference(self):
         )
         self.assertEqual(c.read_preference, ReadPreference.NEAREST)
 
-    async def test_metadata(self):
+
+    def _test_metadata(self, add_meta, *args, **kwargs):
         metadata = copy.deepcopy(_METADATA)
-        metadata["driver"]["name"] = "PyMongo|async"
-        metadata["application"] = {"name": "foobar"}
-        client = self.simple_client("mongodb://foo:27017/?appname=foobar&connect=false")
-        options = client.options
-        self.assertEqual(options.pool_options.metadata, metadata)
-        client = self.simple_client("foo", 27017, appname="foobar", connect=False)
+        metadata["driver"]["name"] = "PyMongo"
+        metadata.update(add_meta)
+        client = self.simple_client(*args, **kwargs)
         options = client.options
-        self.assertEqual(options.pool_options.metadata, metadata)
+        self.assertIn(metadata["driver"]["name"], options.pool_options.metadata["driver"]["name"])
+        if "application" in metadata.keys():
+            self.assertEqual(metadata["application"]["name"], options.pool_options.metadata["application"]["name"])
+
+        self.assertLessEqual(
+            len(bson.encode(options.pool_options.metadata)),
+            _MAX_METADATA_SIZE,
+        )
+
+    async def test_metadata(self):
+        self._test_metadata({"driver": {"name": "async"}, "application": {"name": "foobar"}}, "mongodb://foo:27017/?appname=foobar&connect=false")
+        self._test_metadata({"driver": {"name": "async"}}, "foo", 27017, appname="foobar", connect=False)
+
         # No error
-        self.simple_client(appname="x" * 128)
+        self._test_metadata({}, appname="x" * 128)
+
         with self.assertRaises(ValueError):
-            self.simple_client(appname="x" * 129)
+            self._test_metadata({}, appname="x" * 129)
+
         # Bad "driver" options.
         self.assertRaises(TypeError, DriverInfo, "Foo", 1, "a")
         self.assertRaises(TypeError, DriverInfo, version="1", platform="a")
         self.assertRaises(TypeError, DriverInfo)
+
         with self.assertRaises(TypeError):
-            self.simple_client(driver=1)
+            self._test_metadata({}, driver=1)
         with self.assertRaises(TypeError):
-            self.simple_client(driver="abc")
+            self._test_metadata({}, driver="abc")
         with self.assertRaises(TypeError):
-            self.simple_client(driver=("Foo", "1", "a"))
+            self._test_metadata({}, driver=("Foo", "1", "a"))
+
         # Test appending to driver info.
-        metadata["driver"]["name"] = "PyMongo|c|async|FooDriver"
-        metadata["driver"]["version"] = "{}|1.2.3".format(_METADATA["driver"]["version"])
-        client = self.simple_client(
-            "foo",
-            27017,
-            appname="foobar",
-            driver=DriverInfo("FooDriver", "1.2.3", None),
-            connect=False,
-        )
-        options = client.options
-        self.assertEqual(options.pool_options.metadata, metadata)
-        metadata["platform"] = "{}|FooPlatform".format(_METADATA["platform"])
-        client = self.simple_client(
-            "foo",
-            27017,
-            appname="foobar",
-            driver=DriverInfo("FooDriver", "1.2.3", "FooPlatform"),
-            connect=False,
-        )
-        options = client.options
-        self.assertEqual(options.pool_options.metadata, metadata)
+        self._test_metadata({"driver": {"name": "FooDriver", "version": "{}|1.2.3".format(_METADATA["driver"]["version"])}}, "foo", 27017, appname="foobar", driver=DriverInfo("FooDriver", "1.2.3", None), connect=False)
+        self._test_metadata({"platform": "{}|FooPlatform".format(_METADATA["platform"])}, "foo", 27017, appname="foobar", driver=DriverInfo("FooDriver", "1.2.3", "FooPlatform"), connect=False)
+
         # Test truncating driver info metadata.
-        client = self.simple_client(
-            driver=DriverInfo(name="s" * _MAX_METADATA_SIZE),
-            connect=False,
-        )
-        options = client.options
-        self.assertLessEqual(
-            len(bson.encode(options.pool_options.metadata)),
-            _MAX_METADATA_SIZE,
-        )
-        client = self.simple_client(
-            driver=DriverInfo(name="s" * _MAX_METADATA_SIZE, version="s" * _MAX_METADATA_SIZE),
-            connect=False,
-        )
-        options = client.options
-        self.assertLessEqual(
-            len(bson.encode(options.pool_options.metadata)),
-            _MAX_METADATA_SIZE,
-        )
+        self._test_metadata({}, driver=DriverInfo(name="s" * _MAX_METADATA_SIZE), connect=False)
+        self._test_metadata({}, driver=DriverInfo(name="s" * _MAX_METADATA_SIZE, version="s" * _MAX_METADATA_SIZE), connect=False)
 
     @mock.patch.dict("os.environ", {ENV_VAR_K8S: "1"})
     def test_container_metadata(self):
         metadata = copy.deepcopy(_METADATA)
-        metadata["driver"]["name"] = "PyMongo|c|async"
+        metadata["driver"]["name"] = "PyMongo|async"
         metadata["env"] = {}
         metadata["env"]["container"] = {"orchestrator": "kubernetes"}
         client = self.simple_client("mongodb://foo:27017/?appname=foobar&connect=false")
@@ -1927,7 +1907,7 @@ def test_sigstop_sigcont(self):
     async def _test_handshake(self, env_vars, expected_env):
         with patch.dict("os.environ", env_vars):
             metadata = copy.deepcopy(_METADATA)
-            metadata["driver"]["name"] = "PyMongo|c|async"
+            metadata["driver"]["name"] = "PyMongo"
             if expected_env is not None:
                 metadata["env"] = expected_env
 
@@ -1936,7 +1916,21 @@ async def _test_handshake(self, env_vars, expected_env):
             client = await self.async_rs_or_single_client(serverSelectionTimeoutMS=10000)
             await client.admin.command("ping")
             options = client.options
-            self.assertEqual(options.pool_options.metadata, metadata)
+            self.assertIn(metadata["driver"]["name"], options.pool_options.metadata["driver"]["name"])
+            self.assertEqual(metadata["driver"]["version"], options.pool_options.metadata["driver"]["version"])
+            self.assertEqual(metadata["os"]["type"], options.pool_options.metadata["os"]["type"])
+            self.assertEqual(metadata["os"]["name"], options.pool_options.metadata["os"]["name"])
+            self.assertEqual(metadata["os"]["architecture"], options.pool_options.metadata["os"]["architecture"])
+            self.assertEqual(metadata["os"]["version"], options.pool_options.metadata["os"]["version"])
+            self.assertEqual(metadata["platform"], options.pool_options.metadata["platform"])
+            if "env" in options.pool_options.metadata.keys():
+                self.assertEqual(metadata["env"]["name"], options.pool_options.metadata["env"]["name"])
+                if "region" in options.pool_options.metadata["env"].keys():
+                    self.assertEqual(metadata["env"]["region"], options.pool_options.metadata["env"]["region"])
+                if "memory_mb" in options.pool_options.metadata["env"].keys():
+                    self.assertEqual(metadata["env"]["memory_mb"], options.pool_options.metadata["env"]["memory_mb"])
+                if "timeout_sec" in options.pool_options.metadata["env"].keys():
+                    self.assertEqual(metadata["env"]["timeout_sec"], options.pool_options.metadata["env"]["timeout_sec"])
 
     async def test_handshake_01_aws(self):
         await self._test_handshake(

test/test_client.py

@@ -364,11 +364,11 @@ def test_metadata(self):
         self.assertRaises(TypeError, DriverInfo)
 
         with self.assertRaises(TypeError):
-            self.simple_client(driver=1)
+            self._test_metadata({}, driver=1)
         with self.assertRaises(TypeError):
-            self.simple_client(driver="abc")
+            self._test_metadata({}, driver="abc")
         with self.assertRaises(TypeError):
-            self.simple_client(driver=("Foo", "1", "a"))
+            self._test_metadata({}, driver=("Foo", "1", "a"))
 
         # Test appending to driver info.
         self._test_metadata({"driver": {"name": "FooDriver", "version": "{}|1.2.3".format(_METADATA["driver"]["version"])}}, "foo", 27017, appname="foobar", driver=DriverInfo("FooDriver", "1.2.3", None), connect=False)