13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
"""Tests of the bzr serve command."""
28
26
from bzrlib import (
33
29
revision as _mod_revision,
37
31
from bzrlib.branch import Branch
38
32
from bzrlib.bzrdir import BzrDir
39
from bzrlib.smart import client, medium
40
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
41
from bzrlib.tests import (
42
TestCaseWithMemoryTransport,
43
TestCaseWithTransport,
46
from bzrlib.trace import mutter
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()
33
from bzrlib.errors import ParamikoNotPresent
34
from bzrlib.smart import medium
35
from bzrlib.tests import TestCaseWithTransport, TestSkipped
36
from bzrlib.transport import get_transport, remote
39
class TestBzrServe(TestCaseWithTransport):
98
41
def assertInetServerShutsdownCleanly(self, process):
99
42
"""Shutdown the server process looking for errors."""
206
128
# Connect to the server
207
129
branch = Branch.open(url)
208
self.make_read_requests(branch)
131
# We get a working branch
132
branch.repository.get_revision_graph()
133
self.assertEqual(_mod_revision.NULL_REVISION,
134
_mod_revision.ensure_null(branch.last_revision()))
209
136
self.assertServerFinishesCleanly(process)
211
def test_bzr_serve_supports_protocol(self):
138
def test_bzr_connect_to_bzr_ssh(self):
139
"""User acceptance that get_transport of a bzr+ssh:// behaves correctly.
141
bzr+ssh:// should cause bzr to run a remote bzr smart server over SSH.
144
from bzrlib.transport.sftp import SFTPServer
145
except ParamikoNotPresent:
146
raise TestSkipped('Paramiko not installed')
147
from bzrlib.tests.stub_sftp import StubServer
213
self.make_branch('.')
215
process, url = self.start_server_port(['--allow-writes',
218
# Connect to the server
219
branch = Branch.open(url)
220
self.make_read_requests(branch)
221
self.assertServerFinishesCleanly(process)
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):
241
def test_serve_tcp(self):
242
"""'bzr serve' wraps the given --directory in a ChrootServer.
244
So requests that search up through the parent directories (like
245
find_repositoryV3) will give "not found" responses, rather than
246
InvalidURLJoin or jail break errors.
248
t = self.get_transport()
249
t.mkdir('server-root')
250
self.run_bzr_serve_then_func(
251
['--port', '127.0.0.1:0',
252
'--directory', t.local_abspath('server-root'),
254
func=self.when_server_started)
255
# The when_server_started method issued a find_repositoryV3 that should
256
# fail with 'norepository' because there are no repositories inside the
258
self.assertEqual(('norepository',), self.client_resp)
260
def when_server_started(self):
261
# Connect to the TCP server and issue some requests and see what comes
263
client_medium = medium.SmartTCPClientMedium(
264
'127.0.0.1', self.tcp_server.port,
265
'bzr://localhost:%d/' % (self.tcp_server.port,))
266
smart_client = client._SmartClient(client_medium)
267
resp = smart_client.call('mkdir', 'foo', '')
268
resp = smart_client.call('BzrDirFormat.initialize', 'foo/')
150
self.make_branch('a_branch')
152
# Start an SSH server
153
self.command_executed = []
154
# XXX: This is horrible -- we define a really dumb SSH server that
155
# executes commands, and manage the hooking up of stdin/out/err to the
156
# SSH channel ourselves. Surely this has already been implemented
158
class StubSSHServer(StubServer):
162
def check_channel_exec_request(self, channel, command):
163
self.test.command_executed.append(command)
164
proc = subprocess.Popen(
165
command, shell=True, stdin=subprocess.PIPE,
166
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
168
# XXX: horribly inefficient, not to mention ugly.
169
# Start a thread for each of stdin/out/err, and relay bytes from
170
# the subprocess to channel and vice versa.
171
def ferry_bytes(read, write, close):
180
(channel.recv, proc.stdin.write, proc.stdin.close),
181
(proc.stdout.read, channel.sendall, channel.close),
182
(proc.stderr.read, channel.sendall_stderr, channel.close)]
183
for read, write, close in file_functions:
184
t = threading.Thread(
185
target=ferry_bytes, args=(read, write, close))
190
ssh_server = SFTPServer(StubSSHServer)
191
# XXX: We *don't* want to override the default SSH vendor, so we set
192
# _vendor to what _get_ssh_vendor returns.
194
self.addCleanup(ssh_server.tearDown)
195
port = ssh_server._listener.port
197
# Access the branch via a bzr+ssh URL. The BZR_REMOTE_PATH environment
198
# variable is used to tell bzr what command to run on the remote end.
199
path_to_branch = osutils.abspath('a_branch')
201
orig_bzr_remote_path = os.environ.get('BZR_REMOTE_PATH')
202
bzr_remote_path = self.get_bzr_path()
203
if sys.platform == 'win32':
204
bzr_remote_path = sys.executable + ' ' + self.get_bzr_path()
205
os.environ['BZR_REMOTE_PATH'] = bzr_remote_path
270
resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
271
except errors.ErrorFromSmartServer, e:
273
self.client_resp = resp
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))
207
if sys.platform == 'win32':
208
path_to_branch = os.path.splitdrive(path_to_branch)[1]
209
branch = Branch.open(
210
'bzr+ssh://fred:secret@localhost:%d%s' % (port, path_to_branch))
212
branch.repository.get_revision_graph()
213
self.assertEqual(_mod_revision.NULL_REVISION,
214
_mod_revision.ensure_null(branch.last_revision()))
215
# Check we can perform write operations
216
branch.bzrdir.root_transport.mkdir('foo')
218
# Restore the BZR_REMOTE_PATH environment variable back to its
220
if orig_bzr_remote_path is None:
221
del os.environ['BZR_REMOTE_PATH']
223
os.environ['BZR_REMOTE_PATH'] = orig_bzr_remote_path
226
['%s serve --inet --directory=/ --allow-writes'
228
self.command_executed)
added
removed
bzrlib/tests/blackbox/test_serve.py
