[DRAFT] chore: benchmark tests

google/cloud/bigtable/data/_async/client.py

@@ -29,18 +29,20 @@
 import warnings
 import sys
 import random
+import os
 
 from collections import namedtuple
 
 from google.cloud.bigtable_v2.services.bigtable.client import BigtableClientMeta
 from google.cloud.bigtable_v2.services.bigtable.async_client import BigtableAsyncClient
 from google.cloud.bigtable_v2.services.bigtable.async_client import DEFAULT_CLIENT_INFO
 from google.cloud.bigtable_v2.services.bigtable.transports.pooled_grpc_asyncio import (
-    PooledBigtableGrpcAsyncIOTransport,
+    PooledBigtableGrpcAsyncIOTransport, PooledChannel
 )
 from google.cloud.bigtable_v2.types.bigtable import PingAndWarmRequest
 from google.cloud.client import ClientWithProject
 from google.api_core.exceptions import GoogleAPICallError
+from google.cloud.environment_vars import BIGTABLE_EMULATOR  # type: ignore
 from google.api_core import retry_async as retries
 from google.api_core import exceptions as core_exceptions
 from google.cloud.bigtable.data._async._read_rows import _ReadRowsOperationAsync
@@ -152,23 +154,41 @@ def __init__(
         # attempt to start background tasks
         self._channel_init_time = time.monotonic()
         self._channel_refresh_tasks: list[asyncio.Task[None]] = []
-        try:
-            self.start_background_channel_refresh()
-        except RuntimeError:
+        self._emulator_host = os.getenv(BIGTABLE_EMULATOR)
+        if self._emulator_host is not None:
+            # connect to an emulator host
             warnings.warn(
-                f"{self.__class__.__name__} should be started in an "
-                "asyncio event loop. Channel refresh will not be started",
+                "Connecting to Bigtable emulator at {}".format(self._emulator_host),
                 RuntimeWarning,
                 stacklevel=2,
             )
+            self.transport._grpc_channel = PooledChannel(
+                pool_size=pool_size,
+                host=self._emulator_host,
+                insecure=True,
+            )
+            # refresh cached stubs to use emulator pool
+            self.transport._stubs = {}
+            self.transport._prep_wrapped_messages(client_info)
+        else:
+            # attempt to start background channel refresh tasks
+            try:
+                self.start_background_channel_refresh()
+            except RuntimeError:
+                warnings.warn(
+                    f"{self.__class__.__name__} should be started in an "
+                    "asyncio event loop. Channel refresh will not be started",
+                    RuntimeWarning,
+                    stacklevel=2,
+                )
 
     def start_background_channel_refresh(self) -> None:
         """
         Starts a background task to ping and warm each channel in the pool
         Raises:
           - RuntimeError if not called in an asyncio event loop
         """
-        if not self._channel_refresh_tasks:
+        if not self._channel_refresh_tasks and not self._emulator_host:
             # raise RuntimeError if there is no event loop
             asyncio.get_running_loop()
             for channel_idx in range(self.transport.pool_size):

test_proxy/README.md

@@ -0,0 +1,105 @@
+# CBT Python Test Proxy
+
+The CBT test proxy is intended for running conformance tests for Cloud Bigtable Python Client.
+
+## Start test proxy
+
+#### running the proxy with nox
+
+You can launch the test proxy directly using `nox`, which will handle dependency management
+
+```
+cd python-bigtable/test_proxy
+nox -s test_proxy
+```
+
+The port can be configured using the `PROXY_SERVER_PORT` environment variable
+
+```
+cd python-bigtable/test_proxy
+PROXY_SERVER_PORT=8080
+nox -s test_proxy
+```
+
+#### running the proxy script manually
+
+You can also run the `test_proxy.py` file directly
+
+```
+cd python-bigtable/test_proxy
+python test_proxy.py
+```
+
+The port can be set by passing in an extra positional argument
+
+```
+cd python-bigtable/test_proxy
+python test_proxy.py --port 8080
+```
+
+## Run the test cases
+
+Prerequisites:
+- If you have not already done so, [install golang](https://go.dev/doc/install).
+- Before running tests, [launch an instance of the test proxy](#start-test-proxy) 
+in a separate shell session, and make note of the port
+
+#### running the test cases with nox
+
+You can trigger the tests directly using `nox`, which will clone the test repo locally if it doesn't exist
+
+```
+cd python-bigtable/test_proxy
+nox -s conformance_tests
+```
+
+The port can be configured using the `PROXY_SERVER_PORT` environment variable
+
+```
+cd python-bigtable/test_proxy
+PROXY_SERVER_PORT=8080
+nox -s conformance_tests
+```
+
+#### running the test cases manually
+
+Clone and navigate to the go test library:
+
+```
+git clone https://github.com/googleapis/cloud-bigtable-clients-test.git
+cd cloud-bigtable-clients-test/tests
+```
+
+
+Launch the tests
+
+```
+go test -v -proxy_addr=:50055
+```
+
+## Test a released client
+
+You can run the test proxy against a released version of the library with `nox`
+by setting the `PROXY_CLIENT_VERSION` environment variable:
+
+```
+PROXY_CLIENT_VERSION=3.0.0
+nox -s test_proxy
+```
+
+if unset, it will default to installing the library from source
+
+## Test the legacy client
+
+By default, tests are run against the new data client.You can run the test proxy against the 
+previous client by running it with the `--legacy-client` flag:
+
+```
+nox -s test_proxy -- --legacy-client
+```
+
+or
+
+```
+python test_proxy.py --legacy-client
+```