cassandra: complete instruments_any conversion

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: 2 people

instrumentation/opentelemetry-instrumentation-cassandra/pyproject.toml

@@ -32,7 +32,8 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-instruments = [
+instruments = []
+instruments-any = [
   "cassandra-driver ~= 3.25",
   "scylla-driver ~= 3.25",
 ]

instrumentation/opentelemetry-instrumentation-cassandra/src/opentelemetry/instrumentation/cassandra/__init__.py

@@ -37,13 +37,18 @@
 ---
 """
 
+from importlib.metadata import PackageNotFoundError, distribution
 from typing import Collection
 
 import cassandra.cluster
 from wrapt import wrap_function_wrapper
 
 from opentelemetry import trace
-from opentelemetry.instrumentation.cassandra.package import _instruments
+from opentelemetry.instrumentation.cassandra.package import (
+    _instruments_any,
+    _instruments_cassandra_driver,
+    _instruments_scylla_driver,
+)
 from opentelemetry.instrumentation.cassandra.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.instrumentation.utils import unwrap
@@ -96,7 +101,20 @@ def _traced_execute_async(func, instance, args, kwargs):
 
 class CassandraInstrumentor(BaseInstrumentor):
     def instrumentation_dependencies(self) -> Collection[str]:
-        return _instruments
+        # Determine if cassandra-driver or scylla-driver is installed
+        try:
+            distribution("cassandra-driver")
+            return (_instruments_cassandra_driver,)
+        except PackageNotFoundError:
+            pass
+
+        try:
+            distribution("scylla-driver")
+            return (_instruments_scylla_driver,)
+        except PackageNotFoundError:
+            pass
+
+        return _instruments_any
 
     def _instrument(self, **kwargs):
         _instrument(

instrumentation/opentelemetry-instrumentation-cassandra/tests/test_cassandra_integration.py

@@ -12,14 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from unittest import mock
+from importlib.metadata import PackageNotFoundError
+from unittest import TestCase, mock
+from unittest.mock import call, patch
 
 import cassandra.cluster
 from wrapt import BoundFunctionWrapper
 
 import opentelemetry.instrumentation.cassandra
 from opentelemetry import trace as trace_api
 from opentelemetry.instrumentation.cassandra import CassandraInstrumentor
+from opentelemetry.instrumentation.cassandra.package import (
+    _instruments_cassandra_driver,
+    _instruments_scylla_driver,
+)
 from opentelemetry.sdk import resources
 from opentelemetry.test.test_base import TestBase
 from opentelemetry.trace import SpanKind
@@ -137,3 +143,95 @@ def test_instrument_connection_no_op_tracer_provider(
 
         spans_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(spans_list), 0)
+
+
+class TestCassandraInstrumentationDependencies(TestCase):
+    @patch("opentelemetry.instrumentation.cassandra.distribution")
+    def test_instrumentation_dependencies_cassandra_driver_installed(
+        self, mock_distribution
+    ) -> None:
+        instrumentation = CassandraInstrumentor()
+
+        def _distribution(name):
+            if name == "cassandra-driver":
+                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("cassandra-driver"),
+            ],
+        )
+        self.assertEqual(
+            package_to_instrument, (_instruments_cassandra_driver,)
+        )
+
+    @patch("opentelemetry.instrumentation.cassandra.distribution")
+    def test_instrumentation_dependencies_scylla_driver_installed(
+        self, mock_distribution
+    ) -> None:
+        instrumentation = CassandraInstrumentor()
+
+        def _distribution(name):
+            if name == "scylla-driver":
+                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("cassandra-driver"),
+                call("scylla-driver"),
+            ],
+        )
+        self.assertEqual(package_to_instrument, (_instruments_scylla_driver,))
+
+    @patch("opentelemetry.instrumentation.cassandra.distribution")
+    def test_instrumentation_dependencies_both_installed(
+        self, mock_distribution
+    ) -> None:
+        instrumentation = CassandraInstrumentor()
+
+        def _distribution(name):
+            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("cassandra-driver")]
+        )
+        self.assertEqual(
+            package_to_instrument, (_instruments_cassandra_driver,)
+        )
+
+    @patch("opentelemetry.instrumentation.cassandra.distribution")
+    def test_instrumentation_dependencies_none_installed(
+        self, mock_distribution
+    ) -> None:
+        instrumentation = CassandraInstrumentor()
+
+        def _distribution(name):
+            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("cassandra-driver"),
+                call("scylla-driver"),
+            ],
+        )
+        self.assertEqual(
+            package_to_instrument,
+            (_instruments_cassandra_driver, _instruments_scylla_driver),
+        )