mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-28 20:52:57 +08:00
ac84e9968f
* Integrating sql commenter into otel_django_instrumentation * Added test cases for django * - Linting changes - Added Changelog * - Linting changes * - Linting changes * - Linting changes * - Linting changes * - Linting changes * - Linting changes * - Linting changes * PR changes * PR changes * Linting changes * Linting changes * Linting changes * Linting changes * PR changes * PR changes * PR changes * linting changes * PR changes * linting changes * PR changes * PR changes * PR changes * PR changes * PR changes Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com> Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
101 lines
3.4 KiB
Python
101 lines
3.4 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.
|
|
|
|
# pylint: disable=no-name-in-module
|
|
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from django import VERSION, conf
|
|
from django.http import HttpResponse
|
|
from django.test.utils import setup_test_environment, teardown_test_environment
|
|
|
|
from opentelemetry.instrumentation.django import DjangoInstrumentor
|
|
from opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware import (
|
|
_QueryWrapper,
|
|
)
|
|
from opentelemetry.test.wsgitestutil import WsgiTestBase
|
|
|
|
DJANGO_2_0 = VERSION >= (2, 0)
|
|
|
|
_django_instrumentor = DjangoInstrumentor()
|
|
|
|
|
|
class TestMiddleware(WsgiTestBase):
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
conf.settings.configure(
|
|
SQLCOMMENTER_WITH_FRAMEWORK=False,
|
|
SQLCOMMENTER_WITH_DB_DRIVER=False,
|
|
)
|
|
super().setUpClass()
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
setup_test_environment()
|
|
_django_instrumentor.instrument(is_sql_commentor_enabled=True)
|
|
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
teardown_test_environment()
|
|
_django_instrumentor.uninstrument()
|
|
|
|
@classmethod
|
|
def tearDownClass(cls):
|
|
super().tearDownClass()
|
|
conf.settings = conf.LazySettings()
|
|
|
|
@patch(
|
|
"opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware.SqlCommenter"
|
|
)
|
|
def test_middleware_added(self, sqlcommenter_middleware):
|
|
instance = sqlcommenter_middleware.return_value
|
|
instance.get_response = HttpResponse()
|
|
if DJANGO_2_0:
|
|
middleware = conf.settings.MIDDLEWARE
|
|
else:
|
|
middleware = conf.settings.MIDDLEWARE_CLASSES
|
|
|
|
self.assertTrue(
|
|
"opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware.SqlCommenter"
|
|
in middleware
|
|
)
|
|
|
|
@patch(
|
|
"opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware._get_opentelemetry_values"
|
|
)
|
|
def test_query_wrapper(self, trace_capture):
|
|
requests_mock = MagicMock()
|
|
requests_mock.resolver_match.view_name = "view"
|
|
requests_mock.resolver_match.route = "route"
|
|
requests_mock.resolver_match.app_name = "app"
|
|
|
|
trace_capture.return_value = {
|
|
"traceparent": "*traceparent='00-000000000000000000000000deadbeef-000000000000beef-00"
|
|
}
|
|
qw_instance = _QueryWrapper(requests_mock)
|
|
execute_mock_obj = MagicMock()
|
|
qw_instance(
|
|
execute_mock_obj,
|
|
"Select 1",
|
|
MagicMock("test"),
|
|
MagicMock("test1"),
|
|
MagicMock(),
|
|
)
|
|
output_sql = execute_mock_obj.call_args[0][0]
|
|
self.assertEqual(
|
|
output_sql,
|
|
"Select 1 /*app_name='app',controller='view',route='route',traceparent='%%2Atraceparent%%3D%%2700-0000000"
|
|
"00000000000000000deadbeef-000000000000beef-00'*/",
|
|
)
|