← 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: Jelmer Vernooij
  • Date: 2009-05-01 14:29:06 UTC
  • mto: This revision was merged to the branch mainline in revision 4321.
  • Revision ID: jelmer@samba.org-20090501142906-7zj8hcpp9igzuyi4
Add repository argument to 'repository' info hook, per Roberts review.

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
 
from bzrlib import (
27
 
    config,
28
 
    remote,
29
 
    tests,
30
 
    ui as _mod_ui,
 
26
import bzrlib
 
27
import bzrlib.errors as errors
 
28
from bzrlib.progress import (
 
29
    DotsProgressBar,
 
30
    ProgressBarStack,
 
31
    ProgressTask,
 
32
    TTYProgressBar,
 
33
    )
 
34
from bzrlib.symbol_versioning import (
 
35
    deprecated_in,
31
36
    )
32
37
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)
 
38
    TestCase,
 
39
    TestUIFactory,
 
40
    StringIOWrapper,
 
41
    )
 
42
from bzrlib.tests.test_progress import _TTYStringIO
 
43
from bzrlib.ui import (
 
44
    CLIUIFactory,
 
45
    SilentUIFactory,
 
46
    )
 
47
from bzrlib.ui.text import (
 
48
    TextProgressView,
 
49
    TextUIFactory,
 
50
    )
 
51
 
 
52
 
 
53
class UITests(TestCase):
 
54
 
 
55
    def test_silent_factory(self):
 
56
        ui = SilentUIFactory()
 
57
        stdout = StringIO()
 
58
        self.assertEqual(None,
 
59
                         self.apply_redirected(None, stdout, stdout,
 
60
                                               ui.get_password))
 
61
        self.assertEqual('', stdout.getvalue())
 
62
        self.assertEqual(None,
 
63
                         self.apply_redirected(None, stdout, stdout,
 
64
                                               ui.get_password,
 
65
                                               u'Hello\u1234 %(user)s',
 
66
                                               user=u'some\u1234'))
 
67
        self.assertEqual('', stdout.getvalue())
70
68
 
71
69
    def test_text_factory_ascii_password(self):
72
 
        ui = self.make_test_ui_factory('secret\n')
 
70
        ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
73
71
        pb = ui.nested_progress_bar()
74
72
        try:
75
73
            self.assertEqual('secret',
76
74
                             self.apply_redirected(ui.stdin, ui.stdout,
77
 
                                                   ui.stderr,
 
75
                                                   ui.stdout,
78
76
                                                   ui.get_password))
79
77
            # ': ' is appended to prompt
80
 
            self.assertEqual(': ', ui.stderr.getvalue())
81
 
            self.assertEqual('', ui.stdout.readline())
 
78
            self.assertEqual(': ', ui.stdout.getvalue())
82
79
            # stdin should be empty
83
80
            self.assertEqual('', ui.stdin.readline())
84
81
        finally:
90
87
        We can't predict what encoding users will have for stdin, so we force
91
88
        it to utf8 to test that we transport the password correctly.
92
89
        """
93
 
        ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
94
 
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
 
90
        ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
91
                           stdout=StringIOWrapper())
 
92
        ui.stdin.encoding = 'utf8'
 
93
        ui.stdout.encoding = ui.stdin.encoding
95
94
        pb = ui.nested_progress_bar()
96
95
        try:
97
 
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
96
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
98
97
                                             ui.get_password,
99
98
                                             u'Hello \u1234 %(user)s',
100
99
                                             user=u'some\u1234')
101
100
            # We use StringIO objects, we need to decode them
102
101
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
103
102
            self.assertEqual(u'Hello \u1234 some\u1234: ',
104
 
                             ui.stderr.getvalue().decode('utf8'))
105
 
            # stdin and stdout should be empty
 
103
                             ui.stdout.getvalue().decode('utf8'))
 
104
            # stdin should be empty
106
105
            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
 
                                      "yes with garbage\nY\n" # True
115
 
                                      "not an answer\nno\n" # False
116
 
                                      "I'm sure!\nyes\n" # True
117
 
                                      "NO\n" # False
118
 
                                      "foo\n")
119
 
        stdout = tests.StringIOWrapper()
120
 
        stderr = tests.StringIOWrapper()
121
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
122
 
        self.assertEqual(True, factory.get_boolean(u""))
123
 
        self.assertEqual(False, factory.get_boolean(u""))
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""))
 
106
        finally:
 
107
            pb.finished()
 
108
 
 
109
    def test_progress_note(self):
 
110
        stderr = StringIO()
 
111
        stdout = StringIO()
 
112
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
113
            stderr=stderr,
 
114
            stdout=stdout)
 
115
        pb = ui_factory.nested_progress_bar()
 
116
        try:
 
117
            result = pb.note('t')
 
118
            self.assertEqual(None, result)
 
119
            self.assertEqual("t\n", stdout.getvalue())
 
120
            # Since there was no update() call, there should be no clear() call
 
121
            self.failIf(re.search(r'^\r {10,}\r$',
 
122
                                  stderr.getvalue()) is not None,
 
123
                        'We cleared the stderr without anything to put there')
 
124
        finally:
 
125
            pb.finished()
 
126
 
 
127
    def test_progress_note_clears(self):
 
128
        stderr = StringIO()
 
129
        stdout = StringIO()
 
130
        # The PQM redirects the output to a file, so it
 
131
        # defaults to creating a Dots progress bar. we
 
132
        # need to force it to believe we are a TTY
 
133
        ui_factory = TextUIFactory(
 
134
            stdin=StringIO(''),
 
135
            stdout=stdout, stderr=stderr)
 
136
        pb = ui_factory.nested_progress_bar()
 
137
        try:
 
138
            # Create a progress update that isn't throttled
 
139
            pb.update('x', 1, 1)
 
140
            result = pb.note('t')
 
141
            self.assertEqual(None, result)
 
142
            self.assertEqual("t\n", stdout.getvalue())
 
143
            # the exact contents will depend on the terminal width and we don't
 
144
            # care about that right now - but you're probably running it on at
 
145
            # least a 10-character wide terminal :)
 
146
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
147
        finally:
 
148
            pb.finished()
 
149
 
 
150
    def test_progress_nested(self):
 
151
        # test factory based nested and popping.
 
152
        ui = TextUIFactory(None, None, None)
 
153
        pb1 = ui.nested_progress_bar()
 
154
        pb2 = ui.nested_progress_bar()
 
155
        # You do get a warning if the outermost progress bar wasn't finished
 
156
        # first - it's not clear if this is really useful or if it should just
 
157
        # become orphaned -- mbp 20090120
 
158
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
159
        if len(warnings) != 1:
 
160
            self.fail("unexpected warnings: %r" % (warnings,))
 
161
        pb2.finished()
 
162
        pb1.finished()
 
163
 
 
164
    def test_progress_stack(self):
 
165
        # test the progress bar stack which the default text factory
 
166
        # uses.
 
167
        stderr = StringIO()
 
168
        stdout = StringIO()
 
169
        # make a stack, which accepts parameters like a pb.
 
170
        stack = self.applyDeprecated(
 
171
            deprecated_in((1, 12, 0)),
 
172
            ProgressBarStack,
 
173
            to_file=stderr, to_messages_file=stdout)
 
174
        # but is not one
 
175
        self.assertFalse(getattr(stack, 'note', False))
 
176
        pb1 = stack.get_nested()
 
177
        pb2 = stack.get_nested()
 
178
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
179
        self.assertEqual(len(warnings), 1)
 
180
        pb2.finished()
 
181
        pb1.finished()
 
182
        # the text ui factory never actually removes the stack once its setup.
 
183
        # we need to be able to nest again correctly from here.
 
184
        pb1 = stack.get_nested()
 
185
        pb2 = stack.get_nested()
 
186
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
187
        self.assertEqual(len(warnings), 1)
 
188
        pb2.finished()
 
189
        pb1.finished()
 
190
 
 
191
    def assert_get_bool_acceptance_of_user_input(self, factory):
 
192
        factory.stdin = StringIO("y\nyes with garbage\n"
 
193
                                 "yes\nn\nnot an answer\n"
 
194
                                 "no\nfoo\n")
 
195
        factory.stdout = StringIO()
 
196
        # there is no output from the base factory
 
197
        self.assertEqual(True, factory.get_boolean(""))
 
198
        self.assertEqual(True, factory.get_boolean(""))
 
199
        self.assertEqual(False, factory.get_boolean(""))
 
200
        self.assertEqual(False, factory.get_boolean(""))
128
201
        self.assertEqual("foo\n", factory.stdin.read())
129
202
        # stdin should be empty
130
203
        self.assertEqual('', factory.stdin.readline())
131
204
 
132
 
    def test_text_ui_get_integer(self):
133
 
        stdin = tests.StringIOWrapper(
134
 
            "1\n"
135
 
            "  -2  \n"
136
 
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
137
 
        stdout = tests.StringIOWrapper()
138
 
        stderr = tests.StringIOWrapper()
139
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
140
 
        self.assertEqual(1, factory.get_integer(u""))
141
 
        self.assertEqual(-2, factory.get_integer(u""))
142
 
        self.assertEqual(42, factory.get_integer(u""))
 
205
    def test_silent_ui_getbool(self):
 
206
        factory = SilentUIFactory()
 
207
        self.assert_get_bool_acceptance_of_user_input(factory)
 
208
 
 
209
    def test_silent_factory_prompts_silently(self):
 
210
        factory = SilentUIFactory()
 
211
        stdout = StringIO()
 
212
        factory.stdin = StringIO("y\n")
 
213
        self.assertEqual(True,
 
214
                         self.apply_redirected(None, stdout, stdout,
 
215
                                               factory.get_boolean, "foo"))
 
216
        self.assertEqual("", stdout.getvalue())
 
217
        # stdin should be empty
 
218
        self.assertEqual('', factory.stdin.readline())
 
219
 
 
220
    def test_text_ui_getbool(self):
 
221
        factory = TextUIFactory(None, None, None)
 
222
        self.assert_get_bool_acceptance_of_user_input(factory)
143
223
 
144
224
    def test_text_factory_prompt(self):
145
225
        # see <https://launchpad.net/bugs/365891>
146
 
        StringIO = tests.StringIOWrapper
147
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
148
 
        factory.prompt(u'foo %2e')
149
 
        self.assertEqual('', factory.stdout.getvalue())
150
 
        self.assertEqual('foo %2e', factory.stderr.getvalue())
 
226
        factory = TextUIFactory(None, StringIO(), StringIO())
 
227
        factory.prompt('foo %2e')
151
228
 
152
229
    def test_text_factory_prompts_and_clears(self):
153
230
        # a get_boolean call should clear the pb before prompting
154
 
        out = test_progress._TTYStringIO()
155
 
        self.overrideEnv('TERM', 'xterm')
156
 
        factory = _mod_ui_text.TextUIFactory(
157
 
            stdin=tests.StringIOWrapper("yada\ny\n"),
158
 
            stdout=out, stderr=out)
159
 
        factory._avail_width = lambda: 79
 
231
        out = _TTYStringIO()
 
232
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
160
233
        pb = factory.nested_progress_bar()
161
234
        pb.show_bar = False
162
235
        pb.show_spinner = False
166
239
                         self.apply_redirected(None, factory.stdout,
167
240
                                               factory.stdout,
168
241
                                               factory.get_boolean,
169
 
                                               u"what do you want"))
 
242
                                               "what do you want"))
170
243
        output = out.getvalue()
171
 
        self.assertContainsRe(output,
172
 
            "| foo *\r\r  *\r*")
173
 
        self.assertContainsRe(output,
 
244
        self.assertContainsRe(factory.stdout.getvalue(),
 
245
            "foo *\r\r  *\r*")
 
246
        self.assertContainsRe(factory.stdout.getvalue(),
174
247
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
175
248
        # stdin should have been totally consumed
176
249
        self.assertEqual('', factory.stdin.readline())
177
250
 
178
251
    def test_text_tick_after_update(self):
179
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
180
 
                                                stderr=tests.StringIOWrapper())
 
252
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
181
253
        pb = ui_factory.nested_progress_bar()
182
254
        try:
183
255
            pb.update('task', 0, 3)
187
259
        finally:
188
260
            pb.finished()
189
261
 
 
262
    def test_silent_ui_getusername(self):
 
263
        factory = SilentUIFactory()
 
264
        factory.stdin = StringIO("someuser\n\n")
 
265
        factory.stdout = StringIO()
 
266
        self.assertEquals(None, 
 
267
            factory.get_username(u'Hello\u1234 %(host)s', host=u'some\u1234'))
 
268
        self.assertEquals("", factory.stdout.getvalue())
 
269
        self.assertEquals("someuser\n\n", factory.stdin.getvalue())
 
270
 
190
271
    def test_text_ui_getusername(self):
191
 
        factory = _mod_ui_text.TextUIFactory(None, None, None)
192
 
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
193
 
        factory.stdout = tests.StringIOWrapper()
194
 
        factory.stderr = tests.StringIOWrapper()
 
272
        factory = TextUIFactory(None, None, None)
 
273
        factory.stdin = StringIO("someuser\n\n")
 
274
        factory.stdout = StringIO()
195
275
        factory.stdout.encoding = "utf8"
196
276
        # there is no output from the base factory
197
 
        self.assertEqual("someuser",
198
 
                         factory.get_username(u'Hello %(host)s', host='some'))
199
 
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
200
 
        self.assertEquals('', factory.stdout.getvalue())
201
 
        self.assertEqual("", factory.get_username(u"Gebruiker"))
 
277
        self.assertEqual("someuser", 
 
278
            factory.get_username('Hello %(host)s', host='some'))
 
279
        self.assertEquals("Hello some: ", factory.stdout.getvalue())
 
280
        self.assertEqual("", factory.get_username("Gebruiker"))
202
281
        # stdin should be empty
203
282
        self.assertEqual('', factory.stdin.readline())
204
283
 
205
284
    def test_text_ui_getusername_utf8(self):
206
 
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
207
 
                                 stdout=tests.StringIOWrapper(),
208
 
                                 stderr=tests.StringIOWrapper())
209
 
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
285
        ui = TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
286
                           stdout=StringIOWrapper())
 
287
        ui.stdin.encoding = "utf8"
 
288
        ui.stdout.encoding = ui.stdin.encoding
210
289
        pb = ui.nested_progress_bar()
211
290
        try:
212
291
            # there is no output from the base factory
213
 
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
292
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
214
293
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
215
294
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
216
 
            self.assertEquals(u"Hello\u1234 some\u1234: ",
217
 
                              ui.stderr.getvalue().decode("utf8"))
218
 
            self.assertEquals('', ui.stdout.getvalue())
 
295
            self.assertEquals(u"Hello\u1234 some\u1234: ", 
 
296
                ui.stdout.getvalue().decode("utf8"))
219
297
        finally:
220
298
            pb.finished()
221
299
 
222
 
    def test_quietness(self):
223
 
        self.overrideEnv('BZR_PROGRESS_BAR', 'text')
224
 
        ui_factory = _mod_ui_text.TextUIFactory(None,
225
 
            test_progress._TTYStringIO(),
226
 
            test_progress._TTYStringIO())
227
 
        self.assertIsInstance(ui_factory._progress_view,
228
 
            _mod_ui_text.TextProgressView)
229
 
        ui_factory.be_quiet(True)
230
 
        self.assertIsInstance(ui_factory._progress_view,
231
 
            _mod_ui_text.NullProgressView)
232
 
 
233
 
    def test_text_ui_show_user_warning(self):
234
 
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
235
 
        from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack5
236
 
        err = StringIO()
237
 
        out = StringIO()
238
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
239
 
        remote_fmt = remote.RemoteRepositoryFormat()
240
 
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
241
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
242
 
            to_format=remote_fmt)
243
 
        self.assertEquals('', out.getvalue())
244
 
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
245
 
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
246
 
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
247
 
            "the same format for better performance.\n",
248
 
            err.getvalue())
249
 
        # and now with it suppressed please
250
 
        err = StringIO()
251
 
        out = StringIO()
252
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
253
 
        ui.suppressed_warnings.add('cross_format_fetch')
254
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
255
 
            to_format=remote_fmt)
256
 
        self.assertEquals('', out.getvalue())
257
 
        self.assertEquals('', err.getvalue())
258
 
 
259
 
 
260
 
class TestTextUIOutputStream(tests.TestCase):
261
 
    """Tests for output stream that synchronizes with progress bar."""
262
 
 
263
 
    def test_output_clears_terminal(self):
264
 
        stdout = tests.StringIOWrapper()
265
 
        stderr = tests.StringIOWrapper()
266
 
        clear_calls = []
267
 
 
268
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
269
 
        uif.clear_term = lambda: clear_calls.append('clear')
270
 
 
271
 
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
272
 
        stream.write("Hello world!\n")
273
 
        stream.write("there's more...\n")
274
 
        stream.writelines(["1\n", "2\n", "3\n"])
275
 
 
276
 
        self.assertEqual(stdout.getvalue(),
277
 
            "Hello world!\n"
278
 
            "there's more...\n"
279
 
            "1\n2\n3\n")
280
 
        self.assertEqual(['clear', 'clear', 'clear'],
281
 
            clear_calls)
282
 
 
283
 
        stream.flush()
284
 
 
285
 
 
286
 
class UITests(tests.TestCase):
287
 
 
288
 
    def test_progress_construction(self):
289
 
        """TextUIFactory constructs the right progress view.
290
 
        """
291
 
        TTYStringIO = test_progress._TTYStringIO
292
 
        FileStringIO = tests.StringIOWrapper
293
 
        for (file_class, term, pb, expected_pb_class) in (
294
 
            # on an xterm, either use them or not as the user requests,
295
 
            # otherwise default on
296
 
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
297
 
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
298
 
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
299
 
            # on a dumb terminal, again if there's explicit configuration do
300
 
            # it, otherwise default off
301
 
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
302
 
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
303
 
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
304
 
            # on a non-tty terminal, it's null regardless of $TERM
305
 
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
306
 
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
307
 
            # however, it can still be forced on
308
 
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
309
 
            ):
310
 
            self.overrideEnv('TERM', term)
311
 
            self.overrideEnv('BZR_PROGRESS_BAR', pb)
312
 
            stdin = file_class('')
313
 
            stderr = file_class()
314
 
            stdout = file_class()
315
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
316
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
317
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
318
 
            self.assertIsInstance(uif.make_progress_view(),
319
 
                expected_pb_class,
320
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
321
 
 
322
 
    def test_text_ui_non_terminal(self):
323
 
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
324
 
        stdin = test_progress._NonTTYStringIO('')
325
 
        stderr = test_progress._NonTTYStringIO()
326
 
        stdout = test_progress._NonTTYStringIO()
327
 
        for term_type in ['dumb', None, 'xterm']:
328
 
            self.overrideEnv('TERM', term_type)
329
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
330
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
331
 
                'TERM=%r' % (term_type,))
332
 
 
333
 
 
334
 
class SilentUITests(tests.TestCase):
335
 
 
336
 
    def test_silent_factory_get_password(self):
337
 
        # A silent factory that can't do user interaction can't get a
338
 
        # password.  Possibly it should raise a more specific error but it
339
 
        # can't succeed.
340
 
        ui = _mod_ui.SilentUIFactory()
341
 
        stdout = tests.StringIOWrapper()
342
 
        self.assertRaises(
343
 
            NotImplementedError,
344
 
            self.apply_redirected,
345
 
            None, stdout, stdout, ui.get_password)
346
 
        # and it didn't write anything out either
347
 
        self.assertEqual('', stdout.getvalue())
348
 
 
349
 
    def test_silent_ui_getbool(self):
350
 
        factory = _mod_ui.SilentUIFactory()
351
 
        stdout = tests.StringIOWrapper()
352
 
        self.assertRaises(
353
 
            NotImplementedError,
354
 
            self.apply_redirected,
355
 
            None, stdout, stdout, factory.get_boolean, u"foo")
356
 
 
357
 
 
358
 
class TestUIFactoryTests(tests.TestCase):
359
 
 
360
 
    def test_test_ui_factory_progress(self):
361
 
        # there's no output; we just want to make sure this doesn't crash -
362
 
        # see https://bugs.launchpad.net/bzr/+bug/408201
363
 
        ui = tests.TestUIFactory()
364
 
        pb = ui.nested_progress_bar()
365
 
        pb.update('hello')
366
 
        pb.tick()
367
 
        pb.finished()
368
 
 
369
 
 
370
 
class CannedInputUIFactoryTests(tests.TestCase):
371
 
 
372
 
    def test_canned_input_get_input(self):
373
 
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
374
 
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
375
 
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
376
 
        self.assertEqual('password',
377
 
                         uif.get_password(u'Password for %(host)s',
378
 
                                          host='example.com'))
379
 
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
380
 
 
381
 
 
382
 
class TestBoolFromString(tests.TestCase):
383
 
 
384
 
    def assertIsTrue(self, s, accepted_values=None):
385
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
386
 
        self.assertEquals(True, res)
387
 
 
388
 
    def assertIsFalse(self, s, accepted_values=None):
389
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
390
 
        self.assertEquals(False, res)
391
 
 
392
 
    def assertIsNone(self, s, accepted_values=None):
393
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
394
 
        self.assertIs(None, res)
395
 
 
396
 
    def test_know_valid_values(self):
397
 
        self.assertIsTrue('true')
398
 
        self.assertIsFalse('false')
399
 
        self.assertIsTrue('1')
400
 
        self.assertIsFalse('0')
401
 
        self.assertIsTrue('on')
402
 
        self.assertIsFalse('off')
403
 
        self.assertIsTrue('yes')
404
 
        self.assertIsFalse('no')
405
 
        self.assertIsTrue('y')
406
 
        self.assertIsFalse('n')
407
 
        # Also try some case variations
408
 
        self.assertIsTrue('True')
409
 
        self.assertIsFalse('False')
410
 
        self.assertIsTrue('On')
411
 
        self.assertIsFalse('Off')
412
 
        self.assertIsTrue('ON')
413
 
        self.assertIsFalse('OFF')
414
 
        self.assertIsTrue('oN')
415
 
        self.assertIsFalse('oFf')
416
 
 
417
 
    def test_invalid_values(self):
418
 
        self.assertIsNone(None)
419
 
        self.assertIsNone('doubt')
420
 
        self.assertIsNone('frue')
421
 
        self.assertIsNone('talse')
422
 
        self.assertIsNone('42')
423
 
 
424
 
    def test_provided_values(self):
425
 
        av = dict(y=True, n=False, yes=True, no=False)
426
 
        self.assertIsTrue('y', av)
427
 
        self.assertIsTrue('Y', av)
428
 
        self.assertIsTrue('Yes', av)
429
 
        self.assertIsFalse('n', av)
430
 
        self.assertIsFalse('N', av)
431
 
        self.assertIsFalse('No', av)
432
 
        self.assertIsNone('1', av)
433
 
        self.assertIsNone('0', av)
434
 
        self.assertIsNone('on', av)
435
 
        self.assertIsNone('off', av)
436
 
 
437
 
 
438
 
class TestConfirmationUserInterfacePolicy(tests.TestCase):
439
 
 
440
 
    def test_confirm_action_default(self):
441
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
442
 
        for answer in [True, False]:
443
 
            self.assertEquals(
444
 
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
445
 
                .confirm_action("Do something?",
446
 
                    "bzrlib.tests.do_something", {}),
447
 
                answer)
448
 
 
449
 
    def test_confirm_action_specific(self):
450
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
451
 
        for default_answer in [True, False]:
452
 
            for specific_answer in [True, False]:
453
 
                for conf_id in ['given_id', 'other_id']:
454
 
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
455
 
                        base_ui, default_answer, dict(given_id=specific_answer))
456
 
                    result = wrapper.confirm_action("Do something?", conf_id, {})
457
 
                    if conf_id == 'given_id':
458
 
                        self.assertEquals(result, specific_answer)
459
 
                    else:
460
 
                        self.assertEquals(result, default_answer)
461
 
 
462
 
    def test_repr(self):
463
 
        base_ui = _mod_ui.NoninteractiveUIFactory()
464
 
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
465
 
            base_ui, True, dict(a=2))
466
 
        self.assertThat(repr(wrapper),
467
 
            Equals("ConfirmationUserInterfacePolicy("
468
 
                "NoninteractiveUIFactory(), True, {'a': 2})"))
469
 
 
470
 
 
471
 
class TestProgressRecordingUI(tests.TestCase):
472
 
    """Test test-oriented UIFactory that records progress updates"""
473
 
 
474
 
    def test_nested_ignore_depth_beyond_one(self):
475
 
        # we only want to capture the first level out progress, not
476
 
        # want sub-components might do. So we have nested bars ignored.
477
 
        factory = ProgressRecordingUIFactory()
478
 
        pb1 = factory.nested_progress_bar()
479
 
        pb1.update('foo', 0, 1)
480
 
        pb2 = factory.nested_progress_bar()
481
 
        pb2.update('foo', 0, 1)
482
 
        pb2.finished()
483
 
        pb1.finished()
484
 
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)
 
300
 
 
301
class TestTextProgressView(TestCase):
 
302
    """Tests for text display of progress bars.
 
303
    """
 
304
    # XXX: These might be a bit easier to write if the rendering and
 
305
    # state-maintaining parts of TextProgressView were more separate, and if
 
306
    # the progress task called back directly to its own view not to the ui
 
307
    # factory. -- mbp 20090312
 
308
    
 
309
    def _make_factory(self):
 
310
        out = StringIO()
 
311
        uif = TextUIFactory(stderr=out)
 
312
        uif._progress_view._width = 80
 
313
        return out, uif
 
314
 
 
315
    def test_render_progress_easy(self):
 
316
        """Just one task and one quarter done"""
 
317
        out, uif = self._make_factory()
 
318
        task = uif.nested_progress_bar()
 
319
        task.update('reticulating splines', 5, 20)
 
320
        self.assertEqual(
 
321
'\r[####/               ] reticulating splines 5/20                               \r'
 
322
            , out.getvalue())
 
323
 
 
324
    def test_render_progress_nested(self):
 
325
        """Tasks proportionally contribute to overall progress"""
 
326
        out, uif = self._make_factory()
 
327
        task = uif.nested_progress_bar()
 
328
        task.update('reticulating splines', 0, 2)
 
329
        task2 = uif.nested_progress_bar()
 
330
        task2.update('stage2', 1, 2)
 
331
        # so we're in the first half of the main task, and half way through
 
332
        # that
 
333
        self.assertEqual(
 
334
r'[####\               ] reticulating splines:stage2 1/2'
 
335
            , uif._progress_view._render_line())
 
336
        # if the nested task is complete, then we're all the way through the
 
337
        # first half of the overall work
 
338
        task2.update('stage2', 2, 2)
 
339
        self.assertEqual(
 
340
r'[#########|          ] reticulating splines:stage2 2/2'
 
341
            , uif._progress_view._render_line())
 
342
 
 
343
    def test_render_progress_sub_nested(self):
 
344
        """Intermediate tasks don't mess up calculation."""
 
345
        out, uif = self._make_factory()
 
346
        task_a = uif.nested_progress_bar()
 
347
        task_a.update('a', 0, 2)
 
348
        task_b = uif.nested_progress_bar()
 
349
        task_b.update('b')
 
350
        task_c = uif.nested_progress_bar()
 
351
        task_c.update('c', 1, 2)
 
352
        # the top-level task is in its first half; the middle one has no
 
353
        # progress indication, just a label; and the bottom one is half done,
 
354
        # so the overall fraction is 1/4
 
355
        self.assertEqual(
 
356
            r'[####|               ] a:b:c 1/2'
 
357
            , uif._progress_view._render_line())
 
358