← 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: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

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
 
1
# Copyright (C) 2005-2010 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
22
21
import re
23
 
import sys
24
22
import time
25
23
 
 
24
from StringIO import StringIO
 
25
 
26
26
from bzrlib import (
 
27
    config,
27
28
    errors,
 
29
    remote,
 
30
    repository,
28
31
    tests,
29
32
    ui as _mod_ui,
30
33
    )
32
35
    deprecated_in,
33
36
    )
34
37
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 UITests(tests.TestCase):
 
38
    fixtures,
 
39
    test_progress,
 
40
    )
 
41
from bzrlib.ui import text as _mod_ui_text
 
42
 
 
43
 
 
44
class TestUIConfiguration(tests.TestCaseWithTransport):
 
45
 
 
46
    def test_output_encoding_configuration(self):
 
47
        enc = fixtures.generate_unicode_encodings().next()
 
48
        config.GlobalConfig().set_user_option('output_encoding',
 
49
            enc)
 
50
        ui = tests.TestUIFactory(stdin=None,
 
51
            stdout=tests.StringIOWrapper(),
 
52
            stderr=tests.StringIOWrapper())
 
53
        os = ui.make_output_stream()
 
54
        self.assertEquals(os.encoding, enc)
 
55
 
 
56
 
 
57
class TestTextUIFactory(tests.TestCase):
58
58
 
59
59
    def test_text_factory_ascii_password(self):
60
60
        ui = tests.TestUIFactory(stdin='secret\n',
100
100
        finally:
101
101
            pb.finished()
102
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
 
 
153
 
    def test_progress_note(self):
154
 
        stderr = StringIO()
155
 
        stdout = StringIO()
156
 
        ui_factory = TextUIFactory(stdin=StringIO(''),
157
 
            stderr=stderr,
158
 
            stdout=stdout)
159
 
        pb = ui_factory.nested_progress_bar()
160
 
        try:
161
 
            result = pb.note('t')
162
 
            self.assertEqual(None, result)
163
 
            self.assertEqual("t\n", stdout.getvalue())
164
 
            # Since there was no update() call, there should be no clear() call
165
 
            self.failIf(re.search(r'^\r {10,}\r$',
166
 
                                  stderr.getvalue()) is not None,
167
 
                        'We cleared the stderr without anything to put there')
168
 
        finally:
169
 
            pb.finished()
170
 
 
171
 
    def test_progress_note_clears(self):
172
 
        stderr = _TTYStringIO()
173
 
        stdout = _TTYStringIO()
174
 
        # so that we get a TextProgressBar
175
 
        os.environ['TERM'] = 'xterm'
176
 
        ui_factory = TextUIFactory(
177
 
            stdin=StringIO(''),
178
 
            stdout=stdout, stderr=stderr)
179
 
        self.assertIsInstance(ui_factory._progress_view,
180
 
            TextProgressView)
181
 
        pb = ui_factory.nested_progress_bar()
182
 
        try:
183
 
            # Create a progress update that isn't throttled
184
 
            pb.update('x', 1, 1)
185
 
            result = pb.note('t')
186
 
            self.assertEqual(None, result)
187
 
            self.assertEqual("t\n", stdout.getvalue())
188
 
            # the exact contents will depend on the terminal width and we don't
189
 
            # care about that right now - but you're probably running it on at
190
 
            # least a 10-character wide terminal :)
191
 
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
192
 
        finally:
193
 
            pb.finished()
194
 
 
195
 
    def test_progress_nested(self):
196
 
        # test factory based nested and popping.
197
 
        ui = TextUIFactory(None, None, None)
198
 
        pb1 = ui.nested_progress_bar()
199
 
        pb2 = ui.nested_progress_bar()
200
 
        # You do get a warning if the outermost progress bar wasn't finished
201
 
        # first - it's not clear if this is really useful or if it should just
202
 
        # become orphaned -- mbp 20090120
203
 
        warnings, _ = self.callCatchWarnings(pb1.finished)
204
 
        if len(warnings) != 1:
205
 
            self.fail("unexpected warnings: %r" % (warnings,))
206
 
        pb2.finished()
207
 
        pb1.finished()
208
 
 
209
103
    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()
218
 
        stderr = StringIO()
219
 
        factory = TextUIFactory(stdin, stdout, stderr)
 
104
        stdin = tests.StringIOWrapper("y\n" # True
 
105
                                      "n\n" # False
 
106
                                      "yes with garbage\nY\n" # True
 
107
                                      "not an answer\nno\n" # False
 
108
                                      "I'm sure!\nyes\n" # True
 
109
                                      "NO\n" # False
 
110
                                      "foo\n")
 
111
        stdout = tests.StringIOWrapper()
 
112
        stderr = tests.StringIOWrapper()
 
113
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
220
114
        self.assertEqual(True, factory.get_boolean(""))
221
115
        self.assertEqual(False, factory.get_boolean(""))
222
116
        self.assertEqual(True, factory.get_boolean(""))
227
121
        # stdin should be empty
228
122
        self.assertEqual('', factory.stdin.readline())
229
123
 
 
124
    def test_text_ui_get_integer(self):
 
125
        stdin = tests.StringIOWrapper(
 
126
            "1\n"
 
127
            "  -2  \n"
 
128
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
 
129
        stdout = tests.StringIOWrapper()
 
130
        stderr = tests.StringIOWrapper()
 
131
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
132
        self.assertEqual(1, factory.get_integer(""))
 
133
        self.assertEqual(-2, factory.get_integer(""))
 
134
        self.assertEqual(42, factory.get_integer(""))
 
135
 
230
136
    def test_text_factory_prompt(self):
231
137
        # see <https://launchpad.net/bugs/365891>
232
 
        factory = TextUIFactory(StringIO(), StringIO(), StringIO())
 
138
        StringIO = tests.StringIOWrapper
 
139
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
233
140
        factory.prompt('foo %2e')
234
141
        self.assertEqual('', factory.stdout.getvalue())
235
142
        self.assertEqual('foo %2e', factory.stderr.getvalue())
236
143
 
237
144
    def test_text_factory_prompts_and_clears(self):
238
145
        # a get_boolean call should clear the pb before prompting
239
 
        out = _TTYStringIO()
 
146
        out = test_progress._TTYStringIO()
240
147
        os.environ['TERM'] = 'xterm'
241
 
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
 
148
        factory = _mod_ui_text.TextUIFactory(
 
149
            stdin=tests.StringIOWrapper("yada\ny\n"),
 
150
            stdout=out, stderr=out)
 
151
        factory._avail_width = lambda: 79
242
152
        pb = factory.nested_progress_bar()
243
153
        pb.show_bar = False
244
154
        pb.show_spinner = False
250
160
                                               factory.get_boolean,
251
161
                                               "what do you want"))
252
162
        output = out.getvalue()
253
 
        self.assertContainsRe(factory.stdout.getvalue(),
254
 
            "foo *\r\r  *\r*")
255
 
        self.assertContainsRe(factory.stdout.getvalue(),
 
163
        self.assertContainsRe(output,
 
164
            "| foo *\r\r  *\r*")
 
165
        self.assertContainsRe(output,
256
166
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
257
167
        # stdin should have been totally consumed
258
168
        self.assertEqual('', factory.stdin.readline())
259
169
 
260
170
    def test_text_tick_after_update(self):
261
 
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
 
171
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
 
172
                                                stderr=tests.StringIOWrapper())
262
173
        pb = ui_factory.nested_progress_bar()
263
174
        try:
264
175
            pb.update('task', 0, 3)
269
180
            pb.finished()
270
181
 
271
182
    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()
 
183
        factory = _mod_ui_text.TextUIFactory(None, None, None)
 
184
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
 
185
        factory.stdout = tests.StringIOWrapper()
 
186
        factory.stderr = tests.StringIOWrapper()
276
187
        factory.stdout.encoding = "utf8"
277
188
        # there is no output from the base factory
278
189
        self.assertEqual("someuser",
300
211
        finally:
301
212
            pb.finished()
302
213
 
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):
 
214
    def test_quietness(self):
 
215
        os.environ['BZR_PROGRESS_BAR'] = 'text'
 
216
        ui_factory = _mod_ui_text.TextUIFactory(None,
 
217
            test_progress._TTYStringIO(),
 
218
            test_progress._TTYStringIO())
 
219
        self.assertIsInstance(ui_factory._progress_view,
 
220
            _mod_ui_text.TextProgressView)
 
221
        ui_factory.be_quiet(True)
 
222
        self.assertIsInstance(ui_factory._progress_view,
 
223
            _mod_ui_text.NullProgressView)
 
224
 
 
225
    def test_text_ui_show_user_warning(self):
 
226
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
 
227
        from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
 
228
        err = StringIO()
 
229
        out = StringIO()
 
230
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
 
231
        remote_fmt = remote.RemoteRepositoryFormat()
 
232
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
 
233
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
 
234
            to_format=remote_fmt)
 
235
        self.assertEquals('', out.getvalue())
 
236
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
 
237
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
 
238
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
 
239
            "the same format for better performance.\n",
 
240
            err.getvalue())
 
241
        # and now with it suppressed please
 
242
        err = StringIO()
 
243
        out = StringIO()
 
244
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
 
245
        ui.suppressed_warnings.add('cross_format_fetch')
 
246
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
 
247
            to_format=remote_fmt)
 
248
        self.assertEquals('', out.getvalue())
 
249
        self.assertEquals('', err.getvalue())
 
250
 
 
251
 
 
252
class TestTextUIOutputStream(tests.TestCase):
 
253
    """Tests for output stream that synchronizes with progress bar."""
 
254
 
 
255
    def test_output_clears_terminal(self):
 
256
        stdout = tests.StringIOWrapper()
 
257
        stderr = tests.StringIOWrapper()
 
258
        clear_calls = []
 
259
 
 
260
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
 
261
        uif.clear_term = lambda: clear_calls.append('clear')
 
262
 
 
263
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
 
264
        stream.write("Hello world!\n")
 
265
        stream.write("there's more...\n")
 
266
        stream.writelines(["1\n", "2\n", "3\n"])
 
267
 
 
268
        self.assertEqual(stdout.getvalue(),
 
269
            "Hello world!\n"
 
270
            "there's more...\n"
 
271
            "1\n2\n3\n")
 
272
        self.assertEqual(['clear', 'clear', 'clear'],
 
273
            clear_calls)
 
274
 
 
275
        stream.flush()
 
276
 
 
277
 
 
278
class UITests(tests.TestCase):
 
279
 
 
280
    def test_progress_construction(self):
 
281
        """TextUIFactory constructs the right progress view.
 
282
        """
 
283
        TTYStringIO = test_progress._TTYStringIO
 
284
        FileStringIO = tests.StringIOWrapper
 
285
        for (file_class, term, pb, expected_pb_class) in (
 
286
            # on an xterm, either use them or not as the user requests,
 
287
            # otherwise default on
 
288
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
 
289
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
 
290
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
 
291
            # on a dumb terminal, again if there's explicit configuration do
 
292
            # it, otherwise default off
 
293
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
 
294
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
295
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
296
            # on a non-tty terminal, it's null regardless of $TERM
 
297
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
 
298
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
299
            # however, it can still be forced on
 
300
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
301
            ):
 
302
            os.environ['TERM'] = term
 
303
            if pb is None:
 
304
                if 'BZR_PROGRESS_BAR' in os.environ:
 
305
                    del os.environ['BZR_PROGRESS_BAR']
 
306
            else:
 
307
                os.environ['BZR_PROGRESS_BAR'] = pb
 
308
            stdin = file_class('')
 
309
            stderr = file_class()
 
310
            stdout = file_class()
 
311
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
 
312
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
 
313
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
314
            self.assertIsInstance(uif.make_progress_view(),
 
315
                expected_pb_class,
 
316
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
317
 
 
318
    def test_text_ui_non_terminal(self):
 
319
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
 
320
        stdin = test_progress._NonTTYStringIO('')
 
321
        stderr = test_progress._NonTTYStringIO()
 
322
        stdout = test_progress._NonTTYStringIO()
 
323
        for term_type in ['dumb', None, 'xterm']:
 
324
            if term_type is None:
 
325
                del os.environ['TERM']
 
326
            else:
 
327
                os.environ['TERM'] = term_type
 
328
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
 
329
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
 
330
                'TERM=%r' % (term_type,))
 
331
 
 
332
 
 
333
class SilentUITests(tests.TestCase):
314
334
 
315
335
    def test_silent_factory_get_password(self):
316
336
        # A silent factory that can't do user interaction can't get a
317
337
        # password.  Possibly it should raise a more specific error but it
318
338
        # can't succeed.
319
 
        ui = SilentUIFactory()
320
 
        stdout = StringIO()
 
339
        ui = _mod_ui.SilentUIFactory()
 
340
        stdout = tests.StringIOWrapper()
321
341
        self.assertRaises(
322
342
            NotImplementedError,
323
343
            self.apply_redirected,
326
346
        self.assertEqual('', stdout.getvalue())
327
347
 
328
348
    def test_silent_ui_getbool(self):
329
 
        factory = SilentUIFactory()
330
 
        stdout = StringIO()
 
349
        factory = _mod_ui.SilentUIFactory()
 
350
        stdout = tests.StringIOWrapper()
331
351
        self.assertRaises(
332
352
            NotImplementedError,
333
353
            self.apply_redirected,
334
354
            None, stdout, stdout, factory.get_boolean, "foo")
335
355
 
336
356
 
337
 
class TestUIFactoryTests(TestCase):
 
357
class TestUIFactoryTests(tests.TestCase):
338
358
 
339
359
    def test_test_ui_factory_progress(self):
340
360
        # there's no output; we just want to make sure this doesn't crash -
341
 
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
342
 
        ui = TestUIFactory()
 
361
        # see https://bugs.launchpad.net/bzr/+bug/408201
 
362
        ui = tests.TestUIFactory()
343
363
        pb = ui.nested_progress_bar()
344
364
        pb.update('hello')
345
365
        pb.tick()
346
366
        pb.finished()
347
367
 
348
368
 
349
 
class CannedInputUIFactoryTests(TestCase):
350
 
    
 
369
class CannedInputUIFactoryTests(tests.TestCase):
 
370
 
351
371
    def test_canned_input_get_input(self):
352
 
        uif = CannedInputUIFactory([True, 'mbp', 'password'])
353
 
        self.assertEqual(uif.get_boolean('Extra cheese?'), True)
354
 
        self.assertEqual(uif.get_username('Enter your user name'), 'mbp')
355
 
        self.assertEqual(uif.get_password('Password for %(host)s', host='example.com'),
356
 
            'password')
 
372
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
 
373
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
 
374
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
 
375
        self.assertEqual('password',
 
376
                         uif.get_password('Password for %(host)s',
 
377
                                          host='example.com'))
 
378
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
357
379
 
358
380
 
359
381
class TestBoolFromString(tests.TestCase):