1
# Copyright (C) 2005, 2008, 2009, 2010 Canonical Ltd
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.
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.
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
17
"""Tests for the bzrlib ui
24
from StringIO import StringIO
33
from bzrlib.symbol_versioning import (
36
from bzrlib.tests import test_progress
37
from bzrlib.ui import text as _mod_ui_text
40
class TestTextUIFactory(tests.TestCase):
42
def test_text_factory_ascii_password(self):
43
ui = tests.TestUIFactory(stdin='secret\n',
44
stdout=tests.StringIOWrapper(),
45
stderr=tests.StringIOWrapper())
46
pb = ui.nested_progress_bar()
48
self.assertEqual('secret',
49
self.apply_redirected(ui.stdin, ui.stdout,
52
# ': ' is appended to prompt
53
self.assertEqual(': ', ui.stderr.getvalue())
54
self.assertEqual('', ui.stdout.readline())
55
# stdin should be empty
56
self.assertEqual('', ui.stdin.readline())
60
def test_text_factory_utf8_password(self):
61
"""Test an utf8 password.
63
We can't predict what encoding users will have for stdin, so we force
64
it to utf8 to test that we transport the password correctly.
66
ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
67
stdout=tests.StringIOWrapper(),
68
stderr=tests.StringIOWrapper())
69
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
70
pb = ui.nested_progress_bar()
72
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
74
u'Hello \u1234 %(user)s',
76
# We use StringIO objects, we need to decode them
77
self.assertEqual(u'baz\u1234', password.decode('utf8'))
78
self.assertEqual(u'Hello \u1234 some\u1234: ',
79
ui.stderr.getvalue().decode('utf8'))
80
# stdin and stdout should be empty
81
self.assertEqual('', ui.stdin.readline())
82
self.assertEqual('', ui.stdout.readline())
86
def test_progress_note(self):
87
stderr = tests.StringIOWrapper()
88
stdout = tests.StringIOWrapper()
89
ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
92
pb = ui_factory.nested_progress_bar()
94
result = self.applyDeprecated(deprecated_in((2, 1, 0)),
97
self.assertEqual(None, result)
98
self.assertEqual("t\n", stdout.getvalue())
99
# Since there was no update() call, there should be no clear() call
100
self.failIf(re.search(r'^\r {10,}\r$',
101
stderr.getvalue()) is not None,
102
'We cleared the stderr without anything to put there')
106
def test_progress_note_clears(self):
107
stderr = test_progress._TTYStringIO()
108
stdout = test_progress._TTYStringIO()
109
# so that we get a TextProgressBar
110
os.environ['TERM'] = 'xterm'
111
ui_factory = _mod_ui_text.TextUIFactory(
112
stdin=tests.StringIOWrapper(''),
113
stdout=stdout, stderr=stderr)
114
self.assertIsInstance(ui_factory._progress_view,
115
_mod_ui_text.TextProgressView)
116
pb = ui_factory.nested_progress_bar()
118
# Create a progress update that isn't throttled
120
result = self.applyDeprecated(deprecated_in((2, 1, 0)),
122
self.assertEqual(None, result)
123
self.assertEqual("t\n", stdout.getvalue())
124
# the exact contents will depend on the terminal width and we don't
125
# care about that right now - but you're probably running it on at
126
# least a 10-character wide terminal :)
127
self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
131
def test_progress_nested(self):
132
# test factory based nested and popping.
133
ui = _mod_ui_text.TextUIFactory(None, None, None)
134
pb1 = ui.nested_progress_bar()
135
pb2 = ui.nested_progress_bar()
136
# You do get a warning if the outermost progress bar wasn't finished
137
# first - it's not clear if this is really useful or if it should just
138
# become orphaned -- mbp 20090120
139
warnings, _ = self.callCatchWarnings(pb1.finished)
140
if len(warnings) != 1:
141
self.fail("unexpected warnings: %r" % (warnings,))
145
def test_text_ui_get_boolean(self):
146
stdin = tests.StringIOWrapper("y\n" # True
148
"yes with garbage\nY\n" # True
149
"not an answer\nno\n" # False
150
"I'm sure!\nyes\n" # True
153
stdout = tests.StringIOWrapper()
154
stderr = tests.StringIOWrapper()
155
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
156
self.assertEqual(True, factory.get_boolean(""))
157
self.assertEqual(False, factory.get_boolean(""))
158
self.assertEqual(True, factory.get_boolean(""))
159
self.assertEqual(False, factory.get_boolean(""))
160
self.assertEqual(True, factory.get_boolean(""))
161
self.assertEqual(False, factory.get_boolean(""))
162
self.assertEqual("foo\n", factory.stdin.read())
163
# stdin should be empty
164
self.assertEqual('', factory.stdin.readline())
166
def test_text_ui_get_integer(self):
167
stdin = tests.StringIOWrapper(
170
"hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
171
stdout = tests.StringIOWrapper()
172
stderr = tests.StringIOWrapper()
173
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
174
self.assertEqual(1, factory.get_integer(""))
175
self.assertEqual(-2, factory.get_integer(""))
176
self.assertEqual(42, factory.get_integer(""))
178
def test_text_factory_prompt(self):
179
# see <https://launchpad.net/bugs/365891>
180
StringIO = tests.StringIOWrapper
181
factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
182
factory.prompt('foo %2e')
183
self.assertEqual('', factory.stdout.getvalue())
184
self.assertEqual('foo %2e', factory.stderr.getvalue())
186
def test_text_factory_prompts_and_clears(self):
187
# a get_boolean call should clear the pb before prompting
188
out = test_progress._TTYStringIO()
189
os.environ['TERM'] = 'xterm'
190
factory = _mod_ui_text.TextUIFactory(
191
stdin=tests.StringIOWrapper("yada\ny\n"),
192
stdout=out, stderr=out)
193
pb = factory.nested_progress_bar()
195
pb.show_spinner = False
196
pb.show_count = False
197
pb.update("foo", 0, 1)
198
self.assertEqual(True,
199
self.apply_redirected(None, factory.stdout,
203
output = out.getvalue()
204
self.assertContainsRe(factory.stdout.getvalue(),
206
self.assertContainsRe(factory.stdout.getvalue(),
207
r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
208
# stdin should have been totally consumed
209
self.assertEqual('', factory.stdin.readline())
211
def test_text_tick_after_update(self):
212
ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
213
stderr=tests.StringIOWrapper())
214
pb = ui_factory.nested_progress_bar()
216
pb.update('task', 0, 3)
217
# Reset the clock, so that it actually tries to repaint itself
218
ui_factory._progress_view._last_repaint = time.time() - 1.0
223
def test_text_ui_getusername(self):
224
factory = _mod_ui_text.TextUIFactory(None, None, None)
225
factory.stdin = tests.StringIOWrapper("someuser\n\n")
226
factory.stdout = tests.StringIOWrapper()
227
factory.stderr = tests.StringIOWrapper()
228
factory.stdout.encoding = "utf8"
229
# there is no output from the base factory
230
self.assertEqual("someuser",
231
factory.get_username('Hello %(host)s', host='some'))
232
self.assertEquals("Hello some: ", factory.stderr.getvalue())
233
self.assertEquals('', factory.stdout.getvalue())
234
self.assertEqual("", factory.get_username("Gebruiker"))
235
# stdin should be empty
236
self.assertEqual('', factory.stdin.readline())
238
def test_text_ui_getusername_utf8(self):
239
ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
240
stdout=tests.StringIOWrapper(),
241
stderr=tests.StringIOWrapper())
242
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
243
pb = ui.nested_progress_bar()
245
# there is no output from the base factory
246
username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
247
ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
248
self.assertEquals(u"someuser\u1234", username.decode('utf8'))
249
self.assertEquals(u"Hello\u1234 some\u1234: ",
250
ui.stderr.getvalue().decode("utf8"))
251
self.assertEquals('', ui.stdout.getvalue())
255
def test_quietness(self):
256
os.environ['BZR_PROGRESS_BAR'] = 'text'
257
ui_factory = _mod_ui_text.TextUIFactory(None,
258
test_progress._TTYStringIO(),
259
test_progress._TTYStringIO())
260
self.assertIsInstance(ui_factory._progress_view,
261
_mod_ui_text.TextProgressView)
262
ui_factory.be_quiet(True)
263
self.assertIsInstance(ui_factory._progress_view,
264
_mod_ui_text.NullProgressView)
266
def test_text_ui_show_user_warning(self):
267
from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
268
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
271
ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
272
remote_fmt = remote.RemoteRepositoryFormat()
273
remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
274
ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
275
to_format=remote_fmt)
276
self.assertEquals('', out.getvalue())
277
self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
278
"RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
279
"(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
280
"the same format for better performance.\n",
282
# and now with it suppressed please
285
ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
286
ui.suppressed_warnings.add('cross_format_fetch')
287
ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
288
to_format=remote_fmt)
289
self.assertEquals('', out.getvalue())
290
self.assertEquals('', err.getvalue())
293
class TestTextUIOutputStream(tests.TestCase):
294
"""Tests for output stream that synchronizes with progress bar."""
296
def test_output_clears_terminal(self):
297
stdout = tests.StringIOWrapper()
298
stderr = tests.StringIOWrapper()
301
uif = _mod_ui_text.TextUIFactory(None, stdout, stderr)
302
uif.clear_term = lambda: clear_calls.append('clear')
304
stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
305
stream.write("Hello world!\n")
306
stream.write("there's more...\n")
307
stream.writelines(["1\n", "2\n", "3\n"])
309
self.assertEqual(stdout.getvalue(),
313
self.assertEqual(['clear', 'clear', 'clear'],
319
class UITests(tests.TestCase):
321
def test_progress_construction(self):
322
"""TextUIFactory constructs the right progress view.
324
TTYStringIO = test_progress._TTYStringIO
325
FileStringIO = tests.StringIOWrapper
326
for (file_class, term, pb, expected_pb_class) in (
327
# on an xterm, either use them or not as the user requests,
328
# otherwise default on
329
(TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
330
(TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
331
(TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
332
# on a dumb terminal, again if there's explicit configuration do
333
# it, otherwise default off
334
(TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
335
(TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
336
(TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
337
# on a non-tty terminal, it's null regardless of $TERM
338
(FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
339
(FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
340
# however, it can still be forced on
341
(FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
343
os.environ['TERM'] = term
345
if 'BZR_PROGRESS_BAR' in os.environ:
346
del os.environ['BZR_PROGRESS_BAR']
348
os.environ['BZR_PROGRESS_BAR'] = pb
349
stdin = file_class('')
350
stderr = file_class()
351
stdout = file_class()
352
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
353
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
354
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
355
self.assertIsInstance(uif.make_progress_view(),
357
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
359
def test_text_ui_non_terminal(self):
360
"""Even on non-ttys, make_ui_for_terminal gives a text ui."""
361
stdin = test_progress._NonTTYStringIO('')
362
stderr = test_progress._NonTTYStringIO()
363
stdout = test_progress._NonTTYStringIO()
364
for term_type in ['dumb', None, 'xterm']:
365
if term_type is None:
366
del os.environ['TERM']
368
os.environ['TERM'] = term_type
369
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
370
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
371
'TERM=%r' % (term_type,))
374
class SilentUITests(tests.TestCase):
376
def test_silent_factory_get_password(self):
377
# A silent factory that can't do user interaction can't get a
378
# password. Possibly it should raise a more specific error but it
380
ui = _mod_ui.SilentUIFactory()
381
stdout = tests.StringIOWrapper()
384
self.apply_redirected,
385
None, stdout, stdout, ui.get_password)
386
# and it didn't write anything out either
387
self.assertEqual('', stdout.getvalue())
389
def test_silent_ui_getbool(self):
390
factory = _mod_ui.SilentUIFactory()
391
stdout = tests.StringIOWrapper()
394
self.apply_redirected,
395
None, stdout, stdout, factory.get_boolean, "foo")
398
class TestUIFactoryTests(tests.TestCase):
400
def test_test_ui_factory_progress(self):
401
# there's no output; we just want to make sure this doesn't crash -
402
# see https://bugs.edge.launchpad.net/bzr/+bug/408201
403
ui = tests.TestUIFactory()
404
pb = ui.nested_progress_bar()
410
class CannedInputUIFactoryTests(tests.TestCase):
412
def test_canned_input_get_input(self):
413
uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
414
self.assertEqual(True, uif.get_boolean('Extra cheese?'))
415
self.assertEqual('mbp', uif.get_username('Enter your user name'))
416
self.assertEqual('password',
417
uif.get_password('Password for %(host)s',
419
self.assertEqual(42, uif.get_integer('And all that jazz ?'))
422
class TestBoolFromString(tests.TestCase):
424
def assertIsTrue(self, s, accepted_values=None):
425
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
426
self.assertEquals(True, res)
428
def assertIsFalse(self, s, accepted_values=None):
429
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
430
self.assertEquals(False, res)
432
def assertIsNone(self, s, accepted_values=None):
433
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
434
self.assertIs(None, res)
436
def test_know_valid_values(self):
437
self.assertIsTrue('true')
438
self.assertIsFalse('false')
439
self.assertIsTrue('1')
440
self.assertIsFalse('0')
441
self.assertIsTrue('on')
442
self.assertIsFalse('off')
443
self.assertIsTrue('yes')
444
self.assertIsFalse('no')
445
self.assertIsTrue('y')
446
self.assertIsFalse('n')
447
# Also try some case variations
448
self.assertIsTrue('True')
449
self.assertIsFalse('False')
450
self.assertIsTrue('On')
451
self.assertIsFalse('Off')
452
self.assertIsTrue('ON')
453
self.assertIsFalse('OFF')
454
self.assertIsTrue('oN')
455
self.assertIsFalse('oFf')
457
def test_invalid_values(self):
458
self.assertIsNone(None)
459
self.assertIsNone('doubt')
460
self.assertIsNone('frue')
461
self.assertIsNone('talse')
462
self.assertIsNone('42')
464
def test_provided_values(self):
465
av = dict(y=True, n=False, yes=True, no=False)
466
self.assertIsTrue('y', av)
467
self.assertIsTrue('Y', av)
468
self.assertIsTrue('Yes', av)
469
self.assertIsFalse('n', av)
470
self.assertIsFalse('N', av)
471
self.assertIsFalse('No', av)
472
self.assertIsNone('1', av)
473
self.assertIsNone('0', av)
474
self.assertIsNone('on', av)
475
self.assertIsNone('off', av)