1
# Copyright (C) 2010, 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22
import SocketServer as socketserver
35
from breezy.transport import (
39
from breezy.bzr.smart import (
46
# FIXME: There is a dependency loop between breezy.tests and
47
# breezy.tests.test_server that needs to be fixed. In the mean time
48
# defining this function is enough for our needs. -- vila 20100611
49
from breezy import tests
50
return 'threads' in tests.selftest_debug_flags
53
class TestServer(transport.Server):
54
"""A Transport Server dedicated to tests.
56
The TestServer interface provides a server for a given transport. We use
57
these servers as loopback testing tools. For any given transport the
58
Servers it provides must either allow writing, or serve the contents
59
of osutils.getcwd() at the time start_server is called.
61
Note that these are real servers - they must implement all the things
62
that we want bzr transports to take advantage of.
66
"""Return a url for this server.
68
If the transport does not represent a disk directory (i.e. it is
69
a database like svn, or a memory only transport, it should return
70
a connection to a newly established resource for this Server.
71
Otherwise it should return a url that will provide access to the path
72
that was osutils.getcwd() when start_server() was called.
74
Subsequent calls will return the same resource.
76
raise NotImplementedError
78
def get_bogus_url(self):
79
"""Return a url for this protocol, that will fail to connect.
81
This may raise NotImplementedError to indicate that this server cannot
84
raise NotImplementedError
87
class LocalURLServer(TestServer):
88
"""A pretend server for local transports, using file:// urls.
90
Of course no actual server is required to access the local filesystem, so
91
this just exists to tell the test code how to get to it.
94
def start_server(self):
98
"""See Transport.Server.get_url."""
99
return urlutils.local_path_to_url('')
102
class DecoratorServer(TestServer):
103
"""Server for the TransportDecorator for testing with.
105
To use this when subclassing TransportDecorator, override override the
106
get_decorator_class method.
109
def start_server(self, server=None):
110
"""See breezy.transport.Server.start_server.
112
:server: decorate the urls given by server. If not provided a
113
LocalServer is created.
115
if server is not None:
116
self._made_server = False
117
self._server = server
119
self._made_server = True
120
self._server = LocalURLServer()
121
self._server.start_server()
123
def stop_server(self):
124
if self._made_server:
125
self._server.stop_server()
127
def get_decorator_class(self):
128
"""Return the class of the decorators we should be constructing."""
129
raise NotImplementedError(self.get_decorator_class)
131
def get_url_prefix(self):
132
"""What URL prefix does this decorator produce?"""
133
return self.get_decorator_class()._get_url_prefix()
135
def get_bogus_url(self):
136
"""See breezy.transport.Server.get_bogus_url."""
137
return self.get_url_prefix() + self._server.get_bogus_url()
140
"""See breezy.transport.Server.get_url."""
141
return self.get_url_prefix() + self._server.get_url()
144
class BrokenRenameServer(DecoratorServer):
145
"""Server for the BrokenRenameTransportDecorator for testing with."""
147
def get_decorator_class(self):
148
from breezy.transport import brokenrename
149
return brokenrename.BrokenRenameTransportDecorator
152
class FakeNFSServer(DecoratorServer):
153
"""Server for the FakeNFSTransportDecorator for testing with."""
155
def get_decorator_class(self):
156
from breezy.transport import fakenfs
157
return fakenfs.FakeNFSTransportDecorator
160
class FakeVFATServer(DecoratorServer):
161
"""A server that suggests connections through FakeVFATTransportDecorator
166
def get_decorator_class(self):
167
from breezy.transport import fakevfat
168
return fakevfat.FakeVFATTransportDecorator
171
class LogDecoratorServer(DecoratorServer):
172
"""Server for testing."""
174
def get_decorator_class(self):
175
from breezy.transport import log
176
return log.TransportLogDecorator
179
class NoSmartTransportServer(DecoratorServer):
180
"""Server for the NoSmartTransportDecorator for testing with."""
182
def get_decorator_class(self):
183
from breezy.transport import nosmart
184
return nosmart.NoSmartTransportDecorator
187
class ReadonlyServer(DecoratorServer):
188
"""Server for the ReadonlyTransportDecorator for testing with."""
190
def get_decorator_class(self):
191
from breezy.transport import readonly
192
return readonly.ReadonlyTransportDecorator
195
class TraceServer(DecoratorServer):
196
"""Server for the TransportTraceDecorator for testing with."""
198
def get_decorator_class(self):
199
from breezy.transport import trace
200
return trace.TransportTraceDecorator
203
class UnlistableServer(DecoratorServer):
204
"""Server for the UnlistableTransportDecorator for testing with."""
206
def get_decorator_class(self):
207
from breezy.transport import unlistable
208
return unlistable.UnlistableTransportDecorator
211
class TestingPathFilteringServer(pathfilter.PathFilteringServer):
214
"""TestingPathFilteringServer is not usable until start_server
217
def start_server(self, backing_server=None):
218
"""Setup the Chroot on backing_server."""
219
if backing_server is not None:
220
self.backing_transport = transport.get_transport_from_url(
221
backing_server.get_url())
223
self.backing_transport = transport.get_transport_from_path('.')
224
self.backing_transport.clone('added-by-filter').ensure_base()
225
self.filter_func = lambda x: 'added-by-filter/' + x
226
super(TestingPathFilteringServer, self).start_server()
228
def get_bogus_url(self):
229
raise NotImplementedError
232
class TestingChrootServer(chroot.ChrootServer):
235
"""TestingChrootServer is not usable until start_server is called."""
236
super(TestingChrootServer, self).__init__(None)
238
def start_server(self, backing_server=None):
239
"""Setup the Chroot on backing_server."""
240
if backing_server is not None:
241
self.backing_transport = transport.get_transport_from_url(
242
backing_server.get_url())
244
self.backing_transport = transport.get_transport_from_path('.')
245
super(TestingChrootServer, self).start_server()
247
def get_bogus_url(self):
248
raise NotImplementedError
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[0] 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):
651
"""Server suitable for use by transport tests.
653
This server is backed by the process's cwd.
655
def __init__(self, thread_name_suffix=''):
656
self.client_path_extra = None
657
self.thread_name_suffix = thread_name_suffix
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)
672
def start_server(self, backing_transport_server=None,
673
client_path_extra='/extra/'):
674
"""Set up server for testing.
676
:param backing_transport_server: backing server to use. If not
677
specified, a LocalURLServer at the current working directory will
679
:param client_path_extra: a path segment starting with '/' to append to
680
the root URL for this server. For instance, a value of '/foo/bar/'
681
will mean the root of the backing transport will be published at a
682
URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
683
`bzr://127.0.0.1:nnnn/`. Default value is `extra`, so that tests
684
by default will fail unless they do the necessary path translation.
686
if not client_path_extra.startswith('/'):
687
raise ValueError(client_path_extra)
688
self.root_client_path = self.client_path_extra = client_path_extra
689
from breezy.transport.chroot import ChrootServer
690
if backing_transport_server is None:
691
backing_transport_server = LocalURLServer()
692
self.chroot_server = ChrootServer(
693
self.get_backing_transport(backing_transport_server))
694
self.chroot_server.start_server()
695
self.backing_transport = transport.get_transport_from_url(
696
self.chroot_server.get_url())
697
super(SmartTCPServer_for_testing, self).start_server()
699
def stop_server(self):
701
super(SmartTCPServer_for_testing, self).stop_server()
703
self.chroot_server.stop_server()
705
def get_backing_transport(self, backing_transport_server):
706
"""Get a backing transport from a server we are decorating."""
707
return transport.get_transport_from_url(
708
backing_transport_server.get_url())
711
url = self.server.get_url()
712
return url[:-1] + self.client_path_extra
714
def get_bogus_url(self):
715
"""Return a URL which will fail to connect"""
716
return 'bzr://127.0.0.1:1/'
719
class ReadonlySmartTCPServer_for_testing(SmartTCPServer_for_testing):
720
"""Get a readonly server for testing."""
722
def get_backing_transport(self, backing_transport_server):
723
"""Get a backing transport from a server we are decorating."""
724
url = 'readonly+' + backing_transport_server.get_url()
725
return transport.get_transport_from_url(url)
728
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
729
"""A variation of SmartTCPServer_for_testing that limits the client to
730
using RPCs in protocol v2 (i.e. bzr <= 1.5).
734
url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
735
url = 'bzr-v2://' + url[len('bzr://'):]
739
class ReadonlySmartTCPServer_for_testing_v2_only(
740
SmartTCPServer_for_testing_v2_only):
741
"""Get a readonly server for testing."""
743
def get_backing_transport(self, backing_transport_server):
744
"""Get a backing transport from a server we are decorating."""
745
url = 'readonly+' + backing_transport_server.get_url()
746
return transport.get_transport_from_url(url)
added
removed
breezy/tests/test_server.py
