← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/transport_util.py

Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/transport_util.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from bzrlib.hooks import Hooks
18
 
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
 
17
import bzrlib.hooks
 
18
 
 
19
# SFTPTransport offers better performances but relies on paramiko, if paramiko
 
20
# is not available, we fallback to FtpTransport
 
21
from bzrlib.tests import test_sftp_transport
 
22
if test_sftp_transport.paramiko_loaded:
 
23
    from bzrlib.transport import sftp
 
24
    _backing_scheme = 'sftp'
 
25
    _backing_transport_class = sftp.SFTPTransport
 
26
    _backing_test_class = test_sftp_transport.TestCaseWithSFTPServer
 
27
else:
 
28
    from bzrlib.transport import ftp
 
29
    from bzrlib.tests import test_ftp_transport
 
30
    _backing_scheme = 'ftp'
 
31
    _backing_transport_class = ftp.FtpTransport
 
32
    _backing_test_class = test_ftp_transport.TestCaseWithFTPServer
 
33
 
19
34
from bzrlib.transport import (
 
35
    ConnectedTransport,
20
36
    register_transport,
21
37
    register_urlparse_netloc_protocol,
22
38
    unregister_transport,
23
39
    _unregister_urlparse_netloc_protocol,
24
40
    )
25
 
from bzrlib.transport.sftp import SFTPTransport
26
 
 
27
 
 
28
 
class TransportHooks(Hooks):
 
41
 
 
42
 
 
43
 
 
44
class TransportHooks(bzrlib.hooks.Hooks):
29
45
    """Dict-mapping hook name to a list of callables for transport hooks"""
30
46
 
31
47
    def __init__(self):
32
 
        Hooks.__init__(self)
 
48
        super(TransportHooks, self).__init__()
33
49
        # Invoked when the transport has just created a new connection.
34
50
        # The api signature is (transport, connection, credentials)
35
51
        self['_set_connection'] = []
36
52
 
37
53
_hooked_scheme = 'hooked'
38
54
 
39
 
class InstrumentedTransport(SFTPTransport):
 
55
def _change_scheme_in(url, actual, desired):
 
56
    if not url.startswith(actual + '://'):
 
57
        raise AssertionError('url "%r" does not start with "%r]"'
 
58
                             % (url, actual))
 
59
    return desired + url[len(actual):]
 
60
 
 
61
 
 
62
class InstrumentedTransport(_backing_transport_class):
40
63
    """Instrumented transport class to test commands behavior"""
41
64
 
42
65
    hooks = TransportHooks()
43
66
 
44
67
    def __init__(self, base, _from_transport=None):
45
68
        assert base.startswith(_hooked_scheme + '://')
46
 
        # Avoid SFTPTransport assertion since we use a dedicated scheme
47
 
        super(SFTPTransport, self).__init__(base,
48
 
                                            _from_transport=_from_transport)
 
69
        # We need to trick the backing transport class about the scheme used
 
70
        # We'll do the reverse when we need to talk to the backing server
 
71
        fake_base = _change_scheme_in(base, _hooked_scheme, _backing_scheme)
 
72
        super(InstrumentedTransport, self).__init__(
 
73
            fake_base, _from_transport=_from_transport)
 
74
        # The following is needed to minimize the effects of our trick above
 
75
        # while retaining the best compatibility.
 
76
        self._scheme = _hooked_scheme
 
77
        base = self._unsplit_url(self._scheme,
 
78
                                 self._user, self._password,
 
79
                                 self._host, self._port,
 
80
                                 self._path)
 
81
        super(ConnectedTransport, self).__init__(base)
49
82
 
50
83
 
51
84
class ConnectionHookedTransport(InstrumentedTransport):
59
92
            hook(self, connection, credentials)
60
93
 
61
94
 
62
 
class TestCaseWithConnectionHookedTransport(TestCaseWithSFTPServer):
 
95
class TestCaseWithConnectionHookedTransport(_backing_test_class):
63
96
 
64
97
    def setUp(self):
65
98
        register_urlparse_netloc_protocol(_hooked_scheme)
76
109
    def get_url(self, relpath=None):
77
110
        super_self = super(TestCaseWithConnectionHookedTransport, self)
78
111
        url = super_self.get_url(relpath)
79
 
        # Replace the sftp scheme by our own
80
 
        url = _hooked_scheme + url[len('sftp'):]
 
112
        # Replace the backing scheme by our own (see
 
113
        # InstrumentedTransport.__init__)
 
114
        url = _change_scheme_in(url, _backing_scheme, _hooked_scheme)
81
115
        return url
82
116
 
83
 
    def install_hooks(self):
 
117
    def start_logging_connections(self):
84
118
        ConnectionHookedTransport.hooks.install_hook('_set_connection',
85
 
                                                     self.set_connection_hook)
 
119
                                                     self._collect_connection)
86
120
        # uninstall our hooks when we are finished
87
121
        self.addCleanup(self.reset_hooks)
88
122
 
92
126
    def reset_connections(self):
93
127
        self.connections = []
94
128
 
95
 
    def set_connection_hook(self, transport, connection, credentials):
 
129
    def _collect_connection(self, transport, connection, credentials):
96
130
        # Note: uncomment the following line and use 'bt' under pdb, that will
97
131
        # identify all the connections made including the extraneous ones.
98
132
        # import pdb; pdb.set_trace()