28
import SocketServer as socketserver
37
from ..transport import (
35
from bzrlib.transport import (
40
from . import test_server
43
class StubServer(paramiko.ServerInterface):
45
def __init__(self, test_case_server):
38
from bzrlib.tests import test_server
41
class StubServer (paramiko.ServerInterface):
43
def __init__(self, test_case):
46
44
paramiko.ServerInterface.__init__(self)
47
self.log = test_case_server.log
45
self._test_case = test_case
49
47
def check_auth_password(self, username, password):
51
self.log('sftpserver - authorizing: %s' % (username,))
49
self._test_case.log('sftpserver - authorizing: %s' % (username,))
52
50
return paramiko.AUTH_SUCCESSFUL
54
52
def check_channel_request(self, kind, chanid):
55
self.log('sftpserver - channel request: %s, %s' % (kind, chanid))
54
'sftpserver - channel request: %s, %s' % (kind, chanid))
56
55
return paramiko.OPEN_SUCCEEDED
59
class StubSFTPHandle(paramiko.SFTPHandle):
58
class StubSFTPHandle (paramiko.SFTPHandle):
63
61
return paramiko.SFTPAttributes.from_stat(
64
62
os.fstat(self.readfile.fileno()))
66
64
return paramiko.SFTPServer.convert_errno(e.errno)
68
66
def chattr(self, attr):
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)
284
314
class SocketDelay(object):
285
315
"""A socket decorator to make TCP appear slower.
356
386
return bytes_sent
359
class TestingSFTPConnectionHandler(socketserver.BaseRequestHandler):
362
self.wrap_for_latency()
363
tcs = self.server.test_case_server
364
ptrans = paramiko.Transport(self.request)
365
self.paramiko_transport = ptrans
366
# Set it to a channel under 'bzr' so that we get debug info
367
ptrans.set_log_channel('brz.paramiko.transport')
368
ptrans.add_server_key(tcs.get_host_key())
369
ptrans.set_subsystem_handler('sftp', paramiko.SFTPServer,
370
StubSFTPServer, root=tcs._root,
371
home=tcs._server_homedir)
372
server = tcs._server_interface(tcs)
373
# This blocks until the key exchange has been done
374
ptrans.start_server(None, server)
377
# Wait for the conversation to finish, when the paramiko.Transport
379
# TODO: Consider timing out after XX seconds rather than hanging.
380
# Also we could check paramiko_transport.active and possibly
381
# paramiko_transport.getException().
382
self.paramiko_transport.join()
384
def wrap_for_latency(self):
385
tcs = self.server.test_case_server
387
# Give the socket (which the request really is) a latency adding
389
self.request = SocketDelay(self.request, tcs.add_latency)
392
class TestingSFTPWithoutSSHConnectionHandler(TestingSFTPConnectionHandler):
395
self.wrap_for_latency()
396
# Re-import these as locals, so that they're still accessible during
397
# interpreter shutdown (when all module globals get set to None, leading
398
# to confusing errors like "'NoneType' object has no attribute 'error'".
400
class FakeChannel(object):
401
def get_transport(self):
404
def get_log_channel(self):
405
return 'brz.paramiko'
410
def get_hexdump(self):
416
tcs = self.server.test_case_server
417
sftp_server = paramiko.SFTPServer(
418
FakeChannel(), 'sftp', StubServer(tcs), StubSFTPServer,
419
root=tcs._root, home=tcs._server_homedir)
420
self.sftp_server = sftp_server
421
sys_stderr = sys.stderr # Used in error reporting during shutdown
423
sftp_server.start_subsystem(
424
'sftp', None, ssh.SocketAsChannelAdapter(self.request))
425
except socket.error as e:
426
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
427
# it's okay for the client to disconnect abruptly
428
# (bug in paramiko 1.6: it should absorb this exception)
432
except Exception as e:
433
# This typically seems to happen during interpreter shutdown, so
434
# most of the useful ways to report this error won't work.
435
# Writing the exception type, and then the text of the exception,
436
# seems to be the best we can do.
437
# FIXME: All interpreter shutdown errors should have been related
438
# to daemon threads, cleanup needed -- vila 20100623
439
sys_stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
440
sys_stderr.write('%s\n\n' % (e,))
443
self.sftp_server.finish_subsystem()
446
class TestingSFTPServer(test_server.TestingThreadingTCPServer):
448
def __init__(self, server_address, request_handler_class, test_case_server):
449
test_server.TestingThreadingTCPServer.__init__(
450
self, server_address, request_handler_class)
451
self.test_case_server = test_case_server
454
class SFTPServer(test_server.TestingTCPServerInAThread):
389
class SFTPServer(test_server.TestServer):
455
390
"""Common code for SFTP server facilities."""
457
392
def __init__(self, server_interface=StubServer):
458
self.host = '127.0.0.1'
460
super(SFTPServer, self).__init__((self.host, self.port),
462
TestingSFTPConnectionHandler)
463
393
self._original_vendor = None
395
self._server_homedir = None
396
self._listener = None
464
398
self._vendor = ssh.ParamikoVendor()
465
399
self._server_interface = server_interface
466
self._host_key = None
468
402
self.add_latency = 0
470
self._server_homedir = None
473
404
def _get_sftp_url(self, path):
474
405
"""Calculate an sftp url to this server for path."""
475
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)
477
409
def log(self, message):
478
410
"""StubServer uses this to log when a new server is created."""
479
411
self.logs.append(message)
481
def create_server(self):
482
server = self.server_class((self.host, self.port),
483
self.request_handler_class,
487
def get_host_key(self):
488
if self._host_key is None:
489
key_file = osutils.pathjoin(self._homedir, 'test_rsa.key')
490
f = open(key_file, 'w')
492
f.write(STUB_SERVER_KEY)
495
self._host_key = paramiko.RSAKey.from_private_key_file(key_file)
496
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)
498
439
def start_server(self, backing_server=None):
499
440
# XXX: TODO: make sftpserver back onto backing_server rather than local
501
if not (backing_server is None
502
or isinstance(backing_server, test_server.LocalURLServer)):
442
if not (backing_server is None or
443
isinstance(backing_server, test_server.LocalURLServer)):
503
444
raise AssertionError(
504
445
'backing_server should not be %r, because this can only serve '
505
446
'the local current working directory.' % (backing_server,))
506
447
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
507
448
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
508
self._homedir = osutils.getcwd()
509
449
if sys.platform == 'win32':
450
# Win32 needs to use the UNICODE api
451
self._homedir = os.getcwdu()
510
452
# Normalize the path or it will be wrongly escaped
511
453
self._homedir = osutils.normpath(self._homedir)
513
self._homedir = self._homedir
455
# But unix SFTP servers should just deal in bytestreams
456
self._homedir = os.getcwd()
514
457
if self._server_homedir is None:
515
458
self._server_homedir = self._homedir
517
460
if sys.platform == 'win32':
519
super(SFTPServer, self).start_server()
462
self._listener = SocketListener(self._run_server_entry)
463
self._listener.setDaemon(True)
464
self._listener.start()
521
466
def stop_server(self):
523
super(SFTPServer, self).stop_server()
525
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
467
self._listener.stop()
468
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
527
470
def get_bogus_url(self):
528
"""See breezy.transport.Server.get_bogus_url."""
529
# this is chosen to try to prevent trouble with proxies, weird dns, etc
471
"""See bzrlib.transport.Server.get_bogus_url."""
472
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
530
473
# we bind a random socket, so that we get a guaranteed unused port
531
474
# we just never listen on that port
532
475
s = socket.socket()
552
495
def __init__(self):
553
496
super(SFTPServerWithoutSSH, self).__init__()
554
497
self._vendor = ssh.LoopbackVendor()
555
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()
561
539
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
562
540
"""A test server for sftp transports, using absolute urls."""
564
542
def get_url(self):
565
"""See breezy.transport.Server.get_url."""
543
"""See bzrlib.transport.Server.get_url."""
566
544
homedir = self._homedir
567
545
if sys.platform != 'win32':
568
546
# Remove the initial '/' on all platforms but win32