27
28
from bzrlib import (
30
33
revision as _mod_revision,
33
37
from bzrlib.branch import Branch
34
38
from bzrlib.bzrdir import BzrDir
35
from bzrlib.errors import ParamikoNotPresent
36
39
from bzrlib.smart import client, medium
37
from bzrlib.smart.server import SmartTCPServer
38
from bzrlib.tests import TestCaseWithTransport, TestSkipped
40
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
41
from bzrlib.tests import (
42
TestCaseWithMemoryTransport,
43
TestCaseWithTransport,
39
46
from bzrlib.trace import mutter
40
from bzrlib.transport import get_transport, remote
43
class TestBzrServe(TestCaseWithTransport):
47
from bzrlib.transport import remote
50
class TestBzrServeBase(TestCaseWithTransport):
52
def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
53
*func_args, **func_kwargs):
54
"""Run 'bzr serve', and run the given func in a thread once the server
57
When 'func' terminates, the server will be terminated too.
59
Returns stdout and stderr.
62
def on_server_start(backing_urls, tcp_server):
64
target=on_server_start_thread, args=(tcp_server,))
66
def on_server_start_thread(tcp_server):
69
self.tcp_server = tcp_server
72
func(*func_args, **func_kwargs)
74
# Log errors to make some test failures a little less
76
mutter('func broke: %r', e)
78
# Then stop the server
79
mutter('interrupting...')
80
thread.interrupt_main()
81
SmartTCPServer.hooks.install_named_hook(
82
'server_started_ex', on_server_start,
83
'run_bzr_serve_then_func hook')
86
out, err = self.run_bzr(['serve'] + list(serve_args))
87
except KeyboardInterrupt, e:
92
class TestBzrServe(TestBzrServeBase):
95
super(TestBzrServe, self).setUp()
96
self.disable_missing_extensions_warning()
45
98
def assertInetServerShutsdownCleanly(self, process):
46
99
"""Shutdown the server process looking for errors."""
79
132
finish_bzr_subprocess, a client for the server, and a transport.
81
134
# Serve from the current directory
82
process = self.start_bzr_subprocess(['serve', '--inet'])
135
args = ['serve', '--inet']
136
args.extend(extra_options)
137
process = self.start_bzr_subprocess(args)
84
139
# Connect to the server
85
140
# We use this url because while this is no valid URL to connect to this
86
141
# server instance, the transport needs a URL.
87
142
url = 'bzr://localhost/'
88
144
client_medium = medium.SmartSimplePipesClientMedium(
89
145
process.stdout, process.stdin, url)
90
146
transport = remote.RemoteTransport(url, medium=client_medium)
105
161
prefix = 'listening on port: '
106
162
self.assertStartsWith(port_line, prefix)
107
163
port = int(port_line[len(prefix):])
108
return process,'bzr://localhost:%d/' % port
164
url = 'bzr://localhost:%d/' % port
168
def test_bzr_serve_quiet(self):
169
self.make_branch('.')
170
args = ['--port', 'localhost:0', '--quiet']
171
out, err = self.run_bzr_serve_then_func(args, retcode=3)
172
self.assertEqual('', out)
173
self.assertEqual('', err)
110
175
def test_bzr_serve_inet_readonly(self):
111
176
"""bzr server should provide a read only filesystem by default."""
120
185
process, transport = self.start_server_inet(['--allow-writes'])
122
# We get a working branch
187
# We get a working branch, and can create a directory
123
188
branch = BzrDir.open_from_transport(transport).open_branch()
124
189
self.make_read_requests(branch)
190
transport.mkdir('adir')
125
191
self.assertInetServerShutsdownCleanly(process)
127
193
def test_bzr_serve_port_readonly(self):
128
194
"""bzr server should provide a read only filesystem by default."""
129
195
process, url = self.start_server_port()
130
transport = get_transport(url)
131
self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')
196
t = transport.get_transport(url)
197
self.assertRaises(errors.TransportNotPossible, t.mkdir, 'adir')
132
198
self.assertServerFinishesCleanly(process)
134
200
def test_bzr_serve_port_readwrite(self):
154
220
self.make_read_requests(branch)
155
221
self.assertServerFinishesCleanly(process)
157
def test_bzr_connect_to_bzr_ssh(self):
158
"""User acceptance that get_transport of a bzr+ssh:// behaves correctly.
160
bzr+ssh:// should cause bzr to run a remote bzr smart server over SSH.
163
from bzrlib.transport.sftp import SFTPServer
164
except ParamikoNotPresent:
165
raise TestSkipped('Paramiko not installed')
166
from bzrlib.tests.stub_sftp import StubServer
169
self.make_branch('a_branch')
171
# Start an SSH server
172
self.command_executed = []
173
# XXX: This is horrible -- we define a really dumb SSH server that
174
# executes commands, and manage the hooking up of stdin/out/err to the
175
# SSH channel ourselves. Surely this has already been implemented
177
class StubSSHServer(StubServer):
181
def check_channel_exec_request(self, channel, command):
182
self.test.command_executed.append(command)
183
proc = subprocess.Popen(
184
command, shell=True, stdin=subprocess.PIPE,
185
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
187
# XXX: horribly inefficient, not to mention ugly.
188
# Start a thread for each of stdin/out/err, and relay bytes from
189
# the subprocess to channel and vice versa.
190
def ferry_bytes(read, write, close):
199
(channel.recv, proc.stdin.write, proc.stdin.close),
200
(proc.stdout.read, channel.sendall, channel.close),
201
(proc.stderr.read, channel.sendall_stderr, channel.close)]
202
for read, write, close in file_functions:
203
t = threading.Thread(
204
target=ferry_bytes, args=(read, write, close))
209
ssh_server = SFTPServer(StubSSHServer)
210
# XXX: We *don't* want to override the default SSH vendor, so we set
211
# _vendor to what _get_ssh_vendor returns.
213
self.addCleanup(ssh_server.tearDown)
214
port = ssh_server._listener.port
216
# Access the branch via a bzr+ssh URL. The BZR_REMOTE_PATH environment
217
# variable is used to tell bzr what command to run on the remote end.
218
path_to_branch = osutils.abspath('a_branch')
220
orig_bzr_remote_path = os.environ.get('BZR_REMOTE_PATH')
221
bzr_remote_path = self.get_bzr_path()
222
if sys.platform == 'win32':
223
bzr_remote_path = sys.executable + ' ' + self.get_bzr_path()
224
os.environ['BZR_REMOTE_PATH'] = bzr_remote_path
226
if sys.platform == 'win32':
227
path_to_branch = os.path.splitdrive(path_to_branch)[1]
228
branch = Branch.open(
229
'bzr+ssh://fred:secret@localhost:%d%s' % (port, path_to_branch))
230
self.make_read_requests(branch)
231
# Check we can perform write operations
232
branch.bzrdir.root_transport.mkdir('foo')
234
# Restore the BZR_REMOTE_PATH environment variable back to its
236
if orig_bzr_remote_path is None:
237
del os.environ['BZR_REMOTE_PATH']
239
os.environ['BZR_REMOTE_PATH'] = orig_bzr_remote_path
242
['%s serve --inet --directory=/ --allow-writes'
244
self.command_executed)
247
class TestCmdServeChrooting(TestCaseWithTransport):
223
def test_bzr_serve_dhpss(self):
224
# This is a smoke test that the server doesn't crash when run with
225
# -Dhpss, and does drop some hpss logging to the file.
226
self.make_branch('.')
227
log_fname = os.getcwd() + '/server.log'
228
self._captureVar('BZR_LOG', log_fname)
229
process, transport = self.start_server_inet(['-Dhpss'])
230
branch = BzrDir.open_from_transport(transport).open_branch()
231
self.make_read_requests(branch)
232
self.assertInetServerShutsdownCleanly(process)
233
f = open(log_fname, 'rb')
236
self.assertContainsRe(content, r'hpss request: \[[0-9-]+\]')
239
class TestCmdServeChrooting(TestBzrServeBase):
249
241
def test_serve_tcp(self):
250
242
"""'bzr serve' wraps the given --directory in a ChrootServer.
256
248
t = self.get_transport()
257
249
t.mkdir('server-root')
258
250
self.run_bzr_serve_then_func(
259
['--port', '0', '--directory', t.local_abspath('server-root'),
251
['--port', '127.0.0.1:0',
252
'--directory', t.local_abspath('server-root'),
260
253
'--allow-writes'],
261
self.when_server_started)
254
func=self.when_server_started)
262
255
# The when_server_started method issued a find_repositoryV3 that should
263
256
# fail with 'norepository' because there are no repositories inside the
265
258
self.assertEqual(('norepository',), self.client_resp)
267
def run_bzr_serve_then_func(self, serve_args, func, *func_args,
269
"""Run 'bzr serve', and run the given func in a thread once the server
272
When 'func' terminates, the server will be terminated too.
275
def on_server_start(backing_urls, tcp_server):
276
t = threading.Thread(
277
target=on_server_start_thread, args=(tcp_server,))
279
def on_server_start_thread(tcp_server):
282
self.tcp_server = tcp_server
284
func(*func_args, **func_kwargs)
286
# Log errors to make some test failures a little less
288
mutter('func broke: %r', e)
290
# Then stop the server
291
mutter('interrupting...')
292
thread.interrupt_main()
293
SmartTCPServer.hooks.install_named_hook(
294
'server_started_ex', on_server_start,
295
'run_bzr_serve_then_func hook')
298
self.run_bzr(['serve'] + list(serve_args))
299
except KeyboardInterrupt:
302
260
def when_server_started(self):
303
261
# Connect to the TCP server and issue some requests and see what comes
316
274
client_medium.disconnect()
277
class TestUserdirExpansion(TestCaseWithMemoryTransport):
279
def fake_expanduser(self, path):
280
"""A simple, environment-independent, function for the duration of this
283
Paths starting with a path segment of '~user' will expand to start with
284
'/home/user/'. Every other path will be unchanged.
286
if path.split('/', 1)[0] == '~user':
287
return '/home/user' + path[len('~user'):]
290
def make_test_server(self, base_path='/'):
291
"""Make and start a BzrServerFactory, backed by a memory transport, and
292
creat '/home/user' in that transport.
294
bzr_server = BzrServerFactory(
295
self.fake_expanduser, lambda t: base_path)
296
mem_transport = self.get_transport()
297
mem_transport.mkdir_multi(['home', 'home/user'])
298
bzr_server.set_up(mem_transport, None, None, inet=True)
299
self.addCleanup(bzr_server.tear_down)
302
def test_bzr_serve_expands_userdir(self):
303
bzr_server = self.make_test_server()
304
self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
306
def test_bzr_serve_does_not_expand_userdir_outside_base(self):
307
bzr_server = self.make_test_server('/foo')
308
self.assertFalse(bzr_server.smart_server.backing_transport.has('~user'))
310
def test_get_base_path(self):
311
"""cmd_serve will turn the --directory option into a LocalTransport
312
(optionally decorated with 'readonly+'). BzrServerFactory can
313
determine the original --directory from that transport.
315
# URLs always include the trailing slash, and get_base_path returns it
316
base_dir = osutils.abspath('/a/b/c') + '/'
317
base_url = urlutils.local_path_to_url(base_dir) + '/'
318
# Define a fake 'protocol' to capture the transport that cmd_serve
319
# passes to serve_bzr.
320
def capture_transport(transport, host, port, inet):
321
self.bzr_serve_transport = transport
322
cmd = builtins.cmd_serve()
324
cmd.run(directory=base_dir, protocol=capture_transport)
325
server_maker = BzrServerFactory()
327
'readonly+%s' % base_url, self.bzr_serve_transport.base)
329
base_dir, server_maker.get_base_path(self.bzr_serve_transport))
331
cmd.run(directory=base_dir, protocol=capture_transport,
333
server_maker = BzrServerFactory()
334
self.assertEqual(base_url, self.bzr_serve_transport.base)
335
self.assertEqual(base_dir,
336
server_maker.get_base_path(self.bzr_serve_transport))
added
removed
bzrlib/tests/blackbox/test_serve.py
