← 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: Andrew Bennetts
  • Date: 2009-07-27 05:35:00 UTC
  • mfrom: (4570 +trunk)
  • mto: (4634.6.29 2.0)
  • mto: This revision was merged to the branch mainline in revision 4680.
  • Revision ID: andrew.bennetts@canonical.com-20090727053500-q76zsn2dx33jhmj5
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the bzrlib ui
18
18
"""
23
23
import sys
24
24
import time
25
25
 
26
 
import bzrlib
27
 
import bzrlib.errors as errors
28
 
from bzrlib.progress import (
29
 
    DotsProgressBar,
30
 
    ProgressBarStack,
31
 
    TTYProgressBar,
 
26
from bzrlib import (
 
27
    errors,
 
28
    tests,
 
29
    ui as _mod_ui,
32
30
    )
33
31
from bzrlib.symbol_versioning import (
34
32
    deprecated_in,
38
36
    TestUIFactory,
39
37
    StringIOWrapper,
40
38
    )
41
 
from bzrlib.tests.test_progress import _TTYStringIO
 
39
from bzrlib.tests.test_progress import (
 
40
    _NonTTYStringIO,
 
41
    _TTYStringIO,
 
42
    )
42
43
from bzrlib.ui import (
 
44
    CannedInputUIFactory,
43
45
    CLIUIFactory,
44
46
    SilentUIFactory,
45
 
    )
46
 
from bzrlib.ui.text import TextUIFactory
47
 
 
48
 
 
49
 
class UITests(TestCase):
50
 
 
51
 
    def test_silent_factory(self):
52
 
        ui = SilentUIFactory()
53
 
        stdout = StringIO()
54
 
        self.assertEqual(None,
55
 
                         self.apply_redirected(None, stdout, stdout,
56
 
                                               ui.get_password))
57
 
        self.assertEqual('', stdout.getvalue())
58
 
        self.assertEqual(None,
59
 
                         self.apply_redirected(None, stdout, stdout,
60
 
                                               ui.get_password,
61
 
                                               u'Hello\u1234 %(user)s',
62
 
                                               user=u'some\u1234'))
63
 
        self.assertEqual('', stdout.getvalue())
 
47
    UIFactory,
 
48
    make_ui_for_terminal,
 
49
    )
 
50
from bzrlib.ui.text import (
 
51
    NullProgressView,
 
52
    TextProgressView,
 
53
    TextUIFactory,
 
54
    )
 
55
 
 
56
 
 
57
class UITests(tests.TestCase):
64
58
 
65
59
    def test_text_factory_ascii_password(self):
66
 
        ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
 
60
        ui = tests.TestUIFactory(stdin='secret\n',
 
61
                                 stdout=tests.StringIOWrapper(),
 
62
                                 stderr=tests.StringIOWrapper())
67
63
        pb = ui.nested_progress_bar()
68
64
        try:
69
65
            self.assertEqual('secret',
70
66
                             self.apply_redirected(ui.stdin, ui.stdout,
71
 
                                                   ui.stdout,
 
67
                                                   ui.stderr,
72
68
                                                   ui.get_password))
73
69
            # ': ' is appended to prompt
74
 
            self.assertEqual(': ', ui.stdout.getvalue())
 
70
            self.assertEqual(': ', ui.stderr.getvalue())
 
71
            self.assertEqual('', ui.stdout.readline())
75
72
            # stdin should be empty
76
73
            self.assertEqual('', ui.stdin.readline())
77
74
        finally:
83
80
        We can't predict what encoding users will have for stdin, so we force
84
81
        it to utf8 to test that we transport the password correctly.
85
82
        """
86
 
        ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
87
 
                           stdout=StringIOWrapper())
88
 
        ui.stdin.encoding = 'utf8'
89
 
        ui.stdout.encoding = ui.stdin.encoding
 
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'
90
87
        pb = ui.nested_progress_bar()
91
88
        try:
92
 
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
 
89
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
93
90
                                             ui.get_password,
94
91
                                             u'Hello \u1234 %(user)s',
95
92
                                             user=u'some\u1234')
96
93
            # We use StringIO objects, we need to decode them
97
94
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
98
95
            self.assertEqual(u'Hello \u1234 some\u1234: ',
99
 
                             ui.stdout.getvalue().decode('utf8'))
100
 
            # stdin should be empty
 
96
                             ui.stderr.getvalue().decode('utf8'))
 
97
            # stdin and stdout should be empty
101
98
            self.assertEqual('', ui.stdin.readline())
 
99
            self.assertEqual('', ui.stdout.readline())
102
100
        finally:
103
101
            pb.finished()
104
102
 
 
103
    def test_progress_construction(self):
 
104
        """TextUIFactory constructs the right progress view.
 
105
        """
 
106
        for (file_class, term, pb, expected_pb_class) in (
 
107
            # on an xterm, either use them or not as the user requests,
 
108
            # otherwise default on
 
109
            (_TTYStringIO, 'xterm', 'none', NullProgressView),
 
110
            (_TTYStringIO, 'xterm', 'text', TextProgressView),
 
111
            (_TTYStringIO, 'xterm', None, TextProgressView),
 
112
            # on a dumb terminal, again if there's explicit configuration do
 
113
            # it, otherwise default off
 
114
            (_TTYStringIO, 'dumb', 'none', NullProgressView),
 
115
            (_TTYStringIO, 'dumb', 'text', TextProgressView),
 
116
            (_TTYStringIO, 'dumb', None, NullProgressView),
 
117
            # on a non-tty terminal, it's null regardless of $TERM
 
118
            (StringIO, 'xterm', None, NullProgressView),
 
119
            (StringIO, 'dumb', None, NullProgressView),
 
120
            # however, it can still be forced on
 
121
            (StringIO, 'dumb', 'text', TextProgressView),
 
122
            ):
 
123
            os.environ['TERM'] = term
 
124
            if pb is None:
 
125
                if 'BZR_PROGRESS_BAR' in os.environ:
 
126
                    del os.environ['BZR_PROGRESS_BAR']
 
127
            else:
 
128
                os.environ['BZR_PROGRESS_BAR'] = pb
 
129
            stdin = file_class('')
 
130
            stderr = file_class()
 
131
            stdout = file_class()
 
132
            uif = make_ui_for_terminal(stdin, stdout, stderr)
 
133
            self.assertIsInstance(uif, TextUIFactory,
 
134
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
135
            self.assertIsInstance(uif.make_progress_view(),
 
136
                expected_pb_class,
 
137
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
138
 
 
139
    def test_text_ui_non_terminal(self):
 
140
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
 
141
        stdin = _NonTTYStringIO('')
 
142
        stderr = _NonTTYStringIO()
 
143
        stdout = _NonTTYStringIO()
 
144
        for term_type in ['dumb', None, 'xterm']:
 
145
            if term_type is None:
 
146
                del os.environ['TERM']
 
147
            else:
 
148
                os.environ['TERM'] = term_type
 
149
            uif = make_ui_for_terminal(stdin, stdout, stderr)
 
150
            self.assertIsInstance(uif, TextUIFactory,
 
151
                'TERM=%r' % (term_type,))
 
152
 
105
153
    def test_progress_note(self):
106
154
        stderr = StringIO()
107
155
        stdout = StringIO()
121
169
            pb.finished()
122
170
 
123
171
    def test_progress_note_clears(self):
124
 
        stderr = StringIO()
125
 
        stdout = StringIO()
126
 
        # The PQM redirects the output to a file, so it
127
 
        # defaults to creating a Dots progress bar. we
128
 
        # need to force it to believe we are a TTY
 
172
        stderr = _TTYStringIO()
 
173
        stdout = _TTYStringIO()
 
174
        # so that we get a TextProgressBar
 
175
        os.environ['TERM'] = 'xterm'
129
176
        ui_factory = TextUIFactory(
130
177
            stdin=StringIO(''),
131
178
            stdout=stdout, stderr=stderr)
 
179
        self.assertIsInstance(ui_factory._progress_view,
 
180
            TextProgressView)
132
181
        pb = ui_factory.nested_progress_bar()
133
182
        try:
134
183
            # Create a progress update that isn't throttled
157
206
        pb2.finished()
158
207
        pb1.finished()
159
208
 
160
 
    def test_progress_stack(self):
161
 
        # test the progress bar stack which the default text factory
162
 
        # uses.
 
209
    def test_text_ui_get_boolean(self):
 
210
        stdin = StringIO("y\n" # True
 
211
                         "n\n" # False
 
212
                         "yes with garbage\nY\n" # True
 
213
                         "not an answer\nno\n" # False
 
214
                         "I'm sure!\nyes\n" # True
 
215
                         "NO\n" # False
 
216
                         "foo\n")
 
217
        stdout = StringIO()
163
218
        stderr = StringIO()
164
 
        stdout = StringIO()
165
 
        # make a stack, which accepts parameters like a pb.
166
 
        stack = self.applyDeprecated(
167
 
            deprecated_in((1, 12, 0)),
168
 
            ProgressBarStack,
169
 
            to_file=stderr, to_messages_file=stdout)
170
 
        # but is not one
171
 
        self.assertFalse(getattr(stack, 'note', False))
172
 
        pb1 = stack.get_nested()
173
 
        pb2 = stack.get_nested()
174
 
        warnings, _ = self.callCatchWarnings(pb1.finished)
175
 
        self.assertEqual(len(warnings), 1)
176
 
        pb2.finished()
177
 
        pb1.finished()
178
 
        # the text ui factory never actually removes the stack once its setup.
179
 
        # we need to be able to nest again correctly from here.
180
 
        pb1 = stack.get_nested()
181
 
        pb2 = stack.get_nested()
182
 
        warnings, _ = self.callCatchWarnings(pb1.finished)
183
 
        self.assertEqual(len(warnings), 1)
184
 
        pb2.finished()
185
 
        pb1.finished()
186
 
 
187
 
    def assert_get_bool_acceptance_of_user_input(self, factory):
188
 
        factory.stdin = StringIO("y\nyes with garbage\n"
189
 
                                 "yes\nn\nnot an answer\n"
190
 
                                 "no\nfoo\n")
191
 
        factory.stdout = StringIO()
192
 
        # there is no output from the base factory
193
 
        self.assertEqual(True, factory.get_boolean(""))
194
 
        self.assertEqual(True, factory.get_boolean(""))
195
 
        self.assertEqual(False, factory.get_boolean(""))
 
219
        factory = TextUIFactory(stdin, stdout, stderr)
 
220
        self.assertEqual(True, factory.get_boolean(""))
 
221
        self.assertEqual(False, factory.get_boolean(""))
 
222
        self.assertEqual(True, factory.get_boolean(""))
 
223
        self.assertEqual(False, factory.get_boolean(""))
 
224
        self.assertEqual(True, factory.get_boolean(""))
196
225
        self.assertEqual(False, factory.get_boolean(""))
197
226
        self.assertEqual("foo\n", factory.stdin.read())
198
227
        # stdin should be empty
199
228
        self.assertEqual('', factory.stdin.readline())
200
229
 
201
 
    def test_silent_ui_getbool(self):
202
 
        factory = SilentUIFactory()
203
 
        self.assert_get_bool_acceptance_of_user_input(factory)
204
 
 
205
 
    def test_silent_factory_prompts_silently(self):
206
 
        factory = SilentUIFactory()
207
 
        stdout = StringIO()
208
 
        factory.stdin = StringIO("y\n")
209
 
        self.assertEqual(True,
210
 
                         self.apply_redirected(None, stdout, stdout,
211
 
                                               factory.get_boolean, "foo"))
212
 
        self.assertEqual("", stdout.getvalue())
213
 
        # stdin should be empty
214
 
        self.assertEqual('', factory.stdin.readline())
215
 
 
216
 
    def test_text_ui_getbool(self):
217
 
        factory = TextUIFactory(None, None, None)
218
 
        self.assert_get_bool_acceptance_of_user_input(factory)
 
230
    def test_text_factory_prompt(self):
 
231
        # see <https://launchpad.net/bugs/365891>
 
232
        factory = TextUIFactory(StringIO(), StringIO(), StringIO())
 
233
        factory.prompt('foo %2e')
 
234
        self.assertEqual('', factory.stdout.getvalue())
 
235
        self.assertEqual('foo %2e', factory.stderr.getvalue())
219
236
 
220
237
    def test_text_factory_prompts_and_clears(self):
221
238
        # a get_boolean call should clear the pb before prompting
222
239
        out = _TTYStringIO()
 
240
        os.environ['TERM'] = 'xterm'
223
241
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
224
242
        pb = factory.nested_progress_bar()
225
243
        pb.show_bar = False
249
267
            pb.tick()
250
268
        finally:
251
269
            pb.finished()
 
270
 
 
271
    def test_text_ui_getusername(self):
 
272
        factory = TextUIFactory(None, None, None)
 
273
        factory.stdin = StringIO("someuser\n\n")
 
274
        factory.stdout = StringIO()
 
275
        factory.stderr = StringIO()
 
276
        factory.stdout.encoding = "utf8"
 
277
        # there is no output from the base factory
 
278
        self.assertEqual("someuser",
 
279
                         factory.get_username('Hello %(host)s', host='some'))
 
280
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
 
281
        self.assertEquals('', factory.stdout.getvalue())
 
282
        self.assertEqual("", factory.get_username("Gebruiker"))
 
283
        # stdin should be empty
 
284
        self.assertEqual('', factory.stdin.readline())
 
285
 
 
286
    def test_text_ui_getusername_utf8(self):
 
287
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
288
                                 stdout=tests.StringIOWrapper(),
 
289
                                 stderr=tests.StringIOWrapper())
 
290
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
291
        pb = ui.nested_progress_bar()
 
292
        try:
 
293
            # there is no output from the base factory
 
294
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
295
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
 
296
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
 
297
            self.assertEquals(u"Hello\u1234 some\u1234: ",
 
298
                              ui.stderr.getvalue().decode("utf8"))
 
299
            self.assertEquals('', ui.stdout.getvalue())
 
300
        finally:
 
301
            pb.finished()
 
302
 
 
303
 
 
304
class CLIUITests(TestCase):
 
305
 
 
306
    def test_cli_factory_deprecated(self):
 
307
        uif = self.applyDeprecated(deprecated_in((1, 18, 0)),
 
308
            CLIUIFactory,
 
309
            StringIO(), StringIO(), StringIO())
 
310
        self.assertIsInstance(uif, UIFactory)
 
311
 
 
312
 
 
313
class SilentUITests(TestCase):
 
314
 
 
315
    def test_silent_factory_get_password(self):
 
316
        # A silent factory that can't do user interaction can't get a
 
317
        # password.  Possibly it should raise a more specific error but it
 
318
        # can't succeed.
 
319
        ui = SilentUIFactory()
 
320
        stdout = StringIO()
 
321
        self.assertRaises(
 
322
            NotImplementedError,
 
323
            self.apply_redirected,
 
324
            None, stdout, stdout, ui.get_password)
 
325
        # and it didn't write anything out either
 
326
        self.assertEqual('', stdout.getvalue())
 
327
 
 
328
    def test_silent_ui_getbool(self):
 
329
        factory = SilentUIFactory()
 
330
        stdout = StringIO()
 
331
        self.assertRaises(
 
332
            NotImplementedError,
 
333
            self.apply_redirected,
 
334
            None, stdout, stdout, factory.get_boolean, "foo")
 
335
 
 
336
 
 
337
class CannedInputUIFactoryTests(TestCase):
 
338
    
 
339
    def test_canned_input_get_input(self):
 
340
        uif = CannedInputUIFactory([True, 'mbp', 'password'])
 
341
        self.assertEqual(uif.get_boolean('Extra cheese?'), True)
 
342
        self.assertEqual(uif.get_username('Enter your user name'), 'mbp')
 
343
        self.assertEqual(uif.get_password('Password for %(host)s', host='example.com'),
 
344
            'password')
 
345
 
 
346
 
 
347
class TestBoolFromString(tests.TestCase):
 
348
 
 
349
    def assertIsTrue(self, s, accepted_values=None):
 
350
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
351
        self.assertEquals(True, res)
 
352
 
 
353
    def assertIsFalse(self, s, accepted_values=None):
 
354
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
355
        self.assertEquals(False, res)
 
356
 
 
357
    def assertIsNone(self, s, accepted_values=None):
 
358
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
359
        self.assertIs(None, res)
 
360
 
 
361
    def test_know_valid_values(self):
 
362
        self.assertIsTrue('true')
 
363
        self.assertIsFalse('false')
 
364
        self.assertIsTrue('1')
 
365
        self.assertIsFalse('0')
 
366
        self.assertIsTrue('on')
 
367
        self.assertIsFalse('off')
 
368
        self.assertIsTrue('yes')
 
369
        self.assertIsFalse('no')
 
370
        self.assertIsTrue('y')
 
371
        self.assertIsFalse('n')
 
372
        # Also try some case variations
 
373
        self.assertIsTrue('True')
 
374
        self.assertIsFalse('False')
 
375
        self.assertIsTrue('On')
 
376
        self.assertIsFalse('Off')
 
377
        self.assertIsTrue('ON')
 
378
        self.assertIsFalse('OFF')
 
379
        self.assertIsTrue('oN')
 
380
        self.assertIsFalse('oFf')
 
381
 
 
382
    def test_invalid_values(self):
 
383
        self.assertIsNone(None)
 
384
        self.assertIsNone('doubt')
 
385
        self.assertIsNone('frue')
 
386
        self.assertIsNone('talse')
 
387
        self.assertIsNone('42')
 
388
 
 
389
    def test_provided_values(self):
 
390
        av = dict(y=True, n=False, yes=True, no=False)
 
391
        self.assertIsTrue('y', av)
 
392
        self.assertIsTrue('Y', av)
 
393
        self.assertIsTrue('Yes', av)
 
394
        self.assertIsFalse('n', av)
 
395
        self.assertIsFalse('N', av)
 
396
        self.assertIsFalse('No', av)
 
397
        self.assertIsNone('1', av)
 
398
        self.assertIsNone('0', av)
 
399
        self.assertIsNone('on', av)
 
400
        self.assertIsNone('off', av)