← 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: Martin
  • Date: 2010-04-16 12:59:03 UTC
  • mto: (5177.1.1 integration2)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: gzlist@googlemail.com-20100416125903-yjm9d5uc7l8ilxpf
Catch a couple of missed plugin module docstrings, note need for assignment to __doc__ in developer documentation and 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, 2008, 2009, 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
24
from StringIO import StringIO
23
25
 
24
 
from testtools.matchers import *
25
 
 
26
26
from bzrlib import (
27
 
    config,
 
27
    errors,
28
28
    remote,
 
29
    repository,
29
30
    tests,
30
31
    ui as _mod_ui,
31
32
    )
32
 
from bzrlib.tests import (
33
 
    fixtures,
34
 
    test_progress,
 
33
from bzrlib.symbol_versioning import (
 
34
    deprecated_in,
35
35
    )
 
36
from bzrlib.tests import test_progress
36
37
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
38
 
54
39
 
55
40
class TestTextUIFactory(tests.TestCase):
56
41
 
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
42
    def test_text_factory_ascii_password(self):
72
 
        ui = self.make_test_ui_factory('secret\n')
 
43
        ui = tests.TestUIFactory(stdin='secret\n',
 
44
                                 stdout=tests.StringIOWrapper(),
 
45
                                 stderr=tests.StringIOWrapper())
73
46
        pb = ui.nested_progress_bar()
74
47
        try:
75
48
            self.assertEqual('secret',
90
63
        We can't predict what encoding users will have for stdin, so we force
91
64
        it to utf8 to test that we transport the password correctly.
92
65
        """
93
 
        ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
 
66
        ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
67
                                 stdout=tests.StringIOWrapper(),
 
68
                                 stderr=tests.StringIOWrapper())
94
69
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
95
70
        pb = ui.nested_progress_bar()
96
71
        try:
108
83
        finally:
109
84
            pb.finished()
110
85
 
 
86
    def test_progress_note(self):
 
87
        stderr = tests.StringIOWrapper()
 
88
        stdout = tests.StringIOWrapper()
 
89
        ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
 
90
                                                stderr=stderr,
 
91
                                                stdout=stdout)
 
92
        pb = ui_factory.nested_progress_bar()
 
93
        try:
 
94
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
95
                pb.note,
 
96
                't')
 
97
            self.assertEqual(None, result)
 
98
            self.assertEqual("t\n", stdout.getvalue())
 
99
            # Since there was no update() call, there should be no clear() call
 
100
            self.failIf(re.search(r'^\r {10,}\r$',
 
101
                                  stderr.getvalue()) is not None,
 
102
                        'We cleared the stderr without anything to put there')
 
103
        finally:
 
104
            pb.finished()
 
105
 
 
106
    def test_progress_note_clears(self):
 
107
        stderr = test_progress._TTYStringIO()
 
108
        stdout = test_progress._TTYStringIO()
 
109
        # so that we get a TextProgressBar
 
110
        os.environ['TERM'] = 'xterm'
 
111
        ui_factory = _mod_ui_text.TextUIFactory(
 
112
            stdin=tests.StringIOWrapper(''),
 
113
            stdout=stdout, stderr=stderr)
 
114
        self.assertIsInstance(ui_factory._progress_view,
 
115
                              _mod_ui_text.TextProgressView)
 
116
        pb = ui_factory.nested_progress_bar()
 
117
        try:
 
118
            # Create a progress update that isn't throttled
 
119
            pb.update('x', 1, 1)
 
120
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
121
                pb.note, 't')
 
122
            self.assertEqual(None, result)
 
123
            self.assertEqual("t\n", stdout.getvalue())
 
124
            # the exact contents will depend on the terminal width and we don't
 
125
            # care about that right now - but you're probably running it on at
 
126
            # least a 10-character wide terminal :)
 
127
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
128
        finally:
 
129
            pb.finished()
 
130
 
111
131
    def test_text_ui_get_boolean(self):
112
132
        stdin = tests.StringIOWrapper("y\n" # True
113
133
                                      "n\n" # False
119
139
        stdout = tests.StringIOWrapper()
120
140
        stderr = tests.StringIOWrapper()
121
141
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
122
 
        self.assertEqual(True, factory.get_boolean(u""))
123
 
        self.assertEqual(False, factory.get_boolean(u""))
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""))
 
142
        self.assertEqual(True, factory.get_boolean(""))
 
143
        self.assertEqual(False, factory.get_boolean(""))
 
144
        self.assertEqual(True, factory.get_boolean(""))
 
145
        self.assertEqual(False, factory.get_boolean(""))
 
146
        self.assertEqual(True, factory.get_boolean(""))
 
147
        self.assertEqual(False, factory.get_boolean(""))
128
148
        self.assertEqual("foo\n", factory.stdin.read())
129
149
        # stdin should be empty
130
150
        self.assertEqual('', factory.stdin.readline())
137
157
        stdout = tests.StringIOWrapper()
138
158
        stderr = tests.StringIOWrapper()
139
159
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
140
 
        self.assertEqual(1, factory.get_integer(u""))
141
 
        self.assertEqual(-2, factory.get_integer(u""))
142
 
        self.assertEqual(42, factory.get_integer(u""))
 
160
        self.assertEqual(1, factory.get_integer(""))
 
161
        self.assertEqual(-2, factory.get_integer(""))
 
162
        self.assertEqual(42, factory.get_integer(""))
143
163
 
144
164
    def test_text_factory_prompt(self):
145
165
        # see <https://launchpad.net/bugs/365891>
146
166
        StringIO = tests.StringIOWrapper
147
167
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
148
 
        factory.prompt(u'foo %2e')
 
168
        factory.prompt('foo %2e')
149
169
        self.assertEqual('', factory.stdout.getvalue())
150
170
        self.assertEqual('foo %2e', factory.stderr.getvalue())
151
171
 
152
172
    def test_text_factory_prompts_and_clears(self):
153
173
        # a get_boolean call should clear the pb before prompting
154
174
        out = test_progress._TTYStringIO()
155
 
        self.overrideEnv('TERM', 'xterm')
 
175
        os.environ['TERM'] = 'xterm'
156
176
        factory = _mod_ui_text.TextUIFactory(
157
177
            stdin=tests.StringIOWrapper("yada\ny\n"),
158
178
            stdout=out, stderr=out)
159
 
        factory._avail_width = lambda: 79
160
179
        pb = factory.nested_progress_bar()
161
180
        pb.show_bar = False
162
181
        pb.show_spinner = False
166
185
                         self.apply_redirected(None, factory.stdout,
167
186
                                               factory.stdout,
168
187
                                               factory.get_boolean,
169
 
                                               u"what do you want"))
 
188
                                               "what do you want"))
170
189
        output = out.getvalue()
171
 
        self.assertContainsRe(output,
172
 
            "| foo *\r\r  *\r*")
173
 
        self.assertContainsRe(output,
 
190
        self.assertContainsRe(factory.stdout.getvalue(),
 
191
            "foo *\r\r  *\r*")
 
192
        self.assertContainsRe(factory.stdout.getvalue(),
174
193
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
175
194
        # stdin should have been totally consumed
176
195
        self.assertEqual('', factory.stdin.readline())
195
214
        factory.stdout.encoding = "utf8"
196
215
        # there is no output from the base factory
197
216
        self.assertEqual("someuser",
198
 
                         factory.get_username(u'Hello %(host)s', host='some'))
 
217
                         factory.get_username('Hello %(host)s', host='some'))
199
218
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
200
219
        self.assertEquals('', factory.stdout.getvalue())
201
 
        self.assertEqual("", factory.get_username(u"Gebruiker"))
 
220
        self.assertEqual("", factory.get_username("Gebruiker"))
202
221
        # stdin should be empty
203
222
        self.assertEqual('', factory.stdin.readline())
204
223
 
220
239
            pb.finished()
221
240
 
222
241
    def test_quietness(self):
223
 
        self.overrideEnv('BZR_PROGRESS_BAR', 'text')
 
242
        os.environ['BZR_PROGRESS_BAR'] = 'text'
224
243
        ui_factory = _mod_ui_text.TextUIFactory(None,
225
244
            test_progress._TTYStringIO(),
226
245
            test_progress._TTYStringIO())
232
251
 
233
252
    def test_text_ui_show_user_warning(self):
234
253
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
235
 
        from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack5
 
254
        from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
236
255
        err = StringIO()
237
256
        out = StringIO()
238
257
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
307
326
            # however, it can still be forced on
308
327
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
309
328
            ):
310
 
            self.overrideEnv('TERM', term)
311
 
            self.overrideEnv('BZR_PROGRESS_BAR', pb)
 
329
            os.environ['TERM'] = term
 
330
            if pb is None:
 
331
                if 'BZR_PROGRESS_BAR' in os.environ:
 
332
                    del os.environ['BZR_PROGRESS_BAR']
 
333
            else:
 
334
                os.environ['BZR_PROGRESS_BAR'] = pb
312
335
            stdin = file_class('')
313
336
            stderr = file_class()
314
337
            stdout = file_class()
325
348
        stderr = test_progress._NonTTYStringIO()
326
349
        stdout = test_progress._NonTTYStringIO()
327
350
        for term_type in ['dumb', None, 'xterm']:
328
 
            self.overrideEnv('TERM', term_type)
 
351
            if term_type is None:
 
352
                del os.environ['TERM']
 
353
            else:
 
354
                os.environ['TERM'] = term_type
329
355
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
330
356
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
331
357
                'TERM=%r' % (term_type,))
352
378
        self.assertRaises(
353
379
            NotImplementedError,
354
380
            self.apply_redirected,
355
 
            None, stdout, stdout, factory.get_boolean, u"foo")
 
381
            None, stdout, stdout, factory.get_boolean, "foo")
356
382
 
357
383
 
358
384
class TestUIFactoryTests(tests.TestCase):
359
385
 
360
386
    def test_test_ui_factory_progress(self):
361
387
        # there's no output; we just want to make sure this doesn't crash -
362
 
        # see https://bugs.launchpad.net/bzr/+bug/408201
 
388
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
363
389
        ui = tests.TestUIFactory()
364
390
        pb = ui.nested_progress_bar()
365
391
        pb.update('hello')
371
397
 
372
398
    def test_canned_input_get_input(self):
373
399
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
374
 
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
375
 
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
 
400
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
 
401
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
376
402
        self.assertEqual('password',
377
 
                         uif.get_password(u'Password for %(host)s',
 
403
                         uif.get_password('Password for %(host)s',
378
404
                                          host='example.com'))
379
 
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
 
405
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
380
406
 
381
407
 
382
408
class TestBoolFromString(tests.TestCase):
433
459
        self.assertIsNone('0', av)
434
460
        self.assertIsNone('on', av)
435
461
        self.assertIsNone('off', av)
436
 
 
437
 
 
438
 
class TestConfirmationUserInterfacePolicy(tests.TestCase):
439
 
 
440
 
    def test_confirm_action_default(self):
441
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
442
 
        for answer in [True, False]:
443
 
            self.assertEquals(
444
 
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
445
 
                .confirm_action("Do something?",
446
 
                    "bzrlib.tests.do_something", {}),
447
 
                answer)
448
 
 
449
 
    def test_confirm_action_specific(self):
450
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
451
 
        for default_answer in [True, False]:
452
 
            for specific_answer in [True, False]:
453
 
                for conf_id in ['given_id', 'other_id']:
454
 
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
455
 
                        base_ui, default_answer, dict(given_id=specific_answer))
456
 
                    result = wrapper.confirm_action("Do something?", conf_id, {})
457
 
                    if conf_id == 'given_id':
458
 
                        self.assertEquals(result, specific_answer)
459
 
                    else:
460
 
                        self.assertEquals(result, default_answer)
461
 
 
462
 
    def test_repr(self):
463
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
464
 
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
465
 
            base_ui, True, dict(a=2))
466
 
        self.assertThat(repr(wrapper),
467
 
            Equals("ConfirmationUserInterfacePolicy("
468
 
                "NoninteractiveUIFactory(), True, {'a': 2})"))
469
 
 
470
 
 
471
 
class TestProgressRecordingUI(tests.TestCase):
472
 
    """Test test-oriented UIFactory that records progress updates"""
473
 
 
474
 
    def test_nested_ignore_depth_beyond_one(self):
475
 
        # we only want to capture the first level out progress, not
476
 
        # want sub-components might do. So we have nested bars ignored.
477
 
        factory = ProgressRecordingUIFactory()
478
 
        pb1 = factory.nested_progress_bar()
479
 
        pb1.update('foo', 0, 1)
480
 
        pb2 = factory.nested_progress_bar()
481
 
        pb2.update('foo', 0, 1)
482
 
        pb2.finished()
483
 
        pb1.finished()
484
 
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)