← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ui.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-10 17:52:08 UTC
  • mfrom: (5021 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5023.
  • Revision ID: john@arbash-meinel.com-20100210175208-bubuwav4uqigu291
Merge bzr.dev 5021 to resolve NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Tests for the bzrlib ui
18
18
"""
19
19
 
 
20
import os
 
21
import re
20
22
import time
21
23
 
22
 
from StringIO import StringIO
23
 
 
24
 
from testtools.matchers import *
25
 
 
26
24
from bzrlib import (
27
 
    config,
28
 
    remote,
 
25
    errors,
29
26
    tests,
30
27
    ui as _mod_ui,
31
28
    )
32
 
from bzrlib.tests import (
33
 
    fixtures,
34
 
    test_progress,
 
29
from bzrlib.symbol_versioning import (
 
30
    deprecated_in,
35
31
    )
 
32
from bzrlib.tests import test_progress
36
33
from bzrlib.ui import text as _mod_ui_text
37
 
from bzrlib.tests.testui import (
38
 
    ProgressRecordingUIFactory,
39
 
    )
40
 
 
41
 
 
42
 
class TestUIConfiguration(tests.TestCaseWithTransport):
43
 
 
44
 
    def test_output_encoding_configuration(self):
45
 
        enc = fixtures.generate_unicode_encodings().next()
46
 
        config.GlobalConfig().set_user_option('output_encoding',
47
 
            enc)
48
 
        ui = tests.TestUIFactory(stdin=None,
49
 
            stdout=tests.StringIOWrapper(),
50
 
            stderr=tests.StringIOWrapper())
51
 
        output = ui.make_output_stream()
52
 
        self.assertEquals(output.encoding, enc)
53
34
 
54
35
 
55
36
class TestTextUIFactory(tests.TestCase):
56
37
 
57
 
    def make_test_ui_factory(self, stdin_contents):
58
 
        ui = tests.TestUIFactory(stdin=stdin_contents,
59
 
                                 stdout=tests.StringIOWrapper(),
60
 
                                 stderr=tests.StringIOWrapper())
61
 
        return ui
62
 
 
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',
68
 
            {'thing': 'this'},),
69
 
            False)
70
 
 
71
38
    def test_text_factory_ascii_password(self):
72
 
        ui = self.make_test_ui_factory('secret\n')
 
39
        ui = tests.TestUIFactory(stdin='secret\n',
 
40
                                 stdout=tests.StringIOWrapper(),
 
41
                                 stderr=tests.StringIOWrapper())
73
42
        pb = ui.nested_progress_bar()
74
43
        try:
75
44
            self.assertEqual('secret',
90
59
        We can't predict what encoding users will have for stdin, so we force
91
60
        it to utf8 to test that we transport the password correctly.
92
61
        """
93
 
        ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
 
62
        ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
63
                                 stdout=tests.StringIOWrapper(),
 
64
                                 stderr=tests.StringIOWrapper())
94
65
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
95
66
        pb = ui.nested_progress_bar()
96
67
        try:
108
79
        finally:
109
80
            pb.finished()
110
81
 
 
82
    def test_progress_note(self):
 
83
        stderr = tests.StringIOWrapper()
 
84
        stdout = tests.StringIOWrapper()
 
85
        ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
 
86
                                                stderr=stderr,
 
87
                                                stdout=stdout)
 
88
        pb = ui_factory.nested_progress_bar()
 
89
        try:
 
90
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
91
                pb.note,
 
92
                't')
 
93
            self.assertEqual(None, result)
 
94
            self.assertEqual("t\n", stdout.getvalue())
 
95
            # 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,
 
98
                        'We cleared the stderr without anything to put there')
 
99
        finally:
 
100
            pb.finished()
 
101
 
 
102
    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)
 
112
        pb = ui_factory.nested_progress_bar()
 
113
        try:
 
114
            # Create a progress update that isn't throttled
 
115
            pb.update('x', 1, 1)
 
116
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
117
                pb.note, 't')
 
118
            self.assertEqual(None, result)
 
119
            self.assertEqual("t\n", stdout.getvalue())
 
120
            # the exact contents will depend on the terminal width and we don't
 
121
            # care about that right now - but you're probably running it on at
 
122
            # least a 10-character wide terminal :)
 
123
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
124
        finally:
 
125
            pb.finished()
 
126
 
111
127
    def test_text_ui_get_boolean(self):
112
128
        stdin = tests.StringIOWrapper("y\n" # True
113
129
                                      "n\n" # False
114
 
                                      " \n y \n" # True
115
 
                                      " no \n" # False
116
130
                                      "yes with garbage\nY\n" # True
117
131
                                      "not an answer\nno\n" # False
118
132
                                      "I'm sure!\nyes\n" # True
121
135
        stdout = tests.StringIOWrapper()
122
136
        stderr = tests.StringIOWrapper()
123
137
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
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""))
128
 
        self.assertEqual(True, factory.get_boolean(u""))
129
 
        self.assertEqual(False, factory.get_boolean(u""))
130
 
        self.assertEqual(True, factory.get_boolean(u""))
131
 
        self.assertEqual(False, factory.get_boolean(u""))
132
 
        self.assertEqual("foo\n", factory.stdin.read())
133
 
        # stdin should be empty
134
 
        self.assertEqual('', factory.stdin.readline())
135
 
        # return false on EOF
136
 
        self.assertEqual(False, factory.get_boolean(u""))
137
 
 
138
 
    def test_text_ui_choose_bad_parameters(self):
139
 
        stdin = tests.StringIOWrapper()
140
 
        stdout = tests.StringIOWrapper()
141
 
        stderr = tests.StringIOWrapper()
142
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
143
 
        # invalid default index
144
 
        self.assertRaises(ValueError, factory.choose, u"", u"&Yes\n&No", 3)
145
 
        # duplicated choice
146
 
        self.assertRaises(ValueError, factory.choose, u"", u"&choice\n&ChOiCe")
147
 
        # duplicated shortcut
148
 
        self.assertRaises(ValueError, factory.choose, u"", u"&choice1\nchoi&ce2")
149
 
 
150
 
    def test_text_ui_choose_prompt(self):
151
 
        stdin = tests.StringIOWrapper()
152
 
        stdout = tests.StringIOWrapper()
153
 
        stderr = tests.StringIOWrapper()
154
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
155
 
        # choices with explicit shortcuts
156
 
        factory.choose(u"prompt", u"&yes\n&No\nmore &info")
157
 
        self.assertEqual("prompt ([y]es, [N]o, more [i]nfo): \n", factory.stderr.getvalue())
158
 
        # automatic shortcuts
159
 
        factory.stderr.truncate(0)
160
 
        factory.choose(u"prompt", u"yes\nNo\nmore info")
161
 
        self.assertEqual("prompt ([y]es, [N]o, [m]ore info): \n", factory.stderr.getvalue())
162
 
 
163
 
    def test_text_ui_choose_return_values(self):
164
 
        choose = lambda: factory.choose(u"", u"&Yes\n&No\nMaybe\nmore &info", 3)
165
 
        stdin = tests.StringIOWrapper("y\n" # 0
166
 
                                      "n\n" # 1
167
 
                                      " \n" # default: 3
168
 
                                      " no \n" # 1
169
 
                                      "b\na\nd \n" # bad shortcuts, all ignored
170
 
                                      "yes with garbage\nY\n" # 0
171
 
                                      "not an answer\nno\n" # 1
172
 
                                      "info\nmore info\n" # 3
173
 
                                      "Maybe\n" # 2
174
 
                                      "foo\n")
175
 
        stdout = tests.StringIOWrapper()
176
 
        stderr = tests.StringIOWrapper()
177
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
178
 
        self.assertEqual(0, choose())
179
 
        self.assertEqual(1, choose())
180
 
        self.assertEqual(3, choose())
181
 
        self.assertEqual(1, choose())
182
 
        self.assertEqual(0, choose())
183
 
        self.assertEqual(1, choose())
184
 
        self.assertEqual(3, choose())
185
 
        self.assertEqual(2, choose())
186
 
        self.assertEqual("foo\n", factory.stdin.read())
187
 
        # stdin should be empty
188
 
        self.assertEqual('', factory.stdin.readline())
189
 
        # return None on EOF
190
 
        self.assertEqual(None, choose())
191
 
 
192
 
    def test_text_ui_choose_no_default(self):
193
 
        stdin = tests.StringIOWrapper(" \n" # no default, invalid!
194
 
                                      " yes \n" # 0
195
 
                                      "foo\n")
196
 
        stdout = tests.StringIOWrapper()
197
 
        stderr = tests.StringIOWrapper()
198
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
199
 
        self.assertEqual(0, factory.choose(u"", u"&Yes\n&No"))
200
 
        self.assertEqual("foo\n", factory.stdin.read())
 
138
        self.assertEqual(True, factory.get_boolean(""))
 
139
        self.assertEqual(False, factory.get_boolean(""))
 
140
        self.assertEqual(True, factory.get_boolean(""))
 
141
        self.assertEqual(False, factory.get_boolean(""))
 
142
        self.assertEqual(True, factory.get_boolean(""))
 
143
        self.assertEqual(False, factory.get_boolean(""))
 
144
        self.assertEqual("foo\n", factory.stdin.read())
 
145
        # stdin should be empty
 
146
        self.assertEqual('', factory.stdin.readline())
201
147
 
202
148
    def test_text_ui_get_integer(self):
203
149
        stdin = tests.StringIOWrapper(
207
153
        stdout = tests.StringIOWrapper()
208
154
        stderr = tests.StringIOWrapper()
209
155
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
210
 
        self.assertEqual(1, factory.get_integer(u""))
211
 
        self.assertEqual(-2, factory.get_integer(u""))
212
 
        self.assertEqual(42, factory.get_integer(u""))
 
156
        self.assertEqual(1, factory.get_integer(""))
 
157
        self.assertEqual(-2, factory.get_integer(""))
 
158
        self.assertEqual(42, factory.get_integer(""))
213
159
 
214
160
    def test_text_factory_prompt(self):
215
161
        # see <https://launchpad.net/bugs/365891>
216
162
        StringIO = tests.StringIOWrapper
217
163
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
218
 
        factory.prompt(u'foo %2e')
 
164
        factory.prompt('foo %2e')
219
165
        self.assertEqual('', factory.stdout.getvalue())
220
166
        self.assertEqual('foo %2e', factory.stderr.getvalue())
221
167
 
222
168
    def test_text_factory_prompts_and_clears(self):
223
169
        # a get_boolean call should clear the pb before prompting
224
170
        out = test_progress._TTYStringIO()
225
 
        self.overrideEnv('TERM', 'xterm')
 
171
        os.environ['TERM'] = 'xterm'
226
172
        factory = _mod_ui_text.TextUIFactory(
227
173
            stdin=tests.StringIOWrapper("yada\ny\n"),
228
174
            stdout=out, stderr=out)
229
 
        factory._avail_width = lambda: 79
230
175
        pb = factory.nested_progress_bar()
231
176
        pb.show_bar = False
232
177
        pb.show_spinner = False
236
181
                         self.apply_redirected(None, factory.stdout,
237
182
                                               factory.stdout,
238
183
                                               factory.get_boolean,
239
 
                                               u"what do you want"))
 
184
                                               "what do you want"))
240
185
        output = out.getvalue()
241
 
        self.assertContainsRe(output,
242
 
            "| foo *\r\r  *\r*")
243
 
        self.assertContainsString(output,
244
 
            r"what do you want? ([y]es, [n]o): what do you want? ([y]es, [n]o): ")
 
186
        self.assertContainsRe(factory.stdout.getvalue(),
 
187
            "foo *\r\r  *\r*")
 
188
        self.assertContainsRe(factory.stdout.getvalue(),
 
189
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
245
190
        # stdin should have been totally consumed
246
191
        self.assertEqual('', factory.stdin.readline())
247
192
 
265
210
        factory.stdout.encoding = "utf8"
266
211
        # there is no output from the base factory
267
212
        self.assertEqual("someuser",
268
 
                         factory.get_username(u'Hello %(host)s', host='some'))
 
213
                         factory.get_username('Hello %(host)s', host='some'))
269
214
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
270
215
        self.assertEquals('', factory.stdout.getvalue())
271
 
        self.assertEqual("", factory.get_username(u"Gebruiker"))
 
216
        self.assertEqual("", factory.get_username("Gebruiker"))
272
217
        # stdin should be empty
273
218
        self.assertEqual('', factory.stdin.readline())
274
219
 
290
235
            pb.finished()
291
236
 
292
237
    def test_quietness(self):
293
 
        self.overrideEnv('BZR_PROGRESS_BAR', 'text')
 
238
        os.environ['BZR_PROGRESS_BAR'] = 'text'
294
239
        ui_factory = _mod_ui_text.TextUIFactory(None,
295
240
            test_progress._TTYStringIO(),
296
241
            test_progress._TTYStringIO())
300
245
        self.assertIsInstance(ui_factory._progress_view,
301
246
            _mod_ui_text.NullProgressView)
302
247
 
303
 
    def test_text_ui_show_user_warning(self):
304
 
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
305
 
        from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack5
306
 
        err = StringIO()
307
 
        out = StringIO()
308
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
309
 
        remote_fmt = remote.RemoteRepositoryFormat()
310
 
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
311
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
312
 
            to_format=remote_fmt)
313
 
        self.assertEquals('', out.getvalue())
314
 
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
315
 
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
316
 
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
317
 
            "the same format for better performance.\n",
318
 
            err.getvalue())
319
 
        # and now with it suppressed please
320
 
        err = StringIO()
321
 
        out = StringIO()
322
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
323
 
        ui.suppressed_warnings.add('cross_format_fetch')
324
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
325
 
            to_format=remote_fmt)
326
 
        self.assertEquals('', out.getvalue())
327
 
        self.assertEquals('', err.getvalue())
328
 
 
329
248
 
330
249
class TestTextUIOutputStream(tests.TestCase):
331
250
    """Tests for output stream that synchronizes with progress bar."""
377
296
            # however, it can still be forced on
378
297
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
379
298
            ):
380
 
            self.overrideEnv('TERM', term)
381
 
            self.overrideEnv('BZR_PROGRESS_BAR', pb)
 
299
            os.environ['TERM'] = term
 
300
            if pb is None:
 
301
                if 'BZR_PROGRESS_BAR' in os.environ:
 
302
                    del os.environ['BZR_PROGRESS_BAR']
 
303
            else:
 
304
                os.environ['BZR_PROGRESS_BAR'] = pb
382
305
            stdin = file_class('')
383
306
            stderr = file_class()
384
307
            stdout = file_class()
395
318
        stderr = test_progress._NonTTYStringIO()
396
319
        stdout = test_progress._NonTTYStringIO()
397
320
        for term_type in ['dumb', None, 'xterm']:
398
 
            self.overrideEnv('TERM', term_type)
 
321
            if term_type is None:
 
322
                del os.environ['TERM']
 
323
            else:
 
324
                os.environ['TERM'] = term_type
399
325
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
400
326
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
401
327
                'TERM=%r' % (term_type,))
422
348
        self.assertRaises(
423
349
            NotImplementedError,
424
350
            self.apply_redirected,
425
 
            None, stdout, stdout, factory.get_boolean, u"foo")
 
351
            None, stdout, stdout, factory.get_boolean, "foo")
426
352
 
427
353
 
428
354
class TestUIFactoryTests(tests.TestCase):
429
355
 
430
356
    def test_test_ui_factory_progress(self):
431
357
        # there's no output; we just want to make sure this doesn't crash -
432
 
        # see https://bugs.launchpad.net/bzr/+bug/408201
 
358
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
433
359
        ui = tests.TestUIFactory()
434
360
        pb = ui.nested_progress_bar()
435
361
        pb.update('hello')
441
367
 
442
368
    def test_canned_input_get_input(self):
443
369
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
444
 
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
445
 
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
 
370
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
 
371
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
446
372
        self.assertEqual('password',
447
 
                         uif.get_password(u'Password for %(host)s',
 
373
                         uif.get_password('Password for %(host)s',
448
374
                                          host='example.com'))
449
 
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
 
375
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
450
376
 
451
377
 
452
378
class TestBoolFromString(tests.TestCase):
503
429
        self.assertIsNone('0', av)
504
430
        self.assertIsNone('on', av)
505
431
        self.assertIsNone('off', av)
506
 
 
507
 
 
508
 
class TestConfirmationUserInterfacePolicy(tests.TestCase):
509
 
 
510
 
    def test_confirm_action_default(self):
511
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
512
 
        for answer in [True, False]:
513
 
            self.assertEquals(
514
 
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
515
 
                .confirm_action("Do something?",
516
 
                    "bzrlib.tests.do_something", {}),
517
 
                answer)
518
 
 
519
 
    def test_confirm_action_specific(self):
520
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
521
 
        for default_answer in [True, False]:
522
 
            for specific_answer in [True, False]:
523
 
                for conf_id in ['given_id', 'other_id']:
524
 
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
525
 
                        base_ui, default_answer, dict(given_id=specific_answer))
526
 
                    result = wrapper.confirm_action("Do something?", conf_id, {})
527
 
                    if conf_id == 'given_id':
528
 
                        self.assertEquals(result, specific_answer)
529
 
                    else:
530
 
                        self.assertEquals(result, default_answer)
531
 
 
532
 
    def test_repr(self):
533
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
534
 
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
535
 
            base_ui, True, dict(a=2))
536
 
        self.assertThat(repr(wrapper),
537
 
            Equals("ConfirmationUserInterfacePolicy("
538
 
                "NoninteractiveUIFactory(), True, {'a': 2})"))
539
 
 
540
 
 
541
 
class TestProgressRecordingUI(tests.TestCase):
542
 
    """Test test-oriented UIFactory that records progress updates"""
543
 
 
544
 
    def test_nested_ignore_depth_beyond_one(self):
545
 
        # we only want to capture the first level out progress, not
546
 
        # want sub-components might do. So we have nested bars ignored.
547
 
        factory = ProgressRecordingUIFactory()
548
 
        pb1 = factory.nested_progress_bar()
549
 
        pb1.update('foo', 0, 1)
550
 
        pb2 = factory.nested_progress_bar()
551
 
        pb2.update('foo', 0, 1)
552
 
        pb2.finished()
553
 
        pb1.finished()
554
 
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)