/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/transport_util.py

  • Committer: Martin Pool
  • Date: 2007-10-03 08:06:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2901.
  • Revision ID: mbp@sourcefrog.net-20071003080644-oivy0gkg98sex0ed
Avoid internal error tracebacks on failure to lock on readonly transport (#129701).

Add new LockFailed, which doesn't imply that we failed to get it because of
contention.  Raise this if we fail to create the pending or lock directories
because of Transport errors.

UnlockableTransport is not an internal error.

ReadOnlyLockError has a message which didn't match its name or usage; it's now
deprecated and callers are updated to use LockFailed which is more appropriate.

Add zero_ninetytwo deprecation symbol.

Unify assertMatchesRe with TestCase.assertContainsRe.

When the constructor is deprecated, just say that the class is deprecated, not
the __init__ method - this works better with applyDeprecated in tests.

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
        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
 
 
95
class TestCaseWithConnectionHookedTransport(_backing_test_class):
 
96
 
 
97
    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
        super(TestCaseWithConnectionHookedTransport, self).setUp()
 
107
        self.reset_connections()
 
108
 
 
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
    def install_hooks(self):
 
118
        ConnectionHookedTransport.hooks.install_hook('_set_connection',
 
119
                                                     self.set_connection_hook)
 
120
        # uninstall our hooks when we are finished
 
121
        self.addCleanup(self.reset_hooks)
 
122
 
 
123
    def reset_hooks(self):
 
124
        InstrumentedTransport.hooks = TransportHooks()
 
125
 
 
126
    def reset_connections(self):
 
127
        self.connections = []
 
128
 
 
129
    def set_connection_hook(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