← 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: Aaron Bentley
  • Date: 2006-06-23 23:27:20 UTC
  • mto: This revision was merged to the branch mainline in revision 1811.
  • Revision ID: aaron.bentley@utoronto.ca-20060623232720-5cf2f2d1b095395a
Add log --verbose benchmark

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 by 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
 
 
17
 
 
18
 
import os
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
19
17
from StringIO import StringIO
20
18
 
21
 
from bzrlib import errors
22
19
from bzrlib.progress import (
23
 
    ProgressTask,
24
 
    )
25
 
from bzrlib.symbol_versioning import (
26
 
    deprecated_in,
27
 
    )
 
20
        DummyProgress, ChildProgress,
 
21
        TTYProgressBar,
 
22
        DotsProgressBar,
 
23
        ProgressBarStack,
 
24
        )
28
25
from bzrlib.tests import TestCase
29
 
from bzrlib.ui.text import (
30
 
    TextProgressView,
31
 
    )
32
 
 
33
 
 
34
 
class _TTYStringIO(StringIO):
35
 
    """A helper class which makes a StringIO look like a terminal"""
36
 
 
37
 
    def isatty(self):
38
 
        return True
39
 
 
40
 
 
41
 
class _NonTTYStringIO(StringIO):
42
 
    """Helper that implements isatty() but returns False"""
43
 
 
44
 
    def isatty(self):
45
 
        return False
46
 
 
47
 
 
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._avail_width = lambda: 79
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_clear(self):
74
 
        # <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
75
 
        # send spaces to clear the line
76
 
        out, view = self.make_view()
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
 
        view.clear()
83
 
        self.assertEqual(
84
 
'\r/ reticulating splines 5/20                                                    \r'
85
 
            + '\r' + 79 * ' ' + '\r',
86
 
            out.getvalue())
87
 
 
88
 
    def test_render_progress_no_bar(self):
89
 
        """The default view now has a spinner but no bar."""
90
 
        out, view = self.make_view()
91
 
        # view.enable_bar = False
92
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
93
 
        view.show_progress(task)
94
 
        self.assertEqual(
95
 
'\r/ reticulating splines 5/20                                                    \r'
96
 
            , out.getvalue())
97
 
 
98
 
    def test_render_progress_easy(self):
99
 
        """Just one task and one quarter done"""
100
 
        out, view = self.make_view()
101
 
        view.enable_bar = True
102
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
103
 
        view.show_progress(task)
104
 
        self.assertEqual(
105
 
'\r[####/               ] reticulating splines 5/20                               \r'
106
 
            , out.getvalue())
107
 
 
108
 
    def test_render_progress_nested(self):
109
 
        """Tasks proportionally contribute to overall progress"""
110
 
        out, view = self.make_view()
111
 
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
112
 
        task2 = self.make_task(task, view, 'stage2', 1, 2)
113
 
        view.show_progress(task2)
114
 
        view.enable_bar = True
115
 
        # so we're in the first half of the main task, and half way through
116
 
        # that
117
 
        self.assertEqual(
118
 
'[####-               ] reticulating splines:stage2 1/2                         '
119
 
            , view._render_line())
120
 
        # if the nested task is complete, then we're all the way through the
121
 
        # first half of the overall work
122
 
        task2.update('stage2', 2, 2)
123
 
        self.assertEqual(
124
 
'[#########\          ] reticulating splines:stage2 2/2                         '
125
 
            , view._render_line())
126
 
 
127
 
    def test_render_progress_sub_nested(self):
128
 
        """Intermediate tasks don't mess up calculation."""
129
 
        out, view = self.make_view()
130
 
        view.enable_bar = True
131
 
        task_a = ProgressTask(None, progress_view=view)
132
 
        task_a.update('a', 0, 2)
133
 
        task_b = ProgressTask(task_a, progress_view=view)
134
 
        task_b.update('b')
135
 
        task_c = ProgressTask(task_b, progress_view=view)
136
 
        task_c.update('c', 1, 2)
137
 
        # the top-level task is in its first half; the middle one has no
138
 
        # progress indication, just a label; and the bottom one is half done,
139
 
        # so the overall fraction is 1/4
140
 
        self.assertEqual(
141
 
'[####|               ] a:b:c 1/2                                               '
142
 
            , view._render_line())
143
 
 
144
 
    def test_render_truncated(self):
145
 
        # when the bar is too long for the terminal, we prefer not to truncate
146
 
        # the counters because they might be interesting, and because
147
 
        # truncating the numbers might be misleading
148
 
        out, view = self.make_view()
149
 
        task_a = ProgressTask(None, progress_view=view)
150
 
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
151
 
        line = view._render_line()
152
 
        self.assertEqual(
153
 
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
154
 
           line) 
155
 
        self.assertEqual(len(line), 79)
156
 
 
157
 
 
158
 
    def test_render_with_activity(self):
159
 
        # if the progress view has activity, it's shown before the spinner
160
 
        out, view = self.make_view()
161
 
        task_a = ProgressTask(None, progress_view=view)
162
 
        view._last_transport_msg = '   123kB   100kB/s '
163
 
        line = view._render_line()
164
 
        self.assertEqual(
165
 
'   123kB   100kB/s /                                                           ',
166
 
           line) 
167
 
        self.assertEqual(len(line), 79)
168
 
 
169
 
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
170
 
        view._last_transport_msg = '   123kB   100kB/s '
171
 
        line = view._render_line()
172
 
        self.assertEqual(
173
 
'   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
174
 
           line) 
175
 
        self.assertEqual(len(line), 79)
 
26
 
 
27
class FakeStack:
 
28
    def __init__(self, top):
 
29
        self.__top = top
 
30
 
 
31
    def top(self):
 
32
        return self.__top
 
33
 
 
34
class InstrumentedProgress(TTYProgressBar):
 
35
    """TTYProgress variant that tracks outcomes"""
 
36
 
 
37
    def __init__(self, *args, **kwargs):
 
38
        self.always_throttled = True
 
39
        TTYProgressBar.__init__(self, *args, **kwargs)
 
40
 
 
41
    def throttle(self, old_message):
 
42
        result = TTYProgressBar.throttle(self, old_message)
 
43
        if result is False:
 
44
            self.always_throttled = False
 
45
        
 
46
 
 
47
class TestProgress(TestCase):
 
48
    def setUp(self):
 
49
        q = DummyProgress()
 
50
        self.top = ChildProgress(_stack=FakeStack(q))
 
51
 
 
52
    def test_propogation(self):
 
53
        self.top.update('foobles', 1, 2)
 
54
        self.assertEqual(self.top.message, 'foobles')
 
55
        self.assertEqual(self.top.current, 1)
 
56
        self.assertEqual(self.top.total, 2)
 
57
        self.assertEqual(self.top.child_fraction, 0)
 
58
        child = ChildProgress(_stack=FakeStack(self.top))
 
59
        child.update('baubles', 2, 4)
 
60
        self.assertEqual(self.top.message, 'foobles')
 
61
        self.assertEqual(self.top.current, 1)
 
62
        self.assertEqual(self.top.total, 2)
 
63
        self.assertEqual(self.top.child_fraction, 0.5)
 
64
        grandchild = ChildProgress(_stack=FakeStack(child))
 
65
        grandchild.update('barbells', 1, 2)
 
66
        self.assertEqual(self.top.child_fraction, 0.625)
 
67
        self.assertEqual(child.child_fraction, 0.5)
 
68
        child.update('baubles', 3, 4)
 
69
        self.assertEqual(child.child_fraction, 0)
 
70
        self.assertEqual(self.top.child_fraction, 0.75)
 
71
        grandchild.update('barbells', 1, 2)
 
72
        self.assertEqual(self.top.child_fraction, 0.875)
 
73
        grandchild.update('barbells', 2, 2)
 
74
        self.assertEqual(self.top.child_fraction, 1)
 
75
        child.update('baubles', 4, 4)
 
76
        self.assertEqual(self.top.child_fraction, 1)
 
77
        #test clamping
 
78
        grandchild.update('barbells', 2, 2)
 
79
        self.assertEqual(self.top.child_fraction, 1)
 
80
 
 
81
    def test_implementations(self):
 
82
        for implementation in (TTYProgressBar, DotsProgressBar, 
 
83
                               DummyProgress):
 
84
            self.check_parent_handling(implementation)
 
85
 
 
86
    def check_parent_handling(self, parentclass):
 
87
        top = parentclass(to_file=StringIO())
 
88
        top.update('foobles', 1, 2)
 
89
        child = ChildProgress(_stack=FakeStack(top))
 
90
        child.update('baubles', 4, 4)
 
91
        top.update('lala', 2, 2)
 
92
        child.update('baubles', 4, 4)
 
93
 
 
94
    def test_stacking(self):
 
95
        self.check_stack(TTYProgressBar, ChildProgress)
 
96
        self.check_stack(DotsProgressBar, ChildProgress)
 
97
        self.check_stack(DummyProgress, DummyProgress)
 
98
 
 
99
    def check_stack(self, parent_class, child_class):
 
100
        stack = ProgressBarStack(klass=parent_class, to_file=StringIO())
 
101
        parent = stack.get_nested()
 
102
        try:
 
103
            self.assertIs(parent.__class__, parent_class)
 
104
            child = stack.get_nested()
 
105
            try:
 
106
                self.assertIs(child.__class__, child_class)
 
107
            finally:
 
108
                child.finished()
 
109
        finally:
 
110
            parent.finished()
 
111
 
 
112
    def test_throttling(self):
 
113
        pb = InstrumentedProgress(to_file=StringIO())
 
114
        # instantaneous updates should be squelched
 
115
        pb.update('me', 1, 1)
 
116
        self.assertTrue(pb.always_throttled)
 
117
        pb = InstrumentedProgress(to_file=StringIO())
 
118
        # It's like an instant sleep(1)!
 
119
        pb.start_time -= 1
 
120
        # Updates after a second should not be squelched
 
121
        pb.update('me', 1, 1)
 
122
        self.assertFalse(pb.always_throttled)