← 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: 2007-07-19 16:09:34 UTC
  • mfrom: (2520.4.135 bzr.mpbundle)
  • Revision ID: pqm@pqm.ubuntu.com-20070719160934-d51fyijw69oto88p
Add new bundle and merge-directive formats

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 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tests for the bzrlib ui
18
18
"""
19
19
 
20
 
import time
21
 
 
 
20
import os
22
21
from StringIO import StringIO
23
 
 
24
 
from testtools.matchers import *
25
 
 
26
 
from bzrlib import (
27
 
    config,
28
 
    remote,
29
 
    tests,
30
 
    ui as _mod_ui,
 
22
import re
 
23
import sys
 
24
 
 
25
import bzrlib
 
26
import bzrlib.errors as errors
 
27
from bzrlib.progress import (
 
28
    DotsProgressBar,
 
29
    ProgressBarStack,
 
30
    TTYProgressBar,
31
31
    )
32
32
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)
 
33
    TestCase,
 
34
    TestUIFactory,
 
35
    StringIOWrapper,
 
36
    )
 
37
from bzrlib.tests.test_progress import _TTYStringIO
 
38
from bzrlib.ui import (
 
39
    CLIUIFactory,
 
40
    SilentUIFactory,
 
41
    )
 
42
from bzrlib.ui.text import TextUIFactory
 
43
 
 
44
 
 
45
class UITests(TestCase):
 
46
 
 
47
    def test_silent_factory(self):
 
48
        ui = SilentUIFactory()
 
49
        stdout = StringIO()
 
50
        self.assertEqual(None,
 
51
                         self.apply_redirected(None, stdout, stdout,
 
52
                                               ui.get_password))
 
53
        self.assertEqual('', stdout.getvalue())
 
54
        self.assertEqual(None,
 
55
                         self.apply_redirected(None, stdout, stdout,
 
56
                                               ui.get_password,
 
57
                                               u'Hello\u1234 %(user)s',
 
58
                                               user=u'some\u1234'))
 
59
        self.assertEqual('', stdout.getvalue())
70
60
 
71
61
    def test_text_factory_ascii_password(self):
72
 
        ui = self.make_test_ui_factory('secret\n')
 
62
        ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
73
63
        pb = ui.nested_progress_bar()
74
64
        try:
75
65
            self.assertEqual('secret',
76
66
                             self.apply_redirected(ui.stdin, ui.stdout,
77
 
                                                   ui.stderr,
 
67
                                                   ui.stdout,
78
68
                                                   ui.get_password))
79
69
            # ': ' is appended to prompt
80
 
            self.assertEqual(': ', ui.stderr.getvalue())
81
 
            self.assertEqual('', ui.stdout.readline())
 
70
            self.assertEqual(': ', ui.stdout.getvalue())
82
71
            # stdin should be empty
83
72
            self.assertEqual('', ui.stdin.readline())
84
73
        finally:
90
79
        We can't predict what encoding users will have for stdin, so we force
91
80
        it to utf8 to test that we transport the password correctly.
92
81
        """
93
 
        ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
94
 
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
 
82
        ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
83
                           stdout=StringIOWrapper())
 
84
        ui.stdin.encoding = 'utf8'
 
85
        ui.stdout.encoding = ui.stdin.encoding
95
86
        pb = ui.nested_progress_bar()
96
87
        try:
97
 
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
88
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
98
89
                                             ui.get_password,
99
90
                                             u'Hello \u1234 %(user)s',
100
91
                                             user=u'some\u1234')
101
92
            # We use StringIO objects, we need to decode them
102
93
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
103
94
            self.assertEqual(u'Hello \u1234 some\u1234: ',
104
 
                             ui.stderr.getvalue().decode('utf8'))
105
 
            # stdin and stdout should be empty
 
95
                             ui.stdout.getvalue().decode('utf8'))
 
96
            # stdin should be empty
106
97
            self.assertEqual('', ui.stdin.readline())
107
 
            self.assertEqual('', ui.stdout.readline())
108
 
        finally:
109
 
            pb.finished()
110
 
 
111
 
    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
 
 
214
 
    def test_text_factory_prompt(self):
215
 
        # 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')
219
 
        self.assertEqual('', factory.stdout.getvalue())
220
 
        self.assertEqual('foo %2e', factory.stderr.getvalue())
 
98
        finally:
 
99
            pb.finished()
 
100
 
 
101
    def test_progress_note(self):
 
102
        stderr = StringIO()
 
103
        stdout = StringIO()
 
104
        ui_factory = TextUIFactory(bar_type=TTYProgressBar)
 
105
        pb = ui_factory.nested_progress_bar()
 
106
        try:
 
107
            pb.to_messages_file = stdout
 
108
            ui_factory._progress_bar_stack.bottom().to_file = stderr
 
109
            result = pb.note('t')
 
110
            self.assertEqual(None, result)
 
111
            self.assertEqual("t\n", stdout.getvalue())
 
112
            # Since there was no update() call, there should be no clear() call
 
113
            self.failIf(re.search(r'^\r {10,}\r$',
 
114
                                  stderr.getvalue()) is not None,
 
115
                        'We cleared the stderr without anything to put there')
 
116
        finally:
 
117
            pb.finished()
 
118
 
 
119
    def test_progress_note_clears(self):
 
120
        stderr = StringIO()
 
121
        stdout = StringIO()
 
122
        # The PQM redirects the output to a file, so it
 
123
        # defaults to creating a Dots progress bar. we
 
124
        # need to force it to believe we are a TTY
 
125
        ui_factory = TextUIFactory(bar_type=TTYProgressBar)
 
126
        pb = ui_factory.nested_progress_bar()
 
127
        try:
 
128
            pb.to_messages_file = stdout
 
129
            ui_factory._progress_bar_stack.bottom().to_file = stderr
 
130
            # Create a progress update that isn't throttled
 
131
            pb.start_time -= 10
 
132
            pb.update('x', 1, 1)
 
133
            result = pb.note('t')
 
134
            self.assertEqual(None, result)
 
135
            self.assertEqual("t\n", stdout.getvalue())
 
136
            # the exact contents will depend on the terminal width and we don't
 
137
            # care about that right now - but you're probably running it on at
 
138
            # least a 10-character wide terminal :)
 
139
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
140
        finally:
 
141
            pb.finished()
 
142
 
 
143
    def test_progress_nested(self):
 
144
        # test factory based nested and popping.
 
145
        ui = TextUIFactory()
 
146
        pb1 = ui.nested_progress_bar()
 
147
        pb2 = ui.nested_progress_bar()
 
148
        self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
 
149
        pb2.finished()
 
150
        pb1.finished()
 
151
 
 
152
    def test_progress_stack(self):
 
153
        # test the progress bar stack which the default text factory 
 
154
        # uses.
 
155
        stderr = StringIO()
 
156
        stdout = StringIO()
 
157
        # make a stack, which accepts parameters like a pb.
 
158
        stack = ProgressBarStack(to_file=stderr, to_messages_file=stdout)
 
159
        # but is not one
 
160
        self.assertFalse(getattr(stack, 'note', False))
 
161
        pb1 = stack.get_nested()
 
162
        pb2 = stack.get_nested()
 
163
        self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
 
164
        pb2.finished()
 
165
        pb1.finished()
 
166
        # the text ui factory never actually removes the stack once its setup.
 
167
        # we need to be able to nest again correctly from here.
 
168
        pb1 = stack.get_nested()
 
169
        pb2 = stack.get_nested()
 
170
        self.assertRaises(errors.MissingProgressBarFinish, pb1.finished)
 
171
        pb2.finished()
 
172
        pb1.finished()
 
173
 
 
174
    def test_text_factory_setting_progress_bar(self):
 
175
        # we should be able to choose the progress bar type used.
 
176
        factory = TextUIFactory(bar_type=DotsProgressBar)
 
177
        bar = factory.nested_progress_bar()
 
178
        bar.finished()
 
179
        self.assertIsInstance(bar, DotsProgressBar)
 
180
 
 
181
    def test_cli_stdin_is_default_stdin(self):
 
182
        factory = CLIUIFactory()
 
183
        self.assertEqual(sys.stdin, factory.stdin)
 
184
 
 
185
    def assert_get_bool_acceptance_of_user_input(self, factory):
 
186
        factory.stdin = StringIO("y\nyes with garbage\n"
 
187
                                 "yes\nn\nnot an answer\n"
 
188
                                 "no\nfoo\n")
 
189
        factory.stdout = StringIO()
 
190
        # there is no output from the base factory
 
191
        self.assertEqual(True, factory.get_boolean(""))
 
192
        self.assertEqual(True, factory.get_boolean(""))
 
193
        self.assertEqual(False, factory.get_boolean(""))
 
194
        self.assertEqual(False, factory.get_boolean(""))
 
195
        self.assertEqual("foo\n", factory.stdin.read())
 
196
        # stdin should be empty
 
197
        self.assertEqual('', factory.stdin.readline())
 
198
 
 
199
    def test_silent_ui_getbool(self):
 
200
        factory = SilentUIFactory()
 
201
        self.assert_get_bool_acceptance_of_user_input(factory)
 
202
 
 
203
    def test_silent_factory_prompts_silently(self):
 
204
        factory = SilentUIFactory()
 
205
        stdout = StringIO()
 
206
        factory.stdin = StringIO("y\n")
 
207
        self.assertEqual(True,
 
208
                         self.apply_redirected(None, stdout, stdout,
 
209
                                               factory.get_boolean, "foo"))
 
210
        self.assertEqual("", stdout.getvalue())
 
211
        # stdin should be empty
 
212
        self.assertEqual('', factory.stdin.readline())
 
213
 
 
214
    def test_text_ui_getbool(self):
 
215
        factory = TextUIFactory()
 
216
        self.assert_get_bool_acceptance_of_user_input(factory)
221
217
 
222
218
    def test_text_factory_prompts_and_clears(self):
223
219
        # 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
230
 
        pb = factory.nested_progress_bar()
231
 
        pb.show_bar = False
232
 
        pb.show_spinner = False
233
 
        pb.show_count = False
234
 
        pb.update("foo", 0, 1)
 
220
        factory = TextUIFactory(bar_type=DotsProgressBar)
 
221
        factory.stdout = _TTYStringIO()
 
222
        factory.stdin = StringIO("yada\ny\n")
 
223
        pb = self.apply_redirected(factory.stdin, factory.stdout,
 
224
                                   factory.stdout, factory.nested_progress_bar)
 
225
        pb.start_time = None
 
226
        self.apply_redirected(factory.stdin, factory.stdout,
 
227
                              factory.stdout, pb.update, "foo", 0, 1)
235
228
        self.assertEqual(True,
236
229
                         self.apply_redirected(None, factory.stdout,
237
230
                                               factory.stdout,
238
231
                                               factory.get_boolean,
239
 
                                               u"what do you want"))
240
 
        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): ")
245
 
        # stdin should have been totally consumed
246
 
        self.assertEqual('', factory.stdin.readline())
247
 
 
248
 
    def test_text_tick_after_update(self):
249
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
250
 
                                                stderr=tests.StringIOWrapper())
251
 
        pb = ui_factory.nested_progress_bar()
252
 
        try:
253
 
            pb.update('task', 0, 3)
254
 
            # Reset the clock, so that it actually tries to repaint itself
255
 
            ui_factory._progress_view._last_repaint = time.time() - 1.0
256
 
            pb.tick()
257
 
        finally:
258
 
            pb.finished()
259
 
 
260
 
    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()
265
 
        factory.stdout.encoding = "utf8"
266
 
        # there is no output from the base factory
267
 
        self.assertEqual("someuser",
268
 
                         factory.get_username(u'Hello %(host)s', host='some'))
269
 
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
270
 
        self.assertEquals('', factory.stdout.getvalue())
271
 
        self.assertEqual("", factory.get_username(u"Gebruiker"))
 
232
                                               "what do you want"))
 
233
        output = factory.stdout.getvalue()
 
234
        self.assertEqual("foo: .\n"
 
235
                         "what do you want? [y/n]: what do you want? [y/n]: ",
 
236
                         factory.stdout.getvalue())
272
237
        # stdin should be empty
273
238
        self.assertEqual('', factory.stdin.readline())
274
239
 
275
 
    def test_text_ui_getusername_utf8(self):
276
 
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
277
 
                                 stdout=tests.StringIOWrapper(),
278
 
                                 stderr=tests.StringIOWrapper())
279
 
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
280
 
        pb = ui.nested_progress_bar()
281
 
        try:
282
 
            # there is no output from the base factory
283
 
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
284
 
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
285
 
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
286
 
            self.assertEquals(u"Hello\u1234 some\u1234: ",
287
 
                              ui.stderr.getvalue().decode("utf8"))
288
 
            self.assertEquals('', ui.stdout.getvalue())
289
 
        finally:
290
 
            pb.finished()
291
 
 
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):
405
 
 
406
 
    def test_silent_factory_get_password(self):
407
 
        # A silent factory that can't do user interaction can't get a
408
 
        # password.  Possibly it should raise a more specific error but it
409
 
        # can't succeed.
410
 
        ui = _mod_ui.SilentUIFactory()
411
 
        stdout = tests.StringIOWrapper()
412
 
        self.assertRaises(
413
 
            NotImplementedError,
414
 
            self.apply_redirected,
415
 
            None, stdout, stdout, ui.get_password)
416
 
        # and it didn't write anything out either
417
 
        self.assertEqual('', stdout.getvalue())
418
 
 
419
 
    def test_silent_ui_getbool(self):
420
 
        factory = _mod_ui.SilentUIFactory()
421
 
        stdout = tests.StringIOWrapper()
422
 
        self.assertRaises(
423
 
            NotImplementedError,
424
 
            self.apply_redirected,
425
 
            None, stdout, stdout, factory.get_boolean, u"foo")
426
 
 
427
 
 
428
 
class TestUIFactoryTests(tests.TestCase):
429
 
 
430
 
    def test_test_ui_factory_progress(self):
431
 
        # 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()
434
 
        pb = ui.nested_progress_bar()
435
 
        pb.update('hello')
436
 
        pb.tick()
437
 
        pb.finished()
438
 
 
439
 
 
440
 
class CannedInputUIFactoryTests(tests.TestCase):
441
 
 
442
 
    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 ?'))
450
 
 
451
 
 
452
 
class TestBoolFromString(tests.TestCase):
453
 
 
454
 
    def assertIsTrue(self, s, accepted_values=None):
455
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
456
 
        self.assertEquals(True, res)
457
 
 
458
 
    def assertIsFalse(self, s, accepted_values=None):
459
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
460
 
        self.assertEquals(False, res)
461
 
 
462
 
    def assertIsNone(self, s, accepted_values=None):
463
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
464
 
        self.assertIs(None, res)
465
 
 
466
 
    def test_know_valid_values(self):
467
 
        self.assertIsTrue('true')
468
 
        self.assertIsFalse('false')
469
 
        self.assertIsTrue('1')
470
 
        self.assertIsFalse('0')
471
 
        self.assertIsTrue('on')
472
 
        self.assertIsFalse('off')
473
 
        self.assertIsTrue('yes')
474
 
        self.assertIsFalse('no')
475
 
        self.assertIsTrue('y')
476
 
        self.assertIsFalse('n')
477
 
        # Also try some case variations
478
 
        self.assertIsTrue('True')
479
 
        self.assertIsFalse('False')
480
 
        self.assertIsTrue('On')
481
 
        self.assertIsFalse('Off')
482
 
        self.assertIsTrue('ON')
483
 
        self.assertIsFalse('OFF')
484
 
        self.assertIsTrue('oN')
485
 
        self.assertIsFalse('oFf')
486
 
 
487
 
    def test_invalid_values(self):
488
 
        self.assertIsNone(None)
489
 
        self.assertIsNone('doubt')
490
 
        self.assertIsNone('frue')
491
 
        self.assertIsNone('talse')
492
 
        self.assertIsNone('42')
493
 
 
494
 
    def test_provided_values(self):
495
 
        av = dict(y=True, n=False, yes=True, no=False)
496
 
        self.assertIsTrue('y', av)
497
 
        self.assertIsTrue('Y', av)
498
 
        self.assertIsTrue('Yes', av)
499
 
        self.assertIsFalse('n', av)
500
 
        self.assertIsFalse('N', av)
501
 
        self.assertIsFalse('No', av)
502
 
        self.assertIsNone('1', av)
503
 
        self.assertIsNone('0', av)
504
 
        self.assertIsNone('on', av)
505
 
        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)