881
# ------------- server test implementation --------------
884
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
886
STUB_SERVER_KEY = """
887
-----BEGIN RSA PRIVATE KEY-----
888
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
889
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
890
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
891
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
892
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
893
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
894
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
895
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
896
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
897
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
898
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
899
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
900
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
901
-----END RSA PRIVATE KEY-----
905
class SocketListener(threading.Thread):
907
def __init__(self, callback):
908
threading.Thread.__init__(self)
909
self._callback = callback
910
self._socket = socket.socket()
911
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
912
self._socket.bind(('localhost', 0))
913
self._socket.listen(1)
914
self.port = self._socket.getsockname()[1]
915
self._stop_event = threading.Event()
918
# called from outside this thread
919
self._stop_event.set()
920
# use a timeout here, because if the test fails, the server thread may
921
# never notice the stop_event.
927
readable, writable_unused, exception_unused = \
928
select.select([self._socket], [], [], 0.1)
929
if self._stop_event.isSet():
931
if len(readable) == 0:
934
s, addr_unused = self._socket.accept()
935
# because the loopback socket is inline, and transports are
936
# never explicitly closed, best to launch a new thread.
937
threading.Thread(target=self._callback, args=(s,)).start()
938
except socket.error, x:
939
sys.excepthook(*sys.exc_info())
940
warning('Socket error during accept() within unit test server'
943
# probably a failed test; unit test thread will log the
945
sys.excepthook(*sys.exc_info())
946
warning('Exception from within unit test server thread: %r' %
950
class SocketDelay(object):
951
"""A socket decorator to make TCP appear slower.
953
This changes recv, send, and sendall to add a fixed latency to each python
954
call if a new roundtrip is detected. That is, when a recv is called and the
955
flag new_roundtrip is set, latency is charged. Every send and send_all
958
In addition every send, sendall and recv sleeps a bit per character send to
961
Not all methods are implemented, this is deliberate as this class is not a
962
replacement for the builtin sockets layer. fileno is not implemented to
963
prevent the proxy being bypassed.
967
_proxied_arguments = dict.fromkeys([
968
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
969
"setblocking", "setsockopt", "settimeout", "shutdown"])
971
def __init__(self, sock, latency, bandwidth=1.0,
974
:param bandwith: simulated bandwith (MegaBit)
975
:param really_sleep: If set to false, the SocketDelay will just
976
increase a counter, instead of calling time.sleep. This is useful for
977
unittesting the SocketDelay.
980
self.latency = latency
981
self.really_sleep = really_sleep
982
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
983
self.new_roundtrip = False
986
if self.really_sleep:
989
SocketDelay.simulated_time += s
991
def __getattr__(self, attr):
992
if attr in SocketDelay._proxied_arguments:
993
return getattr(self.sock, attr)
994
raise AttributeError("'SocketDelay' object has no attribute %r" %
998
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
1001
def recv(self, *args):
1002
data = self.sock.recv(*args)
1003
if data and self.new_roundtrip:
1004
self.new_roundtrip = False
1005
self.sleep(self.latency)
1006
self.sleep(len(data) * self.time_per_byte)
1009
def sendall(self, data, flags=0):
1010
if not self.new_roundtrip:
1011
self.new_roundtrip = True
1012
self.sleep(self.latency)
1013
self.sleep(len(data) * self.time_per_byte)
1014
return self.sock.sendall(data, flags)
1016
def send(self, data, flags=0):
1017
if not self.new_roundtrip:
1018
self.new_roundtrip = True
1019
self.sleep(self.latency)
1020
bytes_sent = self.sock.send(data, flags)
1021
self.sleep(bytes_sent * self.time_per_byte)
1025
class SFTPServer(Server):
1026
"""Common code for SFTP server facilities."""
1028
def __init__(self, server_interface=StubServer):
1029
self._original_vendor = None
1030
self._homedir = None
1031
self._server_homedir = None
1032
self._listener = None
1034
self._vendor = ssh.ParamikoVendor()
1035
self._server_interface = server_interface
1038
self.add_latency = 0
1040
def _get_sftp_url(self, path):
1041
"""Calculate an sftp url to this server for path."""
1042
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1044
def log(self, message):
1045
"""StubServer uses this to log when a new server is created."""
1046
self.logs.append(message)
1048
def _run_server_entry(self, sock):
1049
"""Entry point for all implementations of _run_server.
1051
If self.add_latency is > 0.000001 then sock is given a latency adding
1054
if self.add_latency > 0.000001:
1055
sock = SocketDelay(sock, self.add_latency)
1056
return self._run_server(sock)
1058
def _run_server(self, s):
1059
ssh_server = paramiko.Transport(s)
1060
key_file = pathjoin(self._homedir, 'test_rsa.key')
1061
f = open(key_file, 'w')
1062
f.write(STUB_SERVER_KEY)
1064
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1065
ssh_server.add_server_key(host_key)
1066
server = self._server_interface(self)
1067
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1068
StubSFTPServer, root=self._root,
1069
home=self._server_homedir)
1070
event = threading.Event()
1071
ssh_server.start_server(event, server)
1074
def setUp(self, backing_server=None):
1075
# XXX: TODO: make sftpserver back onto backing_server rather than local
1077
if not (backing_server is None or
1078
isinstance(backing_server, local.LocalURLServer)):
1079
raise AssertionError(
1080
"backing_server should not be %r, because this can only serve the "
1081
"local current working directory." % (backing_server,))
1082
self._original_vendor = ssh._ssh_vendor_manager._cached_ssh_vendor
1083
ssh._ssh_vendor_manager._cached_ssh_vendor = self._vendor
1084
if sys.platform == 'win32':
1085
# Win32 needs to use the UNICODE api
1086
self._homedir = getcwd()
1088
# But Linux SFTP servers should just deal in bytestreams
1089
self._homedir = os.getcwd()
1090
if self._server_homedir is None:
1091
self._server_homedir = self._homedir
1093
if sys.platform == 'win32':
1095
self._listener = SocketListener(self._run_server_entry)
1096
self._listener.setDaemon(True)
1097
self._listener.start()
1100
"""See bzrlib.transport.Server.tearDown."""
1101
self._listener.stop()
1102
ssh._ssh_vendor_manager._cached_ssh_vendor = self._original_vendor
1104
def get_bogus_url(self):
1105
"""See bzrlib.transport.Server.get_bogus_url."""
1106
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1107
# we bind a random socket, so that we get a guaranteed unused port
1108
# we just never listen on that port
1110
s.bind(('localhost', 0))
1111
return 'sftp://%s:%s/' % s.getsockname()
1114
class SFTPFullAbsoluteServer(SFTPServer):
1115
"""A test server for sftp transports, using absolute urls and ssh."""
1118
"""See bzrlib.transport.Server.get_url."""
1119
homedir = self._homedir
1120
if sys.platform != 'win32':
1121
# Remove the initial '/' on all platforms but win32
1122
homedir = homedir[1:]
1123
return self._get_sftp_url(urlutils.escape(homedir))
1126
class SFTPServerWithoutSSH(SFTPServer):
1127
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1130
super(SFTPServerWithoutSSH, self).__init__()
1131
self._vendor = ssh.LoopbackVendor()
1133
def _run_server(self, sock):
1134
# Re-import these as locals, so that they're still accessible during
1135
# interpreter shutdown (when all module globals get set to None, leading
1136
# to confusing errors like "'NoneType' object has no attribute 'error'".
1137
class FakeChannel(object):
1138
def get_transport(self):
1140
def get_log_channel(self):
1144
def get_hexdump(self):
1149
server = paramiko.SFTPServer(
1150
FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1151
root=self._root, home=self._server_homedir)
1153
server.start_subsystem(
1154
'sftp', None, ssh.SocketAsChannelAdapter(sock))
1155
except socket.error, e:
1156
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1157
# it's okay for the client to disconnect abruptly
1158
# (bug in paramiko 1.6: it should absorb this exception)
1162
except Exception, e:
1163
# This typically seems to happen during interpreter shutdown, so
1164
# most of the useful ways to report this error are won't work.
1165
# Writing the exception type, and then the text of the exception,
1166
# seems to be the best we can do.
1168
sys.stderr.write('\nEXCEPTION %r: ' % (e.__class__,))
1169
sys.stderr.write('%s\n\n' % (e,))
1170
server.finish_subsystem()
1173
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1174
"""A test server for sftp transports, using absolute urls."""
1177
"""See bzrlib.transport.Server.get_url."""
1178
homedir = self._homedir
1179
if sys.platform != 'win32':
1180
# Remove the initial '/' on all platforms but win32
1181
homedir = homedir[1:]
1182
return self._get_sftp_url(urlutils.escape(homedir))
1185
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1186
"""A test server for sftp transports, using homedir relative urls."""
1189
"""See bzrlib.transport.Server.get_url."""
1190
return self._get_sftp_url("~/")
1193
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1194
"""A test server for sftp transports where only absolute paths will work.
1196
It does this by serving from a deeply-nested directory that doesn't exist.
1199
def setUp(self, backing_server=None):
1200
self._server_homedir = '/dev/noone/runs/tests/here'
1201
super(SFTPSiblingAbsoluteServer, self).setUp(backing_server)
1204
908
def get_test_permutations():
1205
909
"""Return the permutations to be used in testing."""
1206
return [(SFTPTransport, SFTPAbsoluteServer),
1207
(SFTPTransport, SFTPHomeDirServer),
1208
(SFTPTransport, SFTPSiblingAbsoluteServer),
910
from bzrlib.tests import stub_sftp
911
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
912
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
913
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
