Add test for span context key warning

sethmaxwl · sethmaxwl · commit 84b3a12be248 · 2020-07-16T19:20:21.000Z
diff --git a/google/cloud/pubsub_v1/opentelemetry_tracing.py b/google/cloud/pubsub_v1/opentelemetry_tracing.py
@@ -69,7 +69,7 @@ def create_span(span_name, attributes=None, parent=None):
         try:
             parent_span_context = SpanContext(**parent)
         except TypeError:
-            _LOGGER.warn(
+            _LOGGER.warning(
                 "A parent span was provided but it could not be"
                 "converted into a SpanContext. Ensure that the"
                 "parent is a mapping with at least a trace_id, span_id"
diff --git a/google/cloud/pubsub_v1/publisher/client.py b/google/cloud/pubsub_v1/publisher/client.py
@@ -378,7 +378,7 @@ def publish(self, topic, data, ordering_key="", **attrs):
             if span is not None:
 
                 if "googclient_OpenTelemetrySpanContext" in attrs:
-                    _LOGGER.warn(
+                    _LOGGER.warning(
                         "googclient_OpenTelemetrySpanContext set on message"
                         "as an attribute, but will be overridden."
                     )
diff --git a/tests/unit/pubsub_v1/publisher/test_publisher_client.py b/tests/unit/pubsub_v1/publisher/test_publisher_client.py
@@ -21,6 +21,7 @@
 import pytest
 import time
 import sys
+import logging
 from importlib import reload
 
 from google.cloud.pubsub_v1.gapic import publisher_client
@@ -291,6 +292,16 @@ def test_publish_attrs_type_error():
     with pytest.raises(TypeError):
         client.publish(topic, b"foo", answer=42)
 
+def test_publish_opentelemetry_span_key_warning(caplog):
+    creds = mock.Mock(spec=credentials.Credentials)
+    client = publisher.Client(credentials=creds)
+    topic = "topic/path"
+
+    with caplog.at_level(logging.WARNING):
+        client.publish(topic, b"foo", googclient_OpenTelemetrySpanContext=b"bar")
+
+    assert len(caplog.records) == 1
+
 
 def test_stop():
     creds = mock.Mock(spec=credentials.Credentials)

Original file line number	Diff line number	Diff line change
`@@ -378,7 +378,7 @@ def publish(self, topic, data, ordering_key="", **attrs):`
`378`	`378`	`if span is not None:`
`379`	`379`
`380`	`380`	`if "googclient_OpenTelemetrySpanContext" in attrs:`
`381`		`- _LOGGER.warn(`
	`381`	`+ _LOGGER.warning(`
`382`	`382`	`"googclient_OpenTelemetrySpanContext set on message"`
`383`	`383`	`"as an attribute, but will be overridden."`
`384`	`384`	`)`