/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: Canonical.com Patch Queue Manager
  • Date: 2009-10-15 21:28:14 UTC
  • mfrom: (4634.75.2 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20091015212814-i4j0hjrcob5cdw6j
(mbp) Fix bug #446033 by skipping non-existing entries in readdir.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
 
1
# Copyright (C) 2005, 2008, 2009 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
from StringIO import StringIO
 
22
import re
 
23
import sys
 
24
import time
 
25
 
 
26
from bzrlib import (
 
27
    errors,
 
28
    tests,
 
29
    ui as _mod_ui,
 
30
    )
 
31
from bzrlib.symbol_versioning import (
 
32
    deprecated_in,
 
33
    )
 
34
from bzrlib.tests import (
 
35
    TestCase,
 
36
    TestUIFactory,
 
37
    StringIOWrapper,
 
38
    )
 
39
from bzrlib.tests.test_progress import (
 
40
    _NonTTYStringIO,
 
41
    _TTYStringIO,
 
42
    )
 
43
from bzrlib.ui import (
 
44
    CannedInputUIFactory,
 
45
    CLIUIFactory,
 
46
    SilentUIFactory,
 
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 TestTextUIFactory(tests.TestCase):
 
58
 
 
59
    def test_text_factory_ascii_password(self):
 
60
        ui = tests.TestUIFactory(stdin='secret\n',
 
61
                                 stdout=tests.StringIOWrapper(),
 
62
                                 stderr=tests.StringIOWrapper())
 
63
        pb = ui.nested_progress_bar()
 
64
        try:
 
65
            self.assertEqual('secret',
 
66
                             self.apply_redirected(ui.stdin, ui.stdout,
 
67
                                                   ui.stderr,
 
68
                                                   ui.get_password))
 
69
            # ': ' is appended to prompt
 
70
            self.assertEqual(': ', ui.stderr.getvalue())
 
71
            self.assertEqual('', ui.stdout.readline())
 
72
            # stdin should be empty
 
73
            self.assertEqual('', ui.stdin.readline())
 
74
        finally:
 
75
            pb.finished()
 
76
 
 
77
    def test_text_factory_utf8_password(self):
 
78
        """Test an utf8 password.
 
79
 
 
80
        We can't predict what encoding users will have for stdin, so we force
 
81
        it to utf8 to test that we transport the password correctly.
 
82
        """
 
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'
 
87
        pb = ui.nested_progress_bar()
 
88
        try:
 
89
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
90
                                             ui.get_password,
 
91
                                             u'Hello \u1234 %(user)s',
 
92
                                             user=u'some\u1234')
 
93
            # We use StringIO objects, we need to decode them
 
94
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
 
95
            self.assertEqual(u'Hello \u1234 some\u1234: ',
 
96
                             ui.stderr.getvalue().decode('utf8'))
 
97
            # stdin and stdout should be empty
 
98
            self.assertEqual('', ui.stdin.readline())
 
99
            self.assertEqual('', ui.stdout.readline())
 
100
        finally:
 
101
            pb.finished()
 
102
 
 
103
    def test_progress_note(self):
 
104
        stderr = StringIO()
 
105
        stdout = StringIO()
 
106
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
107
            stderr=stderr,
 
108
            stdout=stdout)
 
109
        pb = ui_factory.nested_progress_bar()
 
110
        try:
 
111
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
112
                pb.note,
 
113
                't')
 
114
            self.assertEqual(None, result)
 
115
            self.assertEqual("t\n", stdout.getvalue())
 
116
            # Since there was no update() call, there should be no clear() call
 
117
            self.failIf(re.search(r'^\r {10,}\r$',
 
118
                                  stderr.getvalue()) is not None,
 
119
                        'We cleared the stderr without anything to put there')
 
120
        finally:
 
121
            pb.finished()
 
122
 
 
123
    def test_progress_note_clears(self):
 
124
        stderr = _TTYStringIO()
 
125
        stdout = _TTYStringIO()
 
126
        # so that we get a TextProgressBar
 
127
        os.environ['TERM'] = 'xterm'
 
128
        ui_factory = TextUIFactory(
 
129
            stdin=StringIO(''),
 
130
            stdout=stdout, stderr=stderr)
 
131
        self.assertIsInstance(ui_factory._progress_view,
 
132
            TextProgressView)
 
133
        pb = ui_factory.nested_progress_bar()
 
134
        try:
 
135
            # Create a progress update that isn't throttled
 
136
            pb.update('x', 1, 1)
 
137
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
138
                pb.note, 't')
 
139
            self.assertEqual(None, result)
 
140
            self.assertEqual("t\n", stdout.getvalue())
 
141
            # the exact contents will depend on the terminal width and we don't
 
142
            # care about that right now - but you're probably running it on at
 
143
            # least a 10-character wide terminal :)
 
144
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
145
        finally:
 
146
            pb.finished()
 
147
 
 
148
    def test_progress_nested(self):
 
149
        # test factory based nested and popping.
 
150
        ui = TextUIFactory(None, None, None)
 
151
        pb1 = ui.nested_progress_bar()
 
152
        pb2 = ui.nested_progress_bar()
 
153
        # You do get a warning if the outermost progress bar wasn't finished
 
154
        # first - it's not clear if this is really useful or if it should just
 
155
        # become orphaned -- mbp 20090120
 
156
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
157
        if len(warnings) != 1:
 
158
            self.fail("unexpected warnings: %r" % (warnings,))
 
159
        pb2.finished()
 
160
        pb1.finished()
 
161
 
 
162
    def test_text_ui_get_boolean(self):
 
163
        stdin = StringIO("y\n" # True
 
164
                         "n\n" # False
 
165
                         "yes with garbage\nY\n" # True
 
166
                         "not an answer\nno\n" # False
 
167
                         "I'm sure!\nyes\n" # True
 
168
                         "NO\n" # False
 
169
                         "foo\n")
 
170
        stdout = StringIO()
 
171
        stderr = StringIO()
 
172
        factory = TextUIFactory(stdin, stdout, stderr)
 
173
        self.assertEqual(True, factory.get_boolean(""))
 
174
        self.assertEqual(False, factory.get_boolean(""))
 
175
        self.assertEqual(True, factory.get_boolean(""))
 
176
        self.assertEqual(False, factory.get_boolean(""))
 
177
        self.assertEqual(True, factory.get_boolean(""))
 
178
        self.assertEqual(False, factory.get_boolean(""))
 
179
        self.assertEqual("foo\n", factory.stdin.read())
 
180
        # stdin should be empty
 
181
        self.assertEqual('', factory.stdin.readline())
 
182
 
 
183
    def test_text_factory_prompt(self):
 
184
        # see <https://launchpad.net/bugs/365891>
 
185
        factory = TextUIFactory(StringIO(), StringIO(), StringIO())
 
186
        factory.prompt('foo %2e')
 
187
        self.assertEqual('', factory.stdout.getvalue())
 
188
        self.assertEqual('foo %2e', factory.stderr.getvalue())
 
189
 
 
190
    def test_text_factory_prompts_and_clears(self):
 
191
        # a get_boolean call should clear the pb before prompting
 
192
        out = _TTYStringIO()
 
193
        os.environ['TERM'] = 'xterm'
 
194
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
 
195
        pb = factory.nested_progress_bar()
 
196
        pb.show_bar = False
 
197
        pb.show_spinner = False
 
198
        pb.show_count = False
 
199
        pb.update("foo", 0, 1)
 
200
        self.assertEqual(True,
 
201
                         self.apply_redirected(None, factory.stdout,
 
202
                                               factory.stdout,
 
203
                                               factory.get_boolean,
 
204
                                               "what do you want"))
 
205
        output = out.getvalue()
 
206
        self.assertContainsRe(factory.stdout.getvalue(),
 
207
            "foo *\r\r  *\r*")
 
208
        self.assertContainsRe(factory.stdout.getvalue(),
 
209
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
 
210
        # stdin should have been totally consumed
 
211
        self.assertEqual('', factory.stdin.readline())
 
212
 
 
213
    def test_text_tick_after_update(self):
 
214
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
 
215
        pb = ui_factory.nested_progress_bar()
 
216
        try:
 
217
            pb.update('task', 0, 3)
 
218
            # Reset the clock, so that it actually tries to repaint itself
 
219
            ui_factory._progress_view._last_repaint = time.time() - 1.0
 
220
            pb.tick()
 
221
        finally:
 
222
            pb.finished()
 
223
 
 
224
    def test_text_ui_getusername(self):
 
225
        factory = TextUIFactory(None, None, None)
 
226
        factory.stdin = StringIO("someuser\n\n")
 
227
        factory.stdout = StringIO()
 
228
        factory.stderr = StringIO()
 
229
        factory.stdout.encoding = "utf8"
 
230
        # there is no output from the base factory
 
231
        self.assertEqual("someuser",
 
232
                         factory.get_username('Hello %(host)s', host='some'))
 
233
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
 
234
        self.assertEquals('', factory.stdout.getvalue())
 
235
        self.assertEqual("", factory.get_username("Gebruiker"))
 
236
        # stdin should be empty
 
237
        self.assertEqual('', factory.stdin.readline())
 
238
 
 
239
    def test_text_ui_getusername_utf8(self):
 
240
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
241
                                 stdout=tests.StringIOWrapper(),
 
242
                                 stderr=tests.StringIOWrapper())
 
243
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
244
        pb = ui.nested_progress_bar()
 
245
        try:
 
246
            # there is no output from the base factory
 
247
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
248
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
 
249
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
 
250
            self.assertEquals(u"Hello\u1234 some\u1234: ",
 
251
                              ui.stderr.getvalue().decode("utf8"))
 
252
            self.assertEquals('', ui.stdout.getvalue())
 
253
        finally:
 
254
            pb.finished()
 
255
 
 
256
 
 
257
class UITests(tests.TestCase):
 
258
 
 
259
    def test_progress_construction(self):
 
260
        """TextUIFactory constructs the right progress view.
 
261
        """
 
262
        for (file_class, term, pb, expected_pb_class) in (
 
263
            # on an xterm, either use them or not as the user requests,
 
264
            # otherwise default on
 
265
            (_TTYStringIO, 'xterm', 'none', NullProgressView),
 
266
            (_TTYStringIO, 'xterm', 'text', TextProgressView),
 
267
            (_TTYStringIO, 'xterm', None, TextProgressView),
 
268
            # on a dumb terminal, again if there's explicit configuration do
 
269
            # it, otherwise default off
 
270
            (_TTYStringIO, 'dumb', 'none', NullProgressView),
 
271
            (_TTYStringIO, 'dumb', 'text', TextProgressView),
 
272
            (_TTYStringIO, 'dumb', None, NullProgressView),
 
273
            # on a non-tty terminal, it's null regardless of $TERM
 
274
            (StringIO, 'xterm', None, NullProgressView),
 
275
            (StringIO, 'dumb', None, NullProgressView),
 
276
            # however, it can still be forced on
 
277
            (StringIO, 'dumb', 'text', TextProgressView),
 
278
            ):
 
279
            os.environ['TERM'] = term
 
280
            if pb is None:
 
281
                if 'BZR_PROGRESS_BAR' in os.environ:
 
282
                    del os.environ['BZR_PROGRESS_BAR']
 
283
            else:
 
284
                os.environ['BZR_PROGRESS_BAR'] = pb
 
285
            stdin = file_class('')
 
286
            stderr = file_class()
 
287
            stdout = file_class()
 
288
            uif = make_ui_for_terminal(stdin, stdout, stderr)
 
289
            self.assertIsInstance(uif, TextUIFactory,
 
290
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
291
            self.assertIsInstance(uif.make_progress_view(),
 
292
                expected_pb_class,
 
293
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
294
 
 
295
    def test_text_ui_non_terminal(self):
 
296
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
 
297
        stdin = _NonTTYStringIO('')
 
298
        stderr = _NonTTYStringIO()
 
299
        stdout = _NonTTYStringIO()
 
300
        for term_type in ['dumb', None, 'xterm']:
 
301
            if term_type is None:
 
302
                del os.environ['TERM']
 
303
            else:
 
304
                os.environ['TERM'] = term_type
 
305
            uif = make_ui_for_terminal(stdin, stdout, stderr)
 
306
            self.assertIsInstance(uif, TextUIFactory,
 
307
                'TERM=%r' % (term_type,))
 
308
 
 
309
 
 
310
class CLIUITests(TestCase):
 
311
 
 
312
    def test_cli_factory_deprecated(self):
 
313
        uif = self.applyDeprecated(deprecated_in((1, 18, 0)),
 
314
            CLIUIFactory,
 
315
            StringIO(), StringIO(), StringIO())
 
316
        self.assertIsInstance(uif, UIFactory)
 
317
 
 
318
 
 
319
class SilentUITests(TestCase):
 
320
 
 
321
    def test_silent_factory_get_password(self):
 
322
        # A silent factory that can't do user interaction can't get a
 
323
        # password.  Possibly it should raise a more specific error but it
 
324
        # can't succeed.
 
325
        ui = SilentUIFactory()
 
326
        stdout = StringIO()
 
327
        self.assertRaises(
 
328
            NotImplementedError,
 
329
            self.apply_redirected,
 
330
            None, stdout, stdout, ui.get_password)
 
331
        # and it didn't write anything out either
 
332
        self.assertEqual('', stdout.getvalue())
 
333
 
 
334
    def test_silent_ui_getbool(self):
 
335
        factory = SilentUIFactory()
 
336
        stdout = StringIO()
 
337
        self.assertRaises(
 
338
            NotImplementedError,
 
339
            self.apply_redirected,
 
340
            None, stdout, stdout, factory.get_boolean, "foo")
 
341
 
 
342
 
 
343
class TestUIFactoryTests(TestCase):
 
344
 
 
345
    def test_test_ui_factory_progress(self):
 
346
        # there's no output; we just want to make sure this doesn't crash -
 
347
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
 
348
        ui = TestUIFactory()
 
349
        pb = ui.nested_progress_bar()
 
350
        pb.update('hello')
 
351
        pb.tick()
 
352
        pb.finished()
 
353
 
 
354
 
 
355
class CannedInputUIFactoryTests(TestCase):
 
356
    
 
357
    def test_canned_input_get_input(self):
 
358
        uif = CannedInputUIFactory([True, 'mbp', 'password'])
 
359
        self.assertEqual(uif.get_boolean('Extra cheese?'), True)
 
360
        self.assertEqual(uif.get_username('Enter your user name'), 'mbp')
 
361
        self.assertEqual(uif.get_password('Password for %(host)s', host='example.com'),
 
362
            'password')
 
363
 
 
364
 
 
365
class TestBoolFromString(tests.TestCase):
 
366
 
 
367
    def assertIsTrue(self, s, accepted_values=None):
 
368
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
369
        self.assertEquals(True, res)
 
370
 
 
371
    def assertIsFalse(self, s, accepted_values=None):
 
372
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
373
        self.assertEquals(False, res)
 
374
 
 
375
    def assertIsNone(self, s, accepted_values=None):
 
376
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
 
377
        self.assertIs(None, res)
 
378
 
 
379
    def test_know_valid_values(self):
 
380
        self.assertIsTrue('true')
 
381
        self.assertIsFalse('false')
 
382
        self.assertIsTrue('1')
 
383
        self.assertIsFalse('0')
 
384
        self.assertIsTrue('on')
 
385
        self.assertIsFalse('off')
 
386
        self.assertIsTrue('yes')
 
387
        self.assertIsFalse('no')
 
388
        self.assertIsTrue('y')
 
389
        self.assertIsFalse('n')
 
390
        # Also try some case variations
 
391
        self.assertIsTrue('True')
 
392
        self.assertIsFalse('False')
 
393
        self.assertIsTrue('On')
 
394
        self.assertIsFalse('Off')
 
395
        self.assertIsTrue('ON')
 
396
        self.assertIsFalse('OFF')
 
397
        self.assertIsTrue('oN')
 
398
        self.assertIsFalse('oFf')
 
399
 
 
400
    def test_invalid_values(self):
 
401
        self.assertIsNone(None)
 
402
        self.assertIsNone('doubt')
 
403
        self.assertIsNone('frue')
 
404
        self.assertIsNone('talse')
 
405
        self.assertIsNone('42')
 
406
 
 
407
    def test_provided_values(self):
 
408
        av = dict(y=True, n=False, yes=True, no=False)
 
409
        self.assertIsTrue('y', av)
 
410
        self.assertIsTrue('Y', av)
 
411
        self.assertIsTrue('Yes', av)
 
412
        self.assertIsFalse('n', av)
 
413
        self.assertIsFalse('N', av)
 
414
        self.assertIsFalse('No', av)
 
415
        self.assertIsNone('1', av)
 
416
        self.assertIsNone('0', av)
 
417
        self.assertIsNone('on', av)
 
418
        self.assertIsNone('off', av)