← 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: Martin Pool
  • Date: 2005-06-22 07:56:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050622075641-a85aa3c0272024bf
- Fix typo

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
1
 
# Copyright (C) 2006-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
19
 
 
20
 
from bzrlib import (
21
 
    tests,
22
 
    )
23
 
from bzrlib.progress import (
24
 
    ProgressTask,
25
 
    )
26
 
from bzrlib.ui.text import (
27
 
    TextProgressView,
28
 
    )
29
 
 
30
 
 
31
 
class TestTextProgressView(tests.TestCase):
32
 
    """Tests for text display of progress bars.
33
 
 
34
 
    These try to exercise the progressview independently of its construction,
35
 
    which is arranged by the TextUIFactory.
36
 
    """
37
 
    # The ProgressTask now connects directly to the ProgressView, so we can
38
 
    # check them independently of the factory or of the determination of what
39
 
    # view to use.
40
 
 
41
 
    def make_view_only(self, out, width=79):
42
 
        view = TextProgressView(out)
43
 
        view._avail_width = lambda: width
44
 
        return view
45
 
 
46
 
    def make_view(self):
47
 
        out = StringIO()
48
 
        return out, self.make_view_only(out)
49
 
 
50
 
    def make_task(self, parent_task, view, msg, curr, total):
51
 
        # would normally be done by UIFactory; is done here so that we don't
52
 
        # have to have one.
53
 
        task = ProgressTask(parent_task, progress_view=view)
54
 
        task.msg = msg
55
 
        task.current_cnt = curr
56
 
        task.total_cnt = total
57
 
        return task
58
 
 
59
 
    def test_clear(self):
60
 
        # <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
61
 
        # send spaces to clear the line
62
 
        out, view = self.make_view()
63
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
64
 
        view.show_progress(task)
65
 
        self.assertEqual(
66
 
'\r/ reticulating splines 5/20                                                    \r'
67
 
            , out.getvalue())
68
 
        view.clear()
69
 
        self.assertEqual(
70
 
'\r/ reticulating splines 5/20                                                    \r'
71
 
            + '\r' + 79 * ' ' + '\r',
72
 
            out.getvalue())
73
 
 
74
 
    def test_render_progress_no_bar(self):
75
 
        """The default view now has a spinner but no bar."""
76
 
        out, view = self.make_view()
77
 
        # view.enable_bar = False
78
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
79
 
        view.show_progress(task)
80
 
        self.assertEqual(
81
 
'\r/ reticulating splines 5/20                                                    \r'
82
 
            , out.getvalue())
83
 
 
84
 
    def test_render_progress_easy(self):
85
 
        """Just one task and one quarter done"""
86
 
        out, view = self.make_view()
87
 
        view.enable_bar = True
88
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
89
 
        view.show_progress(task)
90
 
        self.assertEqual(
91
 
'\r[####/               ] reticulating splines 5/20                               \r'
92
 
            , out.getvalue())
93
 
 
94
 
    def test_render_progress_nested(self):
95
 
        """Tasks proportionally contribute to overall progress"""
96
 
        out, view = self.make_view()
97
 
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
98
 
        task2 = self.make_task(task, view, 'stage2', 1, 2)
99
 
        view.show_progress(task2)
100
 
        view.enable_bar = True
101
 
        # so we're in the first half of the main task, and half way through
102
 
        # that
103
 
        self.assertEqual(
104
 
'[####-               ] reticulating splines:stage2 1/2                         '
105
 
            , view._render_line())
106
 
        # if the nested task is complete, then we're all the way through the
107
 
        # first half of the overall work
108
 
        task2.update('stage2', 2, 2)
109
 
        self.assertEqual(
110
 
'[#########\          ] reticulating splines:stage2 2/2                         '
111
 
            , view._render_line())
112
 
 
113
 
    def test_render_progress_sub_nested(self):
114
 
        """Intermediate tasks don't mess up calculation."""
115
 
        out, view = self.make_view()
116
 
        view.enable_bar = True
117
 
        task_a = ProgressTask(None, progress_view=view)
118
 
        task_a.update('a', 0, 2)
119
 
        task_b = ProgressTask(task_a, progress_view=view)
120
 
        task_b.update('b')
121
 
        task_c = ProgressTask(task_b, progress_view=view)
122
 
        task_c.update('c', 1, 2)
123
 
        # the top-level task is in its first half; the middle one has no
124
 
        # progress indication, just a label; and the bottom one is half done,
125
 
        # so the overall fraction is 1/4
126
 
        self.assertEqual(
127
 
'[####|               ] a:b:c 1/2                                               '
128
 
            , view._render_line())
129
 
 
130
 
    def test_render_truncated(self):
131
 
        # when the bar is too long for the terminal, we prefer not to truncate
132
 
        # the counters because they might be interesting, and because
133
 
        # truncating the numbers might be misleading
134
 
        out, view = self.make_view()
135
 
        task_a = ProgressTask(None, progress_view=view)
136
 
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
137
 
        line = view._render_line()
138
 
        self.assertEqual(
139
 
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
140
 
           line) 
141
 
        self.assertEqual(len(line), 79)
142
 
 
143
 
 
144
 
    def test_render_with_activity(self):
145
 
        # if the progress view has activity, it's shown before the spinner
146
 
        out, view = self.make_view()
147
 
        task_a = ProgressTask(None, progress_view=view)
148
 
        view._last_transport_msg = '   123kB   100kB/s '
149
 
        line = view._render_line()
150
 
        self.assertEqual(
151
 
'   123kB   100kB/s /                                                           ',
152
 
           line) 
153
 
        self.assertEqual(len(line), 79)
154
 
 
155
 
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
156
 
        view._last_transport_msg = '   123kB   100kB/s '
157
 
        line = view._render_line()
158
 
        self.assertEqual(
159
 
'   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
160
 
           line) 
161
 
        self.assertEqual(len(line), 79)
162
 
 
163
 
    def test_render_progress_unicode_enc_utf8(self):
164
 
        out = tests.StringIOWrapper()
165
 
        out.encoding = "utf-8"
166
 
        view = self.make_view_only(out, 20)
167
 
        task = self.make_task(None, view, u"\xa7", 0, 1)
168
 
        view.show_progress(task)
169
 
        self.assertEqual('\r/ \xc2\xa7 0/1            \r',
170
 
            out.getvalue())
171
 
 
172
 
    def test_render_progress_unicode_enc_missing(self):
173
 
        out = StringIO()
174
 
        self.assertRaises(AttributeError, getattr, out, "encoding")
175
 
        view = self.make_view_only(out, 20)
176
 
        task = self.make_task(None, view, u"\xa7", 0, 1)
177
 
        view.show_progress(task)
178
 
        self.assertEqual('\r/ ? 0/1             \r',
179
 
            out.getvalue())
180
 
 
181
 
    def test_render_progress_unicode_enc_none(self):
182
 
        out = tests.StringIOWrapper()
183
 
        out.encoding = None
184
 
        view = self.make_view_only(out, 20)
185
 
        task = self.make_task(None, view, u"\xa7", 0, 1)
186
 
        view.show_progress(task)
187
 
        self.assertEqual('\r/ ? 0/1             \r',
188
 
            out.getvalue())