/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ui.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Tests for the bzrlib ui
 
18
"""
 
19
 
 
20
import os
 
21
import re
 
22
import time
 
23
 
 
24
from StringIO import StringIO
 
25
 
 
26
from bzrlib import (
 
27
    config,
 
28
    errors,
 
29
    remote,
 
30
    repository,
 
31
    tests,
 
32
    ui as _mod_ui,
 
33
    )
 
34
from bzrlib.symbol_versioning import (
 
35
    deprecated_in,
 
36
    )
 
37
from bzrlib.tests import (
 
38
    fixtures,
 
39
    test_progress,
 
40
    )
 
41
from bzrlib.ui import text as _mod_ui_text
 
42
 
 
43
 
 
44
class TestUIConfiguration(tests.TestCaseWithTransport):
 
45
 
 
46
    def test_output_encoding_configuration(self):
 
47
        enc = fixtures.generate_unicode_encodings().next()
 
48
        config.GlobalConfig().set_user_option('output_encoding',
 
49
            enc)
 
50
        ui = tests.TestUIFactory(stdin=None,
 
51
            stdout=tests.StringIOWrapper(),
 
52
            stderr=tests.StringIOWrapper())
 
53
        os = ui.make_output_stream()
 
54
        self.assertEquals(os.encoding, enc)
 
55
 
 
56
 
 
57
class TestTextUIFactory(tests.TestCase):
 
58
 
 
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()
 
64
        try:
 
65
            self.assertEqual('secret',
 
66
                             self.apply_redirected(ui.stdin, ui.stdout,
 
67
                                                   ui.stderr,
 
68
                                                   ui.get_password))
 
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())
 
74
        finally:
 
75
            pb.finished()
 
76
 
 
77
    def test_text_factory_utf8_password(self):
 
78
        """Test an utf8 password.
 
79
 
 
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.
 
82
        """
 
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()
 
88
        try:
 
89
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
90
                                             ui.get_password,
 
91
                                             u'Hello \u1234 %(user)s',
 
92
                                             user=u'some\u1234')
 
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())
 
100
        finally:
 
101
            pb.finished()
 
102
 
 
103
    def test_progress_note(self):
 
104
        stderr = tests.StringIOWrapper()
 
105
        stdout = tests.StringIOWrapper()
 
106
        ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
 
107
                                                stderr=stderr,
 
108
                                                stdout=stdout)
 
109
        pb = ui_factory.nested_progress_bar()
 
110
        try:
 
111
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
112
                pb.note,
 
113
                't')
 
114
            self.assertEqual(None, result)
 
115
            self.assertEqual("t\n", stdout.getvalue())
 
116
            # Since there was no update() call, there should be no clear() call
 
117
            self.failIf(re.search(r'^\r {10,}\r$',
 
118
                                  stderr.getvalue()) is not None,
 
119
                        'We cleared the stderr without anything to put there')
 
120
        finally:
 
121
            pb.finished()
 
122
 
 
123
    def test_progress_note_clears(self):
 
124
        stderr = test_progress._TTYStringIO()
 
125
        stdout = test_progress._TTYStringIO()
 
126
        # so that we get a TextProgressBar
 
127
        os.environ['TERM'] = 'xterm'
 
128
        ui_factory = _mod_ui_text.TextUIFactory(
 
129
            stdin=tests.StringIOWrapper(''),
 
130
            stdout=stdout, stderr=stderr)
 
131
        self.assertIsInstance(ui_factory._progress_view,
 
132
                              _mod_ui_text.TextProgressView)
 
133
        pb = ui_factory.nested_progress_bar()
 
134
        try:
 
135
            # Create a progress update that isn't throttled
 
136
            pb.update('x', 1, 1)
 
137
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
138
                pb.note, 't')
 
139
            self.assertEqual(None, result)
 
140
            self.assertEqual("t\n", stdout.getvalue())
 
141
            # the exact contents will depend on the terminal width and we don't
 
142
            # care about that right now - but you're probably running it on at
 
143
            # least a 10-character wide terminal :)
 
144
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
145
        finally:
 
146
            pb.finished()
 
147
 
 
148
    def test_text_ui_get_boolean(self):
 
149
        stdin = tests.StringIOWrapper("y\n" # True
 
150
                                      "n\n" # False
 
151
                                      "yes with garbage\nY\n" # True
 
152
                                      "not an answer\nno\n" # False
 
153
                                      "I'm sure!\nyes\n" # True
 
154
                                      "NO\n" # False
 
155
                                      "foo\n")
 
156
        stdout = tests.StringIOWrapper()
 
157
        stderr = tests.StringIOWrapper()
 
158
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
159
        self.assertEqual(True, factory.get_boolean(""))
 
160
        self.assertEqual(False, factory.get_boolean(""))
 
161
        self.assertEqual(True, factory.get_boolean(""))
 
162
        self.assertEqual(False, factory.get_boolean(""))
 
163
        self.assertEqual(True, factory.get_boolean(""))
 
164
        self.assertEqual(False, factory.get_boolean(""))
 
165
        self.assertEqual("foo\n", factory.stdin.read())
 
166
        # stdin should be empty
 
167
        self.assertEqual('', factory.stdin.readline())
 
168
 
 
169
    def test_text_ui_get_integer(self):
 
170
        stdin = tests.StringIOWrapper(
 
171
            "1\n"
 
172
            "  -2  \n"
 
173
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
 
174
        stdout = tests.StringIOWrapper()
 
175
        stderr = tests.StringIOWrapper()
 
176
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
177
        self.assertEqual(1, factory.get_integer(""))
 
178
        self.assertEqual(-2, factory.get_integer(""))
 
179
        self.assertEqual(42, factory.get_integer(""))
 
180
 
 
181
    def test_text_factory_prompt(self):
 
182
        # see <https://launchpad.net/bugs/365891>
 
183
        StringIO = tests.StringIOWrapper
 
184
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
 
185
        factory.prompt('foo %2e')
 
186
        self.assertEqual('', factory.stdout.getvalue())
 
187
        self.assertEqual('foo %2e', factory.stderr.getvalue())
 
188
 
 
189
    def test_text_factory_prompts_and_clears(self):
 
190
        # a get_boolean call should clear the pb before prompting
 
191
        out = test_progress._TTYStringIO()
 
192
        os.environ['TERM'] = 'xterm'
 
193
        factory = _mod_ui_text.TextUIFactory(
 
194
            stdin=tests.StringIOWrapper("yada\ny\n"),
 
195
            stdout=out, stderr=out)
 
196
        pb = factory.nested_progress_bar()
 
197
        pb.show_bar = False
 
198
        pb.show_spinner = False
 
199
        pb.show_count = False
 
200
        pb.update("foo", 0, 1)
 
201
        self.assertEqual(True,
 
202
                         self.apply_redirected(None, factory.stdout,
 
203
                                               factory.stdout,
 
204
                                               factory.get_boolean,
 
205
                                               "what do you want"))
 
206
        output = out.getvalue()
 
207
        self.assertContainsRe(factory.stdout.getvalue(),
 
208
            "foo *\r\r  *\r*")
 
209
        self.assertContainsRe(factory.stdout.getvalue(),
 
210
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
 
211
        # stdin should have been totally consumed
 
212
        self.assertEqual('', factory.stdin.readline())
 
213
 
 
214
    def test_text_tick_after_update(self):
 
215
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
 
216
                                                stderr=tests.StringIOWrapper())
 
217
        pb = ui_factory.nested_progress_bar()
 
218
        try:
 
219
            pb.update('task', 0, 3)
 
220
            # Reset the clock, so that it actually tries to repaint itself
 
221
            ui_factory._progress_view._last_repaint = time.time() - 1.0
 
222
            pb.tick()
 
223
        finally:
 
224
            pb.finished()
 
225
 
 
226
    def test_text_ui_getusername(self):
 
227
        factory = _mod_ui_text.TextUIFactory(None, None, None)
 
228
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
 
229
        factory.stdout = tests.StringIOWrapper()
 
230
        factory.stderr = tests.StringIOWrapper()
 
231
        factory.stdout.encoding = "utf8"
 
232
        # there is no output from the base factory
 
233
        self.assertEqual("someuser",
 
234
                         factory.get_username('Hello %(host)s', host='some'))
 
235
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
 
236
        self.assertEquals('', factory.stdout.getvalue())
 
237
        self.assertEqual("", factory.get_username("Gebruiker"))
 
238
        # stdin should be empty
 
239
        self.assertEqual('', factory.stdin.readline())
 
240
 
 
241
    def test_text_ui_getusername_utf8(self):
 
242
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
243
                                 stdout=tests.StringIOWrapper(),
 
244
                                 stderr=tests.StringIOWrapper())
 
245
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
246
        pb = ui.nested_progress_bar()
 
247
        try:
 
248
            # there is no output from the base factory
 
249
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
250
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
 
251
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
 
252
            self.assertEquals(u"Hello\u1234 some\u1234: ",
 
253
                              ui.stderr.getvalue().decode("utf8"))
 
254
            self.assertEquals('', ui.stdout.getvalue())
 
255
        finally:
 
256
            pb.finished()
 
257
 
 
258
    def test_quietness(self):
 
259
        os.environ['BZR_PROGRESS_BAR'] = 'text'
 
260
        ui_factory = _mod_ui_text.TextUIFactory(None,
 
261
            test_progress._TTYStringIO(),
 
262
            test_progress._TTYStringIO())
 
263
        self.assertIsInstance(ui_factory._progress_view,
 
264
            _mod_ui_text.TextProgressView)
 
265
        ui_factory.be_quiet(True)
 
266
        self.assertIsInstance(ui_factory._progress_view,
 
267
            _mod_ui_text.NullProgressView)
 
268
 
 
269
    def test_text_ui_show_user_warning(self):
 
270
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
 
271
        from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
 
272
        err = StringIO()
 
273
        out = StringIO()
 
274
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
 
275
        remote_fmt = remote.RemoteRepositoryFormat()
 
276
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
 
277
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
 
278
            to_format=remote_fmt)
 
279
        self.assertEquals('', out.getvalue())
 
280
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
 
281
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
 
282
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
 
283
            "the same format for better performance.\n",
 
284
            err.getvalue())
 
285
        # and now with it suppressed please
 
286
        err = StringIO()
 
287
        out = StringIO()
 
288
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
 
289
        ui.suppressed_warnings.add('cross_format_fetch')
 
290
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
 
291
            to_format=remote_fmt)
 
292
        self.assertEquals('', out.getvalue())
 
293
        self.assertEquals('', err.getvalue())
 
294
 
 
295
 
 
296
class TestTextUIOutputStream(tests.TestCase):
 
297
    """Tests for output stream that synchronizes with progress bar."""
 
298
 
 
299
    def test_output_clears_terminal(self):
 
300
        stdout = tests.StringIOWrapper()
 
301
        stderr = tests.StringIOWrapper()
 
302
        clear_calls = []
 
303
 
 
304
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
 
305
        uif.clear_term = lambda: clear_calls.append('clear')
 
306
 
 
307
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
 
308
        stream.write("Hello world!\n")
 
309
        stream.write("there's more...\n")
 
310
        stream.writelines(["1\n", "2\n", "3\n"])
 
311
 
 
312
        self.assertEqual(stdout.getvalue(),
 
313
            "Hello world!\n"
 
314
            "there's more...\n"
 
315
            "1\n2\n3\n")
 
316
        self.assertEqual(['clear', 'clear', 'clear'],
 
317
            clear_calls)
 
318
 
 
319
        stream.flush()
 
320
 
 
321
 
 
322
class UITests(tests.TestCase):
 
323
 
 
324
    def test_progress_construction(self):
 
325
        """TextUIFactory constructs the right progress view.
 
326
        """
 
327
        TTYStringIO = test_progress._TTYStringIO
 
328
        FileStringIO = tests.StringIOWrapper
 
329
        for (file_class, term, pb, expected_pb_class) in (
 
330
            # on an xterm, either use them or not as the user requests,
 
331
            # otherwise default on
 
332
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
 
333
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
 
334
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
 
335
            # on a dumb terminal, again if there's explicit configuration do
 
336
            # it, otherwise default off
 
337
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
 
338
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
339
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
340
            # on a non-tty terminal, it's null regardless of $TERM
 
341
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
 
342
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
343
            # however, it can still be forced on
 
344
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
345
            ):
 
346
            os.environ['TERM'] = term
 
347
            if pb is None:
 
348
                if 'BZR_PROGRESS_BAR' in os.environ:
 
349
                    del os.environ['BZR_PROGRESS_BAR']
 
350
            else:
 
351
                os.environ['BZR_PROGRESS_BAR'] = pb
 
352
            stdin = file_class('')
 
353
            stderr = file_class()
 
354
            stdout = file_class()
 
355
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
 
356
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
 
357
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
358
            self.assertIsInstance(uif.make_progress_view(),
 
359
                expected_pb_class,
 
360
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
361
 
 
362
    def test_text_ui_non_terminal(self):
 
363
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
 
364
        stdin = test_progress._NonTTYStringIO('')
 
365
        stderr = test_progress._NonTTYStringIO()
 
366
        stdout = test_progress._NonTTYStringIO()
 
367
        for term_type in ['dumb', None, 'xterm']:
 
368
            if term_type is None:
 
369
                del os.environ['TERM']
 
370
            else:
 
371
                os.environ['TERM'] = term_type
 
372
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
 
373
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
 
374
                'TERM=%r' % (term_type,))
 
375
 
 
376
 
 
377
class SilentUITests(tests.TestCase):
 
378
 
 
379
    def test_silent_factory_get_password(self):
 
380
        # A silent factory that can't do user interaction can't get a
 
381
        # password.  Possibly it should raise a more specific error but it
 
382
        # can't succeed.
 
383
        ui = _mod_ui.SilentUIFactory()
 
384
        stdout = tests.StringIOWrapper()
 
385
        self.assertRaises(
 
386
            NotImplementedError,
 
387
            self.apply_redirected,
 
388
            None, stdout, stdout, ui.get_password)
 
389
        # and it didn't write anything out either
 
390
        self.assertEqual('', stdout.getvalue())
 
391
 
 
392
    def test_silent_ui_getbool(self):
 
393
        factory = _mod_ui.SilentUIFactory()
 
394
        stdout = tests.StringIOWrapper()
 
395
        self.assertRaises(
 
396
            NotImplementedError,
 
397
            self.apply_redirected,
 
398
            None, stdout, stdout, factory.get_boolean, "foo")
 
399
 
 
400
 
 
401
class TestUIFactoryTests(tests.TestCase):
 
402
 
 
403
    def test_test_ui_factory_progress(self):
 
404
        # there's no output; we just want to make sure this doesn't crash -
 
405
        # see https://bugs.launchpad.net/bzr/+bug/408201
 
406
        ui = tests.TestUIFactory()
 
407
        pb = ui.nested_progress_bar()
 
408
        pb.update('hello')
 
409
        pb.tick()
 
410
        pb.finished()
 
411
 
 
412
 
 
413
class CannedInputUIFactoryTests(tests.TestCase):
 
414
 
 
415
    def test_canned_input_get_input(self):
 
416
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
 
417
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
 
418
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
 
419
        self.assertEqual('password',
 
420
                         uif.get_password('Password for %(host)s',
 
421
                                          host='example.com'))
 
422
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
 
423
 
 
424
 
 
425
class TestBoolFromString(tests.TestCase):
 
426
 
 
427
    def assertIsTrue(self, s, accepted_values=None):
 
428
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
429
        self.assertEquals(True, res)
 
430
 
 
431
    def assertIsFalse(self, s, accepted_values=None):
 
432
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
433
        self.assertEquals(False, res)
 
434
 
 
435
    def assertIsNone(self, s, accepted_values=None):
 
436
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
437
        self.assertIs(None, res)
 
438
 
 
439
    def test_know_valid_values(self):
 
440
        self.assertIsTrue('true')
 
441
        self.assertIsFalse('false')
 
442
        self.assertIsTrue('1')
 
443
        self.assertIsFalse('0')
 
444
        self.assertIsTrue('on')
 
445
        self.assertIsFalse('off')
 
446
        self.assertIsTrue('yes')
 
447
        self.assertIsFalse('no')
 
448
        self.assertIsTrue('y')
 
449
        self.assertIsFalse('n')
 
450
        # Also try some case variations
 
451
        self.assertIsTrue('True')
 
452
        self.assertIsFalse('False')
 
453
        self.assertIsTrue('On')
 
454
        self.assertIsFalse('Off')
 
455
        self.assertIsTrue('ON')
 
456
        self.assertIsFalse('OFF')
 
457
        self.assertIsTrue('oN')
 
458
        self.assertIsFalse('oFf')
 
459
 
 
460
    def test_invalid_values(self):
 
461
        self.assertIsNone(None)
 
462
        self.assertIsNone('doubt')
 
463
        self.assertIsNone('frue')
 
464
        self.assertIsNone('talse')
 
465
        self.assertIsNone('42')
 
466
 
 
467
    def test_provided_values(self):
 
468
        av = dict(y=True, n=False, yes=True, no=False)
 
469
        self.assertIsTrue('y', av)
 
470
        self.assertIsTrue('Y', av)
 
471
        self.assertIsTrue('Yes', av)
 
472
        self.assertIsFalse('n', av)
 
473
        self.assertIsFalse('N', av)
 
474
        self.assertIsFalse('No', av)
 
475
        self.assertIsNone('1', av)
 
476
        self.assertIsNone('0', av)
 
477
        self.assertIsNone('on', av)
 
478
        self.assertIsNone('off', av)