← 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-06-09 00:59:51 UTC
  • mto: (4443.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 4444.
  • Revision ID: jelmer@samba.org-20090609005951-apv900cdk35o2ygh
Move squashing of XML-invalid characters to XMLSerializer.

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(),
 
71
                           stderr=StringIOWrapper())
73
72
        pb = ui.nested_progress_bar()
74
73
        try:
75
74
            self.assertEqual('secret',
90
89
        We can't predict what encoding users will have for stdin, so we force
91
90
        it to utf8 to test that we transport the password correctly.
92
91
        """
93
 
        ui = self.make_test_ui_factory(u'baz\u1234'.encode('utf8'))
 
92
        ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
93
                           stdout=StringIOWrapper(),
 
94
                           stderr=StringIOWrapper())
94
95
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
95
96
        pb = ui.nested_progress_bar()
96
97
        try:
108
109
        finally:
109
110
            pb.finished()
110
111
 
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""))
 
112
    def test_progress_note(self):
 
113
        stderr = StringIO()
 
114
        stdout = StringIO()
 
115
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
116
            stderr=stderr,
 
117
            stdout=stdout)
 
118
        pb = ui_factory.nested_progress_bar()
 
119
        try:
 
120
            result = pb.note('t')
 
121
            self.assertEqual(None, result)
 
122
            self.assertEqual("t\n", stdout.getvalue())
 
123
            # Since there was no update() call, there should be no clear() call
 
124
            self.failIf(re.search(r'^\r {10,}\r$',
 
125
                                  stderr.getvalue()) is not None,
 
126
                        'We cleared the stderr without anything to put there')
 
127
        finally:
 
128
            pb.finished()
 
129
 
 
130
    def test_progress_note_clears(self):
 
131
        stderr = StringIO()
 
132
        stdout = StringIO()
 
133
        # The PQM redirects the output to a file, so it
 
134
        # defaults to creating a Dots progress bar. we
 
135
        # need to force it to believe we are a TTY
 
136
        ui_factory = TextUIFactory(
 
137
            stdin=StringIO(''),
 
138
            stdout=stdout, stderr=stderr)
 
139
        pb = ui_factory.nested_progress_bar()
 
140
        try:
 
141
            # Create a progress update that isn't throttled
 
142
            pb.update('x', 1, 1)
 
143
            result = pb.note('t')
 
144
            self.assertEqual(None, result)
 
145
            self.assertEqual("t\n", stdout.getvalue())
 
146
            # the exact contents will depend on the terminal width and we don't
 
147
            # care about that right now - but you're probably running it on at
 
148
            # least a 10-character wide terminal :)
 
149
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
150
        finally:
 
151
            pb.finished()
 
152
 
 
153
    def test_progress_nested(self):
 
154
        # test factory based nested and popping.
 
155
        ui = TextUIFactory(None, None, None)
 
156
        pb1 = ui.nested_progress_bar()
 
157
        pb2 = ui.nested_progress_bar()
 
158
        # You do get a warning if the outermost progress bar wasn't finished
 
159
        # first - it's not clear if this is really useful or if it should just
 
160
        # become orphaned -- mbp 20090120
 
161
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
162
        if len(warnings) != 1:
 
163
            self.fail("unexpected warnings: %r" % (warnings,))
 
164
        pb2.finished()
 
165
        pb1.finished()
 
166
 
 
167
    def test_progress_stack(self):
 
168
        # test the progress bar stack which the default text factory
 
169
        # uses.
 
170
        stderr = StringIO()
 
171
        stdout = StringIO()
 
172
        # make a stack, which accepts parameters like a pb.
 
173
        stack = self.applyDeprecated(
 
174
            deprecated_in((1, 12, 0)),
 
175
            ProgressBarStack,
 
176
            to_file=stderr, to_messages_file=stdout)
 
177
        # but is not one
 
178
        self.assertFalse(getattr(stack, 'note', False))
 
179
        pb1 = stack.get_nested()
 
180
        pb2 = stack.get_nested()
 
181
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
182
        self.assertEqual(len(warnings), 1)
 
183
        pb2.finished()
 
184
        pb1.finished()
 
185
        # the text ui factory never actually removes the stack once its setup.
 
186
        # we need to be able to nest again correctly from here.
 
187
        pb1 = stack.get_nested()
 
188
        pb2 = stack.get_nested()
 
189
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
190
        self.assertEqual(len(warnings), 1)
 
191
        pb2.finished()
 
192
        pb1.finished()
 
193
 
 
194
    def assert_get_bool_acceptance_of_user_input(self, factory):
 
195
        factory.stdin = StringIO("y\nyes with garbage\n"
 
196
                                 "yes\nn\nnot an answer\n"
 
197
                                 "no\nfoo\n")
 
198
        factory.stdout = StringIO()
 
199
        factory.stderr = StringIO()
 
200
        # there is no output from the base factory
 
201
        self.assertEqual(True, factory.get_boolean(""))
 
202
        self.assertEqual(True, factory.get_boolean(""))
 
203
        self.assertEqual(False, factory.get_boolean(""))
 
204
        self.assertEqual(False, factory.get_boolean(""))
128
205
        self.assertEqual("foo\n", factory.stdin.read())
129
206
        # stdin should be empty
130
207
        self.assertEqual('', factory.stdin.readline())
131
208
 
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""))
 
209
    def test_silent_ui_getbool(self):
 
210
        factory = SilentUIFactory()
 
211
        self.assert_get_bool_acceptance_of_user_input(factory)
 
212
 
 
213
    def test_silent_factory_prompts_silently(self):
 
214
        factory = SilentUIFactory()
 
215
        stdout = StringIO()
 
216
        factory.stdin = StringIO("y\n")
 
217
        self.assertEqual(True,
 
218
                         self.apply_redirected(None, stdout, stdout,
 
219
                                               factory.get_boolean, "foo"))
 
220
        self.assertEqual("", stdout.getvalue())
 
221
        # stdin should be empty
 
222
        self.assertEqual('', factory.stdin.readline())
 
223
 
 
224
    def test_text_ui_getbool(self):
 
225
        factory = TextUIFactory(None, None, None)
 
226
        self.assert_get_bool_acceptance_of_user_input(factory)
143
227
 
144
228
    def test_text_factory_prompt(self):
145
229
        # 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')
 
230
        factory = TextUIFactory(None, StringIO(), StringIO(), StringIO())
 
231
        factory.prompt('foo %2e')
149
232
        self.assertEqual('', factory.stdout.getvalue())
150
233
        self.assertEqual('foo %2e', factory.stderr.getvalue())
151
234
 
152
235
    def test_text_factory_prompts_and_clears(self):
153
236
        # 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
 
237
        out = _TTYStringIO()
 
238
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
160
239
        pb = factory.nested_progress_bar()
161
240
        pb.show_bar = False
162
241
        pb.show_spinner = False
166
245
                         self.apply_redirected(None, factory.stdout,
167
246
                                               factory.stdout,
168
247
                                               factory.get_boolean,
169
 
                                               u"what do you want"))
 
248
                                               "what do you want"))
170
249
        output = out.getvalue()
171
 
        self.assertContainsRe(output,
172
 
            "| foo *\r\r  *\r*")
173
 
        self.assertContainsRe(output,
 
250
        self.assertContainsRe(factory.stdout.getvalue(),
 
251
            "foo *\r\r  *\r*")
 
252
        self.assertContainsRe(factory.stdout.getvalue(),
174
253
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
175
254
        # stdin should have been totally consumed
176
255
        self.assertEqual('', factory.stdin.readline())
177
256
 
178
257
    def test_text_tick_after_update(self):
179
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
180
 
                                                stderr=tests.StringIOWrapper())
 
258
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
181
259
        pb = ui_factory.nested_progress_bar()
182
260
        try:
183
261
            pb.update('task', 0, 3)
187
265
        finally:
188
266
            pb.finished()
189
267
 
 
268
    def test_silent_ui_getusername(self):
 
269
        factory = SilentUIFactory()
 
270
        factory.stdin = StringIO("someuser\n\n")
 
271
        factory.stdout = StringIO()
 
272
        factory.stderr = StringIO()
 
273
        self.assertEquals(None,
 
274
            factory.get_username(u'Hello\u1234 %(host)s', host=u'some\u1234'))
 
275
        self.assertEquals("", factory.stdout.getvalue())
 
276
        self.assertEquals("", factory.stderr.getvalue())
 
277
        self.assertEquals("someuser\n\n", factory.stdin.getvalue())
 
278
 
190
279
    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()
 
280
        factory = TextUIFactory(None, None, None)
 
281
        factory.stdin = StringIO("someuser\n\n")
 
282
        factory.stdout = StringIO()
 
283
        factory.stderr = StringIO()
195
284
        factory.stdout.encoding = "utf8"
196
285
        # there is no output from the base factory
197
286
        self.assertEqual("someuser",
198
 
                         factory.get_username(u'Hello %(host)s', host='some'))
 
287
                         factory.get_username('Hello %(host)s', host='some'))
199
288
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
200
289
        self.assertEquals('', factory.stdout.getvalue())
201
 
        self.assertEqual("", factory.get_username(u"Gebruiker"))
 
290
        self.assertEqual("", factory.get_username("Gebruiker"))
202
291
        # stdin should be empty
203
292
        self.assertEqual('', factory.stdin.readline())
204
293
 
205
294
    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())
 
295
        ui = TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
296
                           stdout=StringIOWrapper(), stderr=StringIOWrapper())
209
297
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
210
298
        pb = ui.nested_progress_bar()
211
299
        try:
219
307
        finally:
220
308
            pb.finished()
221
309
 
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)
 
310
 
 
311
class TestTextProgressView(TestCase):
 
312
    """Tests for text display of progress bars.
 
313
    """
 
314
    # XXX: These might be a bit easier to write if the rendering and
 
315
    # state-maintaining parts of TextProgressView were more separate, and if
 
316
    # the progress task called back directly to its own view not to the ui
 
317
    # factory. -- mbp 20090312
 
318
    
 
319
    def _make_factory(self):
 
320
        out = StringIO()
 
321
        uif = TextUIFactory(stderr=out)
 
322
        uif._progress_view._width = 80
 
323
        return out, uif
 
324
 
 
325
    def test_render_progress_easy(self):
 
326
        """Just one task and one quarter done"""
 
327
        out, uif = self._make_factory()
 
328
        task = uif.nested_progress_bar()
 
329
        task.update('reticulating splines', 5, 20)
 
330
        self.assertEqual(
 
331
'\r[####/               ] reticulating splines 5/20                               \r'
 
332
            , out.getvalue())
 
333
 
 
334
    def test_render_progress_nested(self):
 
335
        """Tasks proportionally contribute to overall progress"""
 
336
        out, uif = self._make_factory()
 
337
        task = uif.nested_progress_bar()
 
338
        task.update('reticulating splines', 0, 2)
 
339
        task2 = uif.nested_progress_bar()
 
340
        task2.update('stage2', 1, 2)
 
341
        # so we're in the first half of the main task, and half way through
 
342
        # that
 
343
        self.assertEqual(
 
344
r'[####\               ] reticulating splines:stage2 1/2'
 
345
            , uif._progress_view._render_line())
 
346
        # if the nested task is complete, then we're all the way through the
 
347
        # first half of the overall work
 
348
        task2.update('stage2', 2, 2)
 
349
        self.assertEqual(
 
350
r'[#########|          ] reticulating splines:stage2 2/2'
 
351
            , uif._progress_view._render_line())
 
352
 
 
353
    def test_render_progress_sub_nested(self):
 
354
        """Intermediate tasks don't mess up calculation."""
 
355
        out, uif = self._make_factory()
 
356
        task_a = uif.nested_progress_bar()
 
357
        task_a.update('a', 0, 2)
 
358
        task_b = uif.nested_progress_bar()
 
359
        task_b.update('b')
 
360
        task_c = uif.nested_progress_bar()
 
361
        task_c.update('c', 1, 2)
 
362
        # the top-level task is in its first half; the middle one has no
 
363
        # progress indication, just a label; and the bottom one is half done,
 
364
        # so the overall fraction is 1/4
 
365
        self.assertEqual(
 
366
            r'[####|               ] a:b:c 1/2'
 
367
            , uif._progress_view._render_line())
 
368