test(auto-instrumentation): fix diagnostic test lint

Author: pmcollins

opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/_load.py

@@ -93,9 +93,7 @@ def _load_distro() -> BaseDistro:
                         entry_point.name,
                     )
                     continue
-                _debug(
-                    "Distribution %s will be configured", entry_point.name
-                )
+                _debug("Distribution %s will be configured", entry_point.name)
                 return distro
         except Exception as exc:  # pylint: disable=broad-except
             _logger.exception(
@@ -121,9 +119,7 @@ def _load_instrumentors(distro):
             break
 
         if entry_point.name in package_to_exclude:
-            _debug(
-                "Instrumentation skipped for library %s", entry_point.name
-            )
+            _debug("Instrumentation skipped for library %s", entry_point.name)
             continue
 
         try:

opentelemetry-instrumentation/tests/auto_instrumentation/test_load.py

@@ -198,104 +198,66 @@ def _instrumentation_failed_to_load_call(entry_point, dependency_conflict):
             "Skipping instrumentation %s: %s", entry_point, dependency_conflict
         )
 
-    @patch.dict("os.environ", {"OTEL_LOG_LEVEL": "debug"}, clear=True)
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load.stderr")
-    def test_writes_diagnostic_debug_output(
-        self, stderr_mock, logger_mock
-    ):
-        logger_mock.isEnabledFor.return_value = True
-        logger_mock.hasHandlers.return_value = False
-
-        _load._debug("Instrumented %s", "requests")
-
-        logger_mock.debug.assert_called_once_with(
-            "Instrumented %s", "requests"
-        )
-        stderr_mock.write.assert_called_once_with(
-            "DEBUG:"
-            "opentelemetry.instrumentation.auto_instrumentation._load:"
-            "Instrumented 'requests'\n"
-        )
-        stderr_mock.flush.assert_called_once()
-
-    @patch.dict("os.environ", {"OTEL_LOG_LEVEL": "trace"}, clear=True)
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load.stderr")
-    def test_writes_diagnostic_trace_output(self, stderr_mock, logger_mock):
-        logger_mock.isEnabledFor.return_value = True
-        logger_mock.hasHandlers.return_value = False
-
-        _load._debug("Instrumented %s", "requests")
-
-        logger_mock.debug.assert_called_once_with(
-            "Instrumented %s", "requests"
-        )
-        stderr_mock.write.assert_called_once_with(
-            "DEBUG:"
-            "opentelemetry.instrumentation.auto_instrumentation._load:"
-            "Instrumented 'requests'\n"
-        )
-        stderr_mock.flush.assert_called_once()
-
-    @patch.dict("os.environ", {"OTEL_LOG_LEVEL": "debug"}, clear=True)
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load.stderr")
-    def test_does_not_write_diagnostic_when_logger_handles_debug(
-        self, stderr_mock, logger_mock
-    ):
-        logger_mock.isEnabledFor.return_value = True
-        logger_mock.hasHandlers.return_value = True
-
-        _load._debug("Instrumented %s", "requests")
-
-        logger_mock.debug.assert_called_once_with(
-            "Instrumented %s", "requests"
-        )
-        stderr_mock.write.assert_not_called()
-        stderr_mock.flush.assert_not_called()
-
-    @patch.dict("os.environ", {"OTEL_LOG_LEVEL": "info"}, clear=True)
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load.stderr")
-    def test_does_not_write_diagnostic_non_debug_output(
-        self, stderr_mock, logger_mock
-    ):
-        _load._debug("Instrumented %s", "requests")
-
-        logger_mock.debug.assert_called_once_with(
-            "Instrumented %s", "requests"
-        )
-        stderr_mock.write.assert_not_called()
-        stderr_mock.flush.assert_not_called()
-
-    @patch.dict("os.environ", {"OTEL_LOG_LEVEL": "debug2"}, clear=True)
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load.stderr")
-    def test_does_not_write_numbered_debug_output(
-        self, stderr_mock, logger_mock
-    ):
-        _load._debug("Instrumented %s", "requests")
-
-        logger_mock.debug.assert_called_once_with(
-            "Instrumented %s", "requests"
+    def test_writes_diagnostic_output_for_debug_levels(self):
+        for log_level in ("debug", "trace"):
+            with (
+                self.subTest(log_level=log_level),
+                patch.dict(
+                    "os.environ", {"OTEL_LOG_LEVEL": log_level}, clear=True
+                ),
+                patch(
+                    "opentelemetry.instrumentation.auto_instrumentation._load._logger"
+                ) as logger_mock,
+                patch(
+                    "opentelemetry.instrumentation.auto_instrumentation._load.stderr"
+                ) as stderr_mock,
+            ):
+                logger_mock.isEnabledFor.return_value = True
+                logger_mock.hasHandlers.return_value = False
+
+                _load._debug("Instrumented %s", "requests")
+
+                logger_mock.debug.assert_called_once_with(
+                    "Instrumented %s", "requests"
+                )
+                stderr_mock.write.assert_called_once_with(
+                    "DEBUG:"
+                    "opentelemetry.instrumentation.auto_instrumentation._load:"
+                    "Instrumented 'requests'\n"
+                )
+                stderr_mock.flush.assert_called_once()
+
+    def test_does_not_write_diagnostic_output(self):
+        cases = (
+            ("debug", True),
+            ("info", False),
+            ("debug2", False),
+            ("debugger", False),
         )
-        stderr_mock.write.assert_not_called()
-        stderr_mock.flush.assert_not_called()
-
-    @patch.dict("os.environ", {"OTEL_LOG_LEVEL": "debugger"}, clear=True)
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load._logger")
-    @patch("opentelemetry.instrumentation.auto_instrumentation._load.stderr")
-    def test_does_not_prefix_match_diagnostic_debug_output(
-        self, stderr_mock, logger_mock
-    ):
-        _load._debug("Instrumented %s", "requests")
 
-        logger_mock.debug.assert_called_once_with(
-            "Instrumented %s", "requests"
-        )
-        stderr_mock.write.assert_not_called()
-        stderr_mock.flush.assert_not_called()
+        for log_level, logger_has_handlers in cases:
+            with (
+                self.subTest(log_level=log_level),
+                patch.dict(
+                    "os.environ", {"OTEL_LOG_LEVEL": log_level}, clear=True
+                ),
+                patch(
+                    "opentelemetry.instrumentation.auto_instrumentation._load._logger"
+                ) as logger_mock,
+                patch(
+                    "opentelemetry.instrumentation.auto_instrumentation._load.stderr"
+                ) as stderr_mock,
+            ):
+                logger_mock.isEnabledFor.return_value = True
+                logger_mock.hasHandlers.return_value = logger_has_handlers
+
+                _load._debug("Instrumented %s", "requests")
+
+                logger_mock.debug.assert_called_once_with(
+                    "Instrumented %s", "requests"
+                )
+                stderr_mock.write.assert_not_called()
+                stderr_mock.flush.assert_not_called()
 
     @patch.dict(
         "os.environ",