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,
36
31
from bzrlib.branch import Branch
37
32
from bzrlib.bzrdir import BzrDir
38
from bzrlib.smart import client, medium
39
from bzrlib.smart.server import BzrServerFactory, SmartTCPServer
40
from bzrlib.tests import (
41
TestCaseWithMemoryTransport,
42
TestCaseWithTransport,
45
from bzrlib.trace import mutter
33
from bzrlib.errors import ParamikoNotPresent
34
from bzrlib.smart import medium
35
from bzrlib.tests import TestCaseWithTransport, TestSkipped
46
36
from bzrlib.transport import get_transport, remote
49
class TestBzrServeBase(TestCaseWithTransport):
51
def run_bzr_serve_then_func(self, serve_args, retcode=0, func=None,
52
*func_args, **func_kwargs):
53
"""Run 'bzr serve', and run the given func in a thread once the server
56
When 'func' terminates, the server will be terminated too.
58
Returns stdout and stderr.
61
def on_server_start(backing_urls, tcp_server):
63
target=on_server_start_thread, args=(tcp_server,))
65
def on_server_start_thread(tcp_server):
68
self.tcp_server = tcp_server
71
func(*func_args, **func_kwargs)
73
# Log errors to make some test failures a little less
75
mutter('func broke: %r', e)
77
# Then stop the server
78
mutter('interrupting...')
79
thread.interrupt_main()
80
SmartTCPServer.hooks.install_named_hook(
81
'server_started_ex', on_server_start,
82
'run_bzr_serve_then_func hook')
85
out, err = self.run_bzr(['serve'] + list(serve_args))
86
except KeyboardInterrupt, e:
91
class TestBzrServe(TestBzrServeBase):
94
super(TestBzrServe, self).setUp()
95
self.disable_missing_extensions_warning()
39
class TestBzrServe(TestCaseWithTransport):
97
41
def assertInetServerShutsdownCleanly(self, process):
98
42
"""Shutdown the server process looking for errors."""
205
128
# Connect to the server
206
129
branch = Branch.open(url)
207
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()))
208
136
self.assertServerFinishesCleanly(process)
210
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
212
self.make_branch('.')
214
process, url = self.start_server_port(['--allow-writes',
217
# Connect to the server
218
branch = Branch.open(url)
219
self.make_read_requests(branch)
220
self.assertServerFinishesCleanly(process)
222
def test_bzr_serve_dhpss(self):
223
# This is a smoke test that the server doesn't crash when run with
224
# -Dhpss, and does drop some hpss logging to the file.
225
self.make_branch('.')
226
log_fname = os.getcwd() + '/server.log'
227
self._captureVar('BZR_LOG', log_fname)
228
process, transport = self.start_server_inet(['-Dhpss'])
229
branch = BzrDir.open_from_transport(transport).open_branch()
230
self.make_read_requests(branch)
231
self.assertInetServerShutsdownCleanly(process)
232
f = open(log_fname, 'rb')
235
self.assertContainsRe(content, r'hpss request: \[[0-9-]+\]')
238
class TestCmdServeChrooting(TestBzrServeBase):
240
def test_serve_tcp(self):
241
"""'bzr serve' wraps the given --directory in a ChrootServer.
243
So requests that search up through the parent directories (like
244
find_repositoryV3) will give "not found" responses, rather than
245
InvalidURLJoin or jail break errors.
247
t = self.get_transport()
248
t.mkdir('server-root')
249
self.run_bzr_serve_then_func(
250
['--port', '127.0.0.1:0',
251
'--directory', t.local_abspath('server-root'),
253
func=self.when_server_started)
254
# The when_server_started method issued a find_repositoryV3 that should
255
# fail with 'norepository' because there are no repositories inside the
257
self.assertEqual(('norepository',), self.client_resp)
259
def when_server_started(self):
260
# Connect to the TCP server and issue some requests and see what comes
262
client_medium = medium.SmartTCPClientMedium(
263
'127.0.0.1', self.tcp_server.port,
264
'bzr://localhost:%d/' % (self.tcp_server.port,))
265
smart_client = client._SmartClient(client_medium)
266
resp = smart_client.call('mkdir', 'foo', '')
267
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
269
resp = smart_client.call('BzrDir.find_repositoryV3', 'foo/')
270
except errors.ErrorFromSmartServer, e:
272
self.client_resp = resp
273
client_medium.disconnect()
276
class TestUserdirExpansion(TestCaseWithMemoryTransport):
278
def fake_expanduser(self, path):
279
"""A simple, environment-independent, function for the duration of this
282
Paths starting with a path segment of '~user' will expand to start with
283
'/home/user/'. Every other path will be unchanged.
285
if path.split('/', 1)[0] == '~user':
286
return '/home/user' + path[len('~user'):]
289
def make_test_server(self, base_path='/'):
290
"""Make and start a BzrServerFactory, backed by a memory transport, and
291
creat '/home/user' in that transport.
293
bzr_server = BzrServerFactory(
294
self.fake_expanduser, lambda t: base_path)
295
mem_transport = self.get_transport()
296
mem_transport.mkdir_multi(['home', 'home/user'])
297
bzr_server.set_up(mem_transport, None, None, inet=True)
298
self.addCleanup(bzr_server.tear_down)
301
def test_bzr_serve_expands_userdir(self):
302
bzr_server = self.make_test_server()
303
self.assertTrue(bzr_server.smart_server.backing_transport.has('~user'))
305
def test_bzr_serve_does_not_expand_userdir_outside_base(self):
306
bzr_server = self.make_test_server('/foo')
307
self.assertFalse(bzr_server.smart_server.backing_transport.has('~user'))
309
def test_get_base_path(self):
310
"""cmd_serve will turn the --directory option into a LocalTransport
311
(optionally decorated with 'readonly+'). BzrServerFactory can
312
determine the original --directory from that transport.
314
# URLs always include the trailing slash, and get_base_path returns it
315
base_dir = osutils.abspath('/a/b/c') + '/'
316
base_url = urlutils.local_path_to_url(base_dir) + '/'
317
# Define a fake 'protocol' to capture the transport that cmd_serve
318
# passes to serve_bzr.
319
def capture_transport(transport, host, port, inet):
320
self.bzr_serve_transport = transport
321
cmd = builtins.cmd_serve()
323
cmd.run(directory=base_dir, protocol=capture_transport)
324
server_maker = BzrServerFactory()
326
'readonly+%s' % base_url, self.bzr_serve_transport.base)
328
base_dir, server_maker.get_base_path(self.bzr_serve_transport))
330
cmd.run(directory=base_dir, protocol=capture_transport,
332
server_maker = BzrServerFactory()
333
self.assertEqual(base_url, self.bzr_serve_transport.base)
334
self.assertEqual(base_dir,
335
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
