Fixed mock server tests

Author: lszinv

google/cloud/spanner_v1/metrics/metrics_exporter.py

@@ -23,7 +23,7 @@
 )
 
 import logging
-from typing import Optional, List, Union, NoReturn, Tuple
+from typing import Optional, List, Union, NoReturn, Tuple, Dict
 
 import google.auth
 from google.api.distribution_pb2 import (  # pylint: disable=no-name-in-module
@@ -39,10 +39,6 @@
     MonitoredResource,
 )
 
-from google.cloud.monitoring_v3.services.metric_service.transports.grpc import (
-    MetricServiceGrpcTransport,
-)
-
 # pylint: disable=no-name-in-module
 from google.protobuf.timestamp_pb2 import Timestamp
 from google.cloud.spanner_v1.gapic_version import __version__
@@ -60,12 +56,9 @@
         Sum,
     )
     from opentelemetry.sdk.resources import Resource
-
-    HAS_OPENTELEMETRY_INSTALLED = True
-except ImportError:  # pragma: NO COVER
-    HAS_OPENTELEMETRY_INSTALLED = False
-
-try:
+    from google.cloud.monitoring_v3.services.metric_service.transports.grpc import (
+        MetricServiceGrpcTransport,
+    )
     from google.cloud.monitoring_v3 import (
         CreateTimeSeriesRequest,
         MetricServiceClient,
@@ -75,13 +68,10 @@
         TypedValue,
     )
 
-    HAS_GOOGLE_CLOUD_MONITORING_INSTALLED = True
-except ImportError:
-    HAS_GOOGLE_CLOUD_MONITORING_INSTALLED = False
-
-HAS_DEPENDENCIES_INSTALLED = (
-    HAS_OPENTELEMETRY_INSTALLED and HAS_GOOGLE_CLOUD_MONITORING_INSTALLED
-)
+    HAS_OPENTELEMETRY_INSTALLED = True
+except ImportError:  # pragma: NO COVER
+    HAS_OPENTELEMETRY_INSTALLED = False
+    MetricExporter = object
 
 logger = logging.getLogger(__name__)
 MAX_BATCH_WRITE = 200
@@ -120,7 +110,7 @@ class CloudMonitoringMetricsExporter(MetricExporter):
     def __init__(
         self,
         project_id: Optional[str] = None,
-        client: Optional[MetricServiceClient] = None,
+        client: Optional["MetricServiceClient"] = None,
     ):
         """Initialize a custom exporter to send metrics for the Spanner Service Metrics."""
         # Default preferred_temporality is all CUMULATIVE so need to customize
@@ -144,7 +134,7 @@ def __init__(
             self.project_id = project_id
         self.project_name = self.client.common_project_path(self.project_id)
 
-    def _batch_write(self, series: List[TimeSeries], timeout_millis: float) -> None:
+    def _batch_write(self, series: List["TimeSeries"], timeout_millis: float) -> None:
         """Cloud Monitoring allows writing up to 200 time series at once.
 
         :param series: ProtoBuf TimeSeries
@@ -166,8 +156,8 @@ def _batch_write(self, series: List[TimeSeries], timeout_millis: float) -> None:
 
     @staticmethod
     def _resource_to_monitored_resource_pb(
-        resource: Resource, labels: any
-    ) -> MonitoredResource:
+        resource: "Resource", labels: Dict[str, str]
+    ) -> "MonitoredResource":
         """
         Convert the resource to a Google Cloud Monitoring monitored resource.
 
@@ -182,7 +172,7 @@ def _resource_to_monitored_resource_pb(
         return monitored_resource
 
     @staticmethod
-    def _to_metric_kind(metric: Metric) -> MetricDescriptor.MetricKind:
+    def _to_metric_kind(metric: "Metric") -> MetricDescriptor.MetricKind:
         """
         Convert the metric to a Google Cloud Monitoring metric kind.
 
@@ -210,7 +200,7 @@ def _to_metric_kind(metric: Metric) -> MetricDescriptor.MetricKind:
 
     @staticmethod
     def _extract_metric_labels(
-        data_point: Union[NumberDataPoint, HistogramDataPoint]
+        data_point: Union["NumberDataPoint", "HistogramDataPoint"]
     ) -> Tuple[dict, dict]:
         """
         Extract the metric labels from the data point.
@@ -233,8 +223,8 @@ def _extract_metric_labels(
     @staticmethod
     def _to_point(
         kind: "MetricDescriptor.MetricKind.V",
-        data_point: Union[NumberDataPoint, HistogramDataPoint],
-    ) -> Point:
+        data_point: Union["NumberDataPoint", "HistogramDataPoint"],
+    ) -> "Point":
         # Create a Google Cloud Monitoring data point value based on the OpenTelemetry metric data point type
         ## For histograms, we need to calculate the mean and bucket counts
         if isinstance(data_point, HistogramDataPoint):
@@ -281,7 +271,7 @@ def _data_point_to_timeseries_pb(
         metric,
         monitored_resource,
         labels,
-    ) -> TimeSeries:
+    ) -> "TimeSeries":
         """
         Convert the data point to a Google Cloud Monitoring time series.
 
@@ -308,8 +298,8 @@ def _data_point_to_timeseries_pb(
 
     @staticmethod
     def _resource_metrics_to_timeseries_pb(
-        metrics_data: MetricsData,
-    ) -> List[TimeSeries]:
+        metrics_data: "MetricsData",
+    ) -> List["TimeSeries"]:
         """
         Convert the metrics data to a list of Google Cloud Monitoring time series.
 
@@ -346,18 +336,18 @@ def _resource_metrics_to_timeseries_pb(
 
     def export(
         self,
-        metrics_data: MetricsData,
+        metrics_data: "MetricsData",
         timeout_millis: float = 10_000,
         **kwargs,
-    ) -> MetricExportResult:
+    ) -> "MetricExportResult":
         """
         Export the metrics data to Google Cloud Monitoring.
 
         :param metrics_data: OpenTelemetry metrics data
         :param timeout_millis: timeout in milliseconds
         :return: MetricExportResult
         """
-        if not HAS_DEPENDENCIES_INSTALLED:
+        if not HAS_OPENTELEMETRY_INSTALLED:
             logger.warning("Metric exporter called without dependencies installed.")
             return False
 

google/cloud/spanner_v1/metrics/metrics_tracer.py

@@ -251,7 +251,7 @@ def client_attributes(self) -> Dict[str, str]:
         return self._client_attributes
 
     @property
-    def instrument_attempt_counter(self) -> Counter:
+    def instrument_attempt_counter(self) -> "Counter":
         """
         Return the instrument for counting attempts.
 
@@ -264,7 +264,7 @@ def instrument_attempt_counter(self) -> Counter:
         return self._instrument_attempt_counter
 
     @property
-    def instrument_attempt_latency(self) -> Histogram:
+    def instrument_attempt_latency(self) -> "Histogram":
         """
         Return the instrument for measuring attempt latency.
 
@@ -277,7 +277,7 @@ def instrument_attempt_latency(self) -> Histogram:
         return self._instrument_attempt_latency
 
     @property
-    def instrument_operation_counter(self) -> Counter:
+    def instrument_operation_counter(self) -> "Counter":
         """
         Return the instrument for counting operations.
 
@@ -290,7 +290,7 @@ def instrument_operation_counter(self) -> Counter:
         return self._instrument_operation_counter
 
     @property
-    def instrument_operation_latency(self) -> Histogram:
+    def instrument_operation_latency(self) -> "Histogram":
         """
         Return the instrument for measuring operation latency.
 

google/cloud/spanner_v1/metrics/metrics_tracer_factory.py

@@ -50,26 +50,26 @@ class MetricsTracerFactory:
     """Factory class for creating MetricTracer instances. This class facilitates the creation of MetricTracer objects, which are responsible for collecting and tracing metrics."""
 
     enabled: bool
-    _instrument_attempt_latency: Histogram
-    _instrument_attempt_counter: Counter
-    _instrument_operation_latency: Histogram
-    _instrument_operation_counter: Counter
+    _instrument_attempt_latency: "Histogram"
+    _instrument_attempt_counter: "Counter"
+    _instrument_operation_latency: "Histogram"
+    _instrument_operation_counter: "Counter"
     _client_attributes: Dict[str, str]
 
     @property
-    def instrument_attempt_latency(self) -> Histogram:
+    def instrument_attempt_latency(self) -> "Histogram":
         return self._instrument_attempt_latency
 
     @property
-    def instrument_attempt_counter(self) -> Counter:
+    def instrument_attempt_counter(self) -> "Counter":
         return self._instrument_attempt_counter
 
     @property
-    def instrument_operation_latency(self) -> Histogram:
+    def instrument_operation_latency(self) -> "Histogram":
         return self._instrument_operation_latency
 
     @property
-    def instrument_operation_counter(self) -> Counter:
+    def instrument_operation_counter(self) -> "Counter":
         return self._instrument_operation_counter
 
     def __init__(self, enabled: bool, service_name: str):

google/cloud/spanner_v1/metrics/spanner_metrics_tracer_factory.py

@@ -23,12 +23,18 @@
     GOOGLE_CLOUD_REGION_KEY,
     GOOGLE_CLOUD_REGION_GLOBAL,
 )
-from opentelemetry.resourcedetector.gcp_resource_detector import (
-    GoogleCloudResourceDetector,
-)
+
+try:
+    from opentelemetry.resourcedetector.gcp_resource_detector import (
+        GoogleCloudResourceDetector,
+    )
+    import mmh3
+    HAS_OPENTELEMETRY_INSTALLED = True
+except ImportError:  # pragma: NO COVER
+    HAS_OPENTELEMETRY_INSTALLED = False
+
 from .metrics_tracer import MetricsTracer
 from google.cloud.spanner_v1 import __version__
-import mmh3
 from uuid import uuid4
 
 
@@ -105,6 +111,8 @@ def _generate_client_hash(client_uid: str) -> str:
     @staticmethod
     def _get_location() -> str:
         """Get the location of the resource."""
+        if not HAS_OPENTELEMETRY_INSTALLED:
+            return GOOGLE_CLOUD_REGION_GLOBAL
         detector = GoogleCloudResourceDetector()
         resources = detector.detect()
         if GOOGLE_CLOUD_REGION_KEY not in resources.attributes:

tests/mockserver_tests/test_tags.py

@@ -181,10 +181,14 @@ def test_request_tag_is_cleared(self):
             # This query will not have a request tag.
             cursor.execute("select name from singers")
         requests = self.spanner_service.requests
-        self.assertTrue(isinstance(requests[1], ExecuteSqlRequest))
-        self.assertTrue(isinstance(requests[2], ExecuteSqlRequest))
-        self.assertEqual("my_tag", requests[1].request_options.request_tag)
-        self.assertEqual("", requests[2].request_options.request_tag)
+
+        # Filter for SQL requests calls
+        sql_requests = [request for request in requests if isinstance(request, ExecuteSqlRequest)]
+
+        self.assertTrue(isinstance(sql_requests[0], ExecuteSqlRequest))
+        self.assertTrue(isinstance(sql_requests[1], ExecuteSqlRequest))
+        self.assertEqual("my_tag", sql_requests[0].request_options.request_tag)
+        self.assertEqual("", sql_requests[1].request_options.request_tag)
 
     def _execute_and_verify_select_singers(
         self, connection: Connection, request_tag: str = "", transaction_tag: str = ""