← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/transport_util.py

  • Committer: Ian Clatworthy
  • Date: 2009-12-03 23:21:16 UTC
  • mfrom: (4852.4.1 RCStoVCS)
  • mto: This revision was merged to the branch mainline in revision 4860.
  • Revision ID: ian.clatworthy@canonical.com-20091203232116-f8igfvc6muqrn4yx
Revision Control -> Version Control in docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/transport_util.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
 
from bzrlib.tests import features
 
17
import bzrlib.hooks
18
18
 
19
19
# SFTPTransport offers better performances but relies on paramiko, if paramiko
20
20
# is not available, we fallback to FtpTransport
21
 
if features.paramiko.available():
22
 
    from bzrlib.tests import test_sftp_transport
23
 
    from bzrlib.transport import sftp, Transport
 
21
from bzrlib.tests import test_sftp_transport
 
22
if test_sftp_transport.paramiko_loaded:
 
23
    from bzrlib.transport import sftp
24
24
    _backing_scheme = 'sftp'
25
25
    _backing_transport_class = sftp.SFTPTransport
26
26
    _backing_test_class = test_sftp_transport.TestCaseWithSFTPServer
27
27
else:
28
 
    from bzrlib.transport import ftp, Transport
 
28
    from bzrlib.transport import ftp
29
29
    from bzrlib.tests import test_ftp_transport
30
30
    _backing_scheme = 'ftp'
31
31
    _backing_transport_class = ftp.FtpTransport
32
32
    _backing_test_class = test_ftp_transport.TestCaseWithFTPServer
33
33
 
 
34
from bzrlib.transport import (
 
35
    ConnectedTransport,
 
36
    get_transport,
 
37
    register_transport,
 
38
    register_urlparse_netloc_protocol,
 
39
    unregister_transport,
 
40
    _unregister_urlparse_netloc_protocol,
 
41
    )
 
42
 
 
43
 
 
44
 
 
45
class TransportHooks(bzrlib.hooks.Hooks):
 
46
    """Dict-mapping hook name to a list of callables for transport hooks"""
 
47
 
 
48
    def __init__(self):
 
49
        super(TransportHooks, self).__init__()
 
50
        # Invoked when the transport has just created a new connection.
 
51
        # The api signature is (transport, connection, credentials)
 
52
        self['_set_connection'] = []
 
53
 
 
54
_hooked_scheme = 'hooked'
 
55
 
 
56
def _change_scheme_in(url, actual, desired):
 
57
    if not url.startswith(actual + '://'):
 
58
        raise AssertionError('url "%r" does not start with "%r]"'
 
59
                             % (url, actual))
 
60
    return desired + url[len(actual):]
 
61
 
 
62
 
 
63
class InstrumentedTransport(_backing_transport_class):
 
64
    """Instrumented transport class to test commands behavior"""
 
65
 
 
66
    hooks = TransportHooks()
 
67
 
 
68
    def __init__(self, base, _from_transport=None):
 
69
        if not base.startswith(_hooked_scheme + '://'):
 
70
            raise ValueError(base)
 
71
        # We need to trick the backing transport class about the scheme used
 
72
        # We'll do the reverse when we need to talk to the backing server
 
73
        fake_base = _change_scheme_in(base, _hooked_scheme, _backing_scheme)
 
74
        super(InstrumentedTransport, self).__init__(
 
75
            fake_base, _from_transport=_from_transport)
 
76
        # The following is needed to minimize the effects of our trick above
 
77
        # while retaining the best compatibility.
 
78
        self._scheme = _hooked_scheme
 
79
        base = self._unsplit_url(self._scheme,
 
80
                                 self._user, self._password,
 
81
                                 self._host, self._port,
 
82
                                 self._path)
 
83
        super(ConnectedTransport, self).__init__(base)
 
84
 
 
85
 
 
86
class ConnectionHookedTransport(InstrumentedTransport):
 
87
    """Transport instrumented to inspect connections"""
 
88
 
 
89
    def _set_connection(self, connection, credentials):
 
90
        """Called when a new connection is created """
 
91
        super(ConnectionHookedTransport, self)._set_connection(connection,
 
92
                                                               credentials)
 
93
        for hook in self.hooks['_set_connection']:
 
94
            hook(self, connection, credentials)
 
95
 
34
96
 
35
97
class TestCaseWithConnectionHookedTransport(_backing_test_class):
36
98
 
37
99
    def setUp(self):
 
100
        register_urlparse_netloc_protocol(_hooked_scheme)
 
101
        register_transport(_hooked_scheme, ConnectionHookedTransport)
 
102
 
 
103
        def unregister():
 
104
            unregister_transport(_hooked_scheme, ConnectionHookedTransport)
 
105
            _unregister_urlparse_netloc_protocol(_hooked_scheme)
 
106
 
 
107
        self.addCleanup(unregister)
38
108
        super(TestCaseWithConnectionHookedTransport, self).setUp()
39
109
        self.reset_connections()
 
110
        # Add the 'hooked' url to the permitted url list.
 
111
        # XXX: See TestCase.start_server. This whole module shouldn't need to
 
112
        # exist - a bug has been filed on that. once its cleanedup/removed, the
 
113
        # standard test support code will work and permit the server url
 
114
        # correctly.
 
115
        url = self.get_url()
 
116
        t = get_transport(url)
 
117
        if t.base.endswith('work/'):
 
118
            t = t.clone('../..')
 
119
        self.permit_url(t.base)
 
120
 
 
121
    def get_url(self, relpath=None):
 
122
        super_self = super(TestCaseWithConnectionHookedTransport, self)
 
123
        url = super_self.get_url(relpath)
 
124
        # Replace the backing scheme by our own (see
 
125
        # InstrumentedTransport.__init__)
 
126
        url = _change_scheme_in(url, _backing_scheme, _hooked_scheme)
 
127
        return url
40
128
 
41
129
    def start_logging_connections(self):
42
 
        Transport.hooks.install_named_hook('post_connect',
43
 
            self.connections.append, None)
 
130
        ConnectionHookedTransport.hooks.install_named_hook(
 
131
            '_set_connection', self._collect_connection, None)
 
132
        # uninstall our hooks when we are finished
 
133
        self.addCleanup(self.reset_hooks)
 
134
 
 
135
    def reset_hooks(self):
 
136
        InstrumentedTransport.hooks = TransportHooks()
44
137
 
45
138
    def reset_connections(self):
46
139
        self.connections = []
47
140
 
 
141
    def _collect_connection(self, transport, connection, credentials):
 
142
        # Note: uncomment the following line and use 'bt' under pdb, that will
 
143
        # identify all the connections made including the extraneous ones.
 
144
        # import pdb; pdb.set_trace()
 
145
        self.connections.append(connection)
 
146