← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_progress.py

  • Committer: Andrew Bennetts
  • Date: 2008-01-14 22:45:15 UTC
  • mfrom: (3179 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3180.
  • Revision ID: andrew.bennetts@canonical.com-20080114224515-izp51fxci3hhopap
Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
17
import os
19
18
from StringIO import StringIO
20
19
 
21
20
from bzrlib import errors
22
21
from bzrlib.progress import (
23
 
    ProgressTask,
24
 
    )
25
 
from bzrlib.symbol_versioning import (
26
 
    deprecated_in,
27
 
    )
 
22
        DummyProgress,
 
23
        ChildProgress,
 
24
        TTYProgressBar,
 
25
        DotsProgressBar,
 
26
        ProgressBarStack,
 
27
        InstrumentedProgress,
 
28
        )
28
29
from bzrlib.tests import TestCase
29
 
from bzrlib.ui.text import (
30
 
    TextProgressView,
31
 
    )
 
30
 
 
31
 
 
32
class FakeStack:
 
33
    def __init__(self, top):
 
34
        self.__top = top
 
35
 
 
36
    def top(self):
 
37
        return self.__top
32
38
 
33
39
 
34
40
class _TTYStringIO(StringIO):
45
51
        return False
46
52
 
47
53
 
48
 
class TestTextProgressView(TestCase):
49
 
    """Tests for text display of progress bars.
50
 
 
51
 
    These try to exercise the progressview independently of its construction,
52
 
    which is arranged by the TextUIFactory.
53
 
    """
54
 
    # The ProgressTask now connects directly to the ProgressView, so we can
55
 
    # check them independently of the factory or of the determination of what
56
 
    # view to use.
57
 
    
58
 
    def make_view(self):
59
 
        out = StringIO()
60
 
        view = TextProgressView(out)
61
 
        view._width = 80
62
 
        return out, view
63
 
    
64
 
    def make_task(self, parent_task, view, msg, curr, total):
65
 
        # would normally be done by UIFactory; is done here so that we don't
66
 
        # have to have one.
67
 
        task = ProgressTask(parent_task, progress_view=view)
68
 
        task.msg = msg
69
 
        task.current_cnt = curr
70
 
        task.total_cnt = total
71
 
        return task
72
 
 
73
 
    def test_render_progress_no_bar(self):
74
 
        """The default view now has a spinner but no bar."""
75
 
        out, view = self.make_view()
76
 
        # view.enable_bar = False
77
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
78
 
        view.show_progress(task)
79
 
        self.assertEqual(
80
 
'\r/ reticulating splines 5/20                                                    \r'
81
 
            , out.getvalue())
82
 
 
83
 
    def test_render_progress_easy(self):
84
 
        """Just one task and one quarter done"""
85
 
        out, view = self.make_view()
86
 
        view.enable_bar = True
87
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
88
 
        view.show_progress(task)
89
 
        self.assertEqual(
90
 
'\r[####/               ] reticulating splines 5/20                               \r'
91
 
            , out.getvalue())
92
 
 
93
 
    def test_render_progress_nested(self):
94
 
        """Tasks proportionally contribute to overall progress"""
95
 
        out, view = self.make_view()
96
 
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
97
 
        task2 = self.make_task(task, view, 'stage2', 1, 2)
98
 
        view.show_progress(task2)
99
 
        view.enable_bar = True
100
 
        # so we're in the first half of the main task, and half way through
101
 
        # that
102
 
        self.assertEqual(
103
 
r'[####-               ] reticulating splines:stage2 1/2'
104
 
            , view._render_line())
105
 
        # if the nested task is complete, then we're all the way through the
106
 
        # first half of the overall work
107
 
        task2.update('stage2', 2, 2)
108
 
        self.assertEqual(
109
 
r'[#########\          ] reticulating splines:stage2 2/2'
110
 
            , view._render_line())
111
 
 
112
 
    def test_render_progress_sub_nested(self):
113
 
        """Intermediate tasks don't mess up calculation."""
114
 
        out, view = self.make_view()
115
 
        view.enable_bar = True
116
 
        task_a = ProgressTask(None, progress_view=view)
117
 
        task_a.update('a', 0, 2)
118
 
        task_b = ProgressTask(task_a, progress_view=view)
119
 
        task_b.update('b')
120
 
        task_c = ProgressTask(task_b, progress_view=view)
121
 
        task_c.update('c', 1, 2)
122
 
        # the top-level task is in its first half; the middle one has no
123
 
        # progress indication, just a label; and the bottom one is half done,
124
 
        # so the overall fraction is 1/4
125
 
        self.assertEqual(
126
 
            r'[####|               ] a:b:c 1/2'
127
 
            , view._render_line())
 
54
class TestProgress(TestCase):
 
55
    def setUp(self):
 
56
        q = DummyProgress()
 
57
        self.top = ChildProgress(_stack=FakeStack(q))
 
58
 
 
59
    def test_propogation(self):
 
60
        self.top.update('foobles', 1, 2)
 
61
        self.assertEqual(self.top.message, 'foobles')
 
62
        self.assertEqual(self.top.current, 1)
 
63
        self.assertEqual(self.top.total, 2)
 
64
        self.assertEqual(self.top.child_fraction, 0)
 
65
        child = ChildProgress(_stack=FakeStack(self.top))
 
66
        child.update('baubles', 2, 4)
 
67
        self.assertEqual(self.top.message, 'foobles')
 
68
        self.assertEqual(self.top.current, 1)
 
69
        self.assertEqual(self.top.total, 2)
 
70
        self.assertEqual(self.top.child_fraction, 0.5)
 
71
        grandchild = ChildProgress(_stack=FakeStack(child))
 
72
        grandchild.update('barbells', 1, 2)
 
73
        self.assertEqual(self.top.child_fraction, 0.625)
 
74
        self.assertEqual(child.child_fraction, 0.5)
 
75
        child.update('baubles', 3, 4)
 
76
        self.assertEqual(child.child_fraction, 0)
 
77
        self.assertEqual(self.top.child_fraction, 0.75)
 
78
        grandchild.update('barbells', 1, 2)
 
79
        self.assertEqual(self.top.child_fraction, 0.875)
 
80
        grandchild.update('barbells', 2, 2)
 
81
        self.assertEqual(self.top.child_fraction, 1)
 
82
        child.update('baubles', 4, 4)
 
83
        self.assertEqual(self.top.child_fraction, 1)
 
84
        #test clamping
 
85
        grandchild.update('barbells', 2, 2)
 
86
        self.assertEqual(self.top.child_fraction, 1)
 
87
 
 
88
    def test_implementations(self):
 
89
        for implementation in (TTYProgressBar, DotsProgressBar, 
 
90
                               DummyProgress):
 
91
            self.check_parent_handling(implementation)
 
92
 
 
93
    def check_parent_handling(self, parentclass):
 
94
        top = parentclass(to_file=StringIO())
 
95
        top.update('foobles', 1, 2)
 
96
        child = ChildProgress(_stack=FakeStack(top))
 
97
        child.update('baubles', 4, 4)
 
98
        top.update('lala', 2, 2)
 
99
        child.update('baubles', 4, 4)
 
100
 
 
101
    def test_stacking(self):
 
102
        self.check_stack(TTYProgressBar, ChildProgress)
 
103
        self.check_stack(DotsProgressBar, ChildProgress)
 
104
        self.check_stack(DummyProgress, DummyProgress)
 
105
 
 
106
    def check_stack(self, parent_class, child_class):
 
107
        stack = ProgressBarStack(klass=parent_class, to_file=StringIO())
 
108
        parent = stack.get_nested()
 
109
        try:
 
110
            self.assertIs(parent.__class__, parent_class)
 
111
            child = stack.get_nested()
 
112
            try:
 
113
                self.assertIs(child.__class__, child_class)
 
114
            finally:
 
115
                child.finished()
 
116
        finally:
 
117
            parent.finished()
 
118
 
 
119
    def test_throttling(self):
 
120
        pb = InstrumentedProgress(to_file=StringIO())
 
121
        # instantaneous updates should be squelched
 
122
        pb.update('me', 1, 1)
 
123
        self.assertTrue(pb.always_throttled)
 
124
        pb = InstrumentedProgress(to_file=StringIO())
 
125
        # It's like an instant sleep(1)!
 
126
        pb.start_time -= 1
 
127
        # Updates after a second should not be squelched
 
128
        pb.update('me', 1, 1)
 
129
        self.assertFalse(pb.always_throttled)
 
130
 
 
131
    def test_clear(self):
 
132
        sio = StringIO()
 
133
        pb = TTYProgressBar(to_file=sio, show_eta=False)
 
134
        pb.width = 20 # Just make it easier to test
 
135
        # This should not output anything
 
136
        pb.clear()
 
137
        # These two should not be displayed because
 
138
        # of throttling
 
139
        pb.update('foo', 1, 3)
 
140
        pb.update('bar', 2, 3)
 
141
        # So pb.clear() has nothing to do
 
142
        pb.clear()
 
143
 
 
144
        # Make sure the next update isn't throttled
 
145
        pb.start_time -= 1
 
146
        pb.update('baz', 3, 3)
 
147
        pb.clear()
 
148
 
 
149
        self.assertEqual('\r[=========] baz 3/3'
 
150
                         '\r                   \r',
 
151
                         sio.getvalue())
 
152
 
 
153
    def test_no_eta(self):
 
154
        # An old version of the progress bar would
 
155
        # store every update if show_eta was false
 
156
        # because the eta routine was where it was
 
157
        # cleaned out
 
158
        pb = InstrumentedProgress(to_file=StringIO(), show_eta=False)
 
159
        # Just make sure this first few are throttled
 
160
        pb.start_time += 5
 
161
 
 
162
        # These messages are throttled, and don't contribute
 
163
        for count in xrange(100):
 
164
            pb.update('x', count, 300)
 
165
        self.assertEqual(0, len(pb.last_updates))
 
166
 
 
167
        # Unthrottle by time
 
168
        pb.start_time -= 10
 
169
 
 
170
        # These happen too fast, so only one gets through
 
171
        for count in xrange(100):
 
172
            pb.update('x', count+100, 200)
 
173
        self.assertEqual(1, len(pb.last_updates))
 
174
 
 
175
        pb.MIN_PAUSE = 0.0
 
176
 
 
177
        # But all of these go through, don't let the
 
178
        # last_update list grow without bound
 
179
        for count in xrange(100):
 
180
            pb.update('x', count+100, 200)
 
181
 
 
182
        self.assertEqual(pb._max_last_updates, len(pb.last_updates))
 
183
 
 
184
 
 
185
class TestProgressTypes(TestCase):
 
186
    """Test that the right ProgressBar gets instantiated at the right time."""
 
187
 
 
188
    def get_nested(self, outf, term, env_progress=None):
 
189
        """Setup so that ProgressBar thinks we are in the supplied terminal."""
 
190
        orig_term = os.environ.get('TERM')
 
191
        orig_progress = os.environ.get('BZR_PROGRESS_BAR')
 
192
        os.environ['TERM'] = term
 
193
        if env_progress is not None:
 
194
            os.environ['BZR_PROGRESS_BAR'] = env_progress
 
195
        elif orig_progress is not None:
 
196
            del os.environ['BZR_PROGRESS_BAR']
 
197
 
 
198
        def reset():
 
199
            if orig_term is None:
 
200
                del os.environ['TERM']
 
201
            else:
 
202
                os.environ['TERM'] = orig_term
 
203
            # We may have never created BZR_PROGRESS_BAR
 
204
            # So we can't just delete like we can 'TERM' (which is always set)
 
205
            if orig_progress is None:
 
206
                if 'BZR_PROGRESS_BAR' in os.environ:
 
207
                    del os.environ['BZR_PROGRESS_BAR']
 
208
            else:
 
209
                os.environ['BZR_PROGRESS_BAR'] = orig_progress
 
210
 
 
211
        self.addCleanup(reset)
 
212
 
 
213
        stack = ProgressBarStack(to_file=outf)
 
214
        pb = stack.get_nested()
 
215
        pb.start_time -= 1 # Make sure it is ready to write
 
216
        pb.width = 20 # And it is of reasonable size
 
217
        return pb
 
218
 
 
219
    def test_tty_progress(self):
 
220
        # Make sure the ProgressBarStack thinks it is
 
221
        # writing out to a terminal, and thus uses a TTYProgressBar
 
222
        out = _TTYStringIO()
 
223
        pb = self.get_nested(out, 'xterm')
 
224
        self.assertIsInstance(pb, TTYProgressBar)
 
225
        try:
 
226
            pb.update('foo', 1, 2)
 
227
            pb.update('bar', 2, 2)
 
228
        finally:
 
229
            pb.finished()
 
230
 
 
231
        self.assertEqual('\r/ [====   ] foo 1/2'
 
232
                         '\r- [=======] bar 2/2'
 
233
                         '\r                   \r',
 
234
                         out.getvalue())
 
235
 
 
236
    def test_noninteractive_progress(self):
 
237
        out = _NonTTYStringIO()
 
238
        pb = self.get_nested(out, 'xterm')
 
239
        self.assertIsInstance(pb, DummyProgress)
 
240
        try:
 
241
            pb.update('foo', 1, 2)
 
242
            pb.update('bar', 2, 2)
 
243
        finally:
 
244
            pb.finished()
 
245
        self.assertEqual('', out.getvalue())
 
246
 
 
247
    def test_dots_progress(self):
 
248
        # make sure we get the right progress bar when not on a terminal
 
249
        out = _NonTTYStringIO()
 
250
        pb = self.get_nested(out, 'xterm', 'dots')
 
251
        self.assertIsInstance(pb, DotsProgressBar)
 
252
        try:
 
253
            pb.update('foo', 1, 2)
 
254
            pb.update('bar', 2, 2)
 
255
        finally:
 
256
            pb.finished()
 
257
        self.assertEqual('foo: .'
 
258
                         '\nbar: .'
 
259
                         '\n',
 
260
                         out.getvalue())
 
261
 
 
262
    def test_no_isatty_progress(self):
 
263
        # Make sure ProgressBarStack handles a plain StringIO()
 
264
        import cStringIO
 
265
        out = cStringIO.StringIO()
 
266
        pb = self.get_nested(out, 'xterm')
 
267
        pb.finished()
 
268
        self.assertIsInstance(pb, DummyProgress)
 
269
 
 
270
    def test_dumb_progress(self):
 
271
        # using a terminal that can't do cursor movement
 
272
        out = _TTYStringIO()
 
273
        pb = self.get_nested(out, 'dumb')
 
274
        pb.finished()
 
275
        self.assertIsInstance(pb, DummyProgress)
 
276
 
 
277
    def test_progress_env_tty(self):
 
278
        # The environ variable BZR_PROGRESS_BAR controls what type of
 
279
        # progress bar we will get, even if it wouldn't usually be that type
 
280
        import cStringIO
 
281
 
 
282
        # Usually, this would be a DotsProgressBar
 
283
        out = cStringIO.StringIO()
 
284
        pb = self.get_nested(out, 'dumb', 'tty')
 
285
        pb.finished()
 
286
        # Even though we are not a tty, the env_var will override
 
287
        self.assertIsInstance(pb, TTYProgressBar)
 
288
 
 
289
    def test_progress_env_none(self):
 
290
        # Even though we are in a valid tty, no progress
 
291
        out = _TTYStringIO()
 
292
        pb = self.get_nested(out, 'xterm', 'none')
 
293
        pb.finished()
 
294
        self.assertIsInstance(pb, DummyProgress)
 
295
 
 
296
    def test_progress_env_invalid(self):
 
297
        out = _TTYStringIO()
 
298
        self.assertRaises(errors.InvalidProgressBarType, self.get_nested,
 
299
            out, 'xterm', 'nonexistant')