870
# ------------- server test implementation --------------
873
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
875
STUB_SERVER_KEY = """
876
-----BEGIN RSA PRIVATE KEY-----
877
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
878
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
879
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
880
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
881
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
882
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
883
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
884
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
885
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
886
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
887
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
888
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
889
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
890
-----END RSA PRIVATE KEY-----
894
class SocketListener(threading.Thread):
896
def __init__(self, callback):
897
threading.Thread.__init__(self)
898
self._callback = callback
899
self._socket = socket.socket()
900
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
901
self._socket.bind(('localhost', 0))
902
self._socket.listen(1)
903
self.port = self._socket.getsockname()[1]
904
self._stop_event = threading.Event()
907
# called from outside this thread
908
self._stop_event.set()
909
# use a timeout here, because if the test fails, the server thread may
910
# never notice the stop_event.
916
readable, writable_unused, exception_unused = \
917
select.select([self._socket], [], [], 0.1)
918
if self._stop_event.isSet():
920
if len(readable) == 0:
923
s, addr_unused = self._socket.accept()
924
# because the loopback socket is inline, and transports are
925
# never explicitly closed, best to launch a new thread.
926
threading.Thread(target=self._callback, args=(s,)).start()
927
except socket.error, x:
928
sys.excepthook(*sys.exc_info())
929
warning('Socket error during accept() within unit test server'
932
# probably a failed test; unit test thread will log the
934
sys.excepthook(*sys.exc_info())
935
warning('Exception from within unit test server thread: %r' %
939
class SocketDelay(object):
940
"""A socket decorator to make TCP appear slower.
942
This changes recv, send, and sendall to add a fixed latency to each python
943
call if a new roundtrip is detected. That is, when a recv is called and the
944
flag new_roundtrip is set, latency is charged. Every send and send_all
947
In addition every send, sendall and recv sleeps a bit per character send to
950
Not all methods are implemented, this is deliberate as this class is not a
951
replacement for the builtin sockets layer. fileno is not implemented to
952
prevent the proxy being bypassed.
956
_proxied_arguments = dict.fromkeys([
957
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
958
"setblocking", "setsockopt", "settimeout", "shutdown"])
960
def __init__(self, sock, latency, bandwidth=1.0,
963
:param bandwith: simulated bandwith (MegaBit)
964
:param really_sleep: If set to false, the SocketDelay will just
965
increase a counter, instead of calling time.sleep. This is useful for
966
unittesting the SocketDelay.
969
self.latency = latency
970
self.really_sleep = really_sleep
971
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
972
self.new_roundtrip = False
975
if self.really_sleep:
978
SocketDelay.simulated_time += s
980
def __getattr__(self, attr):
981
if attr in SocketDelay._proxied_arguments:
982
return getattr(self.sock, attr)
983
raise AttributeError("'SocketDelay' object has no attribute %r" %
987
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
990
def recv(self, *args):
991
data = self.sock.recv(*args)
992
if data and self.new_roundtrip:
993
self.new_roundtrip = False
994
self.sleep(self.latency)
995
self.sleep(len(data) * self.time_per_byte)
998
def sendall(self, data, flags=0):
999
if not self.new_roundtrip:
1000
self.new_roundtrip = True
1001
self.sleep(self.latency)
1002
self.sleep(len(data) * self.time_per_byte)
1003
return self.sock.sendall(data, flags)
1005
def send(self, data, flags=0):
1006
if not self.new_roundtrip:
1007
self.new_roundtrip = True
1008
self.sleep(self.latency)
1009
bytes_sent = self.sock.send(data, flags)
1010
self.sleep(bytes_sent * self.time_per_byte)
1014
class SFTPServer(Server):
1015
"""Common code for SFTP server facilities."""
1017
def __init__(self, server_interface=StubServer):
1018
self._original_vendor = None
1019
self._homedir = None
1020
self._server_homedir = None
1021
self._listener = None
1023
self._vendor = ssh.ParamikoVendor()
1024
self._server_interface = server_interface
1027
self.add_latency = 0
1029
def _get_sftp_url(self, path):
1030
"""Calculate an sftp url to this server for path."""
1031
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1033
def log(self, message):
1034
"""StubServer uses this to log when a new server is created."""
1035
self.logs.append(message)
1037
def _run_server_entry(self, sock):
1038
"""Entry point for all implementations of _run_server.
1040
If self.add_latency is > 0.000001 then sock is given a latency adding
1043
if self.add_latency > 0.000001:
1044
sock = SocketDelay(sock, self.add_latency)
1045
return self._run_server(sock)
1047
def _run_server(self, s):
1048
ssh_server = paramiko.Transport(s)
1049
key_file = pathjoin(self._homedir, 'test_rsa.key')
1050
f = open(key_file, 'w')
1051
f.write(STUB_SERVER_KEY)
1053
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1054
ssh_server.add_server_key(host_key)
1055
server = self._server_interface(self)
1056
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1057
StubSFTPServer, root=self._root,
1058
home=self._server_homedir)
1059
event = threading.Event()
1060
ssh_server.start_server(event, server)
1063
def setUp(self, backing_server=None):
1064
# XXX: TODO: make sftpserver back onto backing_server rather than local
1066
if not (backing_server is None or
1067
isinstance(backing_server, local.LocalURLServer)):
1068
raise AssertionError(
1069
"backing_server should not be %r, because this can only serve the "
1070
"local current working directory." % (backing_server,))
1071
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1072
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1073
if sys.platform == 'win32':
1074
# Win32 needs to use the UNICODE api
1075
self._homedir = getcwd()
1077
# But Linux SFTP servers should just deal in bytestreams
1078
self._homedir = os.getcwd()
1079
if self._server_homedir is None:
1080
self._server_homedir = self._homedir
1082
if sys.platform == 'win32':
1084
self._listener = SocketListener(self._run_server_entry)
1085
self._listener.setDaemon(True)
1086
self._listener.start()
1089
"""See bzrlib.transport.Server.tearDown."""
1090
self._listener.stop()
1091
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1093
def get_bogus_url(self):
1094
"""See bzrlib.transport.Server.get_bogus_url."""
1095
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1096
# we bind a random socket, so that we get a guaranteed unused port
1097
# we just never listen on that port
1099
s.bind(('localhost', 0))
1100
return 'sftp://%s:%s/' % s.getsockname()
1103
class SFTPFullAbsoluteServer(SFTPServer):
1104
"""A test server for sftp transports, using absolute urls and ssh."""
1107
"""See bzrlib.transport.Server.get_url."""
1108
homedir = self._homedir
1109
if sys.platform != 'win32':
1110
# Remove the initial '/' on all platforms but win32
1111
homedir = homedir[1:]
1112
return self._get_sftp_url(urlutils.escape(homedir))
1115
class SFTPServerWithoutSSH(SFTPServer):
1116
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1119
super(SFTPServerWithoutSSH, self).__init__()
1120
self._vendor = ssh.LoopbackVendor()
1122
def _run_server(self, sock):
1123
# Re-import these as locals, so that they're still accessible during
1124
# interpreter shutdown (when all module globals get set to None, leading
1125
# to confusing errors like "'NoneType' object has no attribute 'error'".
1126
class FakeChannel(object):
1127
def get_transport(self):
1129
def get_log_channel(self):
1133
def get_hexdump(self):
1138
server = paramiko.SFTPServer(
1139
FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1140
root=self._root, home=self._server_homedir)
1142
server.start_subsystem(
1143
'sftp', None, ssh.SocketAsChannelAdapter(sock))
1144
except socket.error, e:
1145
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1146
# it's okay for the client to disconnect abruptly
1147
# (bug in paramiko 1.6: it should absorb this exception)
1151
except Exception, e:
1152
# This typically seems to happen during interpreter shutdown, so
1153
# most of the useful ways to report this error are won't work.
1154
# Writing the exception type, and then the text of the exception,
1155
# seems to be the best we can do.
1157
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1158
sys.stderr.write('%s\n\n' % (e,))
1159
server.finish_subsystem()
1162
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1163
"""A test server for sftp transports, using absolute urls."""
1166
"""See bzrlib.transport.Server.get_url."""
1167
homedir = self._homedir
1168
if sys.platform != 'win32':
1169
# Remove the initial '/' on all platforms but win32
1170
homedir = homedir[1:]
1171
return self._get_sftp_url(urlutils.escape(homedir))
1174
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1175
"""A test server for sftp transports, using homedir relative urls."""
1178
"""See bzrlib.transport.Server.get_url."""
1179
return self._get_sftp_url("~/")
1182
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1183
"""A test server for sftp transports where only absolute paths will work.
1185
It does this by serving from a deeply-nested directory that doesn't exist.
1188
def setUp(self, backing_server=None):
1189
self._server_homedir = '/dev/noone/runs/tests/here'
1190
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
908
1193
def get_test_permutations():
909
1194
"""Return the permutations to be used in testing."""
910
from bzrlib.tests import stub_sftp
911
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
912
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
913
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
1195
return [(SFTPTransport, SFTPAbsoluteServer),
1196
(SFTPTransport, SFTPHomeDirServer),
1197
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
