← 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: Canonical.com Patch Queue Manager
  • Date: 2009-02-18 13:27:08 UTC
  • mfrom: (4011.4.3 ssh-hints)
  • Revision ID: pqm@pqm.ubuntu.com-20090218132708-okubrahz9exvae9r
(Jelmer) Point out bzr+ssh:// to the user when they use ssh://.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/transport_util.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
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
 
 
34
from bzrlib.transport import (
 
35
    ConnectedTransport,
 
36
    register_transport,
 
37
    register_urlparse_netloc_protocol,
 
38
    unregister_transport,
 
39
    _unregister_urlparse_netloc_protocol,
 
40
    )
 
41
 
 
42
 
 
43
 
 
44
class TransportHooks(bzrlib.hooks.Hooks):
 
45
    """Dict-mapping hook name to a list of callables for transport hooks"""
 
46
 
 
47
    def __init__(self):
 
48
        super(TransportHooks, self).__init__()
 
49
        # Invoked when the transport has just created a new connection.
 
50
        # The api signature is (transport, connection, credentials)
 
51
        self['_set_connection'] = []
 
52
 
 
53
_hooked_scheme = 'hooked'
 
54
 
 
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):
 
63
    """Instrumented transport class to test commands behavior"""
 
64
 
 
65
    hooks = TransportHooks()
 
66
 
 
67
    def __init__(self, base, _from_transport=None):
 
68
        if not base.startswith(_hooked_scheme + '://'):
 
69
            raise ValueError(base)
 
70
        # We need to trick the backing transport class about the scheme used
 
71
        # We'll do the reverse when we need to talk to the backing server
 
72
        fake_base = _change_scheme_in(base, _hooked_scheme, _backing_scheme)
 
73
        super(InstrumentedTransport, self).__init__(
 
74
            fake_base, _from_transport=_from_transport)
 
75
        # The following is needed to minimize the effects of our trick above
 
76
        # while retaining the best compatibility.
 
77
        self._scheme = _hooked_scheme
 
78
        base = self._unsplit_url(self._scheme,
 
79
                                 self._user, self._password,
 
80
                                 self._host, self._port,
 
81
                                 self._path)
 
82
        super(ConnectedTransport, self).__init__(base)
 
83
 
 
84
 
 
85
class ConnectionHookedTransport(InstrumentedTransport):
 
86
    """Transport instrumented to inspect connections"""
 
87
 
 
88
    def _set_connection(self, connection, credentials):
 
89
        """Called when a new connection is created """
 
90
        super(ConnectionHookedTransport, self)._set_connection(connection,
 
91
                                                               credentials)
 
92
        for hook in self.hooks['_set_connection']:
 
93
            hook(self, connection, credentials)
 
94
 
 
95
 
 
96
class TestCaseWithConnectionHookedTransport(_backing_test_class):
 
97
 
 
98
    def setUp(self):
 
99
        register_urlparse_netloc_protocol(_hooked_scheme)
 
100
        register_transport(_hooked_scheme, ConnectionHookedTransport)
 
101
 
 
102
        def unregister():
 
103
            unregister_transport(_hooked_scheme, ConnectionHookedTransport)
 
104
            _unregister_urlparse_netloc_protocol(_hooked_scheme)
 
105
 
 
106
        self.addCleanup(unregister)
 
107
        super(TestCaseWithConnectionHookedTransport, self).setUp()
 
108
        self.reset_connections()
 
109
 
 
110
    def get_url(self, relpath=None):
 
111
        super_self = super(TestCaseWithConnectionHookedTransport, self)
 
112
        url = super_self.get_url(relpath)
 
113
        # Replace the backing scheme by our own (see
 
114
        # InstrumentedTransport.__init__)
 
115
        url = _change_scheme_in(url, _backing_scheme, _hooked_scheme)
 
116
        return url
 
117
 
 
118
    def start_logging_connections(self):
 
119
        ConnectionHookedTransport.hooks.install_named_hook(
 
120
            '_set_connection', self._collect_connection, None)
 
121
        # uninstall our hooks when we are finished
 
122
        self.addCleanup(self.reset_hooks)
 
123
 
 
124
    def reset_hooks(self):
 
125
        InstrumentedTransport.hooks = TransportHooks()
 
126
 
 
127
    def reset_connections(self):
 
128
        self.connections = []
 
129
 
 
130
    def _collect_connection(self, transport, connection, credentials):
 
131
        # Note: uncomment the following line and use 'bt' under pdb, that will
 
132
        # identify all the connections made including the extraneous ones.
 
133
        # import pdb; pdb.set_trace()
 
134
        self.connections.append(connection)
 
135