1
# Copyright (C) 2005-2011 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
22
from StringIO import StringIO
24
from testtools.matchers import *
32
from bzrlib.tests import (
35
from bzrlib.ui import text as _mod_ui_text
36
from bzrlib.tests.testui import (
37
ProgressRecordingUIFactory,
41
class TTYStringIO(StringIO):
42
"""A helper class which makes a StringIO look like a terminal"""
48
class NonTTYStringIO(StringIO):
49
"""Helper that implements isatty() but returns False"""
55
class TestUIConfiguration(tests.TestCaseWithTransport):
57
def test_output_encoding_configuration(self):
58
enc = fixtures.generate_unicode_encodings().next()
59
config.GlobalStack().set('output_encoding', enc)
60
ui = tests.TestUIFactory(stdin=None,
61
stdout=tests.StringIOWrapper(),
62
stderr=tests.StringIOWrapper())
63
output = ui.make_output_stream()
64
self.assertEquals(output.encoding, enc)
67
class TestTextUIFactory(tests.TestCase):
69
def make_test_ui_factory(self, stdin_contents):
70
ui = tests.TestUIFactory(stdin=stdin_contents,
71
stdout=tests.StringIOWrapper(),
72
stderr=tests.StringIOWrapper())
75
def test_text_factory_confirm(self):
76
# turns into reading a regular boolean
77
ui = self.make_test_ui_factory('n\n')
78
self.assertEquals(ui.confirm_action(u'Should %(thing)s pass?',
79
'bzrlib.tests.test_ui.confirmation',
83
def test_text_factory_ascii_password(self):
84
ui = self.make_test_ui_factory('secret\n')
85
pb = ui.nested_progress_bar()
87
self.assertEqual('secret',
88
self.apply_redirected(ui.stdin, ui.stdout,
91
# ': ' is appended to prompt
92
self.assertEqual(': ', ui.stderr.getvalue())
93
self.assertEqual('', ui.stdout.readline())
94
# stdin should be empty
95
self.assertEqual('', ui.stdin.readline())
99
def test_text_factory_utf8_password(self):
100
"""Test an utf8 password."""
101
ui = _mod_ui_text.TextUIFactory(None, None, None)
102
ui.stdin = tests.StringIOWrapper(u'baz\u1234'.encode('utf8'))
103
ui.stdout = tests.StringIOWrapper()
104
ui.stderr = tests.StringIOWrapper()
105
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
106
password = ui.get_password(u'Hello \u1234 %(user)s', user=u'some\u1234')
107
self.assertEqual(u'baz\u1234', password)
108
self.assertEqual(u'Hello \u1234 some\u1234: ',
109
ui.stderr.getvalue().decode('utf8'))
110
# stdin and stdout should be empty
111
self.assertEqual('', ui.stdin.readline())
112
self.assertEqual('', ui.stdout.getvalue())
114
def test_text_ui_get_boolean(self):
115
stdin = tests.StringIOWrapper("y\n" # True
119
"yes with garbage\nY\n" # True
120
"not an answer\nno\n" # False
121
"I'm sure!\nyes\n" # True
124
stdout = tests.StringIOWrapper()
125
stderr = tests.StringIOWrapper()
126
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
127
self.assertEqual(True, factory.get_boolean(u""))
128
self.assertEqual(False, factory.get_boolean(u""))
129
self.assertEqual(True, factory.get_boolean(u""))
130
self.assertEqual(False, factory.get_boolean(u""))
131
self.assertEqual(True, factory.get_boolean(u""))
132
self.assertEqual(False, factory.get_boolean(u""))
133
self.assertEqual(True, factory.get_boolean(u""))
134
self.assertEqual(False, factory.get_boolean(u""))
135
self.assertEqual("foo\n", factory.stdin.read())
136
# stdin should be empty
137
self.assertEqual('', factory.stdin.readline())
138
# return false on EOF
139
self.assertEqual(False, factory.get_boolean(u""))
141
def test_text_ui_choose_bad_parameters(self):
142
stdin = tests.StringIOWrapper()
143
stdout = tests.StringIOWrapper()
144
stderr = tests.StringIOWrapper()
145
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
146
# invalid default index
147
self.assertRaises(ValueError, factory.choose, u"", u"&Yes\n&No", 3)
149
self.assertRaises(ValueError, factory.choose, u"", u"&choice\n&ChOiCe")
150
# duplicated shortcut
151
self.assertRaises(ValueError, factory.choose, u"", u"&choice1\nchoi&ce2")
153
def test_text_ui_choose_prompt(self):
154
stdin = tests.StringIOWrapper()
155
stdout = tests.StringIOWrapper()
156
stderr = tests.StringIOWrapper()
157
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
158
# choices with explicit shortcuts
159
factory.choose(u"prompt", u"&yes\n&No\nmore &info")
160
self.assertEqual("prompt ([y]es, [N]o, more [i]nfo): \n", factory.stderr.getvalue())
161
# automatic shortcuts
162
factory.stderr.truncate(0)
163
factory.choose(u"prompt", u"yes\nNo\nmore info")
164
self.assertEqual("prompt ([y]es, [N]o, [m]ore info): \n", factory.stderr.getvalue())
166
def test_text_ui_choose_return_values(self):
167
choose = lambda: factory.choose(u"", u"&Yes\n&No\nMaybe\nmore &info", 3)
168
stdin = tests.StringIOWrapper("y\n" # 0
172
"b\na\nd \n" # bad shortcuts, all ignored
173
"yes with garbage\nY\n" # 0
174
"not an answer\nno\n" # 1
175
"info\nmore info\n" # 3
178
stdout = tests.StringIOWrapper()
179
stderr = tests.StringIOWrapper()
180
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
181
self.assertEqual(0, choose())
182
self.assertEqual(1, choose())
183
self.assertEqual(3, choose())
184
self.assertEqual(1, choose())
185
self.assertEqual(0, choose())
186
self.assertEqual(1, choose())
187
self.assertEqual(3, choose())
188
self.assertEqual(2, choose())
189
self.assertEqual("foo\n", factory.stdin.read())
190
# stdin should be empty
191
self.assertEqual('', factory.stdin.readline())
193
self.assertEqual(None, choose())
195
def test_text_ui_choose_no_default(self):
196
stdin = tests.StringIOWrapper(" \n" # no default, invalid!
199
stdout = tests.StringIOWrapper()
200
stderr = tests.StringIOWrapper()
201
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
202
self.assertEqual(0, factory.choose(u"", u"&Yes\n&No"))
203
self.assertEqual("foo\n", factory.stdin.read())
205
def test_text_ui_get_integer(self):
206
stdin = tests.StringIOWrapper(
209
"hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
210
stdout = tests.StringIOWrapper()
211
stderr = tests.StringIOWrapper()
212
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
213
self.assertEqual(1, factory.get_integer(u""))
214
self.assertEqual(-2, factory.get_integer(u""))
215
self.assertEqual(42, factory.get_integer(u""))
217
def test_text_factory_prompt(self):
218
# see <https://launchpad.net/bugs/365891>
219
StringIO = tests.StringIOWrapper
220
factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
221
factory.prompt(u'foo %2e')
222
self.assertEqual('', factory.stdout.getvalue())
223
self.assertEqual('foo %2e', factory.stderr.getvalue())
225
def test_text_factory_prompts_and_clears(self):
226
# a get_boolean call should clear the pb before prompting
228
self.overrideEnv('TERM', 'xterm')
229
factory = _mod_ui_text.TextUIFactory(
230
stdin=tests.StringIOWrapper("yada\ny\n"),
231
stdout=out, stderr=out)
232
factory._avail_width = lambda: 79
233
pb = factory.nested_progress_bar()
235
pb.show_spinner = False
236
pb.show_count = False
237
pb.update("foo", 0, 1)
238
self.assertEqual(True,
239
self.apply_redirected(None, factory.stdout,
242
u"what do you want"))
243
output = out.getvalue()
244
self.assertContainsRe(output,
246
self.assertContainsString(output,
247
r"what do you want? ([y]es, [n]o): what do you want? ([y]es, [n]o): ")
248
# stdin should have been totally consumed
249
self.assertEqual('', factory.stdin.readline())
251
def test_text_tick_after_update(self):
252
ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
253
stderr=tests.StringIOWrapper())
254
pb = ui_factory.nested_progress_bar()
256
pb.update('task', 0, 3)
257
# Reset the clock, so that it actually tries to repaint itself
258
ui_factory._progress_view._last_repaint = time.time() - 1.0
263
def test_text_ui_getusername(self):
264
ui = _mod_ui_text.TextUIFactory(None, None, None)
265
ui.stdin = tests.StringIOWrapper('someuser\n\n')
266
ui.stdout = tests.StringIOWrapper()
267
ui.stderr = tests.StringIOWrapper()
268
ui.stdout.encoding = 'utf8'
269
self.assertEqual('someuser',
270
ui.get_username(u'Hello %(host)s', host='some'))
271
self.assertEquals('Hello some: ', ui.stderr.getvalue())
272
self.assertEquals('', ui.stdout.getvalue())
273
self.assertEqual('', ui.get_username(u"Gebruiker"))
274
# stdin should be empty
275
self.assertEqual('', ui.stdin.readline())
277
def test_text_ui_getusername_utf8(self):
278
ui = _mod_ui_text.TextUIFactory(None, None, None)
279
ui.stdin = tests.StringIOWrapper(u'someuser\u1234'.encode('utf8'))
280
ui.stdout = tests.StringIOWrapper()
281
ui.stderr = tests.StringIOWrapper()
282
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
283
username = ui.get_username(u'Hello %(host)s', host=u'some\u1234')
284
self.assertEquals(u"someuser\u1234", username)
285
self.assertEquals(u"Hello some\u1234: ",
286
ui.stderr.getvalue().decode("utf8"))
287
self.assertEquals('', ui.stdout.getvalue())
289
def test_quietness(self):
290
self.overrideEnv('BZR_PROGRESS_BAR', 'text')
291
ui_factory = _mod_ui_text.TextUIFactory(None,
294
self.assertIsInstance(ui_factory._progress_view,
295
_mod_ui_text.TextProgressView)
296
ui_factory.be_quiet(True)
297
self.assertIsInstance(ui_factory._progress_view,
298
_mod_ui_text.NullProgressView)
300
def test_text_ui_show_user_warning(self):
301
from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
302
from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack5
305
ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
306
remote_fmt = remote.RemoteRepositoryFormat()
307
remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
308
ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
309
to_format=remote_fmt)
310
self.assertEquals('', out.getvalue())
311
self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
312
"RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
313
"(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
314
"the same format for better performance.\n",
316
# and now with it suppressed please
319
ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
320
ui.suppressed_warnings.add('cross_format_fetch')
321
ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
322
to_format=remote_fmt)
323
self.assertEquals('', out.getvalue())
324
self.assertEquals('', err.getvalue())
327
class TestTextUIOutputStream(tests.TestCase):
328
"""Tests for output stream that synchronizes with progress bar."""
330
def test_output_clears_terminal(self):
331
stdout = tests.StringIOWrapper()
332
stderr = tests.StringIOWrapper()
335
uif = _mod_ui_text.TextUIFactory(None, stdout, stderr)
336
uif.clear_term = lambda: clear_calls.append('clear')
338
stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
339
stream.write("Hello world!\n")
340
stream.write("there's more...\n")
341
stream.writelines(["1\n", "2\n", "3\n"])
343
self.assertEqual(stdout.getvalue(),
347
self.assertEqual(['clear', 'clear', 'clear'],
353
class UITests(tests.TestCase):
355
def test_progress_construction(self):
356
"""TextUIFactory constructs the right progress view.
358
FileStringIO = tests.StringIOWrapper
359
for (file_class, term, pb, expected_pb_class) in (
360
# on an xterm, either use them or not as the user requests,
361
# otherwise default on
362
(TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
363
(TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
364
(TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
365
# on a dumb terminal, again if there's explicit configuration do
366
# it, otherwise default off
367
(TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
368
(TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
369
(TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
370
# on a non-tty terminal, it's null regardless of $TERM
371
(FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
372
(FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
373
# however, it can still be forced on
374
(FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
376
self.overrideEnv('TERM', term)
377
self.overrideEnv('BZR_PROGRESS_BAR', pb)
378
stdin = file_class('')
379
stderr = file_class()
380
stdout = file_class()
381
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
382
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
383
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
384
self.assertIsInstance(uif.make_progress_view(),
386
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
388
def test_text_ui_non_terminal(self):
389
"""Even on non-ttys, make_ui_for_terminal gives a text ui."""
390
stdin = NonTTYStringIO('')
391
stderr = NonTTYStringIO()
392
stdout = NonTTYStringIO()
393
for term_type in ['dumb', None, 'xterm']:
394
self.overrideEnv('TERM', term_type)
395
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
396
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
397
'TERM=%r' % (term_type,))
400
class SilentUITests(tests.TestCase):
402
def test_silent_factory_get_password(self):
403
# A silent factory that can't do user interaction can't get a
404
# password. Possibly it should raise a more specific error but it
406
ui = _mod_ui.SilentUIFactory()
407
stdout = tests.StringIOWrapper()
410
self.apply_redirected,
411
None, stdout, stdout, ui.get_password)
412
# and it didn't write anything out either
413
self.assertEqual('', stdout.getvalue())
415
def test_silent_ui_getbool(self):
416
factory = _mod_ui.SilentUIFactory()
417
stdout = tests.StringIOWrapper()
420
self.apply_redirected,
421
None, stdout, stdout, factory.get_boolean, u"foo")
424
class TestUIFactoryTests(tests.TestCase):
426
def test_test_ui_factory_progress(self):
427
# there's no output; we just want to make sure this doesn't crash -
428
# see https://bugs.launchpad.net/bzr/+bug/408201
429
ui = tests.TestUIFactory()
430
pb = ui.nested_progress_bar()
436
class CannedInputUIFactoryTests(tests.TestCase):
438
def test_canned_input_get_input(self):
439
uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
440
self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
441
self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
442
self.assertEqual('password',
443
uif.get_password(u'Password for %(host)s',
445
self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
448
class TestBoolFromString(tests.TestCase):
450
def assertIsTrue(self, s, accepted_values=None):
451
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
452
self.assertEquals(True, res)
454
def assertIsFalse(self, s, accepted_values=None):
455
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
456
self.assertEquals(False, res)
458
def assertIsNone(self, s, accepted_values=None):
459
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
460
self.assertIs(None, res)
462
def test_know_valid_values(self):
463
self.assertIsTrue('true')
464
self.assertIsFalse('false')
465
self.assertIsTrue('1')
466
self.assertIsFalse('0')
467
self.assertIsTrue('on')
468
self.assertIsFalse('off')
469
self.assertIsTrue('yes')
470
self.assertIsFalse('no')
471
self.assertIsTrue('y')
472
self.assertIsFalse('n')
473
# Also try some case variations
474
self.assertIsTrue('True')
475
self.assertIsFalse('False')
476
self.assertIsTrue('On')
477
self.assertIsFalse('Off')
478
self.assertIsTrue('ON')
479
self.assertIsFalse('OFF')
480
self.assertIsTrue('oN')
481
self.assertIsFalse('oFf')
483
def test_invalid_values(self):
484
self.assertIsNone(None)
485
self.assertIsNone('doubt')
486
self.assertIsNone('frue')
487
self.assertIsNone('talse')
488
self.assertIsNone('42')
490
def test_provided_values(self):
491
av = dict(y=True, n=False, yes=True, no=False)
492
self.assertIsTrue('y', av)
493
self.assertIsTrue('Y', av)
494
self.assertIsTrue('Yes', av)
495
self.assertIsFalse('n', av)
496
self.assertIsFalse('N', av)
497
self.assertIsFalse('No', av)
498
self.assertIsNone('1', av)
499
self.assertIsNone('0', av)
500
self.assertIsNone('on', av)
501
self.assertIsNone('off', av)
504
class TestConfirmationUserInterfacePolicy(tests.TestCase):
506
def test_confirm_action_default(self):
507
base_ui = _mod_ui.NoninteractiveUIFactory()
508
for answer in [True, False]:
510
_mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
511
.confirm_action("Do something?",
512
"bzrlib.tests.do_something", {}),
515
def test_confirm_action_specific(self):
516
base_ui = _mod_ui.NoninteractiveUIFactory()
517
for default_answer in [True, False]:
518
for specific_answer in [True, False]:
519
for conf_id in ['given_id', 'other_id']:
520
wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
521
base_ui, default_answer, dict(given_id=specific_answer))
522
result = wrapper.confirm_action("Do something?", conf_id, {})
523
if conf_id == 'given_id':
524
self.assertEquals(result, specific_answer)
526
self.assertEquals(result, default_answer)
529
base_ui = _mod_ui.NoninteractiveUIFactory()
530
wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
531
base_ui, True, dict(a=2))
532
self.assertThat(repr(wrapper),
533
Equals("ConfirmationUserInterfacePolicy("
534
"NoninteractiveUIFactory(), True, {'a': 2})"))
537
class TestProgressRecordingUI(tests.TestCase):
538
"""Test test-oriented UIFactory that records progress updates"""
540
def test_nested_ignore_depth_beyond_one(self):
541
# we only want to capture the first level out progress, not
542
# want sub-components might do. So we have nested bars ignored.
543
factory = ProgressRecordingUIFactory()
544
pb1 = factory.nested_progress_bar()
545
pb1.update('foo', 0, 1)
546
pb2 = factory.nested_progress_bar()
547
pb2.update('foo', 0, 1)
550
self.assertEqual([("update", 0, 1, 'foo')], factory._calls)
added
removed
bzrlib/tests/test_ui.py
