14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from bzrlib import transport
17
19
from bzrlib.tests import features
19
21
# SFTPTransport offers better performances but relies on paramiko, if paramiko
20
22
# is not available, we fallback to FtpTransport
21
23
if features.paramiko.available():
22
24
from bzrlib.tests import test_sftp_transport
23
from bzrlib.transport import sftp, Transport
25
from bzrlib.transport import sftp
24
26
_backing_scheme = 'sftp'
25
27
_backing_transport_class = sftp.SFTPTransport
26
28
_backing_test_class = test_sftp_transport.TestCaseWithSFTPServer
28
from bzrlib.transport import ftp, Transport
30
from bzrlib.transport import ftp
29
31
from bzrlib.tests import test_ftp_transport
30
32
_backing_scheme = 'ftp'
31
33
_backing_transport_class = ftp.FtpTransport
32
34
_backing_test_class = test_ftp_transport.TestCaseWithFTPServer
36
from bzrlib.transport import (
39
register_urlparse_netloc_protocol,
41
_unregister_urlparse_netloc_protocol,
46
class TransportHooks(bzrlib.hooks.Hooks):
47
"""Dict-mapping hook name to a list of callables for transport hooks"""
50
super(TransportHooks, self).__init__("bzrlib.tests.transport_util",
51
"InstrumentedTransport.hooks")
52
# Invoked when the transport has just created a new connection.
53
# The api signature is (transport, connection, credentials)
54
self['_set_connection'] = []
56
_hooked_scheme = 'hooked'
58
def _change_scheme_in(url, actual, desired):
59
if not url.startswith(actual + '://'):
60
raise AssertionError('url "%r" does not start with "%r]"'
62
return desired + url[len(actual):]
65
class InstrumentedTransport(_backing_transport_class):
66
"""Instrumented transport class to test commands behavior"""
68
hooks = TransportHooks()
70
def __init__(self, base, _from_transport=None):
71
if not base.startswith(_hooked_scheme + '://'):
72
raise ValueError(base)
73
# We need to trick the backing transport class about the scheme used
74
# We'll do the reverse when we need to talk to the backing server
75
fake_base = _change_scheme_in(base, _hooked_scheme, _backing_scheme)
76
super(InstrumentedTransport, self).__init__(
77
fake_base, _from_transport=_from_transport)
78
# The following is needed to minimize the effects of our trick above
79
# while retaining the best compatibility.
80
self._parsed_url.scheme = _hooked_scheme
81
super(ConnectedTransport, self).__init__(str(self._parsed_url))
84
class ConnectionHookedTransport(InstrumentedTransport):
85
"""Transport instrumented to inspect connections"""
87
def _set_connection(self, connection, credentials):
88
"""Called when a new connection is created """
89
super(ConnectionHookedTransport, self)._set_connection(connection,
91
for hook in self.hooks['_set_connection']:
92
hook(self, connection, credentials)
35
95
class TestCaseWithConnectionHookedTransport(_backing_test_class):
98
register_urlparse_netloc_protocol(_hooked_scheme)
99
register_transport(_hooked_scheme, ConnectionHookedTransport)
100
self.addCleanup(unregister_transport, _hooked_scheme,
101
ConnectionHookedTransport)
102
self.addCleanup(_unregister_urlparse_netloc_protocol, _hooked_scheme)
38
103
super(TestCaseWithConnectionHookedTransport, self).setUp()
39
104
self.reset_connections()
105
# Add the 'hooked' url to the permitted url list.
106
# XXX: See TestCase.start_server. This whole module shouldn't need to
107
# exist - a bug has been filed on that. once its cleanedup/removed, the
108
# standard test support code will work and permit the server url
111
t = transport.get_transport_from_url(url)
112
if t.base.endswith('work/'):
114
self.permit_url(t.base)
116
def get_url(self, relpath=None):
117
super_self = super(TestCaseWithConnectionHookedTransport, self)
118
url = super_self.get_url(relpath)
119
# Replace the backing scheme by our own (see
120
# InstrumentedTransport.__init__)
121
url = _change_scheme_in(url, _backing_scheme, _hooked_scheme)
41
124
def start_logging_connections(self):
42
Transport.hooks.install_named_hook('post_connect',
43
self.connections.append, None)
125
self.overrideAttr(InstrumentedTransport, 'hooks', TransportHooks())
126
# We preserved the hooks class attribute. Now we install our hook.
127
ConnectionHookedTransport.hooks.install_named_hook(
128
'_set_connection', self._collect_connection, None)
45
130
def reset_connections(self):
46
131
self.connections = []
133
def _collect_connection(self, transport, connection, credentials):
134
# Note: uncomment the following line and use 'bt' under pdb, that will
135
# identify all the connections made including the extraneous ones.
136
# import pdb; pdb.set_trace()
137
self.connections.append(connection)
added
removed
bzrlib/tests/transport_util.py
