1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
1
# Copyright (C) 2006, 2007 Canonical Ltd
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
39
38
hooks: An instance of SmartServerHooks.
42
def __init__(self, backing_transport, host='127.0.0.1', port=0,
43
root_client_path='/'):
41
def __init__(self, backing_transport, host='127.0.0.1', port=0):
44
42
"""Construct a new server.
46
44
To actually start it running, call either start_background_thread or
49
:param backing_transport: The transport to serve.
50
47
:param host: Name of the interface to listen on.
51
48
:param port: TCP port to listen on, or 0 to allocate a transient port.
52
:param root_client_path: The client path that will correspond to root
55
50
# let connections timeout so that we get a chance to terminate
56
51
# Keep a reference to the exceptions we want to catch because the socket
60
55
self._socket_error = socket_error
61
56
self._socket_timeout = socket_timeout
62
57
self._server_socket = socket.socket()
63
# SO_REUSERADDR has a different meaning on Windows
64
if sys.platform != 'win32':
65
self._server_socket.setsockopt(socket.SOL_SOCKET,
66
socket.SO_REUSEADDR, 1)
68
self._server_socket.bind((host, port))
69
except self._socket_error, message:
70
raise errors.CannotBindAddress(host, port, message)
58
self._server_socket.bind((host, port))
71
59
self._sockname = self._server_socket.getsockname()
72
60
self.port = self._sockname[1]
73
61
self._server_socket.listen(1)
75
63
self.backing_transport = backing_transport
76
64
self._started = threading.Event()
77
65
self._stopped = threading.Event()
78
self.root_client_path = root_client_path
80
def serve(self, thread_name_suffix=''):
81
68
self._should_terminate = False
82
69
# for hooks we are letting code know that a server has started (and
119
106
if e.args[0] != errno.EBADF:
120
107
trace.warning("listening socket error: %s", e)
122
self.serve_conn(conn, thread_name_suffix)
109
self.serve_conn(conn)
123
110
except KeyboardInterrupt:
124
111
# dont log when CTRL-C'd.
142
129
"""Return the url of the server"""
143
130
return "bzr://%s:%d/" % self._sockname
145
def serve_conn(self, conn, thread_name_suffix):
132
def serve_conn(self, conn):
146
133
# For WIN32, where the timeout value from the listening socket
147
134
# propogates to the newly accepted socket.
148
135
conn.setblocking(True)
149
136
conn.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
150
handler = SmartServerSocketStreamMedium(
151
conn, self.backing_transport, self.root_client_path)
152
thread_name = 'smart-server-child' + thread_name_suffix
153
connection_thread = threading.Thread(
154
None, handler.serve, name=thread_name)
137
handler = SmartServerSocketStreamMedium(conn, self.backing_transport)
138
connection_thread = threading.Thread(None, handler.serve, name='smart-server-child')
155
139
connection_thread.setDaemon(True)
156
140
connection_thread.start()
158
def start_background_thread(self, thread_name_suffix=''):
142
def start_background_thread(self):
159
143
self._started.clear()
160
144
self._server_thread = threading.Thread(None,
161
self.serve, args=(thread_name_suffix,),
162
146
name='server-' + self.get_url())
163
147
self._server_thread.setDaemon(True)
164
148
self._server_thread.start()
218
202
This server is backed by the process's cwd.
221
def __init__(self, thread_name_suffix=''):
222
206
SmartTCPServer.__init__(self, None)
223
self.client_path_extra = None
224
self.thread_name_suffix = thread_name_suffix
226
208
def get_backing_transport(self, backing_transport_server):
227
209
"""Get a backing transport from a server we are decorating."""
228
210
return transport.get_transport(backing_transport_server.get_url())
230
def setUp(self, backing_transport_server=None,
231
client_path_extra='/extra/'):
232
"""Set up server for testing.
234
:param backing_transport_server: backing server to use. If not
235
specified, a LocalURLServer at the current working directory will
237
:param client_path_extra: a path segment starting with '/' to append to
238
the root URL for this server. For instance, a value of '/foo/bar/'
239
will mean the root of the backing transport will be published at a
240
URL like `bzr://127.0.0.1:nnnn/foo/bar/`, rather than
241
`bzr://127.0.0.1:nnnn/`. Default value is `extra`, so that tests
242
by default will fail unless they do the necessary path translation.
244
if not client_path_extra.startswith('/'):
245
raise ValueError(client_path_extra)
212
def setUp(self, backing_transport_server=None):
213
"""Set up server for testing"""
246
214
from bzrlib.transport.chroot import ChrootServer
247
215
if backing_transport_server is None:
248
216
from bzrlib.transport.local import LocalURLServer
252
220
self.chroot_server.setUp()
253
221
self.backing_transport = transport.get_transport(
254
222
self.chroot_server.get_url())
255
self.root_client_path = self.client_path_extra = client_path_extra
256
self.start_background_thread(self.thread_name_suffix)
223
self.start_background_thread()
258
225
def tearDown(self):
259
226
self.stop_background_thread()
260
227
self.chroot_server.tearDown()
263
url = super(SmartTCPServer_for_testing, self).get_url()
264
return url[:-1] + self.client_path_extra
266
229
def get_bogus_url(self):
267
230
"""Return a URL which will fail to connect"""
268
231
return 'bzr://127.0.0.1:1/'
276
239
url = 'readonly+' + backing_transport_server.get_url()
277
240
return transport.get_transport(url)
280
class SmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing):
281
"""A variation of SmartTCPServer_for_testing that limits the client to
282
using RPCs in protocol v2 (i.e. bzr <= 1.5).
286
url = super(SmartTCPServer_for_testing_v2_only, self).get_url()
287
url = 'bzr-v2://' + url[len('bzr://'):]
291
class ReadonlySmartTCPServer_for_testing_v2_only(SmartTCPServer_for_testing_v2_only):
292
"""Get a readonly server for testing."""
294
def get_backing_transport(self, backing_transport_server):
295
"""Get a backing transport from a server we are decorating."""
296
url = 'readonly+' + backing_transport_server.get_url()
297
return transport.get_transport(url)
added
removed
bzrlib/smart/server.py
