17
17
"""Tests for the bzrlib ui
22
24
from StringIO import StringIO
24
from testtools.matchers import *
26
26
from bzrlib import (
34
from bzrlib.symbol_versioning import (
32
37
from bzrlib.tests import (
36
41
from bzrlib.ui import text as _mod_ui_text
37
from bzrlib.tests.testui import (
38
ProgressRecordingUIFactory,
42
44
class TestUIConfiguration(tests.TestCaseWithTransport):
48
50
ui = tests.TestUIFactory(stdin=None,
49
51
stdout=tests.StringIOWrapper(),
50
52
stderr=tests.StringIOWrapper())
51
output = ui.make_output_stream()
52
self.assertEquals(output.encoding, enc)
53
os = ui.make_output_stream()
54
self.assertEquals(os.encoding, enc)
55
57
class TestTextUIFactory(tests.TestCase):
57
def make_test_ui_factory(self, stdin_contents):
58
ui = tests.TestUIFactory(stdin=stdin_contents,
59
stdout=tests.StringIOWrapper(),
60
stderr=tests.StringIOWrapper())
63
def test_text_factory_confirm(self):
64
# turns into reading a regular boolean
65
ui = self.make_test_ui_factory('n\n')
66
self.assertEquals(ui.confirm_action(u'Should %(thing)s pass?',
67
'bzrlib.tests.test_ui.confirmation',
71
59
def test_text_factory_ascii_password(self):
72
ui = self.make_test_ui_factory('secret\n')
60
ui = tests.TestUIFactory(stdin='secret\n',
61
stdout=tests.StringIOWrapper(),
62
stderr=tests.StringIOWrapper())
73
63
pb = ui.nested_progress_bar()
75
65
self.assertEqual('secret',
90
80
We can't predict what encoding users will have for stdin, so we force
91
81
it to utf8 to test that we transport the password correctly.
93
ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
83
ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
84
stdout=tests.StringIOWrapper(),
85
stderr=tests.StringIOWrapper())
94
86
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
95
87
pb = ui.nested_progress_bar()
119
111
stdout = tests.StringIOWrapper()
120
112
stderr = tests.StringIOWrapper()
121
113
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
122
self.assertEqual(True, factory.get_boolean(u""))
123
self.assertEqual(False, factory.get_boolean(u""))
124
self.assertEqual(True, factory.get_boolean(u""))
125
self.assertEqual(False, factory.get_boolean(u""))
126
self.assertEqual(True, factory.get_boolean(u""))
127
self.assertEqual(False, factory.get_boolean(u""))
114
self.assertEqual(True, factory.get_boolean(""))
115
self.assertEqual(False, factory.get_boolean(""))
116
self.assertEqual(True, factory.get_boolean(""))
117
self.assertEqual(False, factory.get_boolean(""))
118
self.assertEqual(True, factory.get_boolean(""))
119
self.assertEqual(False, factory.get_boolean(""))
128
120
self.assertEqual("foo\n", factory.stdin.read())
129
121
# stdin should be empty
130
122
self.assertEqual('', factory.stdin.readline())
137
129
stdout = tests.StringIOWrapper()
138
130
stderr = tests.StringIOWrapper()
139
131
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
140
self.assertEqual(1, factory.get_integer(u""))
141
self.assertEqual(-2, factory.get_integer(u""))
142
self.assertEqual(42, factory.get_integer(u""))
132
self.assertEqual(1, factory.get_integer(""))
133
self.assertEqual(-2, factory.get_integer(""))
134
self.assertEqual(42, factory.get_integer(""))
144
136
def test_text_factory_prompt(self):
145
137
# see <https://launchpad.net/bugs/365891>
146
138
StringIO = tests.StringIOWrapper
147
139
factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
148
factory.prompt(u'foo %2e')
140
factory.prompt('foo %2e')
149
141
self.assertEqual('', factory.stdout.getvalue())
150
142
self.assertEqual('foo %2e', factory.stderr.getvalue())
152
144
def test_text_factory_prompts_and_clears(self):
153
145
# a get_boolean call should clear the pb before prompting
154
146
out = test_progress._TTYStringIO()
155
self.overrideEnv('TERM', 'xterm')
147
os.environ['TERM'] = 'xterm'
156
148
factory = _mod_ui_text.TextUIFactory(
157
149
stdin=tests.StringIOWrapper("yada\ny\n"),
158
150
stdout=out, stderr=out)
195
187
factory.stdout.encoding = "utf8"
196
188
# there is no output from the base factory
197
189
self.assertEqual("someuser",
198
factory.get_username(u'Hello %(host)s', host='some'))
190
factory.get_username('Hello %(host)s', host='some'))
199
191
self.assertEquals("Hello some: ", factory.stderr.getvalue())
200
192
self.assertEquals('', factory.stdout.getvalue())
201
self.assertEqual("", factory.get_username(u"Gebruiker"))
193
self.assertEqual("", factory.get_username("Gebruiker"))
202
194
# stdin should be empty
203
195
self.assertEqual('', factory.stdin.readline())
222
214
def test_quietness(self):
223
self.overrideEnv('BZR_PROGRESS_BAR', 'text')
215
os.environ['BZR_PROGRESS_BAR'] = 'text'
224
216
ui_factory = _mod_ui_text.TextUIFactory(None,
225
217
test_progress._TTYStringIO(),
226
218
test_progress._TTYStringIO())
307
299
# however, it can still be forced on
308
300
(FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
310
self.overrideEnv('TERM', term)
311
self.overrideEnv('BZR_PROGRESS_BAR', pb)
302
os.environ['TERM'] = term
304
if 'BZR_PROGRESS_BAR' in os.environ:
305
del os.environ['BZR_PROGRESS_BAR']
307
os.environ['BZR_PROGRESS_BAR'] = pb
312
308
stdin = file_class('')
313
309
stderr = file_class()
314
310
stdout = file_class()
325
321
stderr = test_progress._NonTTYStringIO()
326
322
stdout = test_progress._NonTTYStringIO()
327
323
for term_type in ['dumb', None, 'xterm']:
328
self.overrideEnv('TERM', term_type)
324
if term_type is None:
325
del os.environ['TERM']
327
os.environ['TERM'] = term_type
329
328
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
330
329
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
331
330
'TERM=%r' % (term_type,))
352
351
self.assertRaises(
353
352
NotImplementedError,
354
353
self.apply_redirected,
355
None, stdout, stdout, factory.get_boolean, u"foo")
354
None, stdout, stdout, factory.get_boolean, "foo")
358
357
class TestUIFactoryTests(tests.TestCase):
372
371
def test_canned_input_get_input(self):
373
372
uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
374
self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
375
self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
373
self.assertEqual(True, uif.get_boolean('Extra cheese?'))
374
self.assertEqual('mbp', uif.get_username('Enter your user name'))
376
375
self.assertEqual('password',
377
uif.get_password(u'Password for %(host)s',
376
uif.get_password('Password for %(host)s',
378
377
host='example.com'))
379
self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
378
self.assertEqual(42, uif.get_integer('And all that jazz ?'))
382
381
class TestBoolFromString(tests.TestCase):
433
432
self.assertIsNone('0', av)
434
433
self.assertIsNone('on', av)
435
434
self.assertIsNone('off', av)
438
class TestConfirmationUserInterfacePolicy(tests.TestCase):
440
def test_confirm_action_default(self):
441
base_ui = _mod_ui.NoninteractiveUIFactory()
442
for answer in [True, False]:
444
_mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
445
.confirm_action("Do something?",
446
"bzrlib.tests.do_something", {}),
449
def test_confirm_action_specific(self):
450
base_ui = _mod_ui.NoninteractiveUIFactory()
451
for default_answer in [True, False]:
452
for specific_answer in [True, False]:
453
for conf_id in ['given_id', 'other_id']:
454
wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
455
base_ui, default_answer, dict(given_id=specific_answer))
456
result = wrapper.confirm_action("Do something?", conf_id, {})
457
if conf_id == 'given_id':
458
self.assertEquals(result, specific_answer)
460
self.assertEquals(result, default_answer)
463
base_ui = _mod_ui.NoninteractiveUIFactory()
464
wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
465
base_ui, True, dict(a=2))
466
self.assertThat(repr(wrapper),
467
Equals("ConfirmationUserInterfacePolicy("
468
"NoninteractiveUIFactory(), True, {'a': 2})"))
471
class TestProgressRecordingUI(tests.TestCase):
472
"""Test test-oriented UIFactory that records progress updates"""
474
def test_nested_ignore_depth_beyond_one(self):
475
# we only want to capture the first level out progress, not
476
# want sub-components might do. So we have nested bars ignored.
477
factory = ProgressRecordingUIFactory()
478
pb1 = factory.nested_progress_bar()
479
pb1.update('foo', 0, 1)
480
pb2 = factory.nested_progress_bar()
481
pb2.update('foo', 0, 1)
484
self.assertEqual([("update", 0, 1, 'foo')], factory._calls)