~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ui.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-06 03:15:29 UTC
  • mfrom: (1711.2.78 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060706031529-e189d8c3f42076be
(jam) allow plugins to include benchmarks

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005 by 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 (
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
 
    )
 
27
from bzrlib.progress import TTYProgressBar, ProgressBarStack
 
28
from bzrlib.tests import TestCase
 
29
from bzrlib.ui import SilentUIFactory
42
30
from bzrlib.ui.text import TextUIFactory
43
31
 
44
32
 
46
34
 
47
35
    def test_silent_factory(self):
48
36
        ui = SilentUIFactory()
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()
 
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
 
100
62
 
101
63
    def test_progress_note(self):
102
64
        stderr = StringIO()
103
65
        stdout = StringIO()
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)
 
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
133
71
            result = pb.note('t')
134
72
            self.assertEqual(None, result)
135
73
            self.assertEqual("t\n", stdout.getvalue())
136
74
            # the exact contents will depend on the terminal width and we don't
137
75
            # care about that right now - but you're probably running it on at
138
76
            # least a 10-character wide terminal :)
139
 
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
77
            self.assertContainsRe(stderr.getvalue(), r'^\r {10,}\r$')
140
78
        finally:
141
79
            pb.finished()
142
80
 
173
111
 
174
112
    def test_text_factory_setting_progress_bar(self):
175
113
        # we should be able to choose the progress bar type used.
176
 
        factory = TextUIFactory(bar_type=DotsProgressBar)
 
114
        factory = bzrlib.ui.text.TextUIFactory(
 
115
            bar_type=bzrlib.progress.DotsProgressBar)
177
116
        bar = factory.nested_progress_bar()
178
117
        bar.finished()
179
 
        self.assertIsInstance(bar, DotsProgressBar)
 
118
        self.assertIsInstance(bar, bzrlib.progress.DotsProgressBar)
180
119
 
181
120
    def test_cli_stdin_is_default_stdin(self):
182
 
        factory = CLIUIFactory()
 
121
        factory = bzrlib.ui.CLIUIFactory()
183
122
        self.assertEqual(sys.stdin, factory.stdin)
184
123
 
185
124
    def assert_get_bool_acceptance_of_user_input(self, factory):
186
 
        factory.stdin = StringIO("y\nyes with garbage\n"
187
 
                                 "yes\nn\nnot an answer\n"
188
 
                                 "no\nfoo\n")
 
125
        factory.stdin = StringIO("y\nyes with garbage\nyes\nn\nnot an answer\nno\nfoo\n")
189
126
        factory.stdout = StringIO()
190
127
        # there is no output from the base factory
191
128
        self.assertEqual(True, factory.get_boolean(""))
193
130
        self.assertEqual(False, factory.get_boolean(""))
194
131
        self.assertEqual(False, factory.get_boolean(""))
195
132
        self.assertEqual("foo\n", factory.stdin.read())
196
 
        # stdin should be empty
197
 
        self.assertEqual('', factory.stdin.readline())
198
133
 
199
134
    def test_silent_ui_getbool(self):
200
 
        factory = SilentUIFactory()
 
135
        factory = bzrlib.ui.SilentUIFactory()
201
136
        self.assert_get_bool_acceptance_of_user_input(factory)
202
137
 
203
138
    def test_silent_factory_prompts_silently(self):
204
 
        factory = SilentUIFactory()
 
139
        factory = bzrlib.ui.SilentUIFactory()
205
140
        stdout = StringIO()
206
141
        factory.stdin = StringIO("y\n")
207
 
        self.assertEqual(True,
208
 
                         self.apply_redirected(None, stdout, stdout,
209
 
                                               factory.get_boolean, "foo"))
 
142
        self.assertEqual(
 
143
            True,
 
144
            self.apply_redirected(
 
145
                None, stdout, stdout, factory.get_boolean, "foo")
 
146
            )
210
147
        self.assertEqual("", stdout.getvalue())
211
 
        # stdin should be empty
212
 
        self.assertEqual('', factory.stdin.readline())
213
 
 
 
148
        
214
149
    def test_text_ui_getbool(self):
215
 
        factory = TextUIFactory()
 
150
        factory = bzrlib.ui.text.TextUIFactory()
216
151
        self.assert_get_bool_acceptance_of_user_input(factory)
217
152
 
218
153
    def test_text_factory_prompts_and_clears(self):
219
154
        # a get_boolean call should clear the pb before prompting
220
 
        factory = TextUIFactory(bar_type=DotsProgressBar)
221
 
        factory.stdout = _TTYStringIO()
 
155
        factory = bzrlib.ui.text.TextUIFactory()
 
156
        factory.stdout = StringIO()
222
157
        factory.stdin = StringIO("yada\ny\n")
223
 
        pb = self.apply_redirected(factory.stdin, factory.stdout,
224
 
                                   factory.stdout, factory.nested_progress_bar)
 
158
        pb = self.apply_redirected(
 
159
            factory.stdin, factory.stdout, factory.stdout, factory.nested_progress_bar)
225
160
        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"))
 
161
        self.apply_redirected(
 
162
            factory.stdin, factory.stdout, factory.stdout, pb.update, "foo", 0, 1)
 
163
        self.assertEqual(
 
164
            True,
 
165
            self.apply_redirected(
 
166
                None, factory.stdout, factory.stdout, factory.get_boolean, "what do you want")
 
167
            )
 
168
        # use a regular expression so that we don't depend on the particular
 
169
        # screen width - could also set and restore $COLUMN if that has
 
170
        # priority on all platforms, but it doesn't at present.
233
171
        output = factory.stdout.getvalue()
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
 
 
 
172
        if not re.match(
 
173
            "\r/ \\[    *\\] foo 0/1"
 
174
            "\r   *" 
 
175
            "\rwhat do you want\\? \\[y/n\\]:what do you want\\? \\[y/n\\]:", 
 
176
            output):
 
177
            self.fail("didn't match factory output %r" % factory)