← 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: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
1
 
# Copyright (C) 2005-2011 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
17
17
"""Tests for the bzrlib ui
18
18
"""
19
19
 
 
20
import os
 
21
from StringIO import StringIO
 
22
import re
 
23
import sys
20
24
import time
21
25
 
22
 
from StringIO import StringIO
23
 
 
24
 
from testtools.matchers import *
25
 
 
26
26
from bzrlib import (
27
 
    config,
28
 
    remote,
 
27
    errors,
29
28
    tests,
30
29
    ui as _mod_ui,
31
30
    )
 
31
from bzrlib.symbol_versioning import (
 
32
    deprecated_in,
 
33
    )
32
34
from bzrlib.tests import (
33
 
    fixtures,
34
 
    test_progress,
35
 
    )
36
 
from bzrlib.ui import text as _mod_ui_text
37
 
from bzrlib.tests.testui import (
38
 
    ProgressRecordingUIFactory,
39
 
    )
40
 
 
41
 
 
42
 
class TestUIConfiguration(tests.TestCaseWithTransport):
43
 
 
44
 
    def test_output_encoding_configuration(self):
45
 
        enc = fixtures.generate_unicode_encodings().next()
46
 
        config.GlobalConfig().set_user_option('output_encoding',
47
 
            enc)
48
 
        ui = tests.TestUIFactory(stdin=None,
49
 
            stdout=tests.StringIOWrapper(),
50
 
            stderr=tests.StringIOWrapper())
51
 
        output = ui.make_output_stream()
52
 
        self.assertEquals(output.encoding, enc)
53
 
 
54
 
 
55
 
class TestTextUIFactory(tests.TestCase):
56
 
 
57
 
    def make_test_ui_factory(self, stdin_contents):
58
 
        ui = tests.TestUIFactory(stdin=stdin_contents,
59
 
                                 stdout=tests.StringIOWrapper(),
60
 
                                 stderr=tests.StringIOWrapper())
61
 
        return ui
62
 
 
63
 
    def test_text_factory_confirm(self):
64
 
        # turns into reading a regular boolean
65
 
        ui = self.make_test_ui_factory('n\n')
66
 
        self.assertEquals(ui.confirm_action(u'Should %(thing)s pass?',
67
 
            'bzrlib.tests.test_ui.confirmation',
68
 
            {'thing': 'this'},),
69
 
            False)
 
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):
70
58
 
71
59
    def test_text_factory_ascii_password(self):
72
 
        ui = self.make_test_ui_factory('secret\n')
 
60
        ui = tests.TestUIFactory(stdin='secret\n',
 
61
                                 stdout=tests.StringIOWrapper(),
 
62
                                 stderr=tests.StringIOWrapper())
73
63
        pb = ui.nested_progress_bar()
74
64
        try:
75
65
            self.assertEqual('secret',
90
80
        We can't predict what encoding users will have for stdin, so we force
91
81
        it to utf8 to test that we transport the password correctly.
92
82
        """
93
 
        ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
 
83
        ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
84
                                 stdout=tests.StringIOWrapper(),
 
85
                                 stderr=tests.StringIOWrapper())
94
86
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
95
87
        pb = ui.nested_progress_bar()
96
88
        try:
108
100
        finally:
109
101
            pb.finished()
110
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
 
111
212
    def test_text_ui_get_boolean(self):
112
 
        stdin = tests.StringIOWrapper("y\n" # True
113
 
                                      "n\n" # False
114
 
                                      " \n y \n" # True
115
 
                                      " no \n" # False
116
 
                                      "yes with garbage\nY\n" # True
117
 
                                      "not an answer\nno\n" # False
118
 
                                      "I'm sure!\nyes\n" # True
119
 
                                      "NO\n" # False
120
 
                                      "foo\n")
121
 
        stdout = tests.StringIOWrapper()
122
 
        stderr = tests.StringIOWrapper()
123
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
124
 
        self.assertEqual(True, factory.get_boolean(u""))
125
 
        self.assertEqual(False, factory.get_boolean(u""))
126
 
        self.assertEqual(True, factory.get_boolean(u""))
127
 
        self.assertEqual(False, factory.get_boolean(u""))
128
 
        self.assertEqual(True, factory.get_boolean(u""))
129
 
        self.assertEqual(False, factory.get_boolean(u""))
130
 
        self.assertEqual(True, factory.get_boolean(u""))
131
 
        self.assertEqual(False, factory.get_boolean(u""))
132
 
        self.assertEqual("foo\n", factory.stdin.read())
133
 
        # stdin should be empty
134
 
        self.assertEqual('', factory.stdin.readline())
135
 
        # return false on EOF
136
 
        self.assertEqual(False, factory.get_boolean(u""))
137
 
 
138
 
    def test_text_ui_choose_bad_parameters(self):
139
 
        stdin = tests.StringIOWrapper()
140
 
        stdout = tests.StringIOWrapper()
141
 
        stderr = tests.StringIOWrapper()
142
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
143
 
        # invalid default index
144
 
        self.assertRaises(ValueError, factory.choose, u"", u"&Yes\n&No", 3)
145
 
        # duplicated choice
146
 
        self.assertRaises(ValueError, factory.choose, u"", u"&choice\n&ChOiCe")
147
 
        # duplicated shortcut
148
 
        self.assertRaises(ValueError, factory.choose, u"", u"&choice1\nchoi&ce2")
149
 
 
150
 
    def test_text_ui_choose_prompt(self):
151
 
        stdin = tests.StringIOWrapper()
152
 
        stdout = tests.StringIOWrapper()
153
 
        stderr = tests.StringIOWrapper()
154
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
155
 
        # choices with explicit shortcuts
156
 
        factory.choose(u"prompt", u"&yes\n&No\nmore &info")
157
 
        self.assertEqual("prompt ([y]es, [N]o, more [i]nfo): \n", factory.stderr.getvalue())
158
 
        # automatic shortcuts
159
 
        factory.stderr.truncate(0)
160
 
        factory.choose(u"prompt", u"yes\nNo\nmore info")
161
 
        self.assertEqual("prompt ([y]es, [N]o, [m]ore info): \n", factory.stderr.getvalue())
162
 
 
163
 
    def test_text_ui_choose_return_values(self):
164
 
        choose = lambda: factory.choose(u"", u"&Yes\n&No\nMaybe\nmore &info", 3)
165
 
        stdin = tests.StringIOWrapper("y\n" # 0
166
 
                                      "n\n" # 1
167
 
                                      " \n" # default: 3
168
 
                                      " no \n" # 1
169
 
                                      "b\na\nd \n" # bad shortcuts, all ignored
170
 
                                      "yes with garbage\nY\n" # 0
171
 
                                      "not an answer\nno\n" # 1
172
 
                                      "info\nmore info\n" # 3
173
 
                                      "Maybe\n" # 2
174
 
                                      "foo\n")
175
 
        stdout = tests.StringIOWrapper()
176
 
        stderr = tests.StringIOWrapper()
177
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
178
 
        self.assertEqual(0, choose())
179
 
        self.assertEqual(1, choose())
180
 
        self.assertEqual(3, choose())
181
 
        self.assertEqual(1, choose())
182
 
        self.assertEqual(0, choose())
183
 
        self.assertEqual(1, choose())
184
 
        self.assertEqual(3, choose())
185
 
        self.assertEqual(2, choose())
186
 
        self.assertEqual("foo\n", factory.stdin.read())
187
 
        # stdin should be empty
188
 
        self.assertEqual('', factory.stdin.readline())
189
 
        # return None on EOF
190
 
        self.assertEqual(None, choose())
191
 
 
192
 
    def test_text_ui_choose_no_default(self):
193
 
        stdin = tests.StringIOWrapper(" \n" # no default, invalid!
194
 
                                      " yes \n" # 0
195
 
                                      "foo\n")
196
 
        stdout = tests.StringIOWrapper()
197
 
        stderr = tests.StringIOWrapper()
198
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
199
 
        self.assertEqual(0, factory.choose(u"", u"&Yes\n&No"))
200
 
        self.assertEqual("foo\n", factory.stdin.read())
201
 
 
202
 
    def test_text_ui_get_integer(self):
203
 
        stdin = tests.StringIOWrapper(
204
 
            "1\n"
205
 
            "  -2  \n"
206
 
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
207
 
        stdout = tests.StringIOWrapper()
208
 
        stderr = tests.StringIOWrapper()
209
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
210
 
        self.assertEqual(1, factory.get_integer(u""))
211
 
        self.assertEqual(-2, factory.get_integer(u""))
212
 
        self.assertEqual(42, factory.get_integer(u""))
 
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)
 
223
        self.assertEqual(True, factory.get_boolean(""))
 
224
        self.assertEqual(False, factory.get_boolean(""))
 
225
        self.assertEqual(True, factory.get_boolean(""))
 
226
        self.assertEqual(False, factory.get_boolean(""))
 
227
        self.assertEqual(True, factory.get_boolean(""))
 
228
        self.assertEqual(False, factory.get_boolean(""))
 
229
        self.assertEqual("foo\n", factory.stdin.read())
 
230
        # stdin should be empty
 
231
        self.assertEqual('', factory.stdin.readline())
213
232
 
214
233
    def test_text_factory_prompt(self):
215
234
        # see <https://launchpad.net/bugs/365891>
216
 
        StringIO = tests.StringIOWrapper
217
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
218
 
        factory.prompt(u'foo %2e')
 
235
        factory = TextUIFactory(StringIO(), StringIO(), StringIO())
 
236
        factory.prompt('foo %2e')
219
237
        self.assertEqual('', factory.stdout.getvalue())
220
238
        self.assertEqual('foo %2e', factory.stderr.getvalue())
221
239
 
222
240
    def test_text_factory_prompts_and_clears(self):
223
241
        # a get_boolean call should clear the pb before prompting
224
 
        out = test_progress._TTYStringIO()
225
 
        self.overrideEnv('TERM', 'xterm')
226
 
        factory = _mod_ui_text.TextUIFactory(
227
 
            stdin=tests.StringIOWrapper("yada\ny\n"),
228
 
            stdout=out, stderr=out)
229
 
        factory._avail_width = lambda: 79
 
242
        out = _TTYStringIO()
 
243
        os.environ['TERM'] = 'xterm'
 
244
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
230
245
        pb = factory.nested_progress_bar()
231
246
        pb.show_bar = False
232
247
        pb.show_spinner = False
236
251
                         self.apply_redirected(None, factory.stdout,
237
252
                                               factory.stdout,
238
253
                                               factory.get_boolean,
239
 
                                               u"what do you want"))
 
254
                                               "what do you want"))
240
255
        output = out.getvalue()
241
 
        self.assertContainsRe(output,
242
 
            "| foo *\r\r  *\r*")
243
 
        self.assertContainsString(output,
244
 
            r"what do you want? ([y]es, [n]o): what do you want? ([y]es, [n]o): ")
 
256
        self.assertContainsRe(factory.stdout.getvalue(),
 
257
            "foo *\r\r  *\r*")
 
258
        self.assertContainsRe(factory.stdout.getvalue(),
 
259
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
245
260
        # stdin should have been totally consumed
246
261
        self.assertEqual('', factory.stdin.readline())
247
262
 
248
263
    def test_text_tick_after_update(self):
249
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
250
 
                                                stderr=tests.StringIOWrapper())
 
264
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
251
265
        pb = ui_factory.nested_progress_bar()
252
266
        try:
253
267
            pb.update('task', 0, 3)
258
272
            pb.finished()
259
273
 
260
274
    def test_text_ui_getusername(self):
261
 
        factory = _mod_ui_text.TextUIFactory(None, None, None)
262
 
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
263
 
        factory.stdout = tests.StringIOWrapper()
264
 
        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()
265
279
        factory.stdout.encoding = "utf8"
266
280
        # there is no output from the base factory
267
281
        self.assertEqual("someuser",
268
 
                         factory.get_username(u'Hello %(host)s', host='some'))
 
282
                         factory.get_username('Hello %(host)s', host='some'))
269
283
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
270
284
        self.assertEquals('', factory.stdout.getvalue())
271
 
        self.assertEqual("", factory.get_username(u"Gebruiker"))
 
285
        self.assertEqual("", factory.get_username("Gebruiker"))
272
286
        # stdin should be empty
273
287
        self.assertEqual('', factory.stdin.readline())
274
288
 
289
303
        finally:
290
304
            pb.finished()
291
305
 
292
 
    def test_quietness(self):
293
 
        self.overrideEnv('BZR_PROGRESS_BAR', 'text')
294
 
        ui_factory = _mod_ui_text.TextUIFactory(None,
295
 
            test_progress._TTYStringIO(),
296
 
            test_progress._TTYStringIO())
297
 
        self.assertIsInstance(ui_factory._progress_view,
298
 
            _mod_ui_text.TextProgressView)
299
 
        ui_factory.be_quiet(True)
300
 
        self.assertIsInstance(ui_factory._progress_view,
301
 
            _mod_ui_text.NullProgressView)
302
 
 
303
 
    def test_text_ui_show_user_warning(self):
304
 
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
305
 
        from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack5
306
 
        err = StringIO()
307
 
        out = StringIO()
308
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
309
 
        remote_fmt = remote.RemoteRepositoryFormat()
310
 
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
311
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
312
 
            to_format=remote_fmt)
313
 
        self.assertEquals('', out.getvalue())
314
 
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
315
 
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
316
 
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
317
 
            "the same format for better performance.\n",
318
 
            err.getvalue())
319
 
        # and now with it suppressed please
320
 
        err = StringIO()
321
 
        out = StringIO()
322
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
323
 
        ui.suppressed_warnings.add('cross_format_fetch')
324
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
325
 
            to_format=remote_fmt)
326
 
        self.assertEquals('', out.getvalue())
327
 
        self.assertEquals('', err.getvalue())
328
 
 
329
 
 
330
 
class TestTextUIOutputStream(tests.TestCase):
331
 
    """Tests for output stream that synchronizes with progress bar."""
332
 
 
333
 
    def test_output_clears_terminal(self):
334
 
        stdout = tests.StringIOWrapper()
335
 
        stderr = tests.StringIOWrapper()
336
 
        clear_calls = []
337
 
 
338
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
339
 
        uif.clear_term = lambda: clear_calls.append('clear')
340
 
 
341
 
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
342
 
        stream.write("Hello world!\n")
343
 
        stream.write("there's more...\n")
344
 
        stream.writelines(["1\n", "2\n", "3\n"])
345
 
 
346
 
        self.assertEqual(stdout.getvalue(),
347
 
            "Hello world!\n"
348
 
            "there's more...\n"
349
 
            "1\n2\n3\n")
350
 
        self.assertEqual(['clear', 'clear', 'clear'],
351
 
            clear_calls)
352
 
 
353
 
        stream.flush()
354
 
 
355
 
 
356
 
class UITests(tests.TestCase):
357
 
 
358
 
    def test_progress_construction(self):
359
 
        """TextUIFactory constructs the right progress view.
360
 
        """
361
 
        TTYStringIO = test_progress._TTYStringIO
362
 
        FileStringIO = tests.StringIOWrapper
363
 
        for (file_class, term, pb, expected_pb_class) in (
364
 
            # on an xterm, either use them or not as the user requests,
365
 
            # otherwise default on
366
 
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
367
 
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
368
 
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
369
 
            # on a dumb terminal, again if there's explicit configuration do
370
 
            # it, otherwise default off
371
 
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
372
 
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
373
 
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
374
 
            # on a non-tty terminal, it's null regardless of $TERM
375
 
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
376
 
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
377
 
            # however, it can still be forced on
378
 
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
379
 
            ):
380
 
            self.overrideEnv('TERM', term)
381
 
            self.overrideEnv('BZR_PROGRESS_BAR', pb)
382
 
            stdin = file_class('')
383
 
            stderr = file_class()
384
 
            stdout = file_class()
385
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
386
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
387
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
388
 
            self.assertIsInstance(uif.make_progress_view(),
389
 
                expected_pb_class,
390
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
391
 
 
392
 
    def test_text_ui_non_terminal(self):
393
 
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
394
 
        stdin = test_progress._NonTTYStringIO('')
395
 
        stderr = test_progress._NonTTYStringIO()
396
 
        stdout = test_progress._NonTTYStringIO()
397
 
        for term_type in ['dumb', None, 'xterm']:
398
 
            self.overrideEnv('TERM', term_type)
399
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
400
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
401
 
                'TERM=%r' % (term_type,))
402
 
 
403
 
 
404
 
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):
405
317
 
406
318
    def test_silent_factory_get_password(self):
407
319
        # A silent factory that can't do user interaction can't get a
408
320
        # password.  Possibly it should raise a more specific error but it
409
321
        # can't succeed.
410
 
        ui = _mod_ui.SilentUIFactory()
411
 
        stdout = tests.StringIOWrapper()
 
322
        ui = SilentUIFactory()
 
323
        stdout = StringIO()
412
324
        self.assertRaises(
413
325
            NotImplementedError,
414
326
            self.apply_redirected,
417
329
        self.assertEqual('', stdout.getvalue())
418
330
 
419
331
    def test_silent_ui_getbool(self):
420
 
        factory = _mod_ui.SilentUIFactory()
421
 
        stdout = tests.StringIOWrapper()
 
332
        factory = SilentUIFactory()
 
333
        stdout = StringIO()
422
334
        self.assertRaises(
423
335
            NotImplementedError,
424
336
            self.apply_redirected,
425
 
            None, stdout, stdout, factory.get_boolean, u"foo")
426
 
 
427
 
 
428
 
class TestUIFactoryTests(tests.TestCase):
 
337
            None, stdout, stdout, factory.get_boolean, "foo")
 
338
 
 
339
 
 
340
class TestUIFactoryTests(TestCase):
429
341
 
430
342
    def test_test_ui_factory_progress(self):
431
343
        # there's no output; we just want to make sure this doesn't crash -
432
 
        # see https://bugs.launchpad.net/bzr/+bug/408201
433
 
        ui = tests.TestUIFactory()
 
344
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
 
345
        ui = TestUIFactory()
434
346
        pb = ui.nested_progress_bar()
435
347
        pb.update('hello')
436
348
        pb.tick()
437
349
        pb.finished()
438
350
 
439
351
 
440
 
class CannedInputUIFactoryTests(tests.TestCase):
441
 
 
 
352
class CannedInputUIFactoryTests(TestCase):
 
353
    
442
354
    def test_canned_input_get_input(self):
443
 
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
444
 
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
445
 
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
446
 
        self.assertEqual('password',
447
 
                         uif.get_password(u'Password for %(host)s',
448
 
                                          host='example.com'))
449
 
        self.assertEqual(42, uif.get_integer(u'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')
450
360
 
451
361
 
452
362
class TestBoolFromString(tests.TestCase):
503
413
        self.assertIsNone('0', av)
504
414
        self.assertIsNone('on', av)
505
415
        self.assertIsNone('off', av)
506
 
 
507
 
 
508
 
class TestConfirmationUserInterfacePolicy(tests.TestCase):
509
 
 
510
 
    def test_confirm_action_default(self):
511
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
512
 
        for answer in [True, False]:
513
 
            self.assertEquals(
514
 
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
515
 
                .confirm_action("Do something?",
516
 
                    "bzrlib.tests.do_something", {}),
517
 
                answer)
518
 
 
519
 
    def test_confirm_action_specific(self):
520
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
521
 
        for default_answer in [True, False]:
522
 
            for specific_answer in [True, False]:
523
 
                for conf_id in ['given_id', 'other_id']:
524
 
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
525
 
                        base_ui, default_answer, dict(given_id=specific_answer))
526
 
                    result = wrapper.confirm_action("Do something?", conf_id, {})
527
 
                    if conf_id == 'given_id':
528
 
                        self.assertEquals(result, specific_answer)
529
 
                    else:
530
 
                        self.assertEquals(result, default_answer)
531
 
 
532
 
    def test_repr(self):
533
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
534
 
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
535
 
            base_ui, True, dict(a=2))
536
 
        self.assertThat(repr(wrapper),
537
 
            Equals("ConfirmationUserInterfacePolicy("
538
 
                "NoninteractiveUIFactory(), True, {'a': 2})"))
539
 
 
540
 
 
541
 
class TestProgressRecordingUI(tests.TestCase):
542
 
    """Test test-oriented UIFactory that records progress updates"""
543
 
 
544
 
    def test_nested_ignore_depth_beyond_one(self):
545
 
        # we only want to capture the first level out progress, not
546
 
        # want sub-components might do. So we have nested bars ignored.
547
 
        factory = ProgressRecordingUIFactory()
548
 
        pb1 = factory.nested_progress_bar()
549
 
        pb1.update('foo', 0, 1)
550
 
        pb2 = factory.nested_progress_bar()
551
 
        pb2.update('foo', 0, 1)
552
 
        pb2.finished()
553
 
        pb1.finished()
554
 
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)