13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Tests for the bzrlib ui
23
21
from StringIO import StringIO
25
from testtools.matchers import *
35
from bzrlib.symbol_versioning import (
38
from bzrlib.tests import (
42
from bzrlib.ui import text as _mod_ui_text
43
from bzrlib.tests.testui import (
44
ProgressRecordingUIFactory,
48
class TestUIConfiguration(tests.TestCaseWithTransport):
50
def test_output_encoding_configuration(self):
51
enc = fixtures.generate_unicode_encodings().next()
52
config.GlobalConfig().set_user_option('output_encoding',
54
ui = tests.TestUIFactory(stdin=None,
55
stdout=tests.StringIOWrapper(),
56
stderr=tests.StringIOWrapper())
57
output = ui.make_output_stream()
58
self.assertEquals(output.encoding, enc)
61
class TestTextUIFactory(tests.TestCase):
63
def make_test_ui_factory(self, stdin_contents):
64
ui = tests.TestUIFactory(stdin=stdin_contents,
65
stdout=tests.StringIOWrapper(),
66
stderr=tests.StringIOWrapper())
69
def test_text_factory_confirm(self):
70
# turns into reading a regular boolean
71
ui = self.make_test_ui_factory('n\n')
72
self.assertEquals(ui.confirm_action('Should %(thing)s pass?',
73
'bzrlib.tests.test_ui.confirmation',
77
def test_text_factory_ascii_password(self):
78
ui = self.make_test_ui_factory('secret\n')
79
pb = ui.nested_progress_bar()
81
self.assertEqual('secret',
82
self.apply_redirected(ui.stdin, ui.stdout,
85
# ': ' is appended to prompt
86
self.assertEqual(': ', ui.stderr.getvalue())
87
self.assertEqual('', ui.stdout.readline())
88
# stdin should be empty
89
self.assertEqual('', ui.stdin.readline())
93
def test_text_factory_utf8_password(self):
94
"""Test an utf8 password.
96
We can't predict what encoding users will have for stdin, so we force
97
it to utf8 to test that we transport the password correctly.
99
ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
100
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
101
pb = ui.nested_progress_bar()
103
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
105
u'Hello \u1234 %(user)s',
107
# We use StringIO objects, we need to decode them
108
self.assertEqual(u'baz\u1234', password.decode('utf8'))
109
self.assertEqual(u'Hello \u1234 some\u1234: ',
110
ui.stderr.getvalue().decode('utf8'))
111
# stdin and stdout should be empty
112
self.assertEqual('', ui.stdin.readline())
113
self.assertEqual('', ui.stdout.readline())
117
def test_text_ui_get_boolean(self):
118
stdin = tests.StringIOWrapper("y\n" # True
120
"yes with garbage\nY\n" # True
121
"not an answer\nno\n" # False
122
"I'm sure!\nyes\n" # True
125
stdout = tests.StringIOWrapper()
126
stderr = tests.StringIOWrapper()
127
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
128
self.assertEqual(True, factory.get_boolean(""))
129
self.assertEqual(False, factory.get_boolean(""))
130
self.assertEqual(True, factory.get_boolean(""))
131
self.assertEqual(False, factory.get_boolean(""))
132
self.assertEqual(True, factory.get_boolean(""))
26
import bzrlib.errors as errors
27
from bzrlib.progress import TTYProgressBar, ProgressBarStack
28
from bzrlib.tests import TestCase
29
from bzrlib.tests.test_progress import _TTYStringIO
30
from bzrlib.ui import SilentUIFactory
31
from bzrlib.ui.text import TextUIFactory
34
class UITests(TestCase):
36
def test_silent_factory(self):
37
ui = SilentUIFactory()
38
pb = ui.nested_progress_bar()
40
# TODO: Test that there is no output from SilentUIFactory
42
self.assertEquals(ui.get_password(), None)
43
self.assertEquals(ui.get_password(u'Hello There \u1234 %(user)s',
49
def test_text_factory(self):
51
pb = ui.nested_progress_bar()
53
# TODO: Test the output from TextUIFactory, perhaps by overriding sys.stdout
55
# Unfortunately we can't actually test the ui.get_password() because
56
# that would actually prompt the user for a password during the test suite
57
# This has been tested manually with both LANG=en_US.utf-8 and LANG=C
59
# self.assertEquals(ui.get_password(u"%(user)s please type 'bogus'",
64
def test_progress_note(self):
67
ui_factory = TextUIFactory(bar_type=TTYProgressBar)
68
pb = ui_factory.nested_progress_bar()
70
pb.to_messages_file = stdout
71
ui_factory._progress_bar_stack.bottom().to_file = stderr
73
self.assertEqual(None, result)
74
self.assertEqual("t\n", stdout.getvalue())
75
# Since there was no update() call, there should be no clear() call
76
self.failIf(re.search(r'^\r {10,}\r$', stderr.getvalue()) is not None,
77
'We cleared the stderr without anything to put there')
81
def test_progress_note_clears(self):
84
# The PQM redirects the output to a file, so it
85
# defaults to creating a Dots progress bar. we
86
# need to force it to believe we are a TTY
87
ui_factory = TextUIFactory(bar_type=TTYProgressBar)
88
pb = ui_factory.nested_progress_bar()
90
pb.to_messages_file = stdout
91
ui_factory._progress_bar_stack.bottom().to_file = stderr
92
# Create a progress update that isn't throttled
96
self.assertEqual(None, result)
97
self.assertEqual("t\n", stdout.getvalue())
98
# the exact contents will depend on the terminal width and we don't
99
# care about that right now - but you're probably running it on at
100
# least a 10-character wide terminal :)
101
self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
105
def test_progress_nested(self):
106
# test factory based nested and popping.
108
pb1 = ui.nested_progress_bar()
109
pb2 = ui.nested_progress_bar()
110
self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
114
def test_progress_stack(self):
115
# test the progress bar stack which the default text factory
119
# make a stack, which accepts parameters like a pb.
120
stack = ProgressBarStack(to_file=stderr, to_messages_file=stdout)
122
self.assertFalse(getattr(stack, 'note', False))
123
pb1 = stack.get_nested()
124
pb2 = stack.get_nested()
125
self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
128
# the text ui factory never actually removes the stack once its setup.
129
# we need to be able to nest again correctly from here.
130
pb1 = stack.get_nested()
131
pb2 = stack.get_nested()
132
self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
136
def test_text_factory_setting_progress_bar(self):
137
# we should be able to choose the progress bar type used.
138
factory = bzrlib.ui.text.TextUIFactory(
139
bar_type=bzrlib.progress.DotsProgressBar)
140
bar = factory.nested_progress_bar()
142
self.assertIsInstance(bar, bzrlib.progress.DotsProgressBar)
144
def test_cli_stdin_is_default_stdin(self):
145
factory = bzrlib.ui.CLIUIFactory()
146
self.assertEqual(sys.stdin, factory.stdin)
148
def assert_get_bool_acceptance_of_user_input(self, factory):
149
factory.stdin = StringIO("y\nyes with garbage\nyes\nn\nnot an answer\nno\nfoo\n")
150
factory.stdout = StringIO()
151
# there is no output from the base factory
152
self.assertEqual(True, factory.get_boolean(""))
153
self.assertEqual(True, factory.get_boolean(""))
154
self.assertEqual(False, factory.get_boolean(""))
133
155
self.assertEqual(False, factory.get_boolean(""))
134
156
self.assertEqual("foo\n", factory.stdin.read())
135
# stdin should be empty
136
self.assertEqual('', factory.stdin.readline())
138
def test_text_ui_get_integer(self):
139
stdin = tests.StringIOWrapper(
142
"hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
143
stdout = tests.StringIOWrapper()
144
stderr = tests.StringIOWrapper()
145
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
146
self.assertEqual(1, factory.get_integer(""))
147
self.assertEqual(-2, factory.get_integer(""))
148
self.assertEqual(42, factory.get_integer(""))
150
def test_text_factory_prompt(self):
151
# see <https://launchpad.net/bugs/365891>
152
StringIO = tests.StringIOWrapper
153
factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
154
factory.prompt('foo %2e')
155
self.assertEqual('', factory.stdout.getvalue())
156
self.assertEqual('foo %2e', factory.stderr.getvalue())
158
def test_silent_ui_getbool(self):
159
factory = bzrlib.ui.SilentUIFactory()
160
self.assert_get_bool_acceptance_of_user_input(factory)
162
def test_silent_factory_prompts_silently(self):
163
factory = bzrlib.ui.SilentUIFactory()
165
factory.stdin = StringIO("y\n")
168
self.apply_redirected(
169
None, stdout, stdout, factory.get_boolean, "foo")
171
self.assertEqual("", stdout.getvalue())
173
def test_text_ui_getbool(self):
174
factory = bzrlib.ui.text.TextUIFactory()
175
self.assert_get_bool_acceptance_of_user_input(factory)
158
177
def test_text_factory_prompts_and_clears(self):
159
178
# a get_boolean call should clear the pb before prompting
160
out = test_progress._TTYStringIO()
161
os.environ['TERM'] = 'xterm'
162
factory = _mod_ui_text.TextUIFactory(
163
stdin=tests.StringIOWrapper("yada\ny\n"),
164
stdout=out, stderr=out)
165
factory._avail_width = lambda: 79
166
pb = factory.nested_progress_bar()
168
pb.show_spinner = False
169
pb.show_count = False
170
pb.update("foo", 0, 1)
171
self.assertEqual(True,
172
self.apply_redirected(None, factory.stdout,
176
output = out.getvalue()
177
self.assertContainsRe(output,
179
self.assertContainsRe(output,
180
r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
181
# stdin should have been totally consumed
182
self.assertEqual('', factory.stdin.readline())
184
def test_text_tick_after_update(self):
185
ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
186
stderr=tests.StringIOWrapper())
187
pb = ui_factory.nested_progress_bar()
189
pb.update('task', 0, 3)
190
# Reset the clock, so that it actually tries to repaint itself
191
ui_factory._progress_view._last_repaint = time.time() - 1.0
196
def test_text_ui_getusername(self):
197
factory = _mod_ui_text.TextUIFactory(None, None, None)
198
factory.stdin = tests.StringIOWrapper("someuser\n\n")
199
factory.stdout = tests.StringIOWrapper()
200
factory.stderr = tests.StringIOWrapper()
201
factory.stdout.encoding = "utf8"
202
# there is no output from the base factory
203
self.assertEqual("someuser",
204
factory.get_username('Hello %(host)s', host='some'))
205
self.assertEquals("Hello some: ", factory.stderr.getvalue())
206
self.assertEquals('', factory.stdout.getvalue())
207
self.assertEqual("", factory.get_username("Gebruiker"))
208
# stdin should be empty
209
self.assertEqual('', factory.stdin.readline())
211
def test_text_ui_getusername_utf8(self):
212
ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
213
stdout=tests.StringIOWrapper(),
214
stderr=tests.StringIOWrapper())
215
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
216
pb = ui.nested_progress_bar()
218
# there is no output from the base factory
219
username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
220
ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
221
self.assertEquals(u"someuser\u1234", username.decode('utf8'))
222
self.assertEquals(u"Hello\u1234 some\u1234: ",
223
ui.stderr.getvalue().decode("utf8"))
224
self.assertEquals('', ui.stdout.getvalue())
228
def test_quietness(self):
229
os.environ['BZR_PROGRESS_BAR'] = 'text'
230
ui_factory = _mod_ui_text.TextUIFactory(None,
231
test_progress._TTYStringIO(),
232
test_progress._TTYStringIO())
233
self.assertIsInstance(ui_factory._progress_view,
234
_mod_ui_text.TextProgressView)
235
ui_factory.be_quiet(True)
236
self.assertIsInstance(ui_factory._progress_view,
237
_mod_ui_text.NullProgressView)
239
def test_text_ui_show_user_warning(self):
240
from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
241
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
244
ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
245
remote_fmt = remote.RemoteRepositoryFormat()
246
remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
247
ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
248
to_format=remote_fmt)
249
self.assertEquals('', out.getvalue())
250
self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
251
"RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
252
"(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
253
"the same format for better performance.\n",
255
# and now with it suppressed please
258
ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
259
ui.suppressed_warnings.add('cross_format_fetch')
260
ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
261
to_format=remote_fmt)
262
self.assertEquals('', out.getvalue())
263
self.assertEquals('', err.getvalue())
266
class TestTextUIOutputStream(tests.TestCase):
267
"""Tests for output stream that synchronizes with progress bar."""
269
def test_output_clears_terminal(self):
270
stdout = tests.StringIOWrapper()
271
stderr = tests.StringIOWrapper()
274
uif = _mod_ui_text.TextUIFactory(None, stdout, stderr)
275
uif.clear_term = lambda: clear_calls.append('clear')
277
stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
278
stream.write("Hello world!\n")
279
stream.write("there's more...\n")
280
stream.writelines(["1\n", "2\n", "3\n"])
282
self.assertEqual(stdout.getvalue(),
286
self.assertEqual(['clear', 'clear', 'clear'],
292
class UITests(tests.TestCase):
294
def test_progress_construction(self):
295
"""TextUIFactory constructs the right progress view.
297
TTYStringIO = test_progress._TTYStringIO
298
FileStringIO = tests.StringIOWrapper
299
for (file_class, term, pb, expected_pb_class) in (
300
# on an xterm, either use them or not as the user requests,
301
# otherwise default on
302
(TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
303
(TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
304
(TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
305
# on a dumb terminal, again if there's explicit configuration do
306
# it, otherwise default off
307
(TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
308
(TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
309
(TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
310
# on a non-tty terminal, it's null regardless of $TERM
311
(FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
312
(FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
313
# however, it can still be forced on
314
(FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
316
os.environ['TERM'] = term
318
if 'BZR_PROGRESS_BAR' in os.environ:
319
del os.environ['BZR_PROGRESS_BAR']
321
os.environ['BZR_PROGRESS_BAR'] = pb
322
stdin = file_class('')
323
stderr = file_class()
324
stdout = file_class()
325
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
326
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
327
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
328
self.assertIsInstance(uif.make_progress_view(),
330
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
332
def test_text_ui_non_terminal(self):
333
"""Even on non-ttys, make_ui_for_terminal gives a text ui."""
334
stdin = test_progress._NonTTYStringIO('')
335
stderr = test_progress._NonTTYStringIO()
336
stdout = test_progress._NonTTYStringIO()
337
for term_type in ['dumb', None, 'xterm']:
338
if term_type is None:
339
del os.environ['TERM']
341
os.environ['TERM'] = term_type
342
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
343
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
344
'TERM=%r' % (term_type,))
347
class SilentUITests(tests.TestCase):
349
def test_silent_factory_get_password(self):
350
# A silent factory that can't do user interaction can't get a
351
# password. Possibly it should raise a more specific error but it
353
ui = _mod_ui.SilentUIFactory()
354
stdout = tests.StringIOWrapper()
357
self.apply_redirected,
358
None, stdout, stdout, ui.get_password)
359
# and it didn't write anything out either
360
self.assertEqual('', stdout.getvalue())
362
def test_silent_ui_getbool(self):
363
factory = _mod_ui.SilentUIFactory()
364
stdout = tests.StringIOWrapper()
367
self.apply_redirected,
368
None, stdout, stdout, factory.get_boolean, "foo")
371
class TestUIFactoryTests(tests.TestCase):
373
def test_test_ui_factory_progress(self):
374
# there's no output; we just want to make sure this doesn't crash -
375
# see https://bugs.launchpad.net/bzr/+bug/408201
376
ui = tests.TestUIFactory()
377
pb = ui.nested_progress_bar()
383
class CannedInputUIFactoryTests(tests.TestCase):
385
def test_canned_input_get_input(self):
386
uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
387
self.assertEqual(True, uif.get_boolean('Extra cheese?'))
388
self.assertEqual('mbp', uif.get_username('Enter your user name'))
389
self.assertEqual('password',
390
uif.get_password('Password for %(host)s',
392
self.assertEqual(42, uif.get_integer('And all that jazz ?'))
395
class TestBoolFromString(tests.TestCase):
397
def assertIsTrue(self, s, accepted_values=None):
398
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
399
self.assertEquals(True, res)
401
def assertIsFalse(self, s, accepted_values=None):
402
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
403
self.assertEquals(False, res)
405
def assertIsNone(self, s, accepted_values=None):
406
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
407
self.assertIs(None, res)
409
def test_know_valid_values(self):
410
self.assertIsTrue('true')
411
self.assertIsFalse('false')
412
self.assertIsTrue('1')
413
self.assertIsFalse('0')
414
self.assertIsTrue('on')
415
self.assertIsFalse('off')
416
self.assertIsTrue('yes')
417
self.assertIsFalse('no')
418
self.assertIsTrue('y')
419
self.assertIsFalse('n')
420
# Also try some case variations
421
self.assertIsTrue('True')
422
self.assertIsFalse('False')
423
self.assertIsTrue('On')
424
self.assertIsFalse('Off')
425
self.assertIsTrue('ON')
426
self.assertIsFalse('OFF')
427
self.assertIsTrue('oN')
428
self.assertIsFalse('oFf')
430
def test_invalid_values(self):
431
self.assertIsNone(None)
432
self.assertIsNone('doubt')
433
self.assertIsNone('frue')
434
self.assertIsNone('talse')
435
self.assertIsNone('42')
437
def test_provided_values(self):
438
av = dict(y=True, n=False, yes=True, no=False)
439
self.assertIsTrue('y', av)
440
self.assertIsTrue('Y', av)
441
self.assertIsTrue('Yes', av)
442
self.assertIsFalse('n', av)
443
self.assertIsFalse('N', av)
444
self.assertIsFalse('No', av)
445
self.assertIsNone('1', av)
446
self.assertIsNone('0', av)
447
self.assertIsNone('on', av)
448
self.assertIsNone('off', av)
451
class TestConfirmationUserInterfacePolicy(tests.TestCase):
453
def test_confirm_action_default(self):
454
base_ui = _mod_ui.NoninteractiveUIFactory()
455
for answer in [True, False]:
457
_mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
458
.confirm_action("Do something?",
459
"bzrlib.tests.do_something", {}),
462
def test_confirm_action_specific(self):
463
base_ui = _mod_ui.NoninteractiveUIFactory()
464
for default_answer in [True, False]:
465
for specific_answer in [True, False]:
466
for conf_id in ['given_id', 'other_id']:
467
wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
468
base_ui, default_answer, dict(given_id=specific_answer))
469
result = wrapper.confirm_action("Do something?", conf_id, {})
470
if conf_id == 'given_id':
471
self.assertEquals(result, specific_answer)
473
self.assertEquals(result, default_answer)
476
base_ui = _mod_ui.NoninteractiveUIFactory()
477
wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
478
base_ui, True, dict(a=2))
479
self.assertThat(repr(wrapper),
480
Equals("ConfirmationUserInterfacePolicy("
481
"NoninteractiveUIFactory(), True, {'a': 2})"))
484
class TestProgressRecordingUI(tests.TestCase):
485
"""Test test-oriented UIFactory that records progress updates"""
487
def test_nested_ignore_depth_beyond_one(self):
488
# we only want to capture the first level out progress, not
489
# want sub-components might do. So we have nested bars ignored.
490
factory = ProgressRecordingUIFactory()
491
pb1 = factory.nested_progress_bar()
492
pb1.update('foo', 0, 1)
493
pb2 = factory.nested_progress_bar()
494
pb2.update('foo', 0, 1)
497
self.assertEqual([("update", 0, 1, 'foo')], factory._calls)
179
factory = bzrlib.ui.text.TextUIFactory()
180
factory.stdout = _TTYStringIO()
181
factory.stdin = StringIO("yada\ny\n")
182
pb = self.apply_redirected(
183
factory.stdin, factory.stdout, factory.stdout, factory.nested_progress_bar)
185
self.apply_redirected(
186
factory.stdin, factory.stdout, factory.stdout, pb.update, "foo", 0, 1)
189
self.apply_redirected(
190
None, factory.stdout, factory.stdout, factory.get_boolean, "what do you want")
192
# use a regular expression so that we don't depend on the particular
193
# screen width - could also set and restore $COLUMN if that has
194
# priority on all platforms, but it doesn't at present.
195
output = factory.stdout.getvalue()
197
"\r/ \\[ *\\] foo 0/1"
199
"\rwhat do you want\\? \\[y/n\\]:what do you want\\? \\[y/n\\]:",
201
self.fail("didn't match factory output %r, %s" % (factory, output))
added
removed
bzrlib/tests/test_ui.py
