← 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: Brian de Alwis
  • Date: 2009-09-24 19:51:37 UTC
  • mto: (4715.4.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4727.
  • Revision ID: bsd@acm.org-20090924195137-wubyeqv515mkigi8
Introduce new mailer to support MacOS X's Mail.app

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
 
    config,
28
27
    errors,
29
 
    remote,
30
 
    repository,
31
28
    tests,
32
29
    ui as _mod_ui,
33
30
    )
35
32
    deprecated_in,
36
33
    )
37
34
from bzrlib.tests import (
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):
 
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):
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 = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
162
                pb.note,
 
163
                't')
 
164
            self.assertEqual(None, result)
 
165
            self.assertEqual("t\n", stdout.getvalue())
 
166
            # Since there was no update() call, there should be no clear() call
 
167
            self.failIf(re.search(r'^\r {10,}\r$',
 
168
                                  stderr.getvalue()) is not None,
 
169
                        'We cleared the stderr without anything to put there')
 
170
        finally:
 
171
            pb.finished()
 
172
 
 
173
    def test_progress_note_clears(self):
 
174
        stderr = _TTYStringIO()
 
175
        stdout = _TTYStringIO()
 
176
        # so that we get a TextProgressBar
 
177
        os.environ['TERM'] = 'xterm'
 
178
        ui_factory = TextUIFactory(
 
179
            stdin=StringIO(''),
 
180
            stdout=stdout, stderr=stderr)
 
181
        self.assertIsInstance(ui_factory._progress_view,
 
182
            TextProgressView)
 
183
        pb = ui_factory.nested_progress_bar()
 
184
        try:
 
185
            # Create a progress update that isn't throttled
 
186
            pb.update('x', 1, 1)
 
187
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
 
188
                pb.note, 't')
 
189
            self.assertEqual(None, result)
 
190
            self.assertEqual("t\n", stdout.getvalue())
 
191
            # the exact contents will depend on the terminal width and we don't
 
192
            # care about that right now - but you're probably running it on at
 
193
            # least a 10-character wide terminal :)
 
194
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
195
        finally:
 
196
            pb.finished()
 
197
 
 
198
    def test_progress_nested(self):
 
199
        # test factory based nested and popping.
 
200
        ui = TextUIFactory(None, None, None)
 
201
        pb1 = ui.nested_progress_bar()
 
202
        pb2 = ui.nested_progress_bar()
 
203
        # You do get a warning if the outermost progress bar wasn't finished
 
204
        # first - it's not clear if this is really useful or if it should just
 
205
        # become orphaned -- mbp 20090120
 
206
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
207
        if len(warnings) != 1:
 
208
            self.fail("unexpected warnings: %r" % (warnings,))
 
209
        pb2.finished()
 
210
        pb1.finished()
 
211
 
103
212
    def test_text_ui_get_boolean(self):
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)
 
213
        stdin = StringIO("y\n" # True
 
214
                         "n\n" # False
 
215
                         "yes with garbage\nY\n" # True
 
216
                         "not an answer\nno\n" # False
 
217
                         "I'm sure!\nyes\n" # True
 
218
                         "NO\n" # False
 
219
                         "foo\n")
 
220
        stdout = StringIO()
 
221
        stderr = StringIO()
 
222
        factory = TextUIFactory(stdin, stdout, stderr)
114
223
        self.assertEqual(True, factory.get_boolean(""))
115
224
        self.assertEqual(False, factory.get_boolean(""))
116
225
        self.assertEqual(True, factory.get_boolean(""))
121
230
        # stdin should be empty
122
231
        self.assertEqual('', factory.stdin.readline())
123
232
 
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
 
 
136
233
    def test_text_factory_prompt(self):
137
234
        # see <https://launchpad.net/bugs/365891>
138
 
        StringIO = tests.StringIOWrapper
139
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
 
235
        factory = TextUIFactory(StringIO(), StringIO(), StringIO())
140
236
        factory.prompt('foo %2e')
141
237
        self.assertEqual('', factory.stdout.getvalue())
142
238
        self.assertEqual('foo %2e', factory.stderr.getvalue())
143
239
 
144
240
    def test_text_factory_prompts_and_clears(self):
145
241
        # a get_boolean call should clear the pb before prompting
146
 
        out = test_progress._TTYStringIO()
 
242
        out = _TTYStringIO()
147
243
        os.environ['TERM'] = 'xterm'
148
 
        factory = _mod_ui_text.TextUIFactory(
149
 
            stdin=tests.StringIOWrapper("yada\ny\n"),
150
 
            stdout=out, stderr=out)
151
 
        factory._avail_width = lambda: 79
 
244
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
152
245
        pb = factory.nested_progress_bar()
153
246
        pb.show_bar = False
154
247
        pb.show_spinner = False
160
253
                                               factory.get_boolean,
161
254
                                               "what do you want"))
162
255
        output = out.getvalue()
163
 
        self.assertContainsRe(output,
164
 
            "| foo *\r\r  *\r*")
165
 
        self.assertContainsRe(output,
 
256
        self.assertContainsRe(factory.stdout.getvalue(),
 
257
            "foo *\r\r  *\r*")
 
258
        self.assertContainsRe(factory.stdout.getvalue(),
166
259
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
167
260
        # stdin should have been totally consumed
168
261
        self.assertEqual('', factory.stdin.readline())
169
262
 
170
263
    def test_text_tick_after_update(self):
171
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
172
 
                                                stderr=tests.StringIOWrapper())
 
264
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
173
265
        pb = ui_factory.nested_progress_bar()
174
266
        try:
175
267
            pb.update('task', 0, 3)
180
272
            pb.finished()
181
273
 
182
274
    def test_text_ui_getusername(self):
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()
 
275
        factory = TextUIFactory(None, None, None)
 
276
        factory.stdin = StringIO("someuser\n\n")
 
277
        factory.stdout = StringIO()
 
278
        factory.stderr = StringIO()
187
279
        factory.stdout.encoding = "utf8"
188
280
        # there is no output from the base factory
189
281
        self.assertEqual("someuser",
211
303
        finally:
212
304
            pb.finished()
213
305
 
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):
 
306
 
 
307
class CLIUITests(TestCase):
 
308
 
 
309
    def test_cli_factory_deprecated(self):
 
310
        uif = self.applyDeprecated(deprecated_in((1, 18, 0)),
 
311
            CLIUIFactory,
 
312
            StringIO(), StringIO(), StringIO())
 
313
        self.assertIsInstance(uif, UIFactory)
 
314
 
 
315
 
 
316
class SilentUITests(TestCase):
334
317
 
335
318
    def test_silent_factory_get_password(self):
336
319
        # A silent factory that can't do user interaction can't get a
337
320
        # password.  Possibly it should raise a more specific error but it
338
321
        # can't succeed.
339
 
        ui = _mod_ui.SilentUIFactory()
340
 
        stdout = tests.StringIOWrapper()
 
322
        ui = SilentUIFactory()
 
323
        stdout = StringIO()
341
324
        self.assertRaises(
342
325
            NotImplementedError,
343
326
            self.apply_redirected,
346
329
        self.assertEqual('', stdout.getvalue())
347
330
 
348
331
    def test_silent_ui_getbool(self):
349
 
        factory = _mod_ui.SilentUIFactory()
350
 
        stdout = tests.StringIOWrapper()
 
332
        factory = SilentUIFactory()
 
333
        stdout = StringIO()
351
334
        self.assertRaises(
352
335
            NotImplementedError,
353
336
            self.apply_redirected,
354
337
            None, stdout, stdout, factory.get_boolean, "foo")
355
338
 
356
339
 
357
 
class TestUIFactoryTests(tests.TestCase):
 
340
class TestUIFactoryTests(TestCase):
358
341
 
359
342
    def test_test_ui_factory_progress(self):
360
343
        # there's no output; we just want to make sure this doesn't crash -
361
 
        # see https://bugs.launchpad.net/bzr/+bug/408201
362
 
        ui = tests.TestUIFactory()
 
344
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
 
345
        ui = TestUIFactory()
363
346
        pb = ui.nested_progress_bar()
364
347
        pb.update('hello')
365
348
        pb.tick()
366
349
        pb.finished()
367
350
 
368
351
 
369
 
class CannedInputUIFactoryTests(tests.TestCase):
370
 
 
 
352
class CannedInputUIFactoryTests(TestCase):
 
353
    
371
354
    def test_canned_input_get_input(self):
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 ?'))
 
355
        uif = CannedInputUIFactory([True, 'mbp', 'password'])
 
356
        self.assertEqual(uif.get_boolean('Extra cheese?'), True)
 
357
        self.assertEqual(uif.get_username('Enter your user name'), 'mbp')
 
358
        self.assertEqual(uif.get_password('Password for %(host)s', host='example.com'),
 
359
            'password')
379
360
 
380
361
 
381
362
class TestBoolFromString(tests.TestCase):