← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_test_server.py

  • Committer: Patch Queue Manager
  • Date: 2016-02-01 19:13:13 UTC
  • mfrom: (6614.2.2 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20160201191313-wdfvmfff1djde6oq
(vila) Release 2.7.0 (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_test_server.py
1
 
# Copyright (C) 2010, 2011 Canonical Ltd
 
1
# Copyright (C) 2010, 2011, 2016 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
import SocketServer
20
20
import threading
21
21
 
 
22
 
22
23
from bzrlib import (
23
24
    osutils,
24
25
    tests,
30
31
load_tests = load_tests_apply_scenarios
31
32
 
32
33
 
 
34
def portable_socket_pair():
 
35
    """Return a pair of TCP sockets connected to each other.
 
36
 
 
37
    Unlike socket.socketpair, this should work on Windows.
 
38
    """
 
39
    listen_sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 
40
    listen_sock.bind(('127.0.0.1', 0))
 
41
    listen_sock.listen(1)
 
42
    client_sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 
43
    client_sock.connect(listen_sock.getsockname())
 
44
    server_sock, addr = listen_sock.accept()
 
45
    listen_sock.close()
 
46
    return server_sock, client_sock
 
47
 
 
48
 
33
49
class TCPClient(object):
34
50
 
35
51
    def __init__(self):
61
77
        return self.sock.recv(bufsize)
62
78
 
63
79
 
64
 
class TCPConnectionHandler(SocketServer.StreamRequestHandler):
 
80
class TCPConnectionHandler(SocketServer.BaseRequestHandler):
65
81
 
66
82
    def handle(self):
67
83
        self.done = False
69
85
        while not self.done:
70
86
            self.handle_connection()
71
87
 
 
88
    def readline(self):
 
89
        # TODO: We should be buffering any extra data sent, etc. However, in
 
90
        #       practice, we don't send extra content, so we haven't bothered
 
91
        #       to implement it yet.
 
92
        req = self.request.recv(4096)
 
93
        # An empty string is allowed, to indicate the end of the connection
 
94
        if not req or (req.endswith('\n') and req.count('\n') == 1):
 
95
            return req
 
96
        raise ValueError('[%r] not a simple line' % (req,))
 
97
 
72
98
    def handle_connection(self):
73
 
        req = self.rfile.readline()
 
99
        req = self.readline()
74
100
        if not req:
75
101
            self.done = True
76
102
        elif req == 'ping\n':
77
 
            self.wfile.write('pong\n')
 
103
            self.request.sendall('pong\n')
78
104
        else:
79
105
            raise ValueError('[%s] not understood' % req)
80
106
 
81
107
 
82
108
class TestTCPServerInAThread(tests.TestCase):
83
109
 
84
 
    scenarios = [ 
 
110
    scenarios = [
85
111
        (name, {'server_class': getattr(test_server, name)})
86
112
        for name in
87
113
        ('TestingTCPServer', 'TestingThreadingTCPServer')]
88
114
 
89
 
    # Set by load_tests()
90
 
    server_class = None
91
 
 
92
115
    def get_server(self, server_class=None, connection_handler_class=None):
93
116
        if server_class is not None:
94
117
            self.server_class = server_class
95
118
        if connection_handler_class is None:
96
119
            connection_handler_class = TCPConnectionHandler
97
 
        server =  test_server.TestingTCPServerInAThread(
 
120
        server = test_server.TestingTCPServerInAThread(
98
121
            ('localhost', 0), self.server_class, connection_handler_class)
99
122
        server.start_server()
100
123
        self.addCleanup(server.stop_server)
110
133
 
111
134
    def assertClientAddr(self, client, server, conn_rank):
112
135
        conn = self.get_server_connection(server, conn_rank)
113
 
        self.assertEquals(client.sock.getsockname(), conn[1])
 
136
        self.assertEqual(client.sock.getsockname(), conn[1])
114
137
 
115
138
    def test_start_stop(self):
116
139
        server = self.get_server()
129
152
        self.assertIs(None, client.write('ping\n'))
130
153
        resp = client.read()
131
154
        self.assertClientAddr(client, server, 0)
132
 
        self.assertEquals('pong\n', resp)
 
155
        self.assertEqual('pong\n', resp)
133
156
 
134
157
    def test_server_fails_to_start(self):
135
158
        class CantStart(Exception):
158
181
        # The server won't fail until a client connect
159
182
        client = self.get_client()
160
183
        client.connect((server.host, server.port))
 
184
        # We make sure the server wants to handle a request, but the request is
 
185
        # guaranteed to fail. However, the server should make sure that the
 
186
        # connection gets closed, and stop_server should then raise the
 
187
        # original exception.
 
188
        client.write('ping\n')
161
189
        try:
162
 
            # Now we must force the server to answer by sending the request and
163
 
            # waiting for some answer. But since we don't control when the
164
 
            # server thread will be given cycles, we don't control either
165
 
            # whether our reads or writes may hang.
166
 
            client.sock.settimeout(0.1)
167
 
            client.write('ping\n')
168
 
            client.read()
169
 
        except socket.error:
170
 
            pass
 
190
            self.assertEqual('', client.read())
 
191
        except socket.error, e:
 
192
            # On Windows, failing during 'handle' means we get
 
193
            # 'forced-close-of-connection'. Possibly because we haven't
 
194
            # processed the write request before we close the socket.
 
195
            WSAECONNRESET = 10054
 
196
            if e.errno in (WSAECONNRESET,):
 
197
                pass
171
198
        # Now the server has raised the exception in its own thread
172
199
        self.assertRaises(CantConnect, server.stop_server)
173
200
 
174
201
    def test_server_crash_while_responding(self):
175
 
        sync = threading.Event()
176
 
        sync.clear()
 
202
        # We want to ensure the exception has been caught
 
203
        caught = threading.Event()
 
204
        caught.clear()
 
205
        # The thread that will serve the client, this needs to be an attribute
 
206
        # so the handler below can modify it when it's executed (it's
 
207
        # instantiated when the request is processed)
 
208
        self.connection_thread = None
 
209
 
177
210
        class FailToRespond(Exception):
178
211
            pass
179
212
 
180
213
        class FailingDuringResponseHandler(TCPConnectionHandler):
181
214
 
182
 
            def handle_connection(self):
183
 
                req = self.rfile.readline()
184
 
                threading.currentThread().set_sync_event(sync)
 
215
            # We use 'request' instead of 'self' below because the test matters
 
216
            # more and we need a container to properly set connection_thread.
 
217
            def handle_connection(request):
 
218
                req = request.readline()
 
219
                # Capture the thread and make it use 'caught' so we can wait on
 
220
                # the event that will be set when the exception is caught. We
 
221
                # also capture the thread to know where to look.
 
222
                self.connection_thread = threading.currentThread()
 
223
                self.connection_thread.set_sync_event(caught)
185
224
                raise FailToRespond()
186
225
 
187
226
        server = self.get_server(
189
228
        client = self.get_client()
190
229
        client.connect((server.host, server.port))
191
230
        client.write('ping\n')
192
 
        sync.wait()
193
 
        self.assertRaises(FailToRespond, server.pending_exception)
 
231
        # Wait for the exception to be caught
 
232
        caught.wait()
 
233
        self.assertEqual('', client.read()) # connection closed
 
234
        # Check that the connection thread did catch the exception,
 
235
        # http://pad.lv/869366 was wrongly checking the server thread which
 
236
        # works for TestingTCPServer where the connection is handled in the
 
237
        # same thread than the server one but was racy for
 
238
        # TestingThreadingTCPServer. Since the connection thread detaches
 
239
        # itself before handling the request, we are guaranteed that the
 
240
        # exception won't leak into the server thread anymore.
 
241
        self.assertRaises(FailToRespond,
 
242
                          self.connection_thread.pending_exception)
194
243
 
195
244
    def test_exception_swallowed_while_serving(self):
196
 
        sync = threading.Event()
197
 
        sync.clear()
 
245
        # We need to ensure the exception has been caught
 
246
        caught = threading.Event()
 
247
        caught.clear()
 
248
        # The thread that will serve the client, this needs to be an attribute
 
249
        # so the handler below can access it when it's executed (it's
 
250
        # instantiated when the request is processed)
 
251
        self.connection_thread = None
198
252
        class CantServe(Exception):
199
253
            pass
200
254
 
201
255
        class FailingWhileServingConnectionHandler(TCPConnectionHandler):
202
256
 
203
 
            def handle(self):
204
 
                # We want to sync with the thread that is serving the
205
 
                # connection.
206
 
                threading.currentThread().set_sync_event(sync)
 
257
            # We use 'request' instead of 'self' below because the test matters
 
258
            # more and we need a container to properly set connection_thread.
 
259
            def handle(request):
 
260
                # Capture the thread and make it use 'caught' so we can wait on
 
261
                # the event that will be set when the exception is caught. We
 
262
                # also capture the thread to know where to look.
 
263
                self.connection_thread = threading.currentThread()
 
264
                self.connection_thread.set_sync_event(caught)
207
265
                raise CantServe()
208
266
 
209
267
        server = self.get_server(
210
268
            connection_handler_class=FailingWhileServingConnectionHandler)
 
269
        self.assertEqual(True, server.server.serving)
211
270
        # Install the exception swallower
212
271
        server.set_ignored_exceptions(CantServe)
213
272
        client = self.get_client()
214
273
        # Connect to the server so the exception is raised there
215
274
        client.connect((server.host, server.port))
216
 
        # Wait for the exception to propagate.
217
 
        sync.wait()
 
275
        # Wait for the exception to be caught
 
276
        caught.wait()
 
277
        self.assertEqual('', client.read()) # connection closed
218
278
        # The connection wasn't served properly but the exception should have
219
 
        # been swallowed.
220
 
        server.pending_exception()
 
279
        # been swallowed (see test_server_crash_while_responding remark about
 
280
        # http://pad.lv/869366 explaining why we can't check the server thread
 
281
        # here). More precisely, the exception *has* been caught and captured
 
282
        # but it is cleared when joining the thread (or trying to acquire the
 
283
        # exception) and as such won't propagate to the server thread.
 
284
        self.assertIs(None, self.connection_thread.pending_exception())
 
285
        self.assertIs(None, server.pending_exception())
 
286
 
 
287
    def test_handle_request_closes_if_it_doesnt_process(self):
 
288
        server = self.get_server()
 
289
        client = self.get_client()
 
290
        server.server.serving = False
 
291
        client.connect((server.host, server.port))
 
292
        self.assertEqual('', client.read())
 
293
 
 
294
 
 
295
class TestTestingSmartServer(tests.TestCase):
 
296
 
 
297
    def test_sets_client_timeout(self):
 
298
        server = test_server.TestingSmartServer(('localhost', 0), None, None,
 
299
            root_client_path='/no-such-client/path')
 
300
        self.assertEqual(test_server._DEFAULT_TESTING_CLIENT_TIMEOUT,
 
301
                         server._client_timeout)
 
302
        sock = socket.socket()
 
303
        h = server._make_handler(sock)
 
304
        self.assertEqual(test_server._DEFAULT_TESTING_CLIENT_TIMEOUT,
 
305
                         h._client_timeout)
 
306
 
 
307
 
 
308
class FakeServer(object):
 
309
    """Minimal implementation to pass to TestingSmartConnectionHandler"""
 
310
    backing_transport = None
 
311
    root_client_path = '/'
 
312
 
 
313
 
 
314
class TestTestingSmartConnectionHandler(tests.TestCase):
 
315
 
 
316
    def test_connection_timeout_suppressed(self):
 
317
        self.overrideAttr(test_server, '_DEFAULT_TESTING_CLIENT_TIMEOUT', 0.01)
 
318
        s = FakeServer()
 
319
        server_sock, client_sock = portable_socket_pair()
 
320
        # This should timeout quickly, but not generate an exception.
 
321
        handler = test_server.TestingSmartConnectionHandler(server_sock,
 
322
            server_sock.getpeername(), s)
 
323
 
 
324
    def test_connection_shutdown_while_serving_no_error(self):
 
325
        s = FakeServer()
 
326
        server_sock, client_sock = portable_socket_pair()
 
327
        class ShutdownConnectionHandler(
 
328
            test_server.TestingSmartConnectionHandler):
 
329
 
 
330
            def _build_protocol(self):
 
331
                self.finished = True
 
332
                return super(ShutdownConnectionHandler, self)._build_protocol()
 
333
        # This should trigger shutdown after the entering _build_protocol, and
 
334
        # we should exit cleanly, without raising an exception.
 
335
        handler = ShutdownConnectionHandler(server_sock,
 
336
            server_sock.getpeername(), s)