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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""Tests for the bzrlib ui
21
from StringIO import StringIO
26
import bzrlib.errors as errors
27
from bzrlib.progress import (
32
29
from bzrlib.symbol_versioning import (
35
from bzrlib.tests import (
40
from bzrlib.tests.test_progress import _TTYStringIO
41
from bzrlib.ui import (
45
from bzrlib.ui.text import TextUIFactory
48
class UITests(TestCase):
50
def test_silent_factory(self):
51
ui = SilentUIFactory()
53
self.assertEqual(None,
54
self.apply_redirected(None, stdout, stdout,
56
self.assertEqual('', stdout.getvalue())
57
self.assertEqual(None,
58
self.apply_redirected(None, stdout, stdout,
60
u'Hello\u1234 %(user)s',
62
self.assertEqual('', stdout.getvalue())
32
from bzrlib.tests import test_progress
33
from bzrlib.ui import text as _mod_ui_text
36
class TestTextUIFactory(tests.TestCase):
64
38
def test_text_factory_ascii_password(self):
65
ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
39
ui = tests.TestUIFactory(stdin='secret\n',
40
stdout=tests.StringIOWrapper(),
41
stderr=tests.StringIOWrapper())
66
42
pb = ui.nested_progress_bar()
68
44
self.assertEqual('secret',
69
45
self.apply_redirected(ui.stdin, ui.stdout,
72
48
# ': ' is appended to prompt
73
self.assertEqual(': ', ui.stdout.getvalue())
49
self.assertEqual(': ', ui.stderr.getvalue())
50
self.assertEqual('', ui.stdout.readline())
74
51
# stdin should be empty
75
52
self.assertEqual('', ui.stdin.readline())
82
59
We can't predict what encoding users will have for stdin, so we force
83
60
it to utf8 to test that we transport the password correctly.
85
ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
86
stdout=StringIOWrapper())
87
ui.stdin.encoding = 'utf8'
88
ui.stdout.encoding = ui.stdin.encoding
62
ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
63
stdout=tests.StringIOWrapper(),
64
stderr=tests.StringIOWrapper())
65
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
89
66
pb = ui.nested_progress_bar()
91
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
68
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
93
70
u'Hello \u1234 %(user)s',
94
71
user=u'some\u1234')
95
72
# We use StringIO objects, we need to decode them
96
73
self.assertEqual(u'baz\u1234', password.decode('utf8'))
97
74
self.assertEqual(u'Hello \u1234 some\u1234: ',
98
ui.stdout.getvalue().decode('utf8'))
99
# stdin should be empty
75
ui.stderr.getvalue().decode('utf8'))
76
# stdin and stdout should be empty
100
77
self.assertEqual('', ui.stdin.readline())
78
self.assertEqual('', ui.stdout.readline())
104
82
def test_progress_note(self):
107
ui_factory = TextUIFactory(stdin=StringIO(''),
83
stderr = tests.StringIOWrapper()
84
stdout = tests.StringIOWrapper()
85
ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
110
88
pb = ui_factory.nested_progress_bar()
112
result = pb.note('t')
90
result = self.applyDeprecated(deprecated_in((2, 1, 0)),
113
93
self.assertEqual(None, result)
114
94
self.assertEqual("t\n", stdout.getvalue())
115
95
# Since there was no update() call, there should be no clear() call
159
def test_progress_stack(self):
160
# test the progress bar stack which the default text factory
164
# make a stack, which accepts parameters like a pb.
165
stack = self.applyDeprecated(
166
deprecated_in((1, 12, 0)),
168
to_file=stderr, to_messages_file=stdout)
170
self.assertFalse(getattr(stack, 'note', False))
171
pb1 = stack.get_nested()
172
pb2 = stack.get_nested()
173
warnings, _ = self.callCatchWarnings(pb1.finished)
174
self.assertEqual(len(warnings), 1)
177
# the text ui factory never actually removes the stack once its setup.
178
# we need to be able to nest again correctly from here.
179
pb1 = stack.get_nested()
180
pb2 = stack.get_nested()
181
warnings, _ = self.callCatchWarnings(pb1.finished)
182
self.assertEqual(len(warnings), 1)
186
def assert_get_bool_acceptance_of_user_input(self, factory):
187
factory.stdin = StringIO("y\nyes with garbage\n"
188
"yes\nn\nnot an answer\n"
190
factory.stdout = StringIO()
191
# there is no output from the base factory
192
self.assertEqual(True, factory.get_boolean(""))
193
self.assertEqual(True, factory.get_boolean(""))
194
self.assertEqual(False, factory.get_boolean(""))
141
def test_text_ui_get_boolean(self):
142
stdin = tests.StringIOWrapper("y\n" # True
144
"yes with garbage\nY\n" # True
145
"not an answer\nno\n" # False
146
"I'm sure!\nyes\n" # True
149
stdout = tests.StringIOWrapper()
150
stderr = tests.StringIOWrapper()
151
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
152
self.assertEqual(True, factory.get_boolean(""))
153
self.assertEqual(False, factory.get_boolean(""))
154
self.assertEqual(True, factory.get_boolean(""))
155
self.assertEqual(False, factory.get_boolean(""))
156
self.assertEqual(True, factory.get_boolean(""))
195
157
self.assertEqual(False, factory.get_boolean(""))
196
158
self.assertEqual("foo\n", factory.stdin.read())
197
159
# stdin should be empty
198
160
self.assertEqual('', factory.stdin.readline())
200
def test_silent_ui_getbool(self):
201
factory = SilentUIFactory()
202
self.assert_get_bool_acceptance_of_user_input(factory)
204
def test_silent_factory_prompts_silently(self):
205
factory = SilentUIFactory()
207
factory.stdin = StringIO("y\n")
208
self.assertEqual(True,
209
self.apply_redirected(None, stdout, stdout,
210
factory.get_boolean, "foo"))
211
self.assertEqual("", stdout.getvalue())
212
# stdin should be empty
213
self.assertEqual('', factory.stdin.readline())
215
def test_text_ui_getbool(self):
216
factory = TextUIFactory(None, None, None)
217
self.assert_get_bool_acceptance_of_user_input(factory)
162
def test_text_ui_get_integer(self):
163
stdin = tests.StringIOWrapper(
166
"hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
167
stdout = tests.StringIOWrapper()
168
stderr = tests.StringIOWrapper()
169
factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
170
self.assertEqual(1, factory.get_integer(""))
171
self.assertEqual(-2, factory.get_integer(""))
172
self.assertEqual(42, factory.get_integer(""))
174
def test_text_factory_prompt(self):
175
# see <https://launchpad.net/bugs/365891>
176
StringIO = tests.StringIOWrapper
177
factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
178
factory.prompt('foo %2e')
179
self.assertEqual('', factory.stdout.getvalue())
180
self.assertEqual('foo %2e', factory.stderr.getvalue())
219
182
def test_text_factory_prompts_and_clears(self):
220
183
# a get_boolean call should clear the pb before prompting
222
factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
184
out = test_progress._TTYStringIO()
185
os.environ['TERM'] = 'xterm'
186
factory = _mod_ui_text.TextUIFactory(
187
stdin=tests.StringIOWrapper("yada\ny\n"),
188
stdout=out, stderr=out)
223
189
pb = factory.nested_progress_bar()
224
190
pb.show_bar = False
225
191
pb.show_spinner = False
237
203
r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
238
204
# stdin should have been totally consumed
239
205
self.assertEqual('', factory.stdin.readline())
207
def test_text_tick_after_update(self):
208
ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
209
stderr=tests.StringIOWrapper())
210
pb = ui_factory.nested_progress_bar()
212
pb.update('task', 0, 3)
213
# Reset the clock, so that it actually tries to repaint itself
214
ui_factory._progress_view._last_repaint = time.time() - 1.0
219
def test_text_ui_getusername(self):
220
factory = _mod_ui_text.TextUIFactory(None, None, None)
221
factory.stdin = tests.StringIOWrapper("someuser\n\n")
222
factory.stdout = tests.StringIOWrapper()
223
factory.stderr = tests.StringIOWrapper()
224
factory.stdout.encoding = "utf8"
225
# there is no output from the base factory
226
self.assertEqual("someuser",
227
factory.get_username('Hello %(host)s', host='some'))
228
self.assertEquals("Hello some: ", factory.stderr.getvalue())
229
self.assertEquals('', factory.stdout.getvalue())
230
self.assertEqual("", factory.get_username("Gebruiker"))
231
# stdin should be empty
232
self.assertEqual('', factory.stdin.readline())
234
def test_text_ui_getusername_utf8(self):
235
ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
236
stdout=tests.StringIOWrapper(),
237
stderr=tests.StringIOWrapper())
238
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
239
pb = ui.nested_progress_bar()
241
# there is no output from the base factory
242
username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
243
ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
244
self.assertEquals(u"someuser\u1234", username.decode('utf8'))
245
self.assertEquals(u"Hello\u1234 some\u1234: ",
246
ui.stderr.getvalue().decode("utf8"))
247
self.assertEquals('', ui.stdout.getvalue())
252
class TestTextUIOutputStream(tests.TestCase):
253
"""Tests for output stream that synchronizes with progress bar."""
255
def test_output_clears_terminal(self):
256
stdout = tests.StringIOWrapper()
257
stderr = tests.StringIOWrapper()
260
uif = _mod_ui_text.TextUIFactory(None, stdout, stderr)
261
uif.clear_term = lambda: clear_calls.append('clear')
263
stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
264
stream.write("Hello world!\n")
265
stream.write("there's more...\n")
266
stream.writelines(["1\n", "2\n", "3\n"])
268
self.assertEqual(stdout.getvalue(),
272
self.assertEqual(['clear', 'clear', 'clear'],
278
class UITests(tests.TestCase):
280
def test_progress_construction(self):
281
"""TextUIFactory constructs the right progress view.
283
TTYStringIO = test_progress._TTYStringIO
284
FileStringIO = tests.StringIOWrapper
285
for (file_class, term, pb, expected_pb_class) in (
286
# on an xterm, either use them or not as the user requests,
287
# otherwise default on
288
(TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
289
(TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
290
(TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
291
# on a dumb terminal, again if there's explicit configuration do
292
# it, otherwise default off
293
(TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
294
(TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
295
(TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
296
# on a non-tty terminal, it's null regardless of $TERM
297
(FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
298
(FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
299
# however, it can still be forced on
300
(FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
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
308
stdin = file_class('')
309
stderr = file_class()
310
stdout = file_class()
311
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
312
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
313
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
314
self.assertIsInstance(uif.make_progress_view(),
316
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
318
def test_text_ui_non_terminal(self):
319
"""Even on non-ttys, make_ui_for_terminal gives a text ui."""
320
stdin = test_progress._NonTTYStringIO('')
321
stderr = test_progress._NonTTYStringIO()
322
stdout = test_progress._NonTTYStringIO()
323
for term_type in ['dumb', None, 'xterm']:
324
if term_type is None:
325
del os.environ['TERM']
327
os.environ['TERM'] = term_type
328
uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
329
self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
330
'TERM=%r' % (term_type,))
333
class SilentUITests(tests.TestCase):
335
def test_silent_factory_get_password(self):
336
# A silent factory that can't do user interaction can't get a
337
# password. Possibly it should raise a more specific error but it
339
ui = _mod_ui.SilentUIFactory()
340
stdout = tests.StringIOWrapper()
343
self.apply_redirected,
344
None, stdout, stdout, ui.get_password)
345
# and it didn't write anything out either
346
self.assertEqual('', stdout.getvalue())
348
def test_silent_ui_getbool(self):
349
factory = _mod_ui.SilentUIFactory()
350
stdout = tests.StringIOWrapper()
353
self.apply_redirected,
354
None, stdout, stdout, factory.get_boolean, "foo")
357
class TestUIFactoryTests(tests.TestCase):
359
def test_test_ui_factory_progress(self):
360
# there's no output; we just want to make sure this doesn't crash -
361
# see https://bugs.edge.launchpad.net/bzr/+bug/408201
362
ui = tests.TestUIFactory()
363
pb = ui.nested_progress_bar()
369
class CannedInputUIFactoryTests(tests.TestCase):
371
def test_canned_input_get_input(self):
372
uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
373
self.assertEqual(True, uif.get_boolean('Extra cheese?'))
374
self.assertEqual('mbp', uif.get_username('Enter your user name'))
375
self.assertEqual('password',
376
uif.get_password('Password for %(host)s',
378
self.assertEqual(42, uif.get_integer('And all that jazz ?'))
381
class TestBoolFromString(tests.TestCase):
383
def assertIsTrue(self, s, accepted_values=None):
384
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
385
self.assertEquals(True, res)
387
def assertIsFalse(self, s, accepted_values=None):
388
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
389
self.assertEquals(False, res)
391
def assertIsNone(self, s, accepted_values=None):
392
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
393
self.assertIs(None, res)
395
def test_know_valid_values(self):
396
self.assertIsTrue('true')
397
self.assertIsFalse('false')
398
self.assertIsTrue('1')
399
self.assertIsFalse('0')
400
self.assertIsTrue('on')
401
self.assertIsFalse('off')
402
self.assertIsTrue('yes')
403
self.assertIsFalse('no')
404
self.assertIsTrue('y')
405
self.assertIsFalse('n')
406
# Also try some case variations
407
self.assertIsTrue('True')
408
self.assertIsFalse('False')
409
self.assertIsTrue('On')
410
self.assertIsFalse('Off')
411
self.assertIsTrue('ON')
412
self.assertIsFalse('OFF')
413
self.assertIsTrue('oN')
414
self.assertIsFalse('oFf')
416
def test_invalid_values(self):
417
self.assertIsNone(None)
418
self.assertIsNone('doubt')
419
self.assertIsNone('frue')
420
self.assertIsNone('talse')
421
self.assertIsNone('42')
423
def test_provided_values(self):
424
av = dict(y=True, n=False, yes=True, no=False)
425
self.assertIsTrue('y', av)
426
self.assertIsTrue('Y', av)
427
self.assertIsTrue('Yes', av)
428
self.assertIsFalse('n', av)
429
self.assertIsFalse('N', av)
430
self.assertIsFalse('No', av)
431
self.assertIsNone('1', av)
432
self.assertIsNone('0', av)
433
self.assertIsNone('on', av)
434
self.assertIsNone('off', av)