~bzr-pqm/bzr/bzr.dev

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Copyright (C) 2007 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


from bzrlib.hooks import Hooks
from bzrlib.tests.test_ftp_transport import TestCaseWithFTPServer
from bzrlib.transport import (
    register_transport,
    unregister_transport,
    )
from bzrlib.transport.ftp import FtpTransport


class TransportHooks(Hooks):
    """Dict-mapping hook name to a list of callables for transport hooks"""

    def __init__(self):
        Hooks.__init__(self)
        # invoked when the transport is about to create or reuse
        # an ftp connection. The api signature is (transport, ftp_instance)
        self['get_FTP'] = []


class InstrumentedTransport(FtpTransport):
    """Instrumented transport class to test commands behavior"""

    hooks = TransportHooks()


class ConnectionHookedTransport(InstrumentedTransport):
    """Transport instrumented to inspect connections"""

    def _get_FTP(self):
        """See FtpTransport._get_FTP.

        This is where we can detect if the connection is reused
        or if a new one is created. This a bit ugly, but it's the
        easiest until transport classes are refactored.
        """
        instance = super(ConnectionHookedTransport, self)._get_FTP()
        for hook in self.hooks['get_FTP']:
            hook(self, instance)
        return instance


class TestCaseWithConnectionHookedTransport(TestCaseWithFTPServer):

    def setUp(self):
        super(TestCaseWithConnectionHookedTransport, self).setUp()
        ConnectionHookedTransport.hooks.install_hook('get_FTP',
                                                     self.get_connection_hook)
        # Make our instrumented transport the default ftp transport
        register_transport('ftp://', ConnectionHookedTransport)

        def cleanup():
            InstrumentedTransport.hooks = TransportHooks()
            unregister_transport('ftp://', ConnectionHookedTransport)

        self.addCleanup(cleanup)
        self.connections = []

    def get_connection_hook(self, transport, connection):
        if connection is not None and connection not in self.connections:
            self.connections.append(connection)