Work around httppretty patching

Author: bwoebi

tests/debugging/test_uploader.py

@@ -1,8 +1,10 @@
+from contextlib import ExitStack
 from contextlib import contextmanager
 from http.server import BaseHTTPRequestHandler
 from http.server import ThreadingHTTPServer
 import json
 from queue import Queue
+import socket
 from threading import Thread
 from unittest.mock import MagicMock
 from unittest.mock import patch
@@ -25,6 +27,16 @@
 # so we use a large enough integer as an approximation instead.
 LONG_INTERVAL = 2147483647.0
 
+# httpretty -- reached through tests.internal.remoteconfig.rcm_endpoint, which
+# test_debugger.py uses earlier in this suite -- intermittently leaves the socket
+# module holding its fakes after being disabled. A server built on a fake socket binds
+# a port that never accepts, so the native sender only reports a timeout. These are
+# captured at import time, before any test can patch them, and reinstalled for the
+# lifetime of the intake server below.
+_REAL_SOCKET_ATTRS = {
+    name: getattr(socket, name) for name in ("socket", "create_connection", "getaddrinfo", "socketpair")
+}
+
 
 class MockSignalUploader(SignalUploader):
     def __init__(self, *args, **kwargs):
@@ -212,11 +224,18 @@ def close(self) -> None:
 
 @contextmanager
 def _intake_server():
-    server = _IntakeServer()
-    try:
-        yield server
-    finally:
-        server.close()
+    # socket.socket is consulted again on every accept(), so the real
+    # implementations have to stay installed for as long as the server serves, not
+    # just while it is constructed.
+    with ExitStack() as stack:
+        for name, real in _REAL_SOCKET_ATTRS.items():
+            stack.enter_context(patch.object(socket, name, real))
+
+        server = _IntakeServer()
+        try:
+            yield server
+        finally:
+            server.close()
 
 
 def _uploader_to(url):

tests/internal/remoteconfig/__init__.py

@@ -1,4 +1,15 @@
 from contextlib import contextmanager
+import socket
+
+
+# httpretty replaces these when it patches the socket module, and does not reliably
+# put them back: with ``httpretty.is_enabled()`` already False they can still point at
+# ``httpretty.core``, which leaves every later test in the process unable to open a
+# real socket. Snapshot the real implementations at import time -- before any test can
+# enable httpretty -- so rcm_endpoint can restore them itself.
+_REAL_SOCKET_ATTRS = {
+    name: getattr(socket, name) for name in ("socket", "create_connection", "getaddrinfo", "socketpair")
+}
 
 
 @contextmanager
@@ -13,12 +24,18 @@ def rcm_endpoint(port=10126, poll_interval=0.05):
     from tests.utils import override_env
     from tests.utils import override_global_config
 
-    with (
-        override_env(dict(DD_TRACE_AGENT_URL="http://localhost:%d" % port)),
-        httpretty.enabled(),
-        override_global_config(dict(_remote_config_poll_interval=poll_interval)),
-    ):
-        httpretty.register_uri(
-            httpretty.GET, "http://localhost:%d/info" % port, body='{"endpoints":["%s"]}' % REMOTE_CONFIG_AGENT_ENDPOINT
-        )
-        yield
+    try:
+        with (
+            override_env(dict(DD_TRACE_AGENT_URL="http://localhost:%d" % port)),
+            httpretty.enabled(),
+            override_global_config(dict(_remote_config_poll_interval=poll_interval)),
+        ):
+            httpretty.register_uri(
+                httpretty.GET,
+                "http://localhost:%d/info" % port,
+                body='{"endpoints":["%s"]}' % REMOTE_CONFIG_AGENT_ENDPOINT,
+            )
+            yield
+    finally:
+        for name, real in _REAL_SOCKET_ATTRS.items():
+            setattr(socket, name, real)