1
# Copyright (C) 2005, 2008, 2009 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
21
from StringIO import StringIO
31
from bzrlib.symbol_versioning import (
34
from bzrlib.tests import (
39
from bzrlib.tests.test_progress import (
43
from bzrlib.ui import (
50
from bzrlib.ui.text import (
57
class UITests(tests.TestCase):
59
def test_text_factory_ascii_password(self):
60
ui = tests.TestUIFactory(stdin='secret\n',
61
stdout=tests.StringIOWrapper(),
62
stderr=tests.StringIOWrapper())
63
pb = ui.nested_progress_bar()
65
self.assertEqual('secret',
66
self.apply_redirected(ui.stdin, ui.stdout,
69
# ': ' is appended to prompt
70
self.assertEqual(': ', ui.stderr.getvalue())
71
self.assertEqual('', ui.stdout.readline())
72
# stdin should be empty
73
self.assertEqual('', ui.stdin.readline())
77
def test_text_factory_utf8_password(self):
78
"""Test an utf8 password.
80
We can't predict what encoding users will have for stdin, so we force
81
it to utf8 to test that we transport the password correctly.
83
ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
84
stdout=tests.StringIOWrapper(),
85
stderr=tests.StringIOWrapper())
86
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
87
pb = ui.nested_progress_bar()
89
password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
91
u'Hello \u1234 %(user)s',
93
# We use StringIO objects, we need to decode them
94
self.assertEqual(u'baz\u1234', password.decode('utf8'))
95
self.assertEqual(u'Hello \u1234 some\u1234: ',
96
ui.stderr.getvalue().decode('utf8'))
97
# stdin and stdout should be empty
98
self.assertEqual('', ui.stdin.readline())
99
self.assertEqual('', ui.stdout.readline())
103
def test_progress_construction(self):
104
"""TextUIFactory constructs the right progress view.
106
for (file_class, term, pb, expected_pb_class) in (
107
# on an xterm, either use them or not as the user requests,
108
# otherwise default on
109
(_TTYStringIO, 'xterm', 'none', NullProgressView),
110
(_TTYStringIO, 'xterm', 'text', TextProgressView),
111
(_TTYStringIO, 'xterm', None, TextProgressView),
112
# on a dumb terminal, again if there's explicit configuration do
113
# it, otherwise default off
114
(_TTYStringIO, 'dumb', 'none', NullProgressView),
115
(_TTYStringIO, 'dumb', 'text', TextProgressView),
116
(_TTYStringIO, 'dumb', None, NullProgressView),
117
# on a non-tty terminal, it's null regardless of $TERM
118
(StringIO, 'xterm', None, NullProgressView),
119
(StringIO, 'dumb', None, NullProgressView),
120
# however, it can still be forced on
121
(StringIO, 'dumb', 'text', TextProgressView),
123
os.environ['TERM'] = term
125
if 'BZR_PROGRESS_BAR' in os.environ:
126
del os.environ['BZR_PROGRESS_BAR']
128
os.environ['BZR_PROGRESS_BAR'] = pb
129
stdin = file_class('')
130
stderr = file_class()
131
stdout = file_class()
132
uif = make_ui_for_terminal(stdin, stdout, stderr)
133
self.assertIsInstance(uif, TextUIFactory,
134
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
135
self.assertIsInstance(uif.make_progress_view(),
137
"TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
139
def test_text_ui_non_terminal(self):
140
"""Even on non-ttys, make_ui_for_terminal gives a text ui."""
141
stdin = _NonTTYStringIO('')
142
stderr = _NonTTYStringIO()
143
stdout = _NonTTYStringIO()
144
for term_type in ['dumb', None, 'xterm']:
145
if term_type is None:
146
del os.environ['TERM']
148
os.environ['TERM'] = term_type
149
uif = make_ui_for_terminal(stdin, stdout, stderr)
150
self.assertIsInstance(uif, TextUIFactory,
151
'TERM=%r' % (term_type,))
153
def test_progress_note(self):
156
ui_factory = TextUIFactory(stdin=StringIO(''),
159
pb = ui_factory.nested_progress_bar()
161
result = pb.note('t')
162
self.assertEqual(None, result)
163
self.assertEqual("t\n", stdout.getvalue())
164
# Since there was no update() call, there should be no clear() call
165
self.failIf(re.search(r'^\r {10,}\r$',
166
stderr.getvalue()) is not None,
167
'We cleared the stderr without anything to put there')
171
def test_progress_note_clears(self):
172
stderr = _TTYStringIO()
173
stdout = _TTYStringIO()
174
# so that we get a TextProgressBar
175
os.environ['TERM'] = 'xterm'
176
ui_factory = TextUIFactory(
178
stdout=stdout, stderr=stderr)
179
self.assertIsInstance(ui_factory._progress_view,
181
pb = ui_factory.nested_progress_bar()
183
# Create a progress update that isn't throttled
185
result = pb.note('t')
186
self.assertEqual(None, result)
187
self.assertEqual("t\n", stdout.getvalue())
188
# the exact contents will depend on the terminal width and we don't
189
# care about that right now - but you're probably running it on at
190
# least a 10-character wide terminal :)
191
self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
195
def test_progress_nested(self):
196
# test factory based nested and popping.
197
ui = TextUIFactory(None, None, None)
198
pb1 = ui.nested_progress_bar()
199
pb2 = ui.nested_progress_bar()
200
# You do get a warning if the outermost progress bar wasn't finished
201
# first - it's not clear if this is really useful or if it should just
202
# become orphaned -- mbp 20090120
203
warnings, _ = self.callCatchWarnings(pb1.finished)
204
if len(warnings) != 1:
205
self.fail("unexpected warnings: %r" % (warnings,))
209
def test_text_ui_get_boolean(self):
210
stdin = StringIO("y\n" # True
212
"yes with garbage\nY\n" # True
213
"not an answer\nno\n" # False
214
"I'm sure!\nyes\n" # True
219
factory = TextUIFactory(stdin, stdout, stderr)
220
self.assertEqual(True, factory.get_boolean(""))
221
self.assertEqual(False, factory.get_boolean(""))
222
self.assertEqual(True, factory.get_boolean(""))
223
self.assertEqual(False, factory.get_boolean(""))
224
self.assertEqual(True, factory.get_boolean(""))
225
self.assertEqual(False, factory.get_boolean(""))
226
self.assertEqual("foo\n", factory.stdin.read())
227
# stdin should be empty
228
self.assertEqual('', factory.stdin.readline())
230
def test_text_factory_prompt(self):
231
# see <https://launchpad.net/bugs/365891>
232
factory = TextUIFactory(StringIO(), StringIO(), StringIO())
233
factory.prompt('foo %2e')
234
self.assertEqual('', factory.stdout.getvalue())
235
self.assertEqual('foo %2e', factory.stderr.getvalue())
237
def test_text_factory_prompts_and_clears(self):
238
# a get_boolean call should clear the pb before prompting
240
os.environ['TERM'] = 'xterm'
241
factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
242
pb = factory.nested_progress_bar()
244
pb.show_spinner = False
245
pb.show_count = False
246
pb.update("foo", 0, 1)
247
self.assertEqual(True,
248
self.apply_redirected(None, factory.stdout,
252
output = out.getvalue()
253
self.assertContainsRe(factory.stdout.getvalue(),
255
self.assertContainsRe(factory.stdout.getvalue(),
256
r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
257
# stdin should have been totally consumed
258
self.assertEqual('', factory.stdin.readline())
260
def test_text_tick_after_update(self):
261
ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
262
pb = ui_factory.nested_progress_bar()
264
pb.update('task', 0, 3)
265
# Reset the clock, so that it actually tries to repaint itself
266
ui_factory._progress_view._last_repaint = time.time() - 1.0
271
def test_text_ui_getusername(self):
272
factory = TextUIFactory(None, None, None)
273
factory.stdin = StringIO("someuser\n\n")
274
factory.stdout = StringIO()
275
factory.stderr = StringIO()
276
factory.stdout.encoding = "utf8"
277
# there is no output from the base factory
278
self.assertEqual("someuser",
279
factory.get_username('Hello %(host)s', host='some'))
280
self.assertEquals("Hello some: ", factory.stderr.getvalue())
281
self.assertEquals('', factory.stdout.getvalue())
282
self.assertEqual("", factory.get_username("Gebruiker"))
283
# stdin should be empty
284
self.assertEqual('', factory.stdin.readline())
286
def test_text_ui_getusername_utf8(self):
287
ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
288
stdout=tests.StringIOWrapper(),
289
stderr=tests.StringIOWrapper())
290
ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
291
pb = ui.nested_progress_bar()
293
# there is no output from the base factory
294
username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
295
ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
296
self.assertEquals(u"someuser\u1234", username.decode('utf8'))
297
self.assertEquals(u"Hello\u1234 some\u1234: ",
298
ui.stderr.getvalue().decode("utf8"))
299
self.assertEquals('', ui.stdout.getvalue())
304
class CLIUITests(TestCase):
306
def test_cli_factory_deprecated(self):
307
uif = self.applyDeprecated(deprecated_in((1, 18, 0)),
309
StringIO(), StringIO(), StringIO())
310
self.assertIsInstance(uif, UIFactory)
313
class SilentUITests(TestCase):
315
def test_silent_factory_get_password(self):
316
# A silent factory that can't do user interaction can't get a
317
# password. Possibly it should raise a more specific error but it
319
ui = SilentUIFactory()
323
self.apply_redirected,
324
None, stdout, stdout, ui.get_password)
325
# and it didn't write anything out either
326
self.assertEqual('', stdout.getvalue())
328
def test_silent_ui_getbool(self):
329
factory = SilentUIFactory()
333
self.apply_redirected,
334
None, stdout, stdout, factory.get_boolean, "foo")
337
class TestUIFactoryTests(TestCase):
339
def test_test_ui_factory_progress(self):
340
# there's no output; we just want to make sure this doesn't crash -
341
# see https://bugs.edge.launchpad.net/bzr/+bug/408201
343
pb = ui.nested_progress_bar()
349
class CannedInputUIFactoryTests(TestCase):
351
def test_canned_input_get_input(self):
352
uif = CannedInputUIFactory([True, 'mbp', 'password'])
353
self.assertEqual(uif.get_boolean('Extra cheese?'), True)
354
self.assertEqual(uif.get_username('Enter your user name'), 'mbp')
355
self.assertEqual(uif.get_password('Password for %(host)s', host='example.com'),
359
class TestBoolFromString(tests.TestCase):
361
def assertIsTrue(self, s, accepted_values=None):
362
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
363
self.assertEquals(True, res)
365
def assertIsFalse(self, s, accepted_values=None):
366
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
367
self.assertEquals(False, res)
369
def assertIsNone(self, s, accepted_values=None):
370
res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
371
self.assertIs(None, res)
373
def test_know_valid_values(self):
374
self.assertIsTrue('true')
375
self.assertIsFalse('false')
376
self.assertIsTrue('1')
377
self.assertIsFalse('0')
378
self.assertIsTrue('on')
379
self.assertIsFalse('off')
380
self.assertIsTrue('yes')
381
self.assertIsFalse('no')
382
self.assertIsTrue('y')
383
self.assertIsFalse('n')
384
# Also try some case variations
385
self.assertIsTrue('True')
386
self.assertIsFalse('False')
387
self.assertIsTrue('On')
388
self.assertIsFalse('Off')
389
self.assertIsTrue('ON')
390
self.assertIsFalse('OFF')
391
self.assertIsTrue('oN')
392
self.assertIsFalse('oFf')
394
def test_invalid_values(self):
395
self.assertIsNone(None)
396
self.assertIsNone('doubt')
397
self.assertIsNone('frue')
398
self.assertIsNone('talse')
399
self.assertIsNone('42')
401
def test_provided_values(self):
402
av = dict(y=True, n=False, yes=True, no=False)
403
self.assertIsTrue('y', av)
404
self.assertIsTrue('Y', av)
405
self.assertIsTrue('Yes', av)
406
self.assertIsFalse('n', av)
407
self.assertIsFalse('N', av)
408
self.assertIsFalse('No', av)
409
self.assertIsNone('1', av)
410
self.assertIsNone('0', av)
411
self.assertIsNone('on', av)
412
self.assertIsNone('off', av)
added
removed
bzrlib/tests/test_ui.py
