Skip to content

[3.6] bpo-33540, socketserver: Add _block_on_close for tests #7317

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
vstinner merged 1 commit into from
Jun 1, 2018
Merged

[3.6] bpo-33540, socketserver: Add _block_on_close for tests #7317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 27 additions & 2 deletions Lib/socketserver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,8 +547,10 @@ class ForkingMixIn:
timeout = 300
active_children = None
max_children = 40
# If true, server_close() waits until all child processes complete.
_block_on_close = False

def collect_children(self):
def collect_children(self, *, blocking=False):
"""Internal routine to wait for children that have exited."""
if self.active_children is None:
return
Expand All @@ -572,7 +574,8 @@ def collect_children(self):
# Now reap all defunct children.
for pid in self.active_children.copy():
try:
pid, _ = os.waitpid(pid, os.WNOHANG)
flags = 0 if blocking else os.WNOHANG
pid, _ = os.waitpid(pid, flags)
# if the child hasn't exited yet, pid will be 0 and ignored by
# discard() below
self.active_children.discard(pid)
Expand Down Expand Up @@ -621,13 +624,22 @@ def process_request(self, request, client_address):
finally:
os._exit(status)

def server_close(self):
super().server_close()
self.collect_children(blocking=self._block_on_close)


class ThreadingMixIn:
"""Mix-in class to handle each request in a new thread."""

# Decides how threads will act upon termination of the
# main process
daemon_threads = False
# If true, server_close() waits until all non-daemonic threads terminate.
_block_on_close = False
# For non-daemonic threads, list of threading.Threading objects
# used by server_close() to wait for all threads completion.
_threads = None

def process_request_thread(self, request, client_address):
"""Same as in BaseServer but as a thread.
Expand All @@ -647,8 +659,21 @@ def process_request(self, request, client_address):
t = threading.Thread(target = self.process_request_thread,
args = (request, client_address))
t.daemon = self.daemon_threads
if not t.daemon and self._block_on_close:
if self._threads is None:
self._threads = []
self._threads.append(t)
t.start()

def server_close(self):
super().server_close()
if self._block_on_close:
threads = self._threads
self._threads = None
if threads:
for thread in threads:
thread.join()


if hasattr(os, "fork"):
class ForkingUDPServer(ForkingMixIn, UDPServer): pass
Expand Down
7 changes: 5 additions & 2 deletions Lib/test/test_logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,7 @@ class TestTCPServer(ControlMixin, ThreadingTCPServer):
"""

allow_reuse_address = True
_block_on_close = True

def __init__(self, addr, handler, poll_interval=0.5,
bind_and_activate=True):
Expand Down Expand Up @@ -915,6 +916,8 @@ class TestUDPServer(ControlMixin, ThreadingUDPServer):
before calling :meth:`start`, so that the server will
set up the socket and listen on it.
"""
_block_on_close = True

def __init__(self, addr, handler, poll_interval=0.5,
bind_and_activate=True):
class DelegatingUDPRequestHandler(DatagramRequestHandler):
Expand Down Expand Up @@ -1474,11 +1477,11 @@ def setUp(self):
def tearDown(self):
"""Shutdown the TCP server."""
try:
if self.server:
self.server.stop(2.0)
if self.sock_hdlr:
self.root_logger.removeHandler(self.sock_hdlr)
self.sock_hdlr.close()
if self.server:
self.server.stop(2.0)
finally:
BaseTest.tearDown(self)

Expand Down
52 changes: 25 additions & 27 deletions Lib/test/test_socketserver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ def receive(sock, n, timeout=20):
if HAVE_UNIX_SOCKETS and HAVE_FORKING:
class ForkingUnixStreamServer(socketserver.ForkingMixIn,
socketserver.UnixStreamServer):
pass
_block_on_close = True

class ForkingUnixDatagramServer(socketserver.ForkingMixIn,
socketserver.UnixDatagramServer):
pass
_block_on_close = True


@contextlib.contextmanager
Expand All @@ -62,24 +62,14 @@ def simple_subprocess(testcase):
if pid == 0:
# Don't raise an exception; it would be caught by the test harness.
os._exit(72)
yield None
pid2, status = os.waitpid(pid, 0)
testcase.assertEqual(pid2, pid)
testcase.assertEqual(72 << 8, status)


def close_server(server):
server.server_close()

if hasattr(server, 'active_children'):
# ForkingMixIn: Manually reap all child processes, since server_close()
# calls waitpid() in non-blocking mode using the WNOHANG flag.
for pid in server.active_children.copy():
try:
os.waitpid(pid, 0)
except ChildProcessError:
pass
server.active_children.clear()
try:
yield None
except:
raise
finally:
pid2, status = os.waitpid(pid, 0)
testcase.assertEqual(pid2, pid)
testcase.assertEqual(72 << 8, status)


@unittest.skipUnless(threading, 'Threading required for this test.')
Expand Down Expand Up @@ -115,6 +105,8 @@ def pickaddr(self, proto):

def make_server(self, addr, svrcls, hdlrbase):
class MyServer(svrcls):
_block_on_close = True

def handle_error(self, request, client_address):
self.close_request(request)
raise
Expand Down Expand Up @@ -156,8 +148,12 @@ def run_server(self, svrcls, hdlrbase, testfunc):
if verbose: print("waiting for server")
server.shutdown()
t.join()
close_server(server)
server.server_close()
self.assertEqual(-1, server.socket.fileno())
if HAVE_FORKING and isinstance(server, socketserver.ForkingMixIn):
# bpo-31151: Check that ForkingMixIn.server_close() waits until
# all children completed
self.assertFalse(server.active_children)
if verbose: print("done")

def stream_examine(self, proto, addr):
Expand Down Expand Up @@ -280,7 +276,7 @@ class MyHandler(socketserver.StreamRequestHandler):
s.shutdown()
for t, s in threads:
t.join()
close_server(s)
s.server_close()

def test_tcpserver_bind_leak(self):
# Issue #22435: the server socket wouldn't be closed if bind()/listen()
Expand Down Expand Up @@ -344,6 +340,8 @@ def check_result(self, handled):


class BaseErrorTestServer(socketserver.TCPServer):
_block_on_close = True

def __init__(self, exception):
self.exception = exception
super().__init__((HOST, 0), BadHandler)
Expand All @@ -352,7 +350,7 @@ def __init__(self, exception):
try:
self.handle_request()
finally:
close_server(self)
self.server_close()
self.wait_done()

def handle_error(self, request, client_address):
Expand Down Expand Up @@ -386,7 +384,7 @@ def wait_done(self):

if HAVE_FORKING:
class ForkingErrorTestServer(socketserver.ForkingMixIn, BaseErrorTestServer):
pass
_block_on_close = True


class SocketWriterTest(unittest.TestCase):
Expand All @@ -398,7 +396,7 @@ def handle(self):
self.server.request_fileno = self.request.fileno()

server = socketserver.TCPServer((HOST, 0), Handler)
self.addCleanup(close_server, server)
self.addCleanup(server.server_close)
s = socket.socket(
server.address_family, socket.SOCK_STREAM, socket.IPPROTO_TCP)
with s:
Expand All @@ -422,7 +420,7 @@ def handle(self):
self.server.sent2 = self.wfile.write(big_chunk)

server = socketserver.TCPServer((HOST, 0), Handler)
self.addCleanup(close_server, server)
self.addCleanup(server.server_close)
interrupted = threading.Event()

def signal_handler(signum, frame):
Expand Down Expand Up @@ -498,7 +496,7 @@ def shutdown_request(self, request):
s.close()
server.handle_request()
self.assertEqual(server.shutdown_called, 1)
close_server(server)
server.server_close()


if __name__ == "__main__":
Expand Down