← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/trace.py

  • Committer: Robert Collins
  • Date: 2008-04-06 23:37:06 UTC
  • mto: This revision was merged to the branch mainline in revision 3340.
  • Revision ID: robertc@robertcollins.net-20080406233706-3md3w1c651a0pndm
Fix ReST table formatting in doc/developers/plugin-api.txt.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/trace.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
"""Implementation of Transport that traces transport operations.
 
18
 
 
19
This does not change the transport behaviour at all, merely records every call
 
20
and then delegates it.
 
21
"""
 
22
 
 
23
from bzrlib.transport.decorator import TransportDecorator, DecoratorServer
 
24
 
 
25
 
 
26
class TransportTraceDecorator(TransportDecorator):
 
27
    """A tracing decorator for Transports.
 
28
 
 
29
    Calls that potentially perform IO are logged to self._activity. The
 
30
    _activity attribute is shared as the transport is cloned, but not if a new
 
31
    transport is created without cloning.
 
32
 
 
33
    Not all operations are logged at this point, if you need an unlogged
 
34
    operation please add a test to the tests of this transport, for the logging
 
35
    of the operation you want logged.
 
36
 
 
37
    Another future enhancement would be to log to bzrlib.trace.mutter when
 
38
    trace+ is used from the command line (or perhaps as well/instead use
 
39
    -Dtransport), to make tracing operations of the entire program easily.
 
40
    """
 
41
 
 
42
    def __init__(self, url, _decorated=None, _from_transport=None):
 
43
        """Set the 'base' path where files will be stored.
 
44
        
 
45
        _decorated is a private parameter for cloning.
 
46
        """
 
47
        TransportDecorator.__init__(self, url, _decorated)
 
48
        if _from_transport is None:
 
49
            # newly created
 
50
            self._activity = []
 
51
        else:
 
52
            # cloned
 
53
            self._activity = _from_transport._activity
 
54
 
 
55
    def append_file(self, relpath, f, mode=None):
 
56
        """See Transport.append_file()."""
 
57
        return self._decorated.append_file(relpath, f, mode=mode)
 
58
 
 
59
    def append_bytes(self, relpath, bytes, mode=None):
 
60
        """See Transport.append_bytes()."""
 
61
        return self._decorated.append_bytes(relpath, bytes, mode=mode)
 
62
 
 
63
    def delete(self, relpath):
 
64
        """See Transport.delete()."""
 
65
        return self._decorated.delete(relpath)
 
66
 
 
67
    def delete_tree(self, relpath):
 
68
        """See Transport.delete_tree()."""
 
69
        return self._decorated.delete_tree(relpath)
 
70
 
 
71
    @classmethod
 
72
    def _get_url_prefix(self):
 
73
        """Tracing transports are identified by 'trace+'"""
 
74
        return 'trace+'
 
75
 
 
76
    def get(self, relpath):
 
77
        """See Transport.get()."""
 
78
        self._activity.append(('get', relpath))
 
79
        return self._decorated.get(relpath)
 
80
 
 
81
    def get_smart_client(self):
 
82
        return self._decorated.get_smart_client()
 
83
 
 
84
    def has(self, relpath):
 
85
        """See Transport.has()."""
 
86
        return self._decorated.has(relpath)
 
87
 
 
88
    def is_readonly(self):
 
89
        """See Transport.is_readonly."""
 
90
        return self._decorated.is_readonly()
 
91
 
 
92
    def mkdir(self, relpath, mode=None):
 
93
        """See Transport.mkdir()."""
 
94
        return self._decorated.mkdir(relpath, mode)
 
95
 
 
96
    def open_write_stream(self, relpath, mode=None):
 
97
        """See Transport.open_write_stream."""
 
98
        return self._decorated.open_write_stream(relpath, mode=mode)
 
99
 
 
100
    def put_file(self, relpath, f, mode=None):
 
101
        """See Transport.put_file()."""
 
102
        return self._decorated.put_file(relpath, f, mode)
 
103
    
 
104
    def put_bytes(self, relpath, bytes, mode=None):
 
105
        """See Transport.put_bytes()."""
 
106
        self._activity.append(('put_bytes', relpath, len(bytes), mode))
 
107
        return self._decorated.put_bytes(relpath, bytes, mode)
 
108
 
 
109
    def listable(self):
 
110
        """See Transport.listable."""
 
111
        return self._decorated.listable()
 
112
 
 
113
    def iter_files_recursive(self):
 
114
        """See Transport.iter_files_recursive()."""
 
115
        return self._decorated.iter_files_recursive()
 
116
    
 
117
    def list_dir(self, relpath):
 
118
        """See Transport.list_dir()."""
 
119
        return self._decorated.list_dir(relpath)
 
120
 
 
121
    def readv(self, relpath, offsets, adjust_for_latency=False,
 
122
        upper_limit=None):
 
123
        """See Transport.readv."""
 
124
        self._activity.append(('readv', relpath, offsets, adjust_for_latency,
 
125
            upper_limit))
 
126
        return self._decorated.readv(relpath, offsets, adjust_for_latency,
 
127
            upper_limit)
 
128
 
 
129
    def recommended_page_size(self):
 
130
        """See Transport.recommended_page_size()."""
 
131
        return self._decorated.recommended_page_size()
 
132
 
 
133
    def rename(self, rel_from, rel_to):
 
134
        return self._decorated.rename(rel_from, rel_to)
 
135
    
 
136
    def rmdir(self, relpath):
 
137
        """See Transport.rmdir."""
 
138
        return self._decorated.rmdir(relpath)
 
139
 
 
140
    def stat(self, relpath):
 
141
        """See Transport.stat()."""
 
142
        return self._decorated.stat(relpath)
 
143
 
 
144
    def lock_read(self, relpath):
 
145
        """See Transport.lock_read."""
 
146
        return self._decorated.lock_read(relpath)
 
147
 
 
148
    def lock_write(self, relpath):
 
149
        """See Transport.lock_write."""
 
150
        return self._decorated.lock_write(relpath)
 
151
 
 
152
 
 
153
class TraceServer(DecoratorServer):
 
154
    """Server for the TransportTraceDecorator for testing with."""
 
155
 
 
156
    def get_decorator_class(self):
 
157
        return TransportTraceDecorator
 
158
 
 
159
 
 
160
def get_test_permutations():
 
161
    """Return the permutations to be used in testing."""
 
162
    return [(TransportTraceDecorator, TraceServer)]