~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ui.py

  • Committer: Andrew Bennetts
  • Date: 2008-09-05 10:48:03 UTC
  • mto: This revision was merged to the branch mainline in revision 3693.
  • Revision ID: andrew.bennetts@canonical.com-20080905104803-6g72dz6wcldosfs2
Remove monkey-patching of branch._ensure_real from test_remote.py.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005 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
24
24
 
25
25
import bzrlib
26
26
import bzrlib.errors as errors
27
 
from bzrlib.progress import TTYProgressBar, ProgressBarStack
28
 
from bzrlib.tests import TestCase
29
 
from bzrlib.ui import SilentUIFactory
 
27
from bzrlib.progress import (
 
28
    DotsProgressBar,
 
29
    ProgressBarStack,
 
30
    TTYProgressBar,
 
31
    )
 
32
from bzrlib.tests import (
 
33
    TestCase,
 
34
    TestUIFactory,
 
35
    StringIOWrapper,
 
36
    )
 
37
from bzrlib.tests.test_progress import _TTYStringIO
 
38
from bzrlib.ui import (
 
39
    CLIUIFactory,
 
40
    SilentUIFactory,
 
41
    )
30
42
from bzrlib.ui.text import TextUIFactory
31
43
 
32
44
 
34
46
 
35
47
    def test_silent_factory(self):
36
48
        ui = SilentUIFactory()
37
 
        pb = ui.nested_progress_bar()
38
 
        try:
39
 
            # TODO: Test that there is no output from SilentUIFactory
40
 
    
41
 
            self.assertEquals(ui.get_password(), None)
42
 
            self.assertEquals(ui.get_password(u'Hello There \u1234 %(user)s',
43
 
                                              user=u'some\u1234')
44
 
                             , None)
45
 
        finally:
46
 
            pb.finished()
47
 
 
48
 
    def test_text_factory(self):
49
 
        ui = TextUIFactory()
50
 
        pb = ui.nested_progress_bar()
51
 
        pb.finished()
52
 
        # TODO: Test the output from TextUIFactory, perhaps by overriding sys.stdout
53
 
 
54
 
        # Unfortunately we can't actually test the ui.get_password() because 
55
 
        # that would actually prompt the user for a password during the test suite
56
 
        # This has been tested manually with both LANG=en_US.utf-8 and LANG=C
57
 
        # print
58
 
        # self.assertEquals(ui.get_password(u"%(user)s please type 'bogus'",
59
 
        #                                   user=u'some\u1234')
60
 
        #                  , 'bogus')
61
 
 
 
49
        stdout = StringIO()
 
50
        self.assertEqual(None,
 
51
                         self.apply_redirected(None, stdout, stdout,
 
52
                                               ui.get_password))
 
53
        self.assertEqual('', stdout.getvalue())
 
54
        self.assertEqual(None,
 
55
                         self.apply_redirected(None, stdout, stdout,
 
56
                                               ui.get_password,
 
57
                                               u'Hello\u1234 %(user)s',
 
58
                                               user=u'some\u1234'))
 
59
        self.assertEqual('', stdout.getvalue())
 
60
 
 
61
    def test_text_factory_ascii_password(self):
 
62
        ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
 
63
        pb = ui.nested_progress_bar()
 
64
        try:
 
65
            self.assertEqual('secret',
 
66
                             self.apply_redirected(ui.stdin, ui.stdout,
 
67
                                                   ui.stdout,
 
68
                                                   ui.get_password))
 
69
            # ': ' is appended to prompt
 
70
            self.assertEqual(': ', ui.stdout.getvalue())
 
71
            # stdin should be empty
 
72
            self.assertEqual('', ui.stdin.readline())
 
73
        finally:
 
74
            pb.finished()
 
75
 
 
76
    def test_text_factory_utf8_password(self):
 
77
        """Test an utf8 password.
 
78
 
 
79
        We can't predict what encoding users will have for stdin, so we force
 
80
        it to utf8 to test that we transport the password correctly.
 
81
        """
 
82
        ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
83
                           stdout=StringIOWrapper())
 
84
        ui.stdin.encoding = 'utf8'
 
85
        ui.stdout.encoding = ui.stdin.encoding
 
86
        pb = ui.nested_progress_bar()
 
87
        try:
 
88
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
 
89
                                             ui.get_password,
 
90
                                             u'Hello \u1234 %(user)s',
 
91
                                             user=u'some\u1234')
 
92
            # We use StringIO objects, we need to decode them
 
93
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
 
94
            self.assertEqual(u'Hello \u1234 some\u1234: ',
 
95
                             ui.stdout.getvalue().decode('utf8'))
 
96
            # stdin should be empty
 
97
            self.assertEqual('', ui.stdin.readline())
 
98
        finally:
 
99
            pb.finished()
62
100
 
63
101
    def test_progress_note(self):
64
102
        stderr = StringIO()
65
103
        stdout = StringIO()
66
 
        ui_factory = TextUIFactory()
67
 
        pb = ui_factory.nested_progress_bar()
68
 
        try:
69
 
            pb.to_messages_file = stdout
70
 
            ui_factory._progress_bar_stack.bottom().to_file = stderr
 
104
        ui_factory = TextUIFactory(bar_type=TTYProgressBar)
 
105
        pb = ui_factory.nested_progress_bar()
 
106
        try:
 
107
            pb.to_messages_file = stdout
 
108
            ui_factory._progress_bar_stack.bottom().to_file = stderr
 
109
            result = pb.note('t')
 
110
            self.assertEqual(None, result)
 
111
            self.assertEqual("t\n", stdout.getvalue())
 
112
            # Since there was no update() call, there should be no clear() call
 
113
            self.failIf(re.search(r'^\r {10,}\r$',
 
114
                                  stderr.getvalue()) is not None,
 
115
                        'We cleared the stderr without anything to put there')
 
116
        finally:
 
117
            pb.finished()
 
118
 
 
119
    def test_progress_note_clears(self):
 
120
        stderr = StringIO()
 
121
        stdout = StringIO()
 
122
        # The PQM redirects the output to a file, so it
 
123
        # defaults to creating a Dots progress bar. we
 
124
        # need to force it to believe we are a TTY
 
125
        ui_factory = TextUIFactory(bar_type=TTYProgressBar)
 
126
        pb = ui_factory.nested_progress_bar()
 
127
        try:
 
128
            pb.to_messages_file = stdout
 
129
            ui_factory._progress_bar_stack.bottom().to_file = stderr
 
130
            # Create a progress update that isn't throttled
 
131
            pb.start_time -= 10
 
132
            pb.update('x', 1, 1)
71
133
            result = pb.note('t')
72
134
            self.assertEqual(None, result)
73
135
            self.assertEqual("t\n", stdout.getvalue())
74
136
            # the exact contents will depend on the terminal width and we don't
75
137
            # care about that right now - but you're probably running it on at
76
138
            # least a 10-character wide terminal :)
77
 
            self.assertContainsRe(stderr.getvalue(), r'^\r {10,}\r$')
 
139
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
78
140
        finally:
79
141
            pb.finished()
80
142
 
111
173
 
112
174
    def test_text_factory_setting_progress_bar(self):
113
175
        # we should be able to choose the progress bar type used.
114
 
        factory = bzrlib.ui.text.TextUIFactory(
115
 
            bar_type=bzrlib.progress.DotsProgressBar)
 
176
        factory = TextUIFactory(bar_type=DotsProgressBar)
116
177
        bar = factory.nested_progress_bar()
117
178
        bar.finished()
118
 
        self.assertIsInstance(bar, bzrlib.progress.DotsProgressBar)
 
179
        self.assertIsInstance(bar, DotsProgressBar)
119
180
 
120
181
    def test_cli_stdin_is_default_stdin(self):
121
 
        factory = bzrlib.ui.CLIUIFactory()
 
182
        factory = CLIUIFactory()
122
183
        self.assertEqual(sys.stdin, factory.stdin)
123
184
 
124
185
    def assert_get_bool_acceptance_of_user_input(self, factory):
125
 
        factory.stdin = StringIO("y\nyes with garbage\nyes\nn\nnot an answer\nno\nfoo\n")
 
186
        factory.stdin = StringIO("y\nyes with garbage\n"
 
187
                                 "yes\nn\nnot an answer\n"
 
188
                                 "no\nfoo\n")
126
189
        factory.stdout = StringIO()
127
190
        # there is no output from the base factory
128
191
        self.assertEqual(True, factory.get_boolean(""))
130
193
        self.assertEqual(False, factory.get_boolean(""))
131
194
        self.assertEqual(False, factory.get_boolean(""))
132
195
        self.assertEqual("foo\n", factory.stdin.read())
 
196
        # stdin should be empty
 
197
        self.assertEqual('', factory.stdin.readline())
133
198
 
134
199
    def test_silent_ui_getbool(self):
135
 
        factory = bzrlib.ui.SilentUIFactory()
 
200
        factory = SilentUIFactory()
136
201
        self.assert_get_bool_acceptance_of_user_input(factory)
137
202
 
138
203
    def test_silent_factory_prompts_silently(self):
139
 
        factory = bzrlib.ui.SilentUIFactory()
 
204
        factory = SilentUIFactory()
140
205
        stdout = StringIO()
141
206
        factory.stdin = StringIO("y\n")
142
 
        self.assertEqual(
143
 
            True,
144
 
            self.apply_redirected(
145
 
                None, stdout, stdout, factory.get_boolean, "foo")
146
 
            )
 
207
        self.assertEqual(True,
 
208
                         self.apply_redirected(None, stdout, stdout,
 
209
                                               factory.get_boolean, "foo"))
147
210
        self.assertEqual("", stdout.getvalue())
148
 
        
 
211
        # stdin should be empty
 
212
        self.assertEqual('', factory.stdin.readline())
 
213
 
149
214
    def test_text_ui_getbool(self):
150
 
        factory = bzrlib.ui.text.TextUIFactory()
 
215
        factory = TextUIFactory()
151
216
        self.assert_get_bool_acceptance_of_user_input(factory)
152
217
 
153
218
    def test_text_factory_prompts_and_clears(self):
154
219
        # a get_boolean call should clear the pb before prompting
155
 
        factory = bzrlib.ui.text.TextUIFactory()
156
 
        factory.stdout = StringIO()
 
220
        factory = TextUIFactory(bar_type=DotsProgressBar)
 
221
        factory.stdout = _TTYStringIO()
157
222
        factory.stdin = StringIO("yada\ny\n")
158
 
        pb = self.apply_redirected(
159
 
            factory.stdin, factory.stdout, factory.stdout, factory.nested_progress_bar)
160
 
        self.apply_redirected(
161
 
            factory.stdin, factory.stdout, factory.stdout, pb.update, "foo", 0, 1)
162
 
        self.assertEqual(
163
 
            True,
164
 
            self.apply_redirected(
165
 
                None, factory.stdout, factory.stdout, factory.get_boolean, "what do you want")
166
 
            )
167
 
        # use a regular expression so that we don't depend on the particular
168
 
        # screen width - could also set and restore $COLUMN if that has
169
 
        # priority on all platforms, but it doesn't at present.
 
223
        pb = self.apply_redirected(factory.stdin, factory.stdout,
 
224
                                   factory.stdout, factory.nested_progress_bar)
 
225
        pb.start_time = None
 
226
        self.apply_redirected(factory.stdin, factory.stdout,
 
227
                              factory.stdout, pb.update, "foo", 0, 1)
 
228
        self.assertEqual(True,
 
229
                         self.apply_redirected(None, factory.stdout,
 
230
                                               factory.stdout,
 
231
                                               factory.get_boolean,
 
232
                                               "what do you want"))
170
233
        output = factory.stdout.getvalue()
171
 
        if not re.match(
172
 
            "\r/ \\[    *\\] foo 0/1"
173
 
            "\r   *" 
174
 
            "\rwhat do you want\\? \\[y/n\\]:what do you want\\? \\[y/n\\]:", 
175
 
            output):
176
 
            self.fail("didn't match factory output %r" % factory)
 
234
        self.assertEqual("foo: .\n"
 
235
                         "what do you want? [y/n]: what do you want? [y/n]: ",
 
236
                         factory.stdout.getvalue())
 
237
        # stdin should be empty
 
238
        self.assertEqual('', factory.stdin.readline())
 
239