142 lines
4.9 KiB
Python
142 lines
4.9 KiB
Python
# Copyright The OpenTelemetry Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from unittest import mock
|
|
|
|
import psycopg2
|
|
|
|
import opentelemetry.instrumentation.psycopg2
|
|
from opentelemetry.instrumentation.psycopg2 import Psycopg2Instrumentor
|
|
from opentelemetry.sdk import resources
|
|
from opentelemetry.test.test_base import TestBase
|
|
|
|
|
|
class TestPostgresqlIntegration(TestBase):
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
with self.disable_logging():
|
|
Psycopg2Instrumentor().uninstrument()
|
|
|
|
@mock.patch("psycopg2.connect")
|
|
# pylint: disable=unused-argument
|
|
def test_instrumentor(self, mock_connect):
|
|
Psycopg2Instrumentor().instrument()
|
|
|
|
cnx = psycopg2.connect(database="test")
|
|
|
|
cursor = cnx.cursor()
|
|
|
|
query = "SELECT * FROM test"
|
|
cursor.execute(query)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
|
|
# Check version and name in span's instrumentation info
|
|
self.check_span_instrumentation_info(
|
|
span, opentelemetry.instrumentation.psycopg2
|
|
)
|
|
|
|
# check that no spans are generated after uninstrument
|
|
Psycopg2Instrumentor().uninstrument()
|
|
|
|
cnx = psycopg2.connect(database="test")
|
|
cursor = cnx.cursor()
|
|
query = "SELECT * FROM test"
|
|
cursor.execute(query)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
|
|
@mock.patch("psycopg2.connect")
|
|
# pylint: disable=unused-argument
|
|
def test_not_recording(self, mock_connect):
|
|
mock_tracer = mock.Mock()
|
|
mock_span = mock.Mock()
|
|
mock_span.is_recording.return_value = False
|
|
mock_tracer.start_span.return_value = mock_span
|
|
mock_tracer.use_span.return_value.__enter__ = mock_span
|
|
mock_tracer.use_span.return_value.__exit__ = True
|
|
Psycopg2Instrumentor().instrument()
|
|
with mock.patch("opentelemetry.trace.get_tracer") as tracer:
|
|
tracer.return_value = mock_tracer
|
|
cnx = psycopg2.connect(database="test")
|
|
cursor = cnx.cursor()
|
|
query = "SELECT * FROM test"
|
|
cursor.execute(query)
|
|
self.assertFalse(mock_span.is_recording())
|
|
self.assertTrue(mock_span.is_recording.called)
|
|
self.assertFalse(mock_span.set_attribute.called)
|
|
self.assertFalse(mock_span.set_status.called)
|
|
|
|
Psycopg2Instrumentor().uninstrument()
|
|
|
|
@mock.patch("psycopg2.connect")
|
|
# pylint: disable=unused-argument
|
|
def test_custom_tracer_provider(self, mock_connect):
|
|
resource = resources.Resource.create({})
|
|
result = self.create_tracer_provider(resource=resource)
|
|
tracer_provider, exporter = result
|
|
|
|
Psycopg2Instrumentor().instrument(tracer_provider=tracer_provider)
|
|
|
|
cnx = psycopg2.connect(database="test")
|
|
cursor = cnx.cursor()
|
|
query = "SELECT * FROM test"
|
|
cursor.execute(query)
|
|
|
|
spans_list = exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
|
|
self.assertIs(span.resource, resource)
|
|
|
|
@mock.patch("psycopg2.connect")
|
|
# pylint: disable=unused-argument
|
|
def test_instrument_connection(self, mock_connect):
|
|
cnx = psycopg2.connect(database="test")
|
|
query = "SELECT * FROM test"
|
|
cursor = cnx.cursor()
|
|
cursor.execute(query)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 0)
|
|
|
|
cnx = Psycopg2Instrumentor().instrument_connection(cnx)
|
|
cursor = cnx.cursor()
|
|
cursor.execute(query)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
|
|
@mock.patch("psycopg2.connect")
|
|
# pylint: disable=unused-argument
|
|
def test_uninstrument_connection(self, mock_connect):
|
|
Psycopg2Instrumentor().instrument()
|
|
cnx = psycopg2.connect(database="test")
|
|
query = "SELECT * FROM test"
|
|
cursor = cnx.cursor()
|
|
cursor.execute(query)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
|
|
cnx = Psycopg2Instrumentor().uninstrument_connection(cnx)
|
|
cursor = cnx.cursor()
|
|
cursor.execute(query)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|