59
70
We can't predict what encoding users will have for stdin, so we force
60
71
it to utf8 to test that we transport the password correctly.
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'
73
ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
74
stdout=StringIOWrapper())
75
ui.stdin.encoding = 'utf8'
76
ui.stdout.encoding = ui.stdin.encoding
66
77
pb = ui.nested_progress_bar()
68
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
79
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
70
81
u'Hello \u1234 %(user)s',
71
82
user=u'some\u1234')
72
83
# We use StringIO objects, we need to decode them
73
84
self.assertEqual(u'baz\u1234', password.decode('utf8'))
74
85
self.assertEqual(u'Hello \u1234 some\u1234: ',
75
ui.stderr.getvalue().decode('utf8'))
76
# stdin and stdout should be empty
77
self.assertEqual('', ui.stdin.readline())
78
self.assertEqual('', ui.stdout.readline())
86
ui.stdout.getvalue().decode('utf8'))
82
90
def test_progress_note(self):
83
stderr = tests.StringIOWrapper()
84
stdout = tests.StringIOWrapper()
85
ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
93
ui_factory = TextUIFactory(bar_type=TTYProgressBar)
88
94
pb = ui_factory.nested_progress_bar()
90
result = self.applyDeprecated(deprecated_in((2, 1, 0)),
96
pb.to_messages_file = stdout
97
ui_factory._progress_bar_stack.bottom().to_file = stderr
93
99
self.assertEqual(None, result)
94
100
self.assertEqual("t\n", stdout.getvalue())
95
101
# Since there was no update() call, there should be no clear() call
96
self.failIf(re.search(r'^\r {10,}\r$',
97
stderr.getvalue()) is not None,
102
self.failIf(re.search(r'^\r {10,}\r$', stderr.getvalue()) is not None,
98
103
'We cleared the stderr without anything to put there')
102
107
def test_progress_note_clears(self):
103
stderr = test_progress._TTYStringIO()
104
stdout = test_progress._TTYStringIO()
105
# so that we get a TextProgressBar
106
os.environ['TERM'] = 'xterm'
107
ui_factory = _mod_ui_text.TextUIFactory(
108
stdin=tests.StringIOWrapper(''),
109
stdout=stdout, stderr=stderr)
110
self.assertIsInstance(ui_factory._progress_view,
111
_mod_ui_text.TextProgressView)
110
# The PQM redirects the output to a file, so it
111
# defaults to creating a Dots progress bar. we
112
# need to force it to believe we are a TTY
113
ui_factory = TextUIFactory(bar_type=TTYProgressBar)
112
114
pb = ui_factory.nested_progress_bar()
116
pb.to_messages_file = stdout
117
ui_factory._progress_bar_stack.bottom().to_file = stderr
114
118
# Create a progress update that isn't throttled
115
120
pb.update('x', 1, 1)
116
result = self.applyDeprecated(deprecated_in((2, 1, 0)),
121
result = pb.note('t')
118
122
self.assertEqual(None, result)
119
123
self.assertEqual("t\n", stdout.getvalue())
120
124
# the exact contents will depend on the terminal width and we don't
127
131
def test_progress_nested(self):
128
132
# test factory based nested and popping.
129
ui = _mod_ui_text.TextUIFactory(None, None, None)
130
134
pb1 = ui.nested_progress_bar()
131
135
pb2 = ui.nested_progress_bar()
132
# You do get a warning if the outermost progress bar wasn't finished
133
# first - it's not clear if this is really useful or if it should just
134
# become orphaned -- mbp 20090120
135
warnings, _ = self.callCatchWarnings(pb1.finished)
136
if len(warnings) != 1:
137
self.fail("unexpected warnings: %r" % (warnings,))
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(""))
136
self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
140
def test_progress_stack(self):
141
# test the progress bar stack which the default text factory
145
# make a stack, which accepts parameters like a pb.
146
stack = ProgressBarStack(to_file=stderr, to_messages_file=stdout)
148
self.assertFalse(getattr(stack, 'note', False))
149
pb1 = stack.get_nested()
150
pb2 = stack.get_nested()
151
self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
154
# the text ui factory never actually removes the stack once its setup.
155
# we need to be able to nest again correctly from here.
156
pb1 = stack.get_nested()
157
pb2 = stack.get_nested()
158
self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
162
def test_text_factory_setting_progress_bar(self):
163
# we should be able to choose the progress bar type used.
164
factory = bzrlib.ui.text.TextUIFactory(
165
bar_type=DotsProgressBar)
166
bar = factory.nested_progress_bar()
168
self.assertIsInstance(bar, DotsProgressBar)
170
def test_cli_stdin_is_default_stdin(self):
171
factory = bzrlib.ui.CLIUIFactory()
172
self.assertEqual(sys.stdin, factory.stdin)
174
def assert_get_bool_acceptance_of_user_input(self, factory):
175
factory.stdin = StringIO("y\nyes with garbage\nyes\nn\nnot an answer\nno\nfoo\n")
176
factory.stdout = StringIO()
177
# there is no output from the base factory
178
self.assertEqual(True, factory.get_boolean(""))
179
self.assertEqual(True, factory.get_boolean(""))
180
self.assertEqual(False, factory.get_boolean(""))
157
181
self.assertEqual(False, factory.get_boolean(""))
158
182
self.assertEqual("foo\n", factory.stdin.read())
159
# stdin should be empty
160
self.assertEqual('', factory.stdin.readline())
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())
184
def test_silent_ui_getbool(self):
185
factory = bzrlib.ui.SilentUIFactory()
186
self.assert_get_bool_acceptance_of_user_input(factory)
188
def test_silent_factory_prompts_silently(self):
189
factory = bzrlib.ui.SilentUIFactory()
191
factory.stdin = StringIO("y\n")
194
self.apply_redirected(
195
None, stdout, stdout, factory.get_boolean, "foo")
197
self.assertEqual("", stdout.getvalue())
199
def test_text_ui_getbool(self):
200
factory = bzrlib.ui.text.TextUIFactory()
201
self.assert_get_bool_acceptance_of_user_input(factory)
182
203
def test_text_factory_prompts_and_clears(self):
183
204
# a get_boolean call should clear the pb before prompting
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)
189
pb = factory.nested_progress_bar()
191
pb.show_spinner = False
192
pb.show_count = False
193
pb.update("foo", 0, 1)
194
self.assertEqual(True,
195
self.apply_redirected(None, factory.stdout,
199
output = out.getvalue()
200
self.assertContainsRe(factory.stdout.getvalue(),
202
self.assertContainsRe(factory.stdout.getvalue(),
203
r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
204
# stdin should have been totally consumed
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)
205
factory = bzrlib.ui.text.TextUIFactory(bar_type=DotsProgressBar)
206
factory.stdout = _TTYStringIO()
207
factory.stdin = StringIO("yada\ny\n")
208
pb = self.apply_redirected(
209
factory.stdin, factory.stdout, factory.stdout, factory.nested_progress_bar)
211
self.apply_redirected(
212
factory.stdin, factory.stdout, factory.stdout, pb.update, "foo", 0, 1)
215
self.apply_redirected(
216
None, factory.stdout, factory.stdout, factory.get_boolean, "what do you want")
218
output = factory.stdout.getvalue()
219
self.assertEqual("foo: .\n"
220
"what do you want? [y/n]: what do you want? [y/n]: ",
221
factory.stdout.getvalue())