1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
# Copyright (C) 2005, 2008, 2009 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Tests for the bzrlib ui
"""
import os
from StringIO import StringIO
import re
import sys
import time
import bzrlib
import bzrlib.errors as errors
from bzrlib.progress import (
DotsProgressBar,
ProgressBarStack,
ProgressTask,
TTYProgressBar,
)
from bzrlib.symbol_versioning import (
deprecated_in,
)
from bzrlib.tests import (
TestCase,
TestUIFactory,
StringIOWrapper,
)
from bzrlib.tests.test_progress import _TTYStringIO
from bzrlib.ui import (
CLIUIFactory,
SilentUIFactory,
)
from bzrlib.ui.text import (
TextProgressView,
TextUIFactory,
)
class UITests(TestCase):
def test_silent_factory(self):
ui = SilentUIFactory()
stdout = StringIO()
self.assertEqual(None,
self.apply_redirected(None, stdout, stdout,
ui.get_password))
self.assertEqual('', stdout.getvalue())
self.assertEqual(None,
self.apply_redirected(None, stdout, stdout,
ui.get_password,
u'Hello\u1234 %(user)s',
user=u'some\u1234'))
self.assertEqual('', stdout.getvalue())
def test_text_factory_ascii_password(self):
ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
pb = ui.nested_progress_bar()
try:
self.assertEqual('secret',
self.apply_redirected(ui.stdin, ui.stdout,
ui.stdout,
ui.get_password))
# ': ' is appended to prompt
self.assertEqual(': ', ui.stdout.getvalue())
# stdin should be empty
self.assertEqual('', ui.stdin.readline())
finally:
pb.finished()
def test_text_factory_utf8_password(self):
"""Test an utf8 password.
We can't predict what encoding users will have for stdin, so we force
it to utf8 to test that we transport the password correctly.
"""
ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
stdout=StringIOWrapper())
ui.stdin.encoding = 'utf8'
ui.stdout.encoding = ui.stdin.encoding
pb = ui.nested_progress_bar()
try:
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
ui.get_password,
u'Hello \u1234 %(user)s',
user=u'some\u1234')
# We use StringIO objects, we need to decode them
self.assertEqual(u'baz\u1234', password.decode('utf8'))
self.assertEqual(u'Hello \u1234 some\u1234: ',
ui.stdout.getvalue().decode('utf8'))
# stdin should be empty
self.assertEqual('', ui.stdin.readline())
finally:
pb.finished()
def test_progress_note(self):
stderr = StringIO()
stdout = StringIO()
ui_factory = TextUIFactory(stdin=StringIO(''),
stderr=stderr,
stdout=stdout)
pb = ui_factory.nested_progress_bar()
try:
result = pb.note('t')
self.assertEqual(None, result)
self.assertEqual("t\n", stdout.getvalue())
# Since there was no update() call, there should be no clear() call
self.failIf(re.search(r'^\r {10,}\r$',
stderr.getvalue()) is not None,
'We cleared the stderr without anything to put there')
finally:
pb.finished()
def test_progress_note_clears(self):
stderr = StringIO()
stdout = StringIO()
# The PQM redirects the output to a file, so it
# defaults to creating a Dots progress bar. we
# need to force it to believe we are a TTY
ui_factory = TextUIFactory(
stdin=StringIO(''),
stdout=stdout, stderr=stderr)
pb = ui_factory.nested_progress_bar()
try:
# Create a progress update that isn't throttled
pb.update('x', 1, 1)
result = pb.note('t')
self.assertEqual(None, result)
self.assertEqual("t\n", stdout.getvalue())
# the exact contents will depend on the terminal width and we don't
# care about that right now - but you're probably running it on at
# least a 10-character wide terminal :)
self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
finally:
pb.finished()
def test_progress_nested(self):
# test factory based nested and popping.
ui = TextUIFactory(None, None, None)
pb1 = ui.nested_progress_bar()
pb2 = ui.nested_progress_bar()
# You do get a warning if the outermost progress bar wasn't finished
# first - it's not clear if this is really useful or if it should just
# become orphaned -- mbp 20090120
warnings, _ = self.callCatchWarnings(pb1.finished)
if len(warnings) != 1:
self.fail("unexpected warnings: %r" % (warnings,))
pb2.finished()
pb1.finished()
def test_progress_stack(self):
# test the progress bar stack which the default text factory
# uses.
stderr = StringIO()
stdout = StringIO()
# make a stack, which accepts parameters like a pb.
stack = self.applyDeprecated(
deprecated_in((1, 12, 0)),
ProgressBarStack,
to_file=stderr, to_messages_file=stdout)
# but is not one
self.assertFalse(getattr(stack, 'note', False))
pb1 = stack.get_nested()
pb2 = stack.get_nested()
warnings, _ = self.callCatchWarnings(pb1.finished)
self.assertEqual(len(warnings), 1)
pb2.finished()
pb1.finished()
# the text ui factory never actually removes the stack once its setup.
# we need to be able to nest again correctly from here.
pb1 = stack.get_nested()
pb2 = stack.get_nested()
warnings, _ = self.callCatchWarnings(pb1.finished)
self.assertEqual(len(warnings), 1)
pb2.finished()
pb1.finished()
def assert_get_bool_acceptance_of_user_input(self, factory):
factory.stdin = StringIO("y\nyes with garbage\n"
"yes\nn\nnot an answer\n"
"no\nfoo\n")
factory.stdout = StringIO()
# there is no output from the base factory
self.assertEqual(True, factory.get_boolean(""))
self.assertEqual(True, factory.get_boolean(""))
self.assertEqual(False, factory.get_boolean(""))
self.assertEqual(False, factory.get_boolean(""))
self.assertEqual("foo\n", factory.stdin.read())
# stdin should be empty
self.assertEqual('', factory.stdin.readline())
def test_silent_ui_getbool(self):
factory = SilentUIFactory()
self.assert_get_bool_acceptance_of_user_input(factory)
def test_silent_factory_prompts_silently(self):
factory = SilentUIFactory()
stdout = StringIO()
factory.stdin = StringIO("y\n")
self.assertEqual(True,
self.apply_redirected(None, stdout, stdout,
factory.get_boolean, "foo"))
self.assertEqual("", stdout.getvalue())
# stdin should be empty
self.assertEqual('', factory.stdin.readline())
def test_text_ui_getbool(self):
factory = TextUIFactory(None, None, None)
self.assert_get_bool_acceptance_of_user_input(factory)
def test_text_factory_prompt(self):
# see <https://launchpad.net/bugs/365891>
factory = TextUIFactory(None, StringIO(), StringIO())
factory.prompt('foo %2e')
def test_text_factory_prompts_and_clears(self):
# a get_boolean call should clear the pb before prompting
out = _TTYStringIO()
factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
pb = factory.nested_progress_bar()
pb.show_bar = False
pb.show_spinner = False
pb.show_count = False
pb.update("foo", 0, 1)
self.assertEqual(True,
self.apply_redirected(None, factory.stdout,
factory.stdout,
factory.get_boolean,
"what do you want"))
output = out.getvalue()
self.assertContainsRe(factory.stdout.getvalue(),
"foo *\r\r *\r*")
self.assertContainsRe(factory.stdout.getvalue(),
r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
# stdin should have been totally consumed
self.assertEqual('', factory.stdin.readline())
def test_text_tick_after_update(self):
ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
pb = ui_factory.nested_progress_bar()
try:
pb.update('task', 0, 3)
# Reset the clock, so that it actually tries to repaint itself
ui_factory._progress_view._last_repaint = time.time() - 1.0
pb.tick()
finally:
pb.finished()
def test_silent_ui_getusername(self):
factory = SilentUIFactory()
factory.stdin = StringIO("someuser\n\n")
factory.stdout = StringIO()
self.assertEquals(None,
factory.get_username(u'Hello\u1234 %(host)s', host=u'some\u1234'))
self.assertEquals("", factory.stdout.getvalue())
self.assertEquals("someuser\n\n", factory.stdin.getvalue())
def test_text_ui_getusername(self):
factory = TextUIFactory(None, None, None)
factory.stdin = StringIO("someuser\n\n")
factory.stdout = StringIO()
factory.stdout.encoding = "utf8"
# there is no output from the base factory
self.assertEqual("someuser",
factory.get_username('Hello %(host)s', host='some'))
self.assertEquals("Hello some: ", factory.stdout.getvalue())
self.assertEqual("", factory.get_username("Gebruiker"))
# stdin should be empty
self.assertEqual('', factory.stdin.readline())
def test_text_ui_getusername_utf8(self):
ui = TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
stdout=StringIOWrapper())
ui.stdin.encoding = "utf8"
ui.stdout.encoding = ui.stdin.encoding
pb = ui.nested_progress_bar()
try:
# there is no output from the base factory
username = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
self.assertEquals(u"someuser\u1234", username.decode('utf8'))
self.assertEquals(u"Hello\u1234 some\u1234: ",
ui.stdout.getvalue().decode("utf8"))
finally:
pb.finished()
class TestTextProgressView(TestCase):
"""Tests for text display of progress bars.
"""
# XXX: These might be a bit easier to write if the rendering and
# state-maintaining parts of TextProgressView were more separate, and if
# the progress task called back directly to its own view not to the ui
# factory. -- mbp 20090312
def _make_factory(self):
out = StringIO()
uif = TextUIFactory(stderr=out)
uif._progress_view._width = 80
return out, uif
def test_render_progress_easy(self):
"""Just one task and one quarter done"""
out, uif = self._make_factory()
task = uif.nested_progress_bar()
task.update('reticulating splines', 5, 20)
self.assertEqual(
'\r[####/ ] reticulating splines 5/20 \r'
, out.getvalue())
def test_render_progress_nested(self):
"""Tasks proportionally contribute to overall progress"""
out, uif = self._make_factory()
task = uif.nested_progress_bar()
task.update('reticulating splines', 0, 2)
task2 = uif.nested_progress_bar()
task2.update('stage2', 1, 2)
# so we're in the first half of the main task, and half way through
# that
self.assertEqual(
r'[####\ ] reticulating splines:stage2 1/2'
, uif._progress_view._render_line())
# if the nested task is complete, then we're all the way through the
# first half of the overall work
task2.update('stage2', 2, 2)
self.assertEqual(
r'[#########| ] reticulating splines:stage2 2/2'
, uif._progress_view._render_line())
def test_render_progress_sub_nested(self):
"""Intermediate tasks don't mess up calculation."""
out, uif = self._make_factory()
task_a = uif.nested_progress_bar()
task_a.update('a', 0, 2)
task_b = uif.nested_progress_bar()
task_b.update('b')
task_c = uif.nested_progress_bar()
task_c.update('c', 1, 2)
# the top-level task is in its first half; the middle one has no
# progress indication, just a label; and the bottom one is half done,
# so the overall fraction is 1/4
self.assertEqual(
r'[####| ] a:b:c 1/2'
, uif._progress_view._render_line())
|