48
class TestTextProgressView(TestCase):
49
"""Tests for text display of progress bars.
51
These try to exercise the progressview independently of its construction,
52
which is arranged by the TextUIFactory.
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
60
view = TextProgressView(out)
61
view._avail_width = lambda: 79
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
67
task = ProgressTask(parent_task, progress_view=view)
69
task.current_cnt = curr
70
task.total_cnt = total
58
class TestProgress(TestCase):
63
self.top = ChildProgress(_stack=FakeStack(q))
65
def test_propogation(self):
66
self.top.update('foobles', 1, 2)
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)
71
child = ChildProgress(_stack=FakeStack(self.top))
72
child.update('baubles', 2, 4)
73
self.assertEqual(self.top.message, 'foobles')
74
self.assertEqual(self.top.current, 1)
75
self.assertEqual(self.top.total, 2)
76
self.assertEqual(self.top.child_fraction, 0.5)
77
grandchild = ChildProgress(_stack=FakeStack(child))
78
grandchild.update('barbells', 1, 2)
79
self.assertEqual(self.top.child_fraction, 0.625)
80
self.assertEqual(child.child_fraction, 0.5)
81
child.update('baubles', 3, 4)
82
self.assertEqual(child.child_fraction, 0)
83
self.assertEqual(self.top.child_fraction, 0.75)
84
grandchild.update('barbells', 1, 2)
85
self.assertEqual(self.top.child_fraction, 0.875)
86
grandchild.update('barbells', 2, 2)
87
self.assertEqual(self.top.child_fraction, 1)
88
child.update('baubles', 4, 4)
89
self.assertEqual(self.top.child_fraction, 1)
91
grandchild.update('barbells', 2, 2)
92
self.assertEqual(self.top.child_fraction, 1)
94
def test_implementations(self):
95
for implementation in (TTYProgressBar, DotsProgressBar,
97
self.check_parent_handling(implementation)
99
def check_parent_handling(self, parentclass):
100
top = parentclass(to_file=StringIO())
101
top.update('foobles', 1, 2)
102
child = ChildProgress(_stack=FakeStack(top))
103
child.update('baubles', 4, 4)
104
top.update('lala', 2, 2)
105
child.update('baubles', 4, 4)
107
def test_stacking(self):
108
self.check_stack(TTYProgressBar, ChildProgress)
109
self.check_stack(DotsProgressBar, ChildProgress)
110
self.check_stack(DummyProgress, DummyProgress)
112
def check_stack(self, parent_class, child_class):
113
stack = self.applyDeprecated(
114
deprecated_in((1, 12, 0)),
116
klass=parent_class, to_file=StringIO())
117
parent = stack.get_nested()
119
self.assertIs(parent.__class__, parent_class)
120
child = stack.get_nested()
122
self.assertIs(child.__class__, child_class)
128
def test_throttling(self):
129
pb = InstrumentedProgress(to_file=StringIO())
130
# instantaneous updates should be squelched
131
pb.update('me', 1, 1)
132
self.assertTrue(pb.always_throttled)
133
pb = InstrumentedProgress(to_file=StringIO())
134
# It's like an instant sleep(1)!
136
# Updates after a second should not be squelched
137
pb.update('me', 1, 1)
138
self.assertFalse(pb.always_throttled)
73
140
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)
80
'\r/ reticulating splines 5/20 \r'
84
'\r/ reticulating splines 5/20 \r'
85
+ '\r' + 79 * ' ' + '\r',
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)
95
'\r/ reticulating splines 5/20 \r'
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)
105
'\r[####/ ] reticulating splines 5/20 \r'
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
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)
124
'[#########\ ] reticulating splines:stage2 2/2 '
125
, view._render_line())
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)
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
141
'[####| ] a:b:c 1/2 '
142
, view._render_line())
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()
153
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
155
self.assertEqual(len(line), 79)
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()
167
self.assertEqual(len(line), 79)
169
task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
170
view._last_transport_msg = ' 123kB 100kB/s '
171
line = view._render_line()
173
' 123kB 100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
175
self.assertEqual(len(line), 79)
142
pb = TTYProgressBar(to_file=sio, show_eta=False)
143
pb.width = 20 # Just make it easier to test
144
# This should not output anything
146
# These two should not be displayed because
148
pb.update('foo', 1, 3)
149
pb.update('bar', 2, 3)
150
# So pb.clear() has nothing to do
153
# Make sure the next update isn't throttled
155
pb.update('baz', 3, 3)
158
self.assertEqual('\r[=========] baz 3/3'
162
def test_no_eta(self):
163
# An old version of the progress bar would
164
# store every update if show_eta was false
165
# because the eta routine was where it was
167
pb = InstrumentedProgress(to_file=StringIO(), show_eta=False)
168
# Just make sure this first few are throttled
171
# These messages are throttled, and don't contribute
172
for count in xrange(100):
173
pb.update('x', count, 300)
174
self.assertEqual(0, len(pb.last_updates))
179
# These happen too fast, so only one gets through
180
for count in xrange(100):
181
pb.update('x', count+100, 200)
182
self.assertEqual(1, len(pb.last_updates))
186
# But all of these go through, don't let the
187
# last_update list grow without bound
188
for count in xrange(100):
189
pb.update('x', count+100, 200)
191
self.assertEqual(pb._max_last_updates, len(pb.last_updates))
194
class TestProgressTypes(TestCase):
195
"""Test that the right ProgressBar gets instantiated at the right time."""
197
def get_nested(self, outf, term, env_progress=None):
198
"""Setup so that ProgressBar thinks we are in the supplied terminal."""
199
orig_term = os.environ.get('TERM')
200
orig_progress = os.environ.get('BZR_PROGRESS_BAR')
201
os.environ['TERM'] = term
202
if env_progress is not None:
203
os.environ['BZR_PROGRESS_BAR'] = env_progress
204
elif orig_progress is not None:
205
del os.environ['BZR_PROGRESS_BAR']
208
if orig_term is None:
209
del os.environ['TERM']
211
os.environ['TERM'] = orig_term
212
# We may have never created BZR_PROGRESS_BAR
213
# So we can't just delete like we can 'TERM' (which is always set)
214
if orig_progress is None:
215
if 'BZR_PROGRESS_BAR' in os.environ:
216
del os.environ['BZR_PROGRESS_BAR']
218
os.environ['BZR_PROGRESS_BAR'] = orig_progress
220
self.addCleanup(reset)
222
stack = self.applyDeprecated(
223
deprecated_in((1, 12, 0)),
226
pb = stack.get_nested()
227
pb.start_time -= 1 # Make sure it is ready to write
228
pb.width = 20 # And it is of reasonable size
231
def test_tty_progress(self):
232
# Make sure the ProgressBarStack thinks it is
233
# writing out to a terminal, and thus uses a TTYProgressBar
235
pb = self.get_nested(out, 'xterm')
236
self.assertIsInstance(pb, TTYProgressBar)
238
pb.update('foo', 1, 2)
239
pb.update('bar', 2, 2)
243
self.assertEqual('\r/ [==== ] foo 1/2'
244
'\r- [=======] bar 2/2'
248
def test_noninteractive_progress(self):
249
out = _NonTTYStringIO()
250
pb = self.get_nested(out, 'xterm')
251
self.assertIsInstance(pb, DummyProgress)
253
pb.update('foo', 1, 2)
254
pb.update('bar', 2, 2)
257
self.assertEqual('', out.getvalue())
259
def test_dots_progress(self):
260
# make sure we get the right progress bar when not on a terminal
261
out = _NonTTYStringIO()
262
pb = self.get_nested(out, 'xterm', 'dots')
263
self.assertIsInstance(pb, DotsProgressBar)
265
pb.update('foo', 1, 2)
266
pb.update('bar', 2, 2)
269
self.assertEqual('foo: .'
274
def test_no_isatty_progress(self):
275
# Make sure ProgressBarStack handles a plain StringIO()
277
out = cStringIO.StringIO()
278
pb = self.get_nested(out, 'xterm')
280
self.assertIsInstance(pb, DummyProgress)
282
def test_dumb_progress(self):
283
# using a terminal that can't do cursor movement
285
pb = self.get_nested(out, 'dumb')
287
self.assertIsInstance(pb, DummyProgress)
289
def test_progress_env_tty(self):
290
# The environ variable BZR_PROGRESS_BAR controls what type of
291
# progress bar we will get, even if it wouldn't usually be that type
294
# Usually, this would be a DotsProgressBar
295
out = cStringIO.StringIO()
296
pb = self.get_nested(out, 'dumb', 'tty')
298
# Even though we are not a tty, the env_var will override
299
self.assertIsInstance(pb, TTYProgressBar)
301
def test_progress_env_none(self):
302
# Even though we are in a valid tty, no progress
304
pb = self.get_nested(out, 'xterm', 'none')
306
self.assertIsInstance(pb, DummyProgress)
308
def test_progress_env_invalid(self):
310
self.assertRaises(errors.InvalidProgressBarType, self.get_nested,
311
out, 'xterm', 'nonexistant')
added
removed
bzrlib/tests/test_progress.py
