/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ui.py

  • Committer: Martin Pool
  • Date: 2010-02-19 04:00:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5051.
  • Revision ID: mbp@sourcefrog.net-20100219040031-jyvbgsk5xqwuuej8
Fix ReST syntax

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tests for the bzrlib ui
 
18
"""
 
19
 
 
20
import os
 
21
import re
 
22
import time
 
23
 
 
24
from bzrlib import (
 
25
    errors,
 
26
    tests,
 
27
    ui as _mod_ui,
 
28
    )
 
29
from bzrlib.symbol_versioning import (
 
30
    deprecated_in,
 
31
    )
 
32
from bzrlib.tests import test_progress
 
33
from bzrlib.ui import text as _mod_ui_text
 
34
 
 
35
 
 
36
class TestTextUIFactory(tests.TestCase):
 
37
 
 
38
    def test_text_factory_ascii_password(self):
 
39
        ui = tests.TestUIFactory(stdin='secret\n',
 
40
                                 stdout=tests.StringIOWrapper(),
 
41
                                 stderr=tests.StringIOWrapper())
 
42
        pb = ui.nested_progress_bar()
 
43
        try:
 
44
            self.assertEqual('secret',
 
45
                             self.apply_redirected(ui.stdin, ui.stdout,
 
46
                                                   ui.stderr,
 
47
                                                   ui.get_password))
 
48
            # ': ' is appended to prompt
 
49
            self.assertEqual(': ', ui.stderr.getvalue())
 
50
            self.assertEqual('', ui.stdout.readline())
 
51
            # stdin should be empty
 
52
            self.assertEqual('', ui.stdin.readline())
 
53
        finally:
 
54
            pb.finished()
 
55
 
 
56
    def test_text_factory_utf8_password(self):
 
57
        """Test an utf8 password.
 
58
 
 
59
        We can't predict what encoding users will have for stdin, so we force
 
60
        it to utf8 to test that we transport the password correctly.
 
61
        """
 
62
        ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
63
                                 stdout=tests.StringIOWrapper(),
 
64
                                 stderr=tests.StringIOWrapper())
 
65
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
 
66
        pb = ui.nested_progress_bar()
 
67
        try:
 
68
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
69
                                             ui.get_password,
 
70
                                             u'Hello \u1234 %(user)s',
 
71
                                             user=u'some\u1234')
 
72
            # We use StringIO objects, we need to decode them
 
73
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
 
74
            self.assertEqual(u'Hello \u1234 some\u1234: ',
 
75
                             ui.stderr.getvalue().decode('utf8'))
 
76
            # stdin and stdout should be empty
 
77
            self.assertEqual('', ui.stdin.readline())
 
78
            self.assertEqual('', ui.stdout.readline())
 
79
        finally:
 
80
            pb.finished()
 
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
 
 
127
    def test_text_ui_get_boolean(self):
 
128
        stdin = tests.StringIOWrapper("y\n" # True
 
129
                                      "n\n" # False
 
130
                                      "yes with garbage\nY\n" # True
 
131
                                      "not an answer\nno\n" # False
 
132
                                      "I'm sure!\nyes\n" # True
 
133
                                      "NO\n" # False
 
134
                                      "foo\n")
 
135
        stdout = tests.StringIOWrapper()
 
136
        stderr = tests.StringIOWrapper()
 
137
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
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())
 
147
 
 
148
    def test_text_ui_get_integer(self):
 
149
        stdin = tests.StringIOWrapper(
 
150
            "1\n"
 
151
            "  -2  \n"
 
152
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
 
153
        stdout = tests.StringIOWrapper()
 
154
        stderr = tests.StringIOWrapper()
 
155
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
156
        self.assertEqual(1, factory.get_integer(""))
 
157
        self.assertEqual(-2, factory.get_integer(""))
 
158
        self.assertEqual(42, factory.get_integer(""))
 
159
 
 
160
    def test_text_factory_prompt(self):
 
161
        # see <https://launchpad.net/bugs/365891>
 
162
        StringIO = tests.StringIOWrapper
 
163
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
 
164
        factory.prompt('foo %2e')
 
165
        self.assertEqual('', factory.stdout.getvalue())
 
166
        self.assertEqual('foo %2e', factory.stderr.getvalue())
 
167
 
 
168
    def test_text_factory_prompts_and_clears(self):
 
169
        # a get_boolean call should clear the pb before prompting
 
170
        out = test_progress._TTYStringIO()
 
171
        os.environ['TERM'] = 'xterm'
 
172
        factory = _mod_ui_text.TextUIFactory(
 
173
            stdin=tests.StringIOWrapper("yada\ny\n"),
 
174
            stdout=out, stderr=out)
 
175
        pb = factory.nested_progress_bar()
 
176
        pb.show_bar = False
 
177
        pb.show_spinner = False
 
178
        pb.show_count = False
 
179
        pb.update("foo", 0, 1)
 
180
        self.assertEqual(True,
 
181
                         self.apply_redirected(None, factory.stdout,
 
182
                                               factory.stdout,
 
183
                                               factory.get_boolean,
 
184
                                               "what do you want"))
 
185
        output = out.getvalue()
 
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\]: ")
 
190
        # stdin should have been totally consumed
 
191
        self.assertEqual('', factory.stdin.readline())
 
192
 
 
193
    def test_text_tick_after_update(self):
 
194
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
 
195
                                                stderr=tests.StringIOWrapper())
 
196
        pb = ui_factory.nested_progress_bar()
 
197
        try:
 
198
            pb.update('task', 0, 3)
 
199
            # Reset the clock, so that it actually tries to repaint itself
 
200
            ui_factory._progress_view._last_repaint = time.time() - 1.0
 
201
            pb.tick()
 
202
        finally:
 
203
            pb.finished()
 
204
 
 
205
    def test_text_ui_getusername(self):
 
206
        factory = _mod_ui_text.TextUIFactory(None, None, None)
 
207
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
 
208
        factory.stdout = tests.StringIOWrapper()
 
209
        factory.stderr = tests.StringIOWrapper()
 
210
        factory.stdout.encoding = "utf8"
 
211
        # there is no output from the base factory
 
212
        self.assertEqual("someuser",
 
213
                         factory.get_username('Hello %(host)s', host='some'))
 
214
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
 
215
        self.assertEquals('', factory.stdout.getvalue())
 
216
        self.assertEqual("", factory.get_username("Gebruiker"))
 
217
        # stdin should be empty
 
218
        self.assertEqual('', factory.stdin.readline())
 
219
 
 
220
    def test_text_ui_getusername_utf8(self):
 
221
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
222
                                 stdout=tests.StringIOWrapper(),
 
223
                                 stderr=tests.StringIOWrapper())
 
224
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
225
        pb = ui.nested_progress_bar()
 
226
        try:
 
227
            # there is no output from the base factory
 
228
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
229
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
 
230
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
 
231
            self.assertEquals(u"Hello\u1234 some\u1234: ",
 
232
                              ui.stderr.getvalue().decode("utf8"))
 
233
            self.assertEquals('', ui.stdout.getvalue())
 
234
        finally:
 
235
            pb.finished()
 
236
 
 
237
    def test_quietness(self):
 
238
        os.environ['BZR_PROGRESS_BAR'] = 'text'
 
239
        ui_factory = _mod_ui_text.TextUIFactory(None,
 
240
            test_progress._TTYStringIO(),
 
241
            test_progress._TTYStringIO())
 
242
        self.assertIsInstance(ui_factory._progress_view,
 
243
            _mod_ui_text.TextProgressView)
 
244
        ui_factory.be_quiet(True)
 
245
        self.assertIsInstance(ui_factory._progress_view,
 
246
            _mod_ui_text.NullProgressView)
 
247
 
 
248
 
 
249
class TestTextUIOutputStream(tests.TestCase):
 
250
    """Tests for output stream that synchronizes with progress bar."""
 
251
 
 
252
    def test_output_clears_terminal(self):
 
253
        stdout = tests.StringIOWrapper()
 
254
        stderr = tests.StringIOWrapper()
 
255
        clear_calls = []
 
256
 
 
257
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
 
258
        uif.clear_term = lambda: clear_calls.append('clear')
 
259
 
 
260
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
 
261
        stream.write("Hello world!\n")
 
262
        stream.write("there's more...\n")
 
263
        stream.writelines(["1\n", "2\n", "3\n"])
 
264
 
 
265
        self.assertEqual(stdout.getvalue(),
 
266
            "Hello world!\n"
 
267
            "there's more...\n"
 
268
            "1\n2\n3\n")
 
269
        self.assertEqual(['clear', 'clear', 'clear'],
 
270
            clear_calls)
 
271
 
 
272
        stream.flush()
 
273
 
 
274
 
 
275
class UITests(tests.TestCase):
 
276
 
 
277
    def test_progress_construction(self):
 
278
        """TextUIFactory constructs the right progress view.
 
279
        """
 
280
        TTYStringIO = test_progress._TTYStringIO
 
281
        FileStringIO = tests.StringIOWrapper
 
282
        for (file_class, term, pb, expected_pb_class) in (
 
283
            # on an xterm, either use them or not as the user requests,
 
284
            # otherwise default on
 
285
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
 
286
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
 
287
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
 
288
            # on a dumb terminal, again if there's explicit configuration do
 
289
            # it, otherwise default off
 
290
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
 
291
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
292
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
293
            # on a non-tty terminal, it's null regardless of $TERM
 
294
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
 
295
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
296
            # however, it can still be forced on
 
297
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
298
            ):
 
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
 
305
            stdin = file_class('')
 
306
            stderr = file_class()
 
307
            stdout = file_class()
 
308
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
 
309
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
 
310
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
311
            self.assertIsInstance(uif.make_progress_view(),
 
312
                expected_pb_class,
 
313
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
314
 
 
315
    def test_text_ui_non_terminal(self):
 
316
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
 
317
        stdin = test_progress._NonTTYStringIO('')
 
318
        stderr = test_progress._NonTTYStringIO()
 
319
        stdout = test_progress._NonTTYStringIO()
 
320
        for term_type in ['dumb', None, 'xterm']:
 
321
            if term_type is None:
 
322
                del os.environ['TERM']
 
323
            else:
 
324
                os.environ['TERM'] = term_type
 
325
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
 
326
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
 
327
                'TERM=%r' % (term_type,))
 
328
 
 
329
 
 
330
class SilentUITests(tests.TestCase):
 
331
 
 
332
    def test_silent_factory_get_password(self):
 
333
        # A silent factory that can't do user interaction can't get a
 
334
        # password.  Possibly it should raise a more specific error but it
 
335
        # can't succeed.
 
336
        ui = _mod_ui.SilentUIFactory()
 
337
        stdout = tests.StringIOWrapper()
 
338
        self.assertRaises(
 
339
            NotImplementedError,
 
340
            self.apply_redirected,
 
341
            None, stdout, stdout, ui.get_password)
 
342
        # and it didn't write anything out either
 
343
        self.assertEqual('', stdout.getvalue())
 
344
 
 
345
    def test_silent_ui_getbool(self):
 
346
        factory = _mod_ui.SilentUIFactory()
 
347
        stdout = tests.StringIOWrapper()
 
348
        self.assertRaises(
 
349
            NotImplementedError,
 
350
            self.apply_redirected,
 
351
            None, stdout, stdout, factory.get_boolean, "foo")
 
352
 
 
353
 
 
354
class TestUIFactoryTests(tests.TestCase):
 
355
 
 
356
    def test_test_ui_factory_progress(self):
 
357
        # there's no output; we just want to make sure this doesn't crash -
 
358
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
 
359
        ui = tests.TestUIFactory()
 
360
        pb = ui.nested_progress_bar()
 
361
        pb.update('hello')
 
362
        pb.tick()
 
363
        pb.finished()
 
364
 
 
365
 
 
366
class CannedInputUIFactoryTests(tests.TestCase):
 
367
 
 
368
    def test_canned_input_get_input(self):
 
369
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
 
370
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
 
371
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
 
372
        self.assertEqual('password',
 
373
                         uif.get_password('Password for %(host)s',
 
374
                                          host='example.com'))
 
375
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
 
376
 
 
377
 
 
378
class TestBoolFromString(tests.TestCase):
 
379
 
 
380
    def assertIsTrue(self, s, accepted_values=None):
 
381
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
382
        self.assertEquals(True, res)
 
383
 
 
384
    def assertIsFalse(self, s, accepted_values=None):
 
385
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
386
        self.assertEquals(False, res)
 
387
 
 
388
    def assertIsNone(self, s, accepted_values=None):
 
389
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
390
        self.assertIs(None, res)
 
391
 
 
392
    def test_know_valid_values(self):
 
393
        self.assertIsTrue('true')
 
394
        self.assertIsFalse('false')
 
395
        self.assertIsTrue('1')
 
396
        self.assertIsFalse('0')
 
397
        self.assertIsTrue('on')
 
398
        self.assertIsFalse('off')
 
399
        self.assertIsTrue('yes')
 
400
        self.assertIsFalse('no')
 
401
        self.assertIsTrue('y')
 
402
        self.assertIsFalse('n')
 
403
        # Also try some case variations
 
404
        self.assertIsTrue('True')
 
405
        self.assertIsFalse('False')
 
406
        self.assertIsTrue('On')
 
407
        self.assertIsFalse('Off')
 
408
        self.assertIsTrue('ON')
 
409
        self.assertIsFalse('OFF')
 
410
        self.assertIsTrue('oN')
 
411
        self.assertIsFalse('oFf')
 
412
 
 
413
    def test_invalid_values(self):
 
414
        self.assertIsNone(None)
 
415
        self.assertIsNone('doubt')
 
416
        self.assertIsNone('frue')
 
417
        self.assertIsNone('talse')
 
418
        self.assertIsNone('42')
 
419
 
 
420
    def test_provided_values(self):
 
421
        av = dict(y=True, n=False, yes=True, no=False)
 
422
        self.assertIsTrue('y', av)
 
423
        self.assertIsTrue('Y', av)
 
424
        self.assertIsTrue('Yes', av)
 
425
        self.assertIsFalse('n', av)
 
426
        self.assertIsFalse('N', av)
 
427
        self.assertIsFalse('No', av)
 
428
        self.assertIsNone('1', av)
 
429
        self.assertIsNone('0', av)
 
430
        self.assertIsNone('on', av)
 
431
        self.assertIsNone('off', av)