~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/transport_util.py

  • Committer: Alexander Belchenko
  • Date: 2007-08-10 09:04:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2694.
  • Revision ID: bialix@ukr.net-20070810090438-0835xdz0rl8825qv
fixes after Ian's review

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
 
 
 
17
from bzrlib.hooks import Hooks
 
18
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
34
19
from bzrlib.transport import (
35
 
    ConnectedTransport,
36
20
    register_transport,
37
21
    register_urlparse_netloc_protocol,
38
22
    unregister_transport,
39
23
    _unregister_urlparse_netloc_protocol,
40
24
    )
41
 
 
42
 
 
43
 
 
44
 
class TransportHooks(bzrlib.hooks.Hooks):
 
25
from bzrlib.transport.sftp import SFTPTransport
 
26
 
 
27
 
 
28
class TransportHooks(Hooks):
45
29
    """Dict-mapping hook name to a list of callables for transport hooks"""
46
30
 
47
31
    def __init__(self):
48
 
        super(TransportHooks, self).__init__()
 
32
        Hooks.__init__(self)
49
33
        # Invoked when the transport has just created a new connection.
50
34
        # The api signature is (transport, connection, credentials)
51
35
        self['_set_connection'] = []
52
36
 
53
37
_hooked_scheme = 'hooked'
54
38
 
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):
 
39
class InstrumentedTransport(SFTPTransport):
63
40
    """Instrumented transport class to test commands behavior"""
64
41
 
65
42
    hooks = TransportHooks()
66
43
 
67
44
    def __init__(self, base, _from_transport=None):
68
45
        assert base.startswith(_hooked_scheme + '://')
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)
 
46
        # Avoid SFTPTransport assertion since we use a dedicated scheme
 
47
        super(SFTPTransport, self).__init__(base,
 
48
                                            _from_transport=_from_transport)
82
49
 
83
50
 
84
51
class ConnectionHookedTransport(InstrumentedTransport):
92
59
            hook(self, connection, credentials)
93
60
 
94
61
 
95
 
class TestCaseWithConnectionHookedTransport(_backing_test_class):
 
62
class TestCaseWithConnectionHookedTransport(TestCaseWithSFTPServer):
96
63
 
97
64
    def setUp(self):
98
65
        register_urlparse_netloc_protocol(_hooked_scheme)
109
76
    def get_url(self, relpath=None):
110
77
        super_self = super(TestCaseWithConnectionHookedTransport, self)
111
78
        url = super_self.get_url(relpath)
112
 
        # Replace the backing scheme by our own (see
113
 
        # InstrumentedTransport.__init__)
114
 
        url = _change_scheme_in(url, _backing_scheme, _hooked_scheme)
 
79
        # Replace the sftp scheme by our own
 
80
        url = _hooked_scheme + url[len('sftp'):]
115
81
        return url
116
82
 
117
 
    def start_logging_connections(self):
 
83
    def install_hooks(self):
118
84
        ConnectionHookedTransport.hooks.install_hook('_set_connection',
119
 
                                                     self._collect_connection)
 
85
                                                     self.set_connection_hook)
120
86
        # uninstall our hooks when we are finished
121
87
        self.addCleanup(self.reset_hooks)
122
88
 
126
92
    def reset_connections(self):
127
93
        self.connections = []
128
94
 
129
 
    def _collect_connection(self, transport, connection, credentials):
 
95
    def set_connection_hook(self, transport, connection, credentials):
130
96
        # Note: uncomment the following line and use 'bt' under pdb, that will
131
97
        # identify all the connections made including the extraneous ones.
132
98
        # import pdb; pdb.set_trace()