/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: Matthew Fuller
  • Date: 2009-07-25 08:26:42 UTC
  • mto: This revision was merged to the branch mainline in revision 4625.
  • Revision ID: fullermd@over-yonder.net-20090725082642-gd7rhcn3kgjvv9dx
Eliminate ancient comment.  By now, it's calling for something that's
either already done, or OBE.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2008, 2009 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
18
18
"""
19
19
 
20
20
import os
 
21
from StringIO import StringIO
21
22
import re
 
23
import sys
22
24
import time
23
25
 
24
 
from StringIO import StringIO
25
 
 
26
26
from bzrlib import (
27
27
    errors,
28
 
    remote,
29
 
    repository,
30
28
    tests,
31
29
    ui as _mod_ui,
32
30
    )
33
31
from bzrlib.symbol_versioning import (
34
32
    deprecated_in,
35
33
    )
36
 
from bzrlib.tests import test_progress
37
 
from bzrlib.ui import text as _mod_ui_text
38
 
 
39
 
 
40
 
class TestTextUIFactory(tests.TestCase):
 
34
from bzrlib.tests.test_progress import _TTYStringIO
 
35
from bzrlib.ui.text import (
 
36
    NullProgressView,
 
37
    TextProgressView,
 
38
    TextUIFactory,
 
39
    )
 
40
 
 
41
 
 
42
class UITests(tests.TestCase):
 
43
 
 
44
    def test_silent_factory(self):
 
45
        ui = _mod_ui.SilentUIFactory()
 
46
        stdout = StringIO()
 
47
        self.assertEqual(None,
 
48
                         self.apply_redirected(None, stdout, stdout,
 
49
                                               ui.get_password))
 
50
        self.assertEqual('', stdout.getvalue())
 
51
        self.assertEqual(None,
 
52
                         self.apply_redirected(None, stdout, stdout,
 
53
                                               ui.get_password,
 
54
                                               u'Hello\u1234 %(user)s',
 
55
                                               user=u'some\u1234'))
 
56
        self.assertEqual('', stdout.getvalue())
41
57
 
42
58
    def test_text_factory_ascii_password(self):
43
59
        ui = tests.TestUIFactory(stdin='secret\n',
83
99
        finally:
84
100
            pb.finished()
85
101
 
 
102
    def test_progress_construction(self):
 
103
        """TextUIFactory constructs the right progress view.
 
104
        """
 
105
        os.environ['BZR_PROGRESS_BAR'] = 'none'
 
106
        self.assertIsInstance(TextUIFactory()._progress_view,
 
107
            NullProgressView)
 
108
 
 
109
        os.environ['BZR_PROGRESS_BAR'] = 'text'
 
110
        self.assertIsInstance(TextUIFactory()._progress_view,
 
111
            TextProgressView)
 
112
 
 
113
        os.environ['BZR_PROGRESS_BAR'] = 'text'
 
114
        self.assertIsInstance(TextUIFactory()._progress_view,
 
115
            TextProgressView)
 
116
 
 
117
        del os.environ['BZR_PROGRESS_BAR']
 
118
        self.assertIsInstance(TextUIFactory()._progress_view,
 
119
            TextProgressView)
 
120
 
86
121
    def test_progress_note(self):
87
 
        stderr = tests.StringIOWrapper()
88
 
        stdout = tests.StringIOWrapper()
89
 
        ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
90
 
                                                stderr=stderr,
91
 
                                                stdout=stdout)
 
122
        stderr = StringIO()
 
123
        stdout = StringIO()
 
124
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
125
            stderr=stderr,
 
126
            stdout=stdout)
92
127
        pb = ui_factory.nested_progress_bar()
93
128
        try:
94
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
95
 
                pb.note,
96
 
                't')
 
129
            result = pb.note('t')
97
130
            self.assertEqual(None, result)
98
131
            self.assertEqual("t\n", stdout.getvalue())
99
132
            # Since there was no update() call, there should be no clear() call
104
137
            pb.finished()
105
138
 
106
139
    def test_progress_note_clears(self):
107
 
        stderr = test_progress._TTYStringIO()
108
 
        stdout = test_progress._TTYStringIO()
109
 
        # so that we get a TextProgressBar
110
 
        os.environ['TERM'] = 'xterm'
111
 
        ui_factory = _mod_ui_text.TextUIFactory(
112
 
            stdin=tests.StringIOWrapper(''),
 
140
        stderr = StringIO()
 
141
        stdout = StringIO()
 
142
        # The PQM redirects the output to a file, so it
 
143
        # defaults to creating a Dots progress bar. we
 
144
        # need to force it to believe we are a TTY
 
145
        ui_factory = TextUIFactory(
 
146
            stdin=StringIO(''),
113
147
            stdout=stdout, stderr=stderr)
114
 
        self.assertIsInstance(ui_factory._progress_view,
115
 
                              _mod_ui_text.TextProgressView)
116
148
        pb = ui_factory.nested_progress_bar()
117
149
        try:
118
150
            # Create a progress update that isn't throttled
119
151
            pb.update('x', 1, 1)
120
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
121
 
                pb.note, 't')
 
152
            result = pb.note('t')
122
153
            self.assertEqual(None, result)
123
154
            self.assertEqual("t\n", stdout.getvalue())
124
155
            # the exact contents will depend on the terminal width and we don't
128
159
        finally:
129
160
            pb.finished()
130
161
 
131
 
    def test_text_ui_get_boolean(self):
132
 
        stdin = tests.StringIOWrapper("y\n" # True
133
 
                                      "n\n" # False
134
 
                                      "yes with garbage\nY\n" # True
135
 
                                      "not an answer\nno\n" # False
136
 
                                      "I'm sure!\nyes\n" # True
137
 
                                      "NO\n" # False
138
 
                                      "foo\n")
139
 
        stdout = tests.StringIOWrapper()
140
 
        stderr = tests.StringIOWrapper()
141
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
162
    def test_progress_nested(self):
 
163
        # test factory based nested and popping.
 
164
        ui = TextUIFactory(None, None, None)
 
165
        pb1 = ui.nested_progress_bar()
 
166
        pb2 = ui.nested_progress_bar()
 
167
        # You do get a warning if the outermost progress bar wasn't finished
 
168
        # first - it's not clear if this is really useful or if it should just
 
169
        # become orphaned -- mbp 20090120
 
170
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
171
        if len(warnings) != 1:
 
172
            self.fail("unexpected warnings: %r" % (warnings,))
 
173
        pb2.finished()
 
174
        pb1.finished()
 
175
 
 
176
    def assert_get_bool_acceptance_of_user_input(self, factory):
 
177
        factory.stdin = StringIO("y\n" # True
 
178
                                 "n\n" # False
 
179
                                 "yes with garbage\nY\n" # True
 
180
                                 "not an answer\nno\n" # False
 
181
                                 "I'm sure!\nyes\n" # True
 
182
                                 "NO\n" # False
 
183
                                 "foo\n")
 
184
        factory.stdout = StringIO()
 
185
        factory.stderr = StringIO()
 
186
        # there is no output from the base factory
142
187
        self.assertEqual(True, factory.get_boolean(""))
143
188
        self.assertEqual(False, factory.get_boolean(""))
144
189
        self.assertEqual(True, factory.get_boolean(""))
149
194
        # stdin should be empty
150
195
        self.assertEqual('', factory.stdin.readline())
151
196
 
152
 
    def test_text_ui_get_integer(self):
153
 
        stdin = tests.StringIOWrapper(
154
 
            "1\n"
155
 
            "  -2  \n"
156
 
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
157
 
        stdout = tests.StringIOWrapper()
158
 
        stderr = tests.StringIOWrapper()
159
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
160
 
        self.assertEqual(1, factory.get_integer(""))
161
 
        self.assertEqual(-2, factory.get_integer(""))
162
 
        self.assertEqual(42, factory.get_integer(""))
 
197
    def test_silent_ui_getbool(self):
 
198
        factory = _mod_ui.SilentUIFactory()
 
199
        self.assert_get_bool_acceptance_of_user_input(factory)
 
200
 
 
201
    def test_silent_factory_prompts_silently(self):
 
202
        factory = _mod_ui.SilentUIFactory()
 
203
        stdout = StringIO()
 
204
        factory.stdin = StringIO("y\n")
 
205
        self.assertEqual(True,
 
206
                         self.apply_redirected(None, stdout, stdout,
 
207
                                               factory.get_boolean, "foo"))
 
208
        self.assertEqual("", stdout.getvalue())
 
209
        # stdin should be empty
 
210
        self.assertEqual('', factory.stdin.readline())
 
211
 
 
212
    def test_text_ui_getbool(self):
 
213
        factory = TextUIFactory(None, None, None)
 
214
        self.assert_get_bool_acceptance_of_user_input(factory)
163
215
 
164
216
    def test_text_factory_prompt(self):
165
217
        # see <https://launchpad.net/bugs/365891>
166
 
        StringIO = tests.StringIOWrapper
167
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
 
218
        factory = TextUIFactory(None, StringIO(), StringIO(), StringIO())
168
219
        factory.prompt('foo %2e')
169
220
        self.assertEqual('', factory.stdout.getvalue())
170
221
        self.assertEqual('foo %2e', factory.stderr.getvalue())
171
222
 
172
223
    def test_text_factory_prompts_and_clears(self):
173
224
        # a get_boolean call should clear the pb before prompting
174
 
        out = test_progress._TTYStringIO()
175
 
        os.environ['TERM'] = 'xterm'
176
 
        factory = _mod_ui_text.TextUIFactory(
177
 
            stdin=tests.StringIOWrapper("yada\ny\n"),
178
 
            stdout=out, stderr=out)
 
225
        out = _TTYStringIO()
 
226
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"),
 
227
                                stdout=out, stderr=out)
179
228
        pb = factory.nested_progress_bar()
180
229
        pb.show_bar = False
181
230
        pb.show_spinner = False
195
244
        self.assertEqual('', factory.stdin.readline())
196
245
 
197
246
    def test_text_tick_after_update(self):
198
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
199
 
                                                stderr=tests.StringIOWrapper())
 
247
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
200
248
        pb = ui_factory.nested_progress_bar()
201
249
        try:
202
250
            pb.update('task', 0, 3)
206
254
        finally:
207
255
            pb.finished()
208
256
 
 
257
    def test_silent_ui_getusername(self):
 
258
        factory = _mod_ui.SilentUIFactory()
 
259
        factory.stdin = StringIO("someuser\n\n")
 
260
        factory.stdout = StringIO()
 
261
        factory.stderr = StringIO()
 
262
        self.assertEquals(None,
 
263
            factory.get_username(u'Hello\u1234 %(host)s', host=u'some\u1234'))
 
264
        self.assertEquals("", factory.stdout.getvalue())
 
265
        self.assertEquals("", factory.stderr.getvalue())
 
266
        self.assertEquals("someuser\n\n", factory.stdin.getvalue())
 
267
 
209
268
    def test_text_ui_getusername(self):
210
 
        factory = _mod_ui_text.TextUIFactory(None, None, None)
211
 
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
212
 
        factory.stdout = tests.StringIOWrapper()
213
 
        factory.stderr = tests.StringIOWrapper()
 
269
        factory = TextUIFactory(None, None, None)
 
270
        factory.stdin = StringIO("someuser\n\n")
 
271
        factory.stdout = StringIO()
 
272
        factory.stderr = StringIO()
214
273
        factory.stdout.encoding = "utf8"
215
274
        # there is no output from the base factory
216
275
        self.assertEqual("someuser",
238
297
        finally:
239
298
            pb.finished()
240
299
 
241
 
    def test_quietness(self):
242
 
        os.environ['BZR_PROGRESS_BAR'] = 'text'
243
 
        ui_factory = _mod_ui_text.TextUIFactory(None,
244
 
            test_progress._TTYStringIO(),
245
 
            test_progress._TTYStringIO())
246
 
        self.assertIsInstance(ui_factory._progress_view,
247
 
            _mod_ui_text.TextProgressView)
248
 
        ui_factory.be_quiet(True)
249
 
        self.assertIsInstance(ui_factory._progress_view,
250
 
            _mod_ui_text.NullProgressView)
251
 
 
252
 
    def test_text_ui_show_user_warning(self):
253
 
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
254
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
255
 
        err = StringIO()
256
 
        out = StringIO()
257
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
258
 
        remote_fmt = remote.RemoteRepositoryFormat()
259
 
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
260
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
261
 
            to_format=remote_fmt)
262
 
        self.assertEquals('', out.getvalue())
263
 
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
264
 
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
265
 
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
266
 
            "the same format for better performance.\n",
267
 
            err.getvalue())
268
 
        # and now with it suppressed please
269
 
        err = StringIO()
270
 
        out = StringIO()
271
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
272
 
        ui.suppressed_warnings.add('cross_format_fetch')
273
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
274
 
            to_format=remote_fmt)
275
 
        self.assertEquals('', out.getvalue())
276
 
        self.assertEquals('', err.getvalue())
277
 
 
278
 
 
279
 
class TestTextUIOutputStream(tests.TestCase):
280
 
    """Tests for output stream that synchronizes with progress bar."""
281
 
 
282
 
    def test_output_clears_terminal(self):
283
 
        stdout = tests.StringIOWrapper()
284
 
        stderr = tests.StringIOWrapper()
285
 
        clear_calls = []
286
 
 
287
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
288
 
        uif.clear_term = lambda: clear_calls.append('clear')
289
 
 
290
 
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
291
 
        stream.write("Hello world!\n")
292
 
        stream.write("there's more...\n")
293
 
        stream.writelines(["1\n", "2\n", "3\n"])
294
 
 
295
 
        self.assertEqual(stdout.getvalue(),
296
 
            "Hello world!\n"
297
 
            "there's more...\n"
298
 
            "1\n2\n3\n")
299
 
        self.assertEqual(['clear', 'clear', 'clear'],
300
 
            clear_calls)
301
 
 
302
 
        stream.flush()
303
 
 
304
 
 
305
 
class UITests(tests.TestCase):
306
 
 
307
 
    def test_progress_construction(self):
308
 
        """TextUIFactory constructs the right progress view.
309
 
        """
310
 
        TTYStringIO = test_progress._TTYStringIO
311
 
        FileStringIO = tests.StringIOWrapper
312
 
        for (file_class, term, pb, expected_pb_class) in (
313
 
            # on an xterm, either use them or not as the user requests,
314
 
            # otherwise default on
315
 
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
316
 
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
317
 
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
318
 
            # on a dumb terminal, again if there's explicit configuration do
319
 
            # it, otherwise default off
320
 
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
321
 
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
322
 
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
323
 
            # on a non-tty terminal, it's null regardless of $TERM
324
 
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
325
 
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
326
 
            # however, it can still be forced on
327
 
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
328
 
            ):
329
 
            os.environ['TERM'] = term
330
 
            if pb is None:
331
 
                if 'BZR_PROGRESS_BAR' in os.environ:
332
 
                    del os.environ['BZR_PROGRESS_BAR']
333
 
            else:
334
 
                os.environ['BZR_PROGRESS_BAR'] = pb
335
 
            stdin = file_class('')
336
 
            stderr = file_class()
337
 
            stdout = file_class()
338
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
339
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
340
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
341
 
            self.assertIsInstance(uif.make_progress_view(),
342
 
                expected_pb_class,
343
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
344
 
 
345
 
    def test_text_ui_non_terminal(self):
346
 
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
347
 
        stdin = test_progress._NonTTYStringIO('')
348
 
        stderr = test_progress._NonTTYStringIO()
349
 
        stdout = test_progress._NonTTYStringIO()
350
 
        for term_type in ['dumb', None, 'xterm']:
351
 
            if term_type is None:
352
 
                del os.environ['TERM']
353
 
            else:
354
 
                os.environ['TERM'] = term_type
355
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
356
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
357
 
                'TERM=%r' % (term_type,))
358
 
 
359
 
 
360
 
class SilentUITests(tests.TestCase):
361
 
 
362
 
    def test_silent_factory_get_password(self):
363
 
        # A silent factory that can't do user interaction can't get a
364
 
        # password.  Possibly it should raise a more specific error but it
365
 
        # can't succeed.
366
 
        ui = _mod_ui.SilentUIFactory()
367
 
        stdout = tests.StringIOWrapper()
368
 
        self.assertRaises(
369
 
            NotImplementedError,
370
 
            self.apply_redirected,
371
 
            None, stdout, stdout, ui.get_password)
372
 
        # and it didn't write anything out either
373
 
        self.assertEqual('', stdout.getvalue())
374
 
 
375
 
    def test_silent_ui_getbool(self):
376
 
        factory = _mod_ui.SilentUIFactory()
377
 
        stdout = tests.StringIOWrapper()
378
 
        self.assertRaises(
379
 
            NotImplementedError,
380
 
            self.apply_redirected,
381
 
            None, stdout, stdout, factory.get_boolean, "foo")
382
 
 
383
 
 
384
 
class TestUIFactoryTests(tests.TestCase):
385
 
 
386
 
    def test_test_ui_factory_progress(self):
387
 
        # there's no output; we just want to make sure this doesn't crash -
388
 
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
389
 
        ui = tests.TestUIFactory()
390
 
        pb = ui.nested_progress_bar()
391
 
        pb.update('hello')
392
 
        pb.tick()
393
 
        pb.finished()
394
 
 
395
 
 
396
 
class CannedInputUIFactoryTests(tests.TestCase):
397
 
 
398
 
    def test_canned_input_get_input(self):
399
 
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
400
 
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
401
 
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
402
 
        self.assertEqual('password',
403
 
                         uif.get_password('Password for %(host)s',
404
 
                                          host='example.com'))
405
 
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
 
300
 
 
301
class TestTextProgressView(tests.TestCase):
 
302
    """Tests for text display of progress bars.
 
303
    """
 
304
    # XXX: These might be a bit easier to write if the rendering and
 
305
    # state-maintaining parts of TextProgressView were more separate, and if
 
306
    # the progress task called back directly to its own view not to the ui
 
307
    # factory. -- mbp 20090312
 
308
    
 
309
    def _make_factory(self):
 
310
        out = StringIO()
 
311
        uif = TextUIFactory(stderr=out)
 
312
        uif._progress_view._width = 80
 
313
        return out, uif
 
314
 
 
315
    def test_render_progress_easy(self):
 
316
        """Just one task and one quarter done"""
 
317
        out, uif = self._make_factory()
 
318
        task = uif.nested_progress_bar()
 
319
        task.update('reticulating splines', 5, 20)
 
320
        self.assertEqual(
 
321
'\r[####/               ] reticulating splines 5/20                               \r'
 
322
            , out.getvalue())
 
323
 
 
324
    def test_render_progress_nested(self):
 
325
        """Tasks proportionally contribute to overall progress"""
 
326
        out, uif = self._make_factory()
 
327
        task = uif.nested_progress_bar()
 
328
        task.update('reticulating splines', 0, 2)
 
329
        task2 = uif.nested_progress_bar()
 
330
        task2.update('stage2', 1, 2)
 
331
        # so we're in the first half of the main task, and half way through
 
332
        # that
 
333
        self.assertEqual(
 
334
r'[####\               ] reticulating splines:stage2 1/2'
 
335
            , uif._progress_view._render_line())
 
336
        # if the nested task is complete, then we're all the way through the
 
337
        # first half of the overall work
 
338
        task2.update('stage2', 2, 2)
 
339
        self.assertEqual(
 
340
r'[#########|          ] reticulating splines:stage2 2/2'
 
341
            , uif._progress_view._render_line())
 
342
 
 
343
    def test_render_progress_sub_nested(self):
 
344
        """Intermediate tasks don't mess up calculation."""
 
345
        out, uif = self._make_factory()
 
346
        task_a = uif.nested_progress_bar()
 
347
        task_a.update('a', 0, 2)
 
348
        task_b = uif.nested_progress_bar()
 
349
        task_b.update('b')
 
350
        task_c = uif.nested_progress_bar()
 
351
        task_c.update('c', 1, 2)
 
352
        # the top-level task is in its first half; the middle one has no
 
353
        # progress indication, just a label; and the bottom one is half done,
 
354
        # so the overall fraction is 1/4
 
355
        self.assertEqual(
 
356
            r'[####|               ] a:b:c 1/2'
 
357
            , uif._progress_view._render_line())
406
358
 
407
359
 
408
360
class TestBoolFromString(tests.TestCase):