Skip to content

test(mysql): provide concrete DBAPI connection attributes in mocks #4116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xrmx merged 14 commits into from
Feb 20, 2026
Merged

test(mysql): provide concrete DBAPI connection attributes in mocks #4116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
270d0bc
test(mysql): provide concrete DBAPI connection attributes in mocks
rite7sh Jan 21, 2026
8cf29c7
test(mysql): pass concrete attributes via MagicMock helpers
rite7sh Jan 22, 2026
98dc66c
test(mysql): refactor mocks and remove redundant attribute assignments
rite7sh Jan 22, 2026
af49844
Merge branch 'main' into fix-mysql-test-mock-attributes
rite7sh Jan 23, 2026
8d49dd9
changelog: add mysql test mock fix entry
rite7sh Jan 25, 2026
caa23e9
test(mysql): refactor SQL commenter mocks into helper
rite7sh Jan 26, 2026
24b9b52
Merge branch 'main' into fix-mysql-test-mock-attributes
rite7sh Jan 26, 2026
e3284f2
Merge branch 'main' into fix-mysql-test-mock-attributes
rite7sh Jan 27, 2026
b9f4a95
Merge branch 'main' into fix-mysql-test-mock-attributes
rite7sh Feb 14, 2026
15420f0
test(mysql): refactor SQL commenter mocks into helper
rite7sh Feb 18, 2026
6275488
Merge branch 'main' into fix-mysql-test-mock-attributes
rite7sh Feb 18, 2026
6faa1c0
test(mysql): use concrete DBAPI connection attributes in mocks to fix…
rite7sh Feb 19, 2026
9a54640
Update instrumentation/opentelemetry-instrumentation-mysql/tests/test…
xrmx Feb 20, 2026
786c2cf
Merge branch 'main' into fix-mysql-test-mock-attributes
xrmx Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#4139](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4139))

### Fixed

- `opentelemetry-instrumentation-mysql`: Refactor MySQL integration test mocks to use concrete DBAPI connection attributes, reducing noisy attribute type warnings.
([#4116](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4116))
- `opentelemetry-instrumentation-cassandra`: Use `_instruments_any` instead of `_instruments` for driver dependencies so that having either `cassandra-driver` or `scylla-driver` installed is sufficient
([#4182](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4182))
- `opentelemetry-instrumentation-asyncpg`: Hydrate span attributes before creation so samplers can filter on database details
Expand Down
150 changes: 61 additions & 89 deletions instrumentation/opentelemetry-instrumentation-mysql/tests/test_mysql_integration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,50 @@ def connect_and_execute_query():
return cnx, query


def make_mysql_connection_mock():
cnx = mock.MagicMock()
cnx.database = "test"
cnx.server_host = "localhost"
cnx.server_port = 3306

cursor = mock.MagicMock()
cursor._cnx = cnx

cnx.cursor.return_value = cursor
return cnx


def make_mysql_commenter_mocks(client_version="foobaz"):
"""Create mock objects for MySQL connector with SQL commenter support.

Args:
client_version: The MySQL client version string to return from get_client_info()

Returns:
Tuple of (mock_connect_module, mock_connection, mock_cursor)
"""
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
)
mock_connection = mock.MagicMock()
mock_connection.database = "test"
mock_connection.server_host = "localhost"
mock_connection.server_port = 3306

mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx = mock_connection
mock_cursor._cnx._cmysql.get_client_info.return_value = client_version

mock_connection.cursor.return_value = mock_cursor
mock_connect_module.connect.return_value = mock_connection

return mock_connect_module, mock_connection, mock_cursor


class TestMysqlIntegration(TestBase):
def tearDown(self):
super().tearDown()
Expand All @@ -44,6 +88,7 @@ def tearDown(self):
@mock.patch("mysql.connector.connect")
# pylint: disable=unused-argument
def test_instrumentor(self, mock_connect):
mock_connect.return_value = make_mysql_connection_mock()
MySQLInstrumentor().instrument()

connect_and_execute_query()
Expand All @@ -68,6 +113,7 @@ def test_instrumentor(self, mock_connect):
@mock.patch("mysql.connector.connect")
# pylint: disable=unused-argument
def test_custom_tracer_provider(self, mock_connect):
mock_connect.return_value = make_mysql_connection_mock()
resource = resources.Resource.create({})
result = self.create_tracer_provider(resource=resource)
tracer_provider, exporter = result
Expand All @@ -84,6 +130,7 @@ def test_custom_tracer_provider(self, mock_connect):
@mock.patch("mysql.connector.connect")
# pylint: disable=unused-argument
def test_instrument_connection(self, mock_connect):
mock_connect.return_value = make_mysql_connection_mock()
cnx, query = connect_and_execute_query()

spans_list = self.memory_exporter.get_finished_spans()
Expand All @@ -98,6 +145,7 @@ def test_instrument_connection(self, mock_connect):

@mock.patch("mysql.connector.connect")
def test_instrument_connection_no_op_tracer_provider(self, mock_connect):
mock_connect.return_value = make_mysql_connection_mock()
tracer_provider = trace_api.NoOpTracerProvider()
MySQLInstrumentor().instrument(tracer_provider=tracer_provider)
connect_and_execute_query()
Expand Down Expand Up @@ -128,17 +176,9 @@ def test_instrument_connection_enable_commenter_dbapi_kwargs(
self.assertEqual(kwargs["enable_attribute_commenter"], True)

def test_instrument_connection_with_dbapi_sqlcomment_enabled(self):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
mock_connect_module, mock_connection, mock_cursor = (
make_mysql_commenter_mocks()
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -166,17 +206,9 @@ def test_instrument_connection_with_dbapi_sqlcomment_enabled(self):
def test_instrument_connection_with_dbapi_sqlcomment_enabled_stmt_enabled(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
mock_connect_module, mock_connection, mock_cursor = (
make_mysql_commenter_mocks()
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -205,17 +237,9 @@ def test_instrument_connection_with_dbapi_sqlcomment_enabled_stmt_enabled(
def test_instrument_connection_with_dbapi_sqlcomment_enabled_with_options(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
mock_connect_module, mock_connection, mock_cursor = (
make_mysql_commenter_mocks()
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -248,18 +272,9 @@ def test_instrument_connection_with_dbapi_sqlcomment_enabled_with_options(
def test_instrument_connection_with_dbapi_sqlcomment_not_enabled_default(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
mock_connect_module, mock_connection, mock_cursor = (
make_mysql_commenter_mocks()
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_cursor = mock_connect_module.connect().cursor()
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -301,18 +316,7 @@ def test_instrument_enable_commenter_dbapi_kwargs(
def test_instrument_with_dbapi_sqlcomment_enabled(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_cursor = mock_connect_module.connect().cursor()
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor
mock_connect_module, _, mock_cursor = make_mysql_commenter_mocks()

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -341,18 +345,7 @@ def test_instrument_with_dbapi_sqlcomment_enabled(
def test_instrument_with_dbapi_sqlcomment_enabled_stmt_enabled(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_cursor = mock_connect_module.connect().cursor()
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor
mock_connect_module, _, mock_cursor = make_mysql_commenter_mocks()

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -382,18 +375,7 @@ def test_instrument_with_dbapi_sqlcomment_enabled_stmt_enabled(
def test_instrument_with_dbapi_sqlcomment_enabled_with_options(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_cursor = mock_connect_module.connect().cursor()
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor
mock_connect_module, _, mock_cursor = make_mysql_commenter_mocks()

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand Down Expand Up @@ -427,18 +409,7 @@ def test_instrument_with_dbapi_sqlcomment_enabled_with_options(
def test_instrument_with_dbapi_sqlcomment_not_enabled_default(
self,
):
mock_connect_module = mock.MagicMock(
__name__="mysql.connector",
__version__="foobar",
threadsafety="123",
apilevel="123",
paramstyle="test",
)
mock_cursor = mock_connect_module.connect().cursor()
mock_cursor._cnx._cmysql.get_client_info.return_value = "foobaz"
mock_cursor = mock_connect_module.connect().cursor()
mock_connection = mock.MagicMock()
mock_connection.cursor.return_value = mock_cursor
mock_connect_module, _, mock_cursor = make_mysql_commenter_mocks()

with mock.patch(
"opentelemetry.instrumentation.mysql.mysql.connector",
Expand All @@ -462,6 +433,7 @@ def test_instrument_with_dbapi_sqlcomment_not_enabled_default(
@mock.patch("mysql.connector.connect")
# pylint: disable=unused-argument
def test_uninstrument_connection(self, mock_connect):
mock_connect.return_value = make_mysql_connection_mock()
MySQLInstrumentor().instrument()
cnx, query = connect_and_execute_query()

Expand Down