mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-29 13:12:39 +08:00
d6f6c60c16
* Update instrumentor.py * Add tests for dependency conflict logging * Format code in test_instrument_missing_dependency * Add comments for dependency conflict handling
91 lines
3.0 KiB
Python
91 lines
3.0 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.
|
|
# type: ignore
|
|
|
|
from logging import WARNING
|
|
from unittest import TestCase
|
|
from unittest.mock import patch
|
|
|
|
from opentelemetry.instrumentation.dependencies import (
|
|
DependencyConflict,
|
|
DependencyConflictError,
|
|
)
|
|
from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
|
|
|
|
|
|
class TestInstrumentor(TestCase):
|
|
class Instrumentor(BaseInstrumentor):
|
|
def _instrument(self, **kwargs):
|
|
return "instrumented"
|
|
|
|
def _uninstrument(self, **kwargs):
|
|
return "uninstrumented"
|
|
|
|
def instrumentation_dependencies(self):
|
|
return []
|
|
|
|
def test_protect(self):
|
|
instrumentor = self.Instrumentor()
|
|
|
|
with self.assertLogs(level=WARNING):
|
|
self.assertIs(instrumentor.uninstrument(), None)
|
|
|
|
self.assertEqual(instrumentor.instrument(), "instrumented")
|
|
|
|
with self.assertLogs(level=WARNING):
|
|
self.assertIs(instrumentor.instrument(), None)
|
|
|
|
self.assertEqual(instrumentor.uninstrument(), "uninstrumented")
|
|
|
|
with self.assertLogs(level=WARNING):
|
|
self.assertIs(instrumentor.uninstrument(), None)
|
|
|
|
def test_singleton(self):
|
|
self.assertIs(self.Instrumentor(), self.Instrumentor())
|
|
|
|
@patch("opentelemetry.instrumentation.instrumentor._LOG")
|
|
@patch(
|
|
"opentelemetry.instrumentation.instrumentor.BaseInstrumentor._check_dependency_conflicts"
|
|
)
|
|
def test_instrument_missing_dependency_raise(
|
|
self, mock__check_dependency_conflicts, mock_logger
|
|
):
|
|
instrumentor = self.Instrumentor()
|
|
|
|
mock__check_dependency_conflicts.return_value = DependencyConflict(
|
|
"missing", "missing"
|
|
)
|
|
|
|
self.assertRaises(
|
|
DependencyConflictError,
|
|
instrumentor.instrument,
|
|
raise_exception_on_conflict=True,
|
|
)
|
|
mock_logger.error.assert_not_called()
|
|
|
|
@patch("opentelemetry.instrumentation.instrumentor._LOG")
|
|
@patch(
|
|
"opentelemetry.instrumentation.instrumentor.BaseInstrumentor._check_dependency_conflicts"
|
|
)
|
|
def test_instrument_missing_dependency_log_error(
|
|
self, mock__check_dependency_conflicts, mock_logger
|
|
):
|
|
instrumentor = self.Instrumentor()
|
|
conflict = DependencyConflict("missing", "missing")
|
|
mock__check_dependency_conflicts.return_value = conflict
|
|
self.assertIsNone(
|
|
instrumentor.instrument(raise_exception_on_conflict=False)
|
|
)
|
|
mock_logger.error.assert_any_call(conflict)
|