← 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-27 08:33:37 UTC
  • mto: (4398.5.1 bencode_serializer)
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: jelmer@samba.org-20090527083337-fij2klthhtsdl2hy
Fix copyright headers, add _bencode_py.py to the list of files that do not have to have canonical copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
"""
19
19
 
20
20
import os
 
21
from StringIO import StringIO
21
22
import re
 
23
import sys
22
24
import time
23
25
 
24
 
from StringIO import StringIO
25
 
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    remote,
29
 
    repository,
30
 
    tests,
31
 
    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,
32
33
    )
33
34
from bzrlib.symbol_versioning import (
34
35
    deprecated_in,
35
36
    )
36
 
from bzrlib.tests import test_progress
37
 
from bzrlib.ui import text as _mod_ui_text
38
 
 
39
 
 
40
 
class TestTextUIFactory(tests.TestCase):
 
37
from bzrlib.tests import (
 
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())
41
68
 
42
69
    def test_text_factory_ascii_password(self):
43
 
        ui = tests.TestUIFactory(stdin='secret\n',
44
 
                                 stdout=tests.StringIOWrapper(),
45
 
                                 stderr=tests.StringIOWrapper())
 
70
        ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
46
71
        pb = ui.nested_progress_bar()
47
72
        try:
48
73
            self.assertEqual('secret',
49
74
                             self.apply_redirected(ui.stdin, ui.stdout,
50
 
                                                   ui.stderr,
 
75
                                                   ui.stdout,
51
76
                                                   ui.get_password))
52
77
            # ': ' is appended to prompt
53
 
            self.assertEqual(': ', ui.stderr.getvalue())
54
 
            self.assertEqual('', ui.stdout.readline())
 
78
            self.assertEqual(': ', ui.stdout.getvalue())
55
79
            # stdin should be empty
56
80
            self.assertEqual('', ui.stdin.readline())
57
81
        finally:
63
87
        We can't predict what encoding users will have for stdin, so we force
64
88
        it to utf8 to test that we transport the password correctly.
65
89
        """
66
 
        ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
67
 
                                 stdout=tests.StringIOWrapper(),
68
 
                                 stderr=tests.StringIOWrapper())
69
 
        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
70
94
        pb = ui.nested_progress_bar()
71
95
        try:
72
 
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
96
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
73
97
                                             ui.get_password,
74
98
                                             u'Hello \u1234 %(user)s',
75
99
                                             user=u'some\u1234')
76
100
            # We use StringIO objects, we need to decode them
77
101
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
78
102
            self.assertEqual(u'Hello \u1234 some\u1234: ',
79
 
                             ui.stderr.getvalue().decode('utf8'))
80
 
            # stdin and stdout should be empty
 
103
                             ui.stdout.getvalue().decode('utf8'))
 
104
            # stdin should be empty
81
105
            self.assertEqual('', ui.stdin.readline())
82
 
            self.assertEqual('', ui.stdout.readline())
83
106
        finally:
84
107
            pb.finished()
85
108
 
86
109
    def test_progress_note(self):
87
 
        stderr = tests.StringIOWrapper()
88
 
        stdout = tests.StringIOWrapper()
89
 
        ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
90
 
                                                stderr=stderr,
91
 
                                                stdout=stdout)
 
110
        stderr = StringIO()
 
111
        stdout = StringIO()
 
112
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
113
            stderr=stderr,
 
114
            stdout=stdout)
92
115
        pb = ui_factory.nested_progress_bar()
93
116
        try:
94
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
95
 
                pb.note,
96
 
                't')
 
117
            result = pb.note('t')
97
118
            self.assertEqual(None, result)
98
119
            self.assertEqual("t\n", stdout.getvalue())
99
120
            # Since there was no update() call, there should be no clear() call
104
125
            pb.finished()
105
126
 
106
127
    def test_progress_note_clears(self):
107
 
        stderr = test_progress._TTYStringIO()
108
 
        stdout = test_progress._TTYStringIO()
109
 
        # so that we get a TextProgressBar
110
 
        os.environ['TERM'] = 'xterm'
111
 
        ui_factory = _mod_ui_text.TextUIFactory(
112
 
            stdin=tests.StringIOWrapper(''),
 
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(''),
113
135
            stdout=stdout, stderr=stderr)
114
 
        self.assertIsInstance(ui_factory._progress_view,
115
 
                              _mod_ui_text.TextProgressView)
116
136
        pb = ui_factory.nested_progress_bar()
117
137
        try:
118
138
            # Create a progress update that isn't throttled
119
139
            pb.update('x', 1, 1)
120
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
121
 
                pb.note, 't')
 
140
            result = pb.note('t')
122
141
            self.assertEqual(None, result)
123
142
            self.assertEqual("t\n", stdout.getvalue())
124
143
            # the exact contents will depend on the terminal width and we don't
128
147
        finally:
129
148
            pb.finished()
130
149
 
131
 
    def test_text_ui_get_boolean(self):
132
 
        stdin = tests.StringIOWrapper("y\n" # True
133
 
                                      "n\n" # False
134
 
                                      "yes with garbage\nY\n" # True
135
 
                                      "not an answer\nno\n" # False
136
 
                                      "I'm sure!\nyes\n" # True
137
 
                                      "NO\n" # False
138
 
                                      "foo\n")
139
 
        stdout = tests.StringIOWrapper()
140
 
        stderr = tests.StringIOWrapper()
141
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
142
 
        self.assertEqual(True, factory.get_boolean(""))
143
 
        self.assertEqual(False, factory.get_boolean(""))
144
 
        self.assertEqual(True, factory.get_boolean(""))
145
 
        self.assertEqual(False, factory.get_boolean(""))
146
 
        self.assertEqual(True, factory.get_boolean(""))
 
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(""))
147
200
        self.assertEqual(False, factory.get_boolean(""))
148
201
        self.assertEqual("foo\n", factory.stdin.read())
149
202
        # stdin should be empty
150
203
        self.assertEqual('', factory.stdin.readline())
151
204
 
152
 
    def test_text_ui_get_integer(self):
153
 
        stdin = tests.StringIOWrapper(
154
 
            "1\n"
155
 
            "  -2  \n"
156
 
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
157
 
        stdout = tests.StringIOWrapper()
158
 
        stderr = tests.StringIOWrapper()
159
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
160
 
        self.assertEqual(1, factory.get_integer(""))
161
 
        self.assertEqual(-2, factory.get_integer(""))
162
 
        self.assertEqual(42, factory.get_integer(""))
 
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)
163
223
 
164
224
    def test_text_factory_prompt(self):
165
225
        # see <https://launchpad.net/bugs/365891>
166
 
        StringIO = tests.StringIOWrapper
167
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
 
226
        factory = TextUIFactory(None, StringIO(), StringIO())
168
227
        factory.prompt('foo %2e')
169
 
        self.assertEqual('', factory.stdout.getvalue())
170
 
        self.assertEqual('foo %2e', factory.stderr.getvalue())
171
228
 
172
229
    def test_text_factory_prompts_and_clears(self):
173
230
        # a get_boolean call should clear the pb before prompting
174
 
        out = test_progress._TTYStringIO()
175
 
        os.environ['TERM'] = 'xterm'
176
 
        factory = _mod_ui_text.TextUIFactory(
177
 
            stdin=tests.StringIOWrapper("yada\ny\n"),
178
 
            stdout=out, stderr=out)
 
231
        out = _TTYStringIO()
 
232
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
179
233
        pb = factory.nested_progress_bar()
180
234
        pb.show_bar = False
181
235
        pb.show_spinner = False
195
249
        self.assertEqual('', factory.stdin.readline())
196
250
 
197
251
    def test_text_tick_after_update(self):
198
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
199
 
                                                stderr=tests.StringIOWrapper())
 
252
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
200
253
        pb = ui_factory.nested_progress_bar()
201
254
        try:
202
255
            pb.update('task', 0, 3)
206
259
        finally:
207
260
            pb.finished()
208
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
 
209
271
    def test_text_ui_getusername(self):
210
 
        factory = _mod_ui_text.TextUIFactory(None, None, None)
211
 
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
212
 
        factory.stdout = tests.StringIOWrapper()
213
 
        factory.stderr = tests.StringIOWrapper()
 
272
        factory = TextUIFactory(None, None, None)
 
273
        factory.stdin = StringIO("someuser\n\n")
 
274
        factory.stdout = StringIO()
214
275
        factory.stdout.encoding = "utf8"
215
276
        # there is no output from the base factory
216
 
        self.assertEqual("someuser",
217
 
                         factory.get_username('Hello %(host)s', host='some'))
218
 
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
219
 
        self.assertEquals('', factory.stdout.getvalue())
 
277
        self.assertEqual("someuser", 
 
278
            factory.get_username('Hello %(host)s', host='some'))
 
279
        self.assertEquals("Hello some: ", factory.stdout.getvalue())
220
280
        self.assertEqual("", factory.get_username("Gebruiker"))
221
281
        # stdin should be empty
222
282
        self.assertEqual('', factory.stdin.readline())
223
283
 
224
284
    def test_text_ui_getusername_utf8(self):
225
 
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
226
 
                                 stdout=tests.StringIOWrapper(),
227
 
                                 stderr=tests.StringIOWrapper())
228
 
        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
229
289
        pb = ui.nested_progress_bar()
230
290
        try:
231
291
            # there is no output from the base factory
232
 
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
292
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
233
293
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
234
294
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
235
 
            self.assertEquals(u"Hello\u1234 some\u1234: ",
236
 
                              ui.stderr.getvalue().decode("utf8"))
237
 
            self.assertEquals('', ui.stdout.getvalue())
 
295
            self.assertEquals(u"Hello\u1234 some\u1234: ", 
 
296
                ui.stdout.getvalue().decode("utf8"))
238
297
        finally:
239
298
            pb.finished()
240
299
 
241
 
    def test_quietness(self):
242
 
        os.environ['BZR_PROGRESS_BAR'] = 'text'
243
 
        ui_factory = _mod_ui_text.TextUIFactory(None,
244
 
            test_progress._TTYStringIO(),
245
 
            test_progress._TTYStringIO())
246
 
        self.assertIsInstance(ui_factory._progress_view,
247
 
            _mod_ui_text.TextProgressView)
248
 
        ui_factory.be_quiet(True)
249
 
        self.assertIsInstance(ui_factory._progress_view,
250
 
            _mod_ui_text.NullProgressView)
251
 
 
252
 
    def test_text_ui_show_user_warning(self):
253
 
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
254
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
255
 
        err = StringIO()
256
 
        out = StringIO()
257
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
258
 
        remote_fmt = remote.RemoteRepositoryFormat()
259
 
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
260
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
261
 
            to_format=remote_fmt)
262
 
        self.assertEquals('', out.getvalue())
263
 
        self.assertEquals("Doing on-the-fly conversion from RepositoryFormat2a() to "
264
 
            "RemoteRepositoryFormat(_network_name='Bazaar RepositoryFormatKnitPack5 "
265
 
            "(bzr 1.6)\\n').\nThis may take some time. Upgrade the repositories to "
266
 
            "the same format for better performance.\n",
267
 
            err.getvalue())
268
 
        # and now with it suppressed please
269
 
        err = StringIO()
270
 
        out = StringIO()
271
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
272
 
        ui.suppressed_warnings.add('cross_format_fetch')
273
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
274
 
            to_format=remote_fmt)
275
 
        self.assertEquals('', out.getvalue())
276
 
        self.assertEquals('', err.getvalue())
277
 
 
278
 
 
279
 
class TestTextUIOutputStream(tests.TestCase):
280
 
    """Tests for output stream that synchronizes with progress bar."""
281
 
 
282
 
    def test_output_clears_terminal(self):
283
 
        stdout = tests.StringIOWrapper()
284
 
        stderr = tests.StringIOWrapper()
285
 
        clear_calls = []
286
 
 
287
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
288
 
        uif.clear_term = lambda: clear_calls.append('clear')
289
 
 
290
 
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
291
 
        stream.write("Hello world!\n")
292
 
        stream.write("there's more...\n")
293
 
        stream.writelines(["1\n", "2\n", "3\n"])
294
 
 
295
 
        self.assertEqual(stdout.getvalue(),
296
 
            "Hello world!\n"
297
 
            "there's more...\n"
298
 
            "1\n2\n3\n")
299
 
        self.assertEqual(['clear', 'clear', 'clear'],
300
 
            clear_calls)
301
 
 
302
 
        stream.flush()
303
 
 
304
 
 
305
 
class UITests(tests.TestCase):
306
 
 
307
 
    def test_progress_construction(self):
308
 
        """TextUIFactory constructs the right progress view.
309
 
        """
310
 
        TTYStringIO = test_progress._TTYStringIO
311
 
        FileStringIO = tests.StringIOWrapper
312
 
        for (file_class, term, pb, expected_pb_class) in (
313
 
            # on an xterm, either use them or not as the user requests,
314
 
            # otherwise default on
315
 
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
316
 
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
317
 
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
318
 
            # on a dumb terminal, again if there's explicit configuration do
319
 
            # it, otherwise default off
320
 
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
321
 
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
322
 
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
323
 
            # on a non-tty terminal, it's null regardless of $TERM
324
 
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
325
 
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
326
 
            # however, it can still be forced on
327
 
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
328
 
            ):
329
 
            os.environ['TERM'] = term
330
 
            if pb is None:
331
 
                if 'BZR_PROGRESS_BAR' in os.environ:
332
 
                    del os.environ['BZR_PROGRESS_BAR']
333
 
            else:
334
 
                os.environ['BZR_PROGRESS_BAR'] = pb
335
 
            stdin = file_class('')
336
 
            stderr = file_class()
337
 
            stdout = file_class()
338
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
339
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
340
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
341
 
            self.assertIsInstance(uif.make_progress_view(),
342
 
                expected_pb_class,
343
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
344
 
 
345
 
    def test_text_ui_non_terminal(self):
346
 
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
347
 
        stdin = test_progress._NonTTYStringIO('')
348
 
        stderr = test_progress._NonTTYStringIO()
349
 
        stdout = test_progress._NonTTYStringIO()
350
 
        for term_type in ['dumb', None, 'xterm']:
351
 
            if term_type is None:
352
 
                del os.environ['TERM']
353
 
            else:
354
 
                os.environ['TERM'] = term_type
355
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
356
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
357
 
                'TERM=%r' % (term_type,))
358
 
 
359
 
 
360
 
class SilentUITests(tests.TestCase):
361
 
 
362
 
    def test_silent_factory_get_password(self):
363
 
        # A silent factory that can't do user interaction can't get a
364
 
        # password.  Possibly it should raise a more specific error but it
365
 
        # can't succeed.
366
 
        ui = _mod_ui.SilentUIFactory()
367
 
        stdout = tests.StringIOWrapper()
368
 
        self.assertRaises(
369
 
            NotImplementedError,
370
 
            self.apply_redirected,
371
 
            None, stdout, stdout, ui.get_password)
372
 
        # and it didn't write anything out either
373
 
        self.assertEqual('', stdout.getvalue())
374
 
 
375
 
    def test_silent_ui_getbool(self):
376
 
        factory = _mod_ui.SilentUIFactory()
377
 
        stdout = tests.StringIOWrapper()
378
 
        self.assertRaises(
379
 
            NotImplementedError,
380
 
            self.apply_redirected,
381
 
            None, stdout, stdout, factory.get_boolean, "foo")
382
 
 
383
 
 
384
 
class TestUIFactoryTests(tests.TestCase):
385
 
 
386
 
    def test_test_ui_factory_progress(self):
387
 
        # there's no output; we just want to make sure this doesn't crash -
388
 
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
389
 
        ui = tests.TestUIFactory()
390
 
        pb = ui.nested_progress_bar()
391
 
        pb.update('hello')
392
 
        pb.tick()
393
 
        pb.finished()
394
 
 
395
 
 
396
 
class CannedInputUIFactoryTests(tests.TestCase):
397
 
 
398
 
    def test_canned_input_get_input(self):
399
 
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
400
 
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
401
 
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
402
 
        self.assertEqual('password',
403
 
                         uif.get_password('Password for %(host)s',
404
 
                                          host='example.com'))
405
 
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
406
 
 
407
 
 
408
 
class TestBoolFromString(tests.TestCase):
409
 
 
410
 
    def assertIsTrue(self, s, accepted_values=None):
411
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
412
 
        self.assertEquals(True, res)
413
 
 
414
 
    def assertIsFalse(self, s, accepted_values=None):
415
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
416
 
        self.assertEquals(False, res)
417
 
 
418
 
    def assertIsNone(self, s, accepted_values=None):
419
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
420
 
        self.assertIs(None, res)
421
 
 
422
 
    def test_know_valid_values(self):
423
 
        self.assertIsTrue('true')
424
 
        self.assertIsFalse('false')
425
 
        self.assertIsTrue('1')
426
 
        self.assertIsFalse('0')
427
 
        self.assertIsTrue('on')
428
 
        self.assertIsFalse('off')
429
 
        self.assertIsTrue('yes')
430
 
        self.assertIsFalse('no')
431
 
        self.assertIsTrue('y')
432
 
        self.assertIsFalse('n')
433
 
        # Also try some case variations
434
 
        self.assertIsTrue('True')
435
 
        self.assertIsFalse('False')
436
 
        self.assertIsTrue('On')
437
 
        self.assertIsFalse('Off')
438
 
        self.assertIsTrue('ON')
439
 
        self.assertIsFalse('OFF')
440
 
        self.assertIsTrue('oN')
441
 
        self.assertIsFalse('oFf')
442
 
 
443
 
    def test_invalid_values(self):
444
 
        self.assertIsNone(None)
445
 
        self.assertIsNone('doubt')
446
 
        self.assertIsNone('frue')
447
 
        self.assertIsNone('talse')
448
 
        self.assertIsNone('42')
449
 
 
450
 
    def test_provided_values(self):
451
 
        av = dict(y=True, n=False, yes=True, no=False)
452
 
        self.assertIsTrue('y', av)
453
 
        self.assertIsTrue('Y', av)
454
 
        self.assertIsTrue('Yes', av)
455
 
        self.assertIsFalse('n', av)
456
 
        self.assertIsFalse('N', av)
457
 
        self.assertIsFalse('No', av)
458
 
        self.assertIsNone('1', av)
459
 
        self.assertIsNone('0', av)
460
 
        self.assertIsNone('on', av)
461
 
        self.assertIsNone('off', av)
 
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