remove pkg_resources and use alternative to align with upstream otel >= 1.28.0

Author: yiyuan-he

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/_utils.py

@@ -3,9 +3,10 @@
 
 import os
 import sys
+from importlib.metadata import PackageNotFoundError, version
 from logging import Logger, getLogger
 
-import pkg_resources
+from packaging.requirements import Requirement
 
 _logger: Logger = getLogger(__name__)
 
@@ -18,10 +19,23 @@ def is_installed(req: str) -> bool:
     if req in sys.modules and sys.modules[req] is not None:
         return True
 
+    return _is_installed(req)
+
+
+def _is_installed(req):
+    req = Requirement(req)
+
     try:
-        pkg_resources.get_distribution(req)
-    except Exception as exc:  # pylint: disable=broad-except
-        _logger.debug("Skipping instrumentation patch: package %s, exception: %s", req, exc)
+        dist_version = version(req.name)
+    except PackageNotFoundError:
+        return False
+
+    if not req.specifier.filter(dist_version):
+        _logger.warning(
+            "instrumentation for package %s is available but version %s is installed. Skipping.",
+            req,
+            dist_version,
+        )
         return False
     return True
 

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_aws_auth_session.py

@@ -1,5 +1,6 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
+from importlib.metadata import PackageNotFoundError
 from unittest import TestCase
 from unittest.mock import patch
 
@@ -19,11 +20,12 @@
 
 
 class TestAwsAuthSession(TestCase):
-    @patch("pkg_resources.get_distribution", side_effect=ImportError("test error"))
-    @patch.dict("sys.modules", {"botocore": None}, clear=False)
+    @patch("amazon.opentelemetry.distro._utils.version")
+    @patch.dict("sys.modules", {"botocore": None})
     @patch("requests.Session.request", return_value=requests.Response())
-    def test_aws_auth_session_no_botocore(self, _, __):
+    def test_aws_auth_session_no_botocore(self, mock_request, mock_version):
         """Tests that aws_auth_session will not inject SigV4 Headers if botocore is not installed."""
+        mock_version.side_effect = PackageNotFoundError("botocore")
 
         session = AwsAuthSession("us-east-1", "xray")
         actual_headers = {"test": "test"}

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_aws_opentelemetry_distro.py

@@ -1,13 +1,12 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
+from importlib.metadata import PackageNotFoundError, version
 from unittest import TestCase
 
-from pkg_resources import DistributionNotFound, require
-
 
 class TestAwsOpenTelemetryDistro(TestCase):
     def test_package_available(self):
         try:
-            require(["aws-opentelemetry-distro"])
-        except DistributionNotFound:
+            version("aws-opentelemetry-distro")
+        except PackageNotFoundError:
             self.fail("aws-opentelemetry-distro not installed")

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_instrumentation_patch.py

@@ -9,8 +9,8 @@
 from unittest.mock import MagicMock, patch
 
 import gevent.monkey
-import pkg_resources
 from botocore.response import StreamingBody
+from importlib.metadata import PackageNotFoundError
 
 from amazon.opentelemetry.distro.patches._instrumentation_patch import (
     AWS_GEVENT_PATCH_MODULES,
@@ -38,7 +38,7 @@
 _LAMBDA_SOURCE_MAPPING_ID: str = "lambdaEventSourceMappingID"
 
 # Patch names
-GET_DISTRIBUTION_PATCH: str = "amazon.opentelemetry.distro._utils.pkg_resources.get_distribution"
+GET_DISTRIBUTION_PATCH: str = "amazon.opentelemetry.distro._utils.version"
 
 
 class TestInstrumentationPatch(TestCase):
@@ -73,7 +73,7 @@ def test_instrumentation_patch(self):
 
     def _run_patch_behaviour_tests(self):
         # Test setup
-        self.method_patches[GET_DISTRIBUTION_PATCH].return_value = "CorrectDistributionObject"
+        self.method_patches[GET_DISTRIBUTION_PATCH].return_value = "1.0.0"
         # Test setup to not patch gevent
         os.environ[AWS_GEVENT_PATCH_MODULES] = "none"
 
@@ -359,16 +359,12 @@ def _test_botocore_installed_flag(self):
             "amazon.opentelemetry.distro.patches._botocore_patches._apply_botocore_instrumentation_patches"
         ) as mock_apply_patches:
             get_distribution_patch: patch = self.method_patches[GET_DISTRIBUTION_PATCH]
-            get_distribution_patch.side_effect = pkg_resources.DistributionNotFound
-            apply_instrumentation_patches()
-            mock_apply_patches.assert_not_called()
-
-            get_distribution_patch.side_effect = pkg_resources.VersionConflict("botocore==1.0.0", "botocore==0.0.1")
+            get_distribution_patch.side_effect = PackageNotFoundError
             apply_instrumentation_patches()
             mock_apply_patches.assert_not_called()
 
             get_distribution_patch.side_effect = None
-            get_distribution_patch.return_value = "CorrectDistributionObject"
+            get_distribution_patch.return_value = "1.0.0"
             apply_instrumentation_patches()
             mock_apply_patches.assert_called()