14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from StringIO import StringIO
21
from bzrlib import errors
22
from bzrlib.progress import (
20
from ..progress import (
25
from bzrlib.symbol_versioning import (
28
from bzrlib.tests import TestCase
29
from bzrlib.ui.text import (
23
from ..ui.text import (
34
class _TTYStringIO(StringIO):
35
"""A helper class which makes a StringIO look like a terminal"""
41
class _NonTTYStringIO(StringIO):
42
"""Helper that implements isatty() but returns False"""
48
class TestTextProgressView(TestCase):
35
class TestTextProgressView(tests.TestCase):
49
36
"""Tests for text display of progress bars.
51
38
These try to exercise the progressview independently of its construction,
54
41
# The ProgressTask now connects directly to the ProgressView, so we can
55
42
# check them independently of the factory or of the determination of what
45
def make_view_only(self, out, width=79):
46
view = TextProgressView(out)
47
view._avail_width = lambda: width
58
50
def make_view(self):
60
view = TextProgressView(out)
51
out = ui_testing.StringIOWithEncoding()
52
return out, self.make_view_only(out)
64
54
def make_task(self, parent_task, view, msg, curr, total):
65
55
# would normally be done by UIFactory; is done here so that we don't
66
56
# have to have one.
70
60
task.total_cnt = total
64
# <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
65
# send spaces to clear the line
66
out, view = self.make_view()
67
task = self.make_task(None, view, 'reticulating splines', 5, 20)
68
view.show_progress(task)
70
'\r/ reticulating splines 5/20 \r'
74
'\r/ reticulating splines 5/20 \r'
75
+ '\r' + 79 * ' ' + '\r',
73
78
def test_render_progress_no_bar(self):
74
79
"""The default view now has a spinner but no bar."""
75
80
out, view = self.make_view()
100
105
# so we're in the first half of the main task, and half way through
102
107
self.assertEqual(
103
r'[####- ] reticulating splines:stage2 1/2'
108
'[####- ] reticulating splines:stage2 1/2 '
104
109
, view._render_line())
105
110
# if the nested task is complete, then we're all the way through the
106
111
# first half of the overall work
107
112
task2.update('stage2', 2, 2)
108
113
self.assertEqual(
109
r'[#########\ ] reticulating splines:stage2 2/2'
114
'[#########\\ ] reticulating splines:stage2 2/2 '
110
115
, view._render_line())
112
117
def test_render_progress_sub_nested(self):
123
128
# progress indication, just a label; and the bottom one is half done,
124
129
# so the overall fraction is 1/4
125
130
self.assertEqual(
126
r'[####| ] a:b:c 1/2'
131
'[####| ] a:b:c 1/2 '
127
132
, view._render_line())
134
def test_render_truncated(self):
135
# when the bar is too long for the terminal, we prefer not to truncate
136
# the counters because they might be interesting, and because
137
# truncating the numbers might be misleading
138
out, view = self.make_view()
139
task_a = ProgressTask(None, progress_view=view)
140
task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
141
line = view._render_line()
143
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
145
self.assertEqual(len(line), 79)
148
def test_render_with_activity(self):
149
# if the progress view has activity, it's shown before the spinner
150
out, view = self.make_view()
151
task_a = ProgressTask(None, progress_view=view)
152
view._last_transport_msg = ' 123kB 100kB/s '
153
line = view._render_line()
157
self.assertEqual(len(line), 79)
159
task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
160
view._last_transport_msg = ' 123kB 100kB/s '
161
line = view._render_line()
163
' 123kB 100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
165
self.assertEqual(len(line), 79)
167
def test_render_progress_unicode_enc_utf8(self):
168
out = ui_testing.StringIOWithEncoding()
169
out.encoding = "utf-8"
170
view = self.make_view_only(out, 20)
171
task = self.make_task(None, view, u"\xa7", 0, 1)
172
view.show_progress(task)
173
self.assertEqual(u'\r/ \xa7 0/1 \r', out.getvalue())
175
def test_render_progress_unicode_enc_missing(self):
176
out = codecs.getwriter("ascii")(io.BytesIO())
177
self.assertRaises(AttributeError, getattr, out, "encoding")
178
view = self.make_view_only(out, 20)
179
task = self.make_task(None, view, u"\xa7", 0, 1)
180
view.show_progress(task)
181
self.assertEqual(b'\r/ ? 0/1 \r', out.getvalue())
183
def test_render_progress_unicode_enc_none(self):
184
out = ui_testing.StringIOWithEncoding()
186
view = self.make_view_only(out, 20)
187
task = self.make_task(None, view, u"\xa7", 0, 1)
188
view.show_progress(task)
189
self.assertEqual(u'\r/ ? 0/1 \r', out.getvalue())