← 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: Vincent Ladeuil
  • Date: 2009-04-06 14:01:16 UTC
  • mto: (4241.10.1 bzr.1.14)
  • mto: This revision was merged to the branch mainline in revision 4267.
  • Revision ID: v.ladeuil+lp@free.fr-20090406140116-zkbvjtaxfhbql4l4
Fix unicode related OSX failures.

* bzrlib/tests/test_export.py: 
Fix imports.

* bzrlib/tests/blackbox/test_export.py:
(TestExport.test_tar_export_unicode,
TestExport.test_zip_export_unicode): Use a less problematic
unicode char for OSX.

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