← 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: Canonical.com Patch Queue Manager
  • Date: 2006-05-29 23:15:16 UTC
  • mfrom: (1711.2.25 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060529231516-cad98b5042ea75f3
(jam) Updates to PatienceDiff for performance, and other cleanups.

Show diffs side-by-side

added added

removed removed

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