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)
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
73
def test_render_progress_no_bar(self):
74
"""The default view now has a spinner but no bar."""
75
out, view = self.make_view()
76
# view.enable_bar = False
77
task = self.make_task(None, view, 'reticulating splines', 5, 20)
78
view.show_progress(task)
80
'\r/ reticulating splines 5/20 \r'
83
def test_render_progress_easy(self):
84
"""Just one task and one quarter done"""
85
out, view = self.make_view()
86
view.enable_bar = True
87
task = self.make_task(None, view, 'reticulating splines', 5, 20)
88
view.show_progress(task)
90
'\r[####/ ] reticulating splines 5/20 \r'
93
def test_render_progress_nested(self):
94
"""Tasks proportionally contribute to overall progress"""
95
out, view = self.make_view()
96
task = self.make_task(None, view, 'reticulating splines', 0, 2)
97
task2 = self.make_task(task, view, 'stage2', 1, 2)
98
view.show_progress(task2)
99
view.enable_bar = True
100
# so we're in the first half of the main task, and half way through
103
r'[####- ] reticulating splines:stage2 1/2'
104
, view._render_line())
105
# if the nested task is complete, then we're all the way through the
106
# first half of the overall work
107
task2.update('stage2', 2, 2)
109
r'[#########\ ] reticulating splines:stage2 2/2'
110
, view._render_line())
112
def test_render_progress_sub_nested(self):
113
"""Intermediate tasks don't mess up calculation."""
114
out, view = self.make_view()
115
view.enable_bar = True
116
task_a = ProgressTask(None, progress_view=view)
117
task_a.update('a', 0, 2)
118
task_b = ProgressTask(task_a, progress_view=view)
120
task_c = ProgressTask(task_b, progress_view=view)
121
task_c.update('c', 1, 2)
122
# the top-level task is in its first half; the middle one has no
123
# progress indication, just a label; and the bottom one is half done,
124
# so the overall fraction is 1/4
126
r'[####| ] a:b:c 1/2'
127
, view._render_line())
58
class TestProgress(TestCase):
62
self.top = ChildProgress(_stack=FakeStack(q))
64
def test_propogation(self):
65
self.top.update('foobles', 1, 2)
66
self.assertEqual(self.top.message, 'foobles')
67
self.assertEqual(self.top.current, 1)
68
self.assertEqual(self.top.total, 2)
69
self.assertEqual(self.top.child_fraction, 0)
70
child = ChildProgress(_stack=FakeStack(self.top))
71
child.update('baubles', 2, 4)
72
self.assertEqual(self.top.message, 'foobles')
73
self.assertEqual(self.top.current, 1)
74
self.assertEqual(self.top.total, 2)
75
self.assertEqual(self.top.child_fraction, 0.5)
76
grandchild = ChildProgress(_stack=FakeStack(child))
77
grandchild.update('barbells', 1, 2)
78
self.assertEqual(self.top.child_fraction, 0.625)
79
self.assertEqual(child.child_fraction, 0.5)
80
child.update('baubles', 3, 4)
81
self.assertEqual(child.child_fraction, 0)
82
self.assertEqual(self.top.child_fraction, 0.75)
83
grandchild.update('barbells', 1, 2)
84
self.assertEqual(self.top.child_fraction, 0.875)
85
grandchild.update('barbells', 2, 2)
86
self.assertEqual(self.top.child_fraction, 1)
87
child.update('baubles', 4, 4)
88
self.assertEqual(self.top.child_fraction, 1)
90
grandchild.update('barbells', 2, 2)
91
self.assertEqual(self.top.child_fraction, 1)
93
def test_implementations(self):
94
for implementation in (TTYProgressBar, DotsProgressBar,
96
self.check_parent_handling(implementation)
98
def check_parent_handling(self, parentclass):
99
top = parentclass(to_file=StringIO())
100
top.update('foobles', 1, 2)
101
child = ChildProgress(_stack=FakeStack(top))
102
child.update('baubles', 4, 4)
103
top.update('lala', 2, 2)
104
child.update('baubles', 4, 4)
106
def test_stacking(self):
107
self.check_stack(TTYProgressBar, ChildProgress)
108
self.check_stack(DotsProgressBar, ChildProgress)
109
self.check_stack(DummyProgress, DummyProgress)
111
def check_stack(self, parent_class, child_class):
112
stack = self.applyDeprecated(
113
deprecated_in((1, 12, 0)),
115
klass=parent_class, to_file=StringIO())
116
parent = stack.get_nested()
118
self.assertIs(parent.__class__, parent_class)
119
child = stack.get_nested()
121
self.assertIs(child.__class__, child_class)
127
def test_throttling(self):
128
pb = InstrumentedProgress(to_file=StringIO())
129
# instantaneous updates should be squelched
130
pb.update('me', 1, 1)
131
self.assertTrue(pb.always_throttled)
132
pb = InstrumentedProgress(to_file=StringIO())
133
# It's like an instant sleep(1)!
135
# Updates after a second should not be squelched
136
pb.update('me', 1, 1)
137
self.assertFalse(pb.always_throttled)
139
def test_clear(self):
141
pb = TTYProgressBar(to_file=sio, show_eta=False)
142
pb.width = 20 # Just make it easier to test
143
# This should not output anything
145
# These two should not be displayed because
147
pb.update('foo', 1, 3)
148
pb.update('bar', 2, 3)
149
# So pb.clear() has nothing to do
152
# Make sure the next update isn't throttled
154
pb.update('baz', 3, 3)
157
self.assertEqual('\r[=========] baz 3/3'
161
def test_no_eta(self):
162
# An old version of the progress bar would
163
# store every update if show_eta was false
164
# because the eta routine was where it was
166
pb = InstrumentedProgress(to_file=StringIO(), show_eta=False)
167
# Just make sure this first few are throttled
170
# These messages are throttled, and don't contribute
171
for count in xrange(100):
172
pb.update('x', count, 300)
173
self.assertEqual(0, len(pb.last_updates))
178
# These happen too fast, so only one gets through
179
for count in xrange(100):
180
pb.update('x', count+100, 200)
181
self.assertEqual(1, len(pb.last_updates))
185
# But all of these go through, don't let the
186
# last_update list grow without bound
187
for count in xrange(100):
188
pb.update('x', count+100, 200)
190
self.assertEqual(pb._max_last_updates, len(pb.last_updates))
193
class TestProgressTypes(TestCase):
194
"""Test that the right ProgressBar gets instantiated at the right time."""
196
def get_nested(self, outf, term, env_progress=None):
197
"""Setup so that ProgressBar thinks we are in the supplied terminal."""
198
orig_term = os.environ.get('TERM')
199
orig_progress = os.environ.get('BZR_PROGRESS_BAR')
200
os.environ['TERM'] = term
201
if env_progress is not None:
202
os.environ['BZR_PROGRESS_BAR'] = env_progress
203
elif orig_progress is not None:
204
del os.environ['BZR_PROGRESS_BAR']
207
if orig_term is None:
208
del os.environ['TERM']
210
os.environ['TERM'] = orig_term
211
# We may have never created BZR_PROGRESS_BAR
212
# So we can't just delete like we can 'TERM' (which is always set)
213
if orig_progress is None:
214
if 'BZR_PROGRESS_BAR' in os.environ:
215
del os.environ['BZR_PROGRESS_BAR']
217
os.environ['BZR_PROGRESS_BAR'] = orig_progress
219
self.addCleanup(reset)
221
stack = self.applyDeprecated(
222
deprecated_in((1, 12, 0)),
225
pb = stack.get_nested()
226
pb.start_time -= 1 # Make sure it is ready to write
227
pb.width = 20 # And it is of reasonable size
230
def test_tty_progress(self):
231
# Make sure the ProgressBarStack thinks it is
232
# writing out to a terminal, and thus uses a TTYProgressBar
234
pb = self.get_nested(out, 'xterm')
235
self.assertIsInstance(pb, TTYProgressBar)
237
pb.update('foo', 1, 2)
238
pb.update('bar', 2, 2)
242
self.assertEqual('\r/ [==== ] foo 1/2'
243
'\r- [=======] bar 2/2'
247
def test_noninteractive_progress(self):
248
out = _NonTTYStringIO()
249
pb = self.get_nested(out, 'xterm')
250
self.assertIsInstance(pb, DummyProgress)
252
pb.update('foo', 1, 2)
253
pb.update('bar', 2, 2)
256
self.assertEqual('', out.getvalue())
258
def test_dots_progress(self):
259
# make sure we get the right progress bar when not on a terminal
260
out = _NonTTYStringIO()
261
pb = self.get_nested(out, 'xterm', 'dots')
262
self.assertIsInstance(pb, DotsProgressBar)
264
pb.update('foo', 1, 2)
265
pb.update('bar', 2, 2)
268
self.assertEqual('foo: .'
273
def test_no_isatty_progress(self):
274
# Make sure ProgressBarStack handles a plain StringIO()
276
out = cStringIO.StringIO()
277
pb = self.get_nested(out, 'xterm')
279
self.assertIsInstance(pb, DummyProgress)
281
def test_dumb_progress(self):
282
# using a terminal that can't do cursor movement
284
pb = self.get_nested(out, 'dumb')
286
self.assertIsInstance(pb, DummyProgress)
288
def test_progress_env_tty(self):
289
# The environ variable BZR_PROGRESS_BAR controls what type of
290
# progress bar we will get, even if it wouldn't usually be that type
293
# Usually, this would be a DotsProgressBar
294
out = cStringIO.StringIO()
295
pb = self.get_nested(out, 'dumb', 'tty')
297
# Even though we are not a tty, the env_var will override
298
self.assertIsInstance(pb, TTYProgressBar)
300
def test_progress_env_none(self):
301
# Even though we are in a valid tty, no progress
303
pb = self.get_nested(out, 'xterm', 'none')
305
self.assertIsInstance(pb, DummyProgress)
307
def test_progress_env_invalid(self):
309
self.assertRaises(errors.InvalidProgressBarType, self.get_nested,
310
out, 'xterm', 'nonexistant')
added
removed
bzrlib/tests/test_progress.py
