← 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: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/transport_util.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
import bzrlib.hooks
 
17
from bzrlib.tests import features
18
18
 
19
19
# SFTPTransport offers better performances but relies on paramiko, if paramiko
20
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
 
21
if features.paramiko.available():
 
22
    from bzrlib.tests import test_sftp_transport
 
23
    from bzrlib.transport import sftp, Transport
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
 
28
    from bzrlib.transport import ftp, Transport
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
 
    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
 
        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)
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
 
 
101
 
        def unregister():
102
 
            unregister_transport(_hooked_scheme, ConnectionHookedTransport)
103
 
            _unregister_urlparse_netloc_protocol(_hooked_scheme)
104
 
 
105
 
        self.addCleanup(unregister)
106
38
        super(TestCaseWithConnectionHookedTransport, self).setUp()
107
39
        self.reset_connections()
108
40
 
109
 
    def get_url(self, relpath=None):
110
 
        super_self = super(TestCaseWithConnectionHookedTransport, self)
111
 
        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)
115
 
        return url
116
 
 
117
41
    def start_logging_connections(self):
118
 
        ConnectionHookedTransport.hooks.install_hook('_set_connection',
119
 
                                                     self._collect_connection)
120
 
        # uninstall our hooks when we are finished
121
 
        self.addCleanup(self.reset_hooks)
122
 
 
123
 
    def reset_hooks(self):
124
 
        InstrumentedTransport.hooks = TransportHooks()
 
42
        Transport.hooks.install_named_hook('post_connect',
 
43
            self.connections.append, None)
125
44
 
126
45
    def reset_connections(self):
127
46
        self.connections = []
128
47
 
129
 
    def _collect_connection(self, transport, connection, credentials):
130
 
        # Note: uncomment the following line and use 'bt' under pdb, that will
131
 
        # identify all the connections made including the extraneous ones.
132
 
        # import pdb; pdb.set_trace()
133
 
        self.connections.append(connection)
134