← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/transport_util.py

(jelmer) Add a post_connect hook for transports. (Bazaar Developers)

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
import bzrlib.hooks
18
 
from bzrlib import transport
19
17
from bzrlib.tests import features
20
18
 
21
19
# SFTPTransport offers better performances but relies on paramiko, if paramiko
22
20
# is not available, we fallback to FtpTransport
23
21
if features.paramiko.available():
24
22
    from bzrlib.tests import test_sftp_transport
25
 
    from bzrlib.transport import sftp
 
23
    from bzrlib.transport import sftp, Transport
26
24
    _backing_scheme = 'sftp'
27
25
    _backing_transport_class = sftp.SFTPTransport
28
26
    _backing_test_class = test_sftp_transport.TestCaseWithSFTPServer
29
27
else:
30
 
    from bzrlib.transport import ftp
 
28
    from bzrlib.transport import ftp, Transport
31
29
    from bzrlib.tests import test_ftp_transport
32
30
    _backing_scheme = 'ftp'
33
31
    _backing_transport_class = ftp.FtpTransport
34
32
    _backing_test_class = test_ftp_transport.TestCaseWithFTPServer
35
33
 
36
 
from bzrlib.transport import (
37
 
    ConnectedTransport,
38
 
    register_transport,
39
 
    register_urlparse_netloc_protocol,
40
 
    unregister_transport,
41
 
    _unregister_urlparse_netloc_protocol,
42
 
    )
43
 
 
44
 
 
45
 
 
46
 
class TransportHooks(bzrlib.hooks.Hooks):
47
 
    """Dict-mapping hook name to a list of callables for transport hooks"""
48
 
 
49
 
    def __init__(self):
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'] = []
55
 
 
56
 
_hooked_scheme = 'hooked'
57
 
 
58
 
def _change_scheme_in(url, actual, desired):
59
 
    if not url.startswith(actual + '://'):
60
 
        raise AssertionError('url "%r" does not start with "%r]"'
61
 
                             % (url, actual))
62
 
    return desired + url[len(actual):]
63
 
 
64
 
 
65
 
class InstrumentedTransport(_backing_transport_class):
66
 
    """Instrumented transport class to test commands behavior"""
67
 
 
68
 
    hooks = TransportHooks()
69
 
 
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))
82
 
 
83
 
 
84
 
class ConnectionHookedTransport(InstrumentedTransport):
85
 
    """Transport instrumented to inspect connections"""
86
 
 
87
 
    def _set_connection(self, connection, credentials):
88
 
        """Called when a new connection is created """
89
 
        super(ConnectionHookedTransport, self)._set_connection(connection,
90
 
                                                               credentials)
91
 
        for hook in self.hooks['_set_connection']:
92
 
            hook(self, connection, credentials)
93
 
 
94
34
 
95
35
class TestCaseWithConnectionHookedTransport(_backing_test_class):
96
36
 
97
37
    def setUp(self):
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)
103
38
        super(TestCaseWithConnectionHookedTransport, self).setUp()
104
39
        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
109
 
        # correctly.
110
 
        url = self.get_url()
111
 
        t = transport.get_transport_from_url(url)
112
 
        if t.base.endswith('work/'):
113
 
            t = t.clone('../..')
114
 
        self.permit_url(t.base)
115
 
 
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)
122
 
        return url
123
40
 
124
41
    def start_logging_connections(self):
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)
 
42
        Transport.hooks.install_named_hook('post_connect',
 
43
            self.connections.append, None)
129
44
 
130
45
    def reset_connections(self):
131
46
        self.connections = []
132
47
 
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)
138