213
238
def start_server(self, backing_server=None):
214
239
"""Setup the Chroot on backing_server."""
215
240
if backing_server is not None:
216
self.backing_transport = transport.get_transport(
241
self.backing_transport = transport.get_transport_from_url(
217
242
backing_server.get_url())
219
self.backing_transport = transport.get_transport('.')
244
self.backing_transport = transport.get_transport_from_path('.')
220
245
super(TestingChrootServer, self).start_server()
222
247
def get_bogus_url(self):
223
248
raise NotImplementedError
226
class SmartTCPServer_for_testing(server.SmartTCPServer):
251
class TestThread(cethread.CatchingExceptionThread):
253
def join(self, timeout=5):
254
"""Overrides to use a default timeout.
256
The default timeout is set to 5 and should expire only when a thread
257
serving a client connection is hung.
259
super(TestThread, self).join(timeout)
260
if timeout and self.isAlive():
261
# The timeout expired without joining the thread, the thread is
262
# therefore stucked and that's a failure as far as the test is
263
# concerned. We used to hang here.
265
# FIXME: we need to kill the thread, but as far as the test is
266
# concerned, raising an assertion is too strong. On most of the
267
# platforms, this doesn't occur, so just mentioning the problem is
268
# enough for now -- vila 2010824
269
sys.stderr.write('thread %s hung\n' % (self.name,))
270
#raise AssertionError('thread %s hung' % (self.name,))
273
class TestingTCPServerMixin(object):
274
"""Mixin to support running socketserver.TCPServer in a thread.
276
Tests are connecting from the main thread, the server has to be run in a
281
self.started = threading.Event()
283
self.stopped = threading.Event()
284
# We collect the resources used by the clients so we can release them
287
self.ignored_exceptions = None
289
def server_bind(self):
290
self.socket.bind(self.server_address)
291
self.server_address = self.socket.getsockname()
295
# We are listening and ready to accept connections
299
# Really a connection but the python framework is generic and
301
self.handle_request()
302
# Let's close the listening socket
307
def handle_request(self):
308
"""Handle one request.
310
The python version swallows some socket exceptions and we don't use
311
timeout, so we override it to better control the server behavior.
313
request, client_address = self.get_request()
314
if self.verify_request(request, client_address):
316
self.process_request(request, client_address)
318
self.handle_error(request, client_address)
320
self.close_request(request)
322
def get_request(self):
323
return self.socket.accept()
325
def verify_request(self, request, client_address):
326
"""Verify the request.
328
Return True if we should proceed with this request, False if we should
329
not even touch a single byte in the socket ! This is useful when we
330
stop the server with a dummy last connection.
334
def handle_error(self, request, client_address):
335
# Stop serving and re-raise the last exception seen
337
# The following can be used for debugging purposes, it will display the
338
# exception and the traceback just when it occurs instead of waiting
339
# for the thread to be joined.
340
# socketserver.BaseServer.handle_error(self, request, client_address)
342
# We call close_request manually, because we are going to raise an
343
# exception. The socketserver implementation calls:
346
# But because we raise the exception, close_request will never be
347
# triggered. This helps client not block waiting for a response when
348
# the server gets an exception.
349
self.close_request(request)
352
def ignored_exceptions_during_shutdown(self, e):
353
if sys.platform == 'win32':
354
accepted_errnos = [errno.EBADF,
362
accepted_errnos = [errno.EBADF,
367
if isinstance(e, socket.error) and e.errno in accepted_errnos:
371
# The following methods are called by the main thread
373
def stop_client_connections(self):
375
c = self.clients.pop()
376
self.shutdown_client(c)
378
def shutdown_socket(self, sock):
379
"""Properly shutdown a socket.
381
This should be called only when no other thread is trying to use the
385
sock.shutdown(socket.SHUT_RDWR)
387
except Exception as e:
388
if self.ignored_exceptions(e):
393
# The following methods are called by the main thread
395
def set_ignored_exceptions(self, thread, ignored_exceptions):
396
self.ignored_exceptions = ignored_exceptions
397
thread.set_ignored_exceptions(self.ignored_exceptions)
399
def _pending_exception(self, thread):
400
"""Raise server uncaught exception.
402
Daughter classes can override this if they use daughter threads.
404
thread.pending_exception()
407
class TestingTCPServer(TestingTCPServerMixin, socketserver.TCPServer):
409
def __init__(self, server_address, request_handler_class):
410
TestingTCPServerMixin.__init__(self)
411
socketserver.TCPServer.__init__(self, server_address,
412
request_handler_class)
414
def get_request(self):
415
"""Get the request and client address from the socket."""
416
sock, addr = TestingTCPServerMixin.get_request(self)
417
self.clients.append((sock, addr))
420
# The following methods are called by the main thread
422
def shutdown_client(self, client):
424
self.shutdown_socket(sock)
427
class TestingThreadingTCPServer(TestingTCPServerMixin,
428
socketserver.ThreadingTCPServer):
430
def __init__(self, server_address, request_handler_class):
431
TestingTCPServerMixin.__init__(self)
432
socketserver.ThreadingTCPServer.__init__(self, server_address,
433
request_handler_class)
435
def get_request(self):
436
"""Get the request and client address from the socket."""
437
sock, addr = TestingTCPServerMixin.get_request(self)
438
# The thread is not created yet, it will be updated in process_request
439
self.clients.append((sock, addr, None))
442
def process_request_thread(self, started, detached, stopped,
443
request, client_address):
445
# We will be on our own once the server tells us we're detached
447
socketserver.ThreadingTCPServer.process_request_thread(
448
self, request, client_address)
449
self.close_request(request)
452
def process_request(self, request, client_address):
453
"""Start a new thread to process the request."""
454
started = threading.Event()
455
detached = threading.Event()
456
stopped = threading.Event()
459
name='%s -> %s' % (client_address, self.server_address),
460
target = self.process_request_thread,
461
args = (started, detached, stopped, request, client_address))
462
# Update the client description
464
self.clients.append((request, client_address, t))
465
# Propagate the exception handler since we must use the same one as
466
# TestingTCPServer for connections running in their own threads.
467
t.set_ignored_exceptions(self.ignored_exceptions)
470
# If an exception occured during the thread start, it will get raised.
471
t.pending_exception()
473
sys.stderr.write('Client thread %s started\n' % (t.name,))
474
# Tell the thread, it's now on its own for exception handling.
477
# The following methods are called by the main thread
479
def shutdown_client(self, client):
480
sock, addr, connection_thread = client
481
self.shutdown_socket(sock)
482
if connection_thread is not None:
483
# The thread has been created only if the request is processed but
484
# after the connection is inited. This could happen during server
485
# shutdown. If an exception occurred in the thread it will be
488
sys.stderr.write('Client thread %s will be joined\n'
489
% (connection_thread.name,))
490
connection_thread.join()
492
def set_ignored_exceptions(self, thread, ignored_exceptions):
493
TestingTCPServerMixin.set_ignored_exceptions(self, thread,
495
for sock, addr, connection_thread in self.clients:
496
if connection_thread is not None:
497
connection_thread.set_ignored_exceptions(
498
self.ignored_exceptions)
500
def _pending_exception(self, thread):
501
for sock, addr, connection_thread in self.clients:
502
if connection_thread is not None:
503
connection_thread.pending_exception()
504
TestingTCPServerMixin._pending_exception(self, thread)
507
class TestingTCPServerInAThread(transport.Server):
508
"""A server in a thread that re-raise thread exceptions."""
510
def __init__(self, server_address, server_class, request_handler_class):
511
self.server_class = server_class
512
self.request_handler_class = request_handler_class
513
self.host, self.port = server_address
515
self._server_thread = None
518
return "%s(%s:%s)" % (self.__class__.__name__, self.host, self.port)
520
def create_server(self):
521
return self.server_class((self.host, self.port),
522
self.request_handler_class)
524
def start_server(self):
525
self.server = self.create_server()
526
self._server_thread = TestThread(
527
sync_event=self.server.started,
528
target=self.run_server)
529
self._server_thread.start()
530
# Wait for the server thread to start (i.e. release the lock)
531
self.server.started.wait()
532
# Get the real address, especially the port
533
self.host, self.port = self.server.server_address
534
self._server_thread.name = self.server.server_address
536
sys.stderr.write('Server thread %s started\n'
537
% (self._server_thread.name,))
538
# If an exception occured during the server start, it will get raised,
539
# otherwise, the server is blocked on its accept() call.
540
self._server_thread.pending_exception()
541
# From now on, we'll use a different event to ensure the server can set
543
self._server_thread.set_sync_event(self.server.stopped)
545
def run_server(self):
548
def stop_server(self):
549
if self.server is None:
552
# The server has been started successfully, shut it down now. As
553
# soon as we stop serving, no more connection are accepted except
554
# one to get out of the blocking listen.
555
self.set_ignored_exceptions(
556
self.server.ignored_exceptions_during_shutdown)
557
self.server.serving = False
559
sys.stderr.write('Server thread %s will be joined\n'
560
% (self._server_thread.name,))
561
# The server is listening for a last connection, let's give it:
564
last_conn = osutils.connect_socket((self.host, self.port))
565
except socket.error as e:
566
# But ignore connection errors as the point is to unblock the
567
# server thread, it may happen that it's not blocked or even
570
# We start shutting down the clients while the server itself is
572
self.server.stop_client_connections()
573
# Now we wait for the thread running self.server.serve() to finish
574
self.server.stopped.wait()
575
if last_conn is not None:
576
# Close the last connection without trying to use it. The
577
# server will not process a single byte on that socket to avoid
578
# complications (SSL starts with a handshake for example).
580
# Check for any exception that could have occurred in the server
583
self._server_thread.join()
584
except Exception as e:
585
if self.server.ignored_exceptions(e):
590
# Make sure we can be called twice safely, note that this means
591
# that we will raise a single exception even if several occurred in
592
# the various threads involved.
595
def set_ignored_exceptions(self, ignored_exceptions):
596
"""Install an exception handler for the server."""
597
self.server.set_ignored_exceptions(self._server_thread,
600
def pending_exception(self):
601
"""Raise uncaught exception in the server."""
602
self.server._pending_exception(self._server_thread)
605
class TestingSmartConnectionHandler(socketserver.BaseRequestHandler,
606
medium.SmartServerSocketStreamMedium):
608
def __init__(self, request, client_address, server):
609
medium.SmartServerSocketStreamMedium.__init__(
610
self, request, server.backing_transport,
611
server.root_client_path,
612
timeout=_DEFAULT_TESTING_CLIENT_TIMEOUT)
613
request.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
614
socketserver.BaseRequestHandler.__init__(self, request, client_address,
619
while not self.finished:
620
server_protocol = self._build_protocol()
621
self._serve_one_request(server_protocol)
622
except errors.ConnectionTimeout:
623
# idle connections aren't considered a failure of the server
627
_DEFAULT_TESTING_CLIENT_TIMEOUT = 60.0
629
class TestingSmartServer(TestingThreadingTCPServer, server.SmartTCPServer):
631
def __init__(self, server_address, request_handler_class,
632
backing_transport, root_client_path):
633
TestingThreadingTCPServer.__init__(self, server_address,
634
request_handler_class)
635
server.SmartTCPServer.__init__(self, backing_transport,
636
root_client_path, client_timeout=_DEFAULT_TESTING_CLIENT_TIMEOUT)
639
self.run_server_started_hooks()
641
TestingThreadingTCPServer.serve(self)
643
self.run_server_stopped_hooks()
646
"""Return the url of the server"""
647
return "bzr://%s:%d/" % self.server_address
650
class SmartTCPServer_for_testing(TestingTCPServerInAThread):
227
651
"""Server suitable for use by transport tests.
229
653
This server is backed by the process's cwd.
232
655
def __init__(self, thread_name_suffix=''):
233
super(SmartTCPServer_for_testing, self).__init__(None)
234
656
self.client_path_extra = None
235
657
self.thread_name_suffix = thread_name_suffix
237
def get_backing_transport(self, backing_transport_server):
238
"""Get a backing transport from a server we are decorating."""
239
return transport.get_transport(backing_transport_server.get_url())
658
self.host = '127.0.0.1'
660
super(SmartTCPServer_for_testing, self).__init__(
661
(self.host, self.port),
663
TestingSmartConnectionHandler)
665
def create_server(self):
666
return self.server_class((self.host, self.port),
667
self.request_handler_class,
668
self.backing_transport,
669
self.root_client_path)
241
672
def start_server(self, backing_transport_server=None,
242
client_path_extra='/extra/'):
673
client_path_extra='/extra/'):
243
674
"""Set up server for testing.
245
676
:param backing_transport_server: backing server to use. If not