39
38
from bzrlib.tests import test_server
42
class StubServer(paramiko.ServerInterface):
41
class StubServer (paramiko.ServerInterface):
44
def __init__(self, test_case_server):
43
def __init__(self, test_case):
45
44
paramiko.ServerInterface.__init__(self)
46
self.log = test_case_server.log
45
self._test_case = test_case
48
47
def check_auth_password(self, username, password):
50
self.log('sftpserver - authorizing: %s' % (username,))
49
self._test_case.log('sftpserver - authorizing: %s' % (username,))
51
50
return paramiko.AUTH_SUCCESSFUL
53
52
def check_channel_request(self, kind, chanid):
54
self.log('sftpserver - channel request: %s, %s' % (kind, chanid))
54
'sftpserver - channel request: %s, %s' % (kind, chanid))
55
55
return paramiko.OPEN_SUCCEEDED
58
class StubSFTPHandle(paramiko.SFTPHandle):
58
class StubSFTPHandle (paramiko.SFTPHandle):
62
61
return paramiko.SFTPAttributes.from_stat(
265
class SocketListener(threading.Thread):
267
def __init__(self, callback):
268
threading.Thread.__init__(self)
269
self._callback = callback
270
self._socket = socket.socket()
271
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
272
self._socket.bind(('localhost', 0))
273
self._socket.listen(1)
274
self.host, self.port = self._socket.getsockname()[:2]
275
self._stop_event = threading.Event()
278
# called from outside this thread
279
self._stop_event.set()
280
# use a timeout here, because if the test fails, the server thread may
281
# never notice the stop_event.
286
trace.mutter('SocketListener %r has started', self)
288
readable, writable_unused, exception_unused = \
289
select.select([self._socket], [], [], 0.1)
290
if self._stop_event.isSet():
291
trace.mutter('SocketListener %r has stopped', self)
293
if len(readable) == 0:
296
s, addr_unused = self._socket.accept()
297
trace.mutter('SocketListener %r has accepted connection %r',
299
# because the loopback socket is inline, and transports are
300
# never explicitly closed, best to launch a new thread.
301
threading.Thread(target=self._callback, args=(s,)).start()
302
except socket.error, x:
303
sys.excepthook(*sys.exc_info())
304
trace.warning('Socket error during accept() '
305
'within unit test server thread: %r' % x)
307
# probably a failed test; unit test thread will log the
309
sys.excepthook(*sys.exc_info())
311
'Exception from within unit test server thread: %r' % x)
267
314
class SocketDelay(object):
268
315
"""A socket decorator to make TCP appear slower.
339
386
return bytes_sent
342
class TestingSFTPConnectionHandler(SocketServer.BaseRequestHandler):
345
self.wrap_for_latency()
346
tcs = self.server.test_case_server
347
ssh_server = paramiko.Transport(self.request)
348
ssh_server.add_server_key(tcs.get_host_key())
349
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
350
StubSFTPServer, root=tcs._root,
351
home=tcs._server_homedir)
352
server = tcs._server_interface(tcs)
353
ssh_server.start_server(None, server)
354
# FIXME: Long story short:
355
# bt.test_transport.TestSSHConnections.test_bzr_connect_to_bzr_ssh
356
# fails if we wait less than 0.2 seconds... paramiko uses a lot of
357
# timeouts internally which probably mask a synchronisation
358
# problem. Note that this is the only test that requires this hack and
359
# the test may need to be fixed instead, but it's late and the test is
360
# horrible as mentioned in its comments :) -- vila 20100623
364
def wrap_for_latency(self):
365
tcs = self.server.test_case_server
367
# Give the socket (which the request really is) a latency adding
369
self.request = SocketDelay(self.request, tcs.add_latency)
372
class TestingSFTPWithoutSSHConnectionHandler(TestingSFTPConnectionHandler):
375
self.wrap_for_latency()
376
# Re-import these as locals, so that they're still accessible during
377
# interpreter shutdown (when all module globals get set to None, leading
378
# to confusing errors like "'NoneType' object has no attribute 'error'".
379
class FakeChannel(object):
380
def get_transport(self):
382
def get_log_channel(self):
386
def get_hexdump(self):
391
tcs = self.server.test_case_server
392
server = paramiko.SFTPServer(
393
FakeChannel(), 'sftp', StubServer(tcs), StubSFTPServer,
394
root=tcs._root, home=tcs._server_homedir)
396
server.start_subsystem(
397
'sftp', None, ssh.SocketAsChannelAdapter(self.request))
398
except socket.error, e:
399
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
400
# it's okay for the client to disconnect abruptly
401
# (bug in paramiko 1.6: it should absorb this exception)
406
# This typically seems to happen during interpreter shutdown, so
407
# most of the useful ways to report this error won't work.
408
# Writing the exception type, and then the text of the exception,
409
# seems to be the best we can do.
410
# FIXME: All interpreter shutdown errors should have been related
411
# to daemon threads, cleanup needed -- vila 20100623
413
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
414
sys.stderr.write('%s\n\n' % (e,))
415
server.finish_subsystem()
418
class TestingSFTPServer(test_server.TestingThreadingTCPServer):
420
def __init__(self, server_address, request_handler_class, test_case_server):
421
test_server.TestingThreadingTCPServer.__init__(
422
self, server_address, request_handler_class)
423
self.test_case_server = test_case_server
426
class SFTPServer(test_server.TestingTCPServerInAThread):
389
class SFTPServer(test_server.TestServer):
427
390
"""Common code for SFTP server facilities."""
429
392
def __init__(self, server_interface=StubServer):
430
self.host = '127.0.0.1'
432
super(SFTPServer, self).__init__((self.host, self.port),
434
TestingSFTPConnectionHandler)
435
393
self._original_vendor = None
395
self._server_homedir = None
396
self._listener = None
436
398
self._vendor = ssh.ParamikoVendor()
437
399
self._server_interface = server_interface
438
self._host_key = None
440
402
self.add_latency = 0
442
self._server_homedir = None
445
404
def _get_sftp_url(self, path):
446
405
"""Calculate an sftp url to this server for path."""
447
return "sftp://foo:bar@%s:%s/%s" % (self.host, self.port, path)
406
return 'sftp://foo:bar@%s:%d/%s' % (self._listener.host,
407
self._listener.port, path)
449
409
def log(self, message):
450
410
"""StubServer uses this to log when a new server is created."""
451
411
self.logs.append(message)
453
def create_server(self):
454
server = self.server_class((self.host, self.port),
455
self.request_handler_class,
459
def get_host_key(self):
460
if self._host_key is None:
461
key_file = osutils.pathjoin(self._homedir, 'test_rsa.key')
462
f = open(key_file, 'w')
464
f.write(STUB_SERVER_KEY)
467
self._host_key = paramiko.RSAKey.from_private_key_file(key_file)
468
return self._host_key
413
def _run_server_entry(self, sock):
414
"""Entry point for all implementations of _run_server.
416
If self.add_latency is > 0.000001 then sock is given a latency adding
419
if self.add_latency > 0.000001:
420
sock = SocketDelay(sock, self.add_latency)
421
return self._run_server(sock)
423
def _run_server(self, s):
424
ssh_server = paramiko.Transport(s)
425
key_file = osutils.pathjoin(self._homedir, 'test_rsa.key')
426
f = open(key_file, 'w')
427
f.write(STUB_SERVER_KEY)
429
host_key = paramiko.RSAKey.from_private_key_file(key_file)
430
ssh_server.add_server_key(host_key)
431
server = self._server_interface(self)
432
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
433
StubSFTPServer, root=self._root,
434
home=self._server_homedir)
435
event = threading.Event()
436
ssh_server.start_server(event, server)
470
439
def start_server(self, backing_server=None):
471
440
# XXX: TODO: make sftpserver back onto backing_server rather than local
526
495
def __init__(self):
527
496
super(SFTPServerWithoutSSH, self).__init__()
528
497
self._vendor = ssh.LoopbackVendor()
529
self.request_handler_class = TestingSFTPWithoutSSHConnectionHandler
499
def _run_server(self, sock):
500
# Re-import these as locals, so that they're still accessible during
501
# interpreter shutdown (when all module globals get set to None, leading
502
# to confusing errors like "'NoneType' object has no attribute 'error'".
503
class FakeChannel(object):
504
def get_transport(self):
506
def get_log_channel(self):
510
def get_hexdump(self):
515
server = paramiko.SFTPServer(
516
FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
517
root=self._root, home=self._server_homedir)
519
server.start_subsystem(
520
'sftp', None, ssh.SocketAsChannelAdapter(sock))
521
except socket.error, e:
522
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
523
# it's okay for the client to disconnect abruptly
524
# (bug in paramiko 1.6: it should absorb this exception)
529
# This typically seems to happen during interpreter shutdown, so
530
# most of the useful ways to report this error are won't work.
531
# Writing the exception type, and then the text of the exception,
532
# seems to be the best we can do.
534
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
535
sys.stderr.write('%s\n\n' % (e,))
536
server.finish_subsystem()
535
539
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
added
removed
bzrlib/tests/stub_sftp.py
