opensource/opentelemetry-python-contrib
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git synced 2025-08-02 19:47:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Make auto instrumentation use the same dependency resolver as manual instrumentation does (#3202)

Browse Source
This commit is contained in:
RJ Duffner
2025-04-08 06:11:09 -07:00
committed by GitHub
parent 6bde73ce34
commit 6d5a5149d0
10 changed files with 396 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
instrumentation/opentelemetry-instrumentation-kafka-python/tests/test_instrumentation.py
View File

@ -11,12 +11,19 @@
# 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 importlib.metadata import PackageNotFoundError
from unittest import TestCase
from unittest.mock import call, patch
from kafka import KafkaConsumer, KafkaProducer
from wrapt import BoundFunctionWrapper
from opentelemetry.instrumentation.kafka import KafkaInstrumentor
from opentelemetry.instrumentation.kafka.package import (
_instruments,
_instruments_kafka_python,
_instruments_kafka_python_ng,
)
class TestKafka(TestCase):
@ -34,3 +41,97 @@ class TestKafka(TestCase):
self.assertFalse(
isinstance(KafkaConsumer.__next__, BoundFunctionWrapper)
)
@patch("opentelemetry.instrumentation.kafka.distribution")
def test_instrumentation_dependencies_kafka_python_installed(
self, mock_distribution
) -> None:
instrumentation = KafkaInstrumentor()
def _distribution(name):
if name == "kafka-python":
return None
raise PackageNotFoundError
mock_distribution.side_effect = _distribution
package_to_instrument = instrumentation.instrumentation_dependencies()
self.assertEqual(mock_distribution.call_count, 2)
self.assertEqual(
mock_distribution.mock_calls,
[
call("kafka-python-ng"),
call("kafka-python"),
],
)
self.assertEqual(package_to_instrument, (_instruments_kafka_python,))
@patch("opentelemetry.instrumentation.kafka.distribution")
def test_instrumentation_dependencies_kafka_python_ng_installed(
self, mock_distribution
) -> None:
instrumentation = KafkaInstrumentor()
def _distribution(name):
if name == "kafka-python-ng":
return None
raise PackageNotFoundError
mock_distribution.side_effect = _distribution
package_to_instrument = instrumentation.instrumentation_dependencies()
self.assertEqual(mock_distribution.call_count, 1)
self.assertEqual(
mock_distribution.mock_calls, [call("kafka-python-ng")]
)
self.assertEqual(
package_to_instrument, (_instruments_kafka_python_ng,)
)
@patch("opentelemetry.instrumentation.kafka.distribution")
def test_instrumentation_dependencies_both_installed(
self, mock_distribution
) -> None:
instrumentation = KafkaInstrumentor()
def _distribution(name):
# The function returns None here for all names
# to simulate both packages being installed
return None
mock_distribution.side_effect = _distribution
package_to_instrument = instrumentation.instrumentation_dependencies()
self.assertEqual(mock_distribution.call_count, 1)
self.assertEqual(
mock_distribution.mock_calls, [call("kafka-python-ng")]
)
self.assertEqual(
package_to_instrument, (_instruments_kafka_python_ng,)
)
@patch("opentelemetry.instrumentation.kafka.distribution")
def test_instrumentation_dependencies_none_installed(
self, mock_distribution
) -> None:
instrumentation = KafkaInstrumentor()
def _distribution(name):
# Function raises PackageNotFoundError
# if name is not in the list. We will
# raise it for both names to simulate
# neither being installed
raise PackageNotFoundError
mock_distribution.side_effect = _distribution
package_to_instrument = instrumentation.instrumentation_dependencies()
self.assertEqual(mock_distribution.call_count, 2)
self.assertEqual(
mock_distribution.mock_calls,
[
call("kafka-python-ng"),
call("kafka-python"),
],
)
self.assertEqual(package_to_instrument, _instruments)