/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_ui.py

  • Committer: Jelmer Vernooij
  • Date: 2018-07-08 14:45:27 UTC
  • mto: This revision was merged to the branch mainline in revision 7036.
  • Revision ID: jelmer@jelmer.uk-20180708144527-codhlvdcdg9y0nji
Fix a bunch of merge tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_ui.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2012, 2016 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Tests for the bzrlib ui
18
 
"""
 
17
"""Tests for the breezy ui."""
19
18
 
20
 
import os
21
 
import re
22
19
import time
23
20
 
24
 
from StringIO import StringIO
 
21
from testtools.matchers import *
25
22
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    remote,
29
 
    repository,
 
23
from .. import (
 
24
    config,
30
25
    tests,
31
26
    ui as _mod_ui,
32
27
    )
33
 
from bzrlib.symbol_versioning import (
34
 
    deprecated_in,
35
 
    )
36
 
from bzrlib.tests import test_progress
37
 
from bzrlib.ui import text as _mod_ui_text
 
28
from ..bzr import (
 
29
    remote,
 
30
    )
 
31
from . import (
 
32
    fixtures,
 
33
    ui_testing,
 
34
    )
 
35
from ..ui import text as _mod_ui_text
 
36
from .testui import (
 
37
    ProgressRecordingUIFactory,
 
38
    )
 
39
 
 
40
 
 
41
class TestUIConfiguration(tests.TestCaseInTempDir):
 
42
 
 
43
    def test_output_encoding_configuration(self):
 
44
        enc = next(fixtures.generate_unicode_encodings())
 
45
        config.GlobalStack().set('output_encoding', enc)
 
46
        IO = ui_testing.BytesIOWithEncoding
 
47
        ui = _mod_ui.make_ui_for_terminal(IO(), IO(), IO())
 
48
        output = ui.make_output_stream()
 
49
        self.assertEqual(output.encoding, enc)
38
50
 
39
51
 
40
52
class TestTextUIFactory(tests.TestCase):
41
53
 
 
54
    def test_text_factory_confirm(self):
 
55
        # turns into reading a regular boolean
 
56
        with ui_testing.TestUIFactory('n\n') as ui:
 
57
            self.assertEqual(
 
58
                False,
 
59
                ui.confirm_action(
 
60
                    u'Should %(thing)s pass?',
 
61
                    'breezy.tests.test_ui.confirmation',
 
62
                    {'thing': 'this'}))
 
63
 
42
64
    def test_text_factory_ascii_password(self):
43
 
        ui = tests.TestUIFactory(stdin='secret\n',
44
 
                                 stdout=tests.StringIOWrapper(),
45
 
                                 stderr=tests.StringIOWrapper())
46
 
        pb = ui.nested_progress_bar()
47
 
        try:
 
65
        ui = ui_testing.TestUIFactory('secret\n')
 
66
        with ui.nested_progress_bar() as pb:
48
67
            self.assertEqual('secret',
49
68
                             self.apply_redirected(ui.stdin, ui.stdout,
50
69
                                                   ui.stderr,
54
73
            self.assertEqual('', ui.stdout.readline())
55
74
            # stdin should be empty
56
75
            self.assertEqual('', ui.stdin.readline())
57
 
        finally:
58
 
            pb.finished()
59
 
 
60
 
    def test_text_factory_utf8_password(self):
61
 
        """Test an utf8 password.
62
 
 
63
 
        We can't predict what encoding users will have for stdin, so we force
64
 
        it to utf8 to test that we transport the password correctly.
65
 
        """
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'
70
 
        pb = ui.nested_progress_bar()
71
 
        try:
72
 
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
73
 
                                             ui.get_password,
74
 
                                             u'Hello \u1234 %(user)s',
75
 
                                             user=u'some\u1234')
76
 
            # We use StringIO objects, we need to decode them
77
 
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
78
 
            self.assertEqual(u'Hello \u1234 some\u1234: ',
79
 
                             ui.stderr.getvalue().decode('utf8'))
80
 
            # stdin and stdout should be empty
81
 
            self.assertEqual('', ui.stdin.readline())
82
 
            self.assertEqual('', ui.stdout.readline())
83
 
        finally:
84
 
            pb.finished()
85
 
 
86
 
    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)
92
 
        pb = ui_factory.nested_progress_bar()
93
 
        try:
94
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
95
 
                pb.note,
96
 
                't')
97
 
            self.assertEqual(None, result)
98
 
            self.assertEqual("t\n", stdout.getvalue())
99
 
            # Since there was no update() call, there should be no clear() call
100
 
            self.failIf(re.search(r'^\r {10,}\r$',
101
 
                                  stderr.getvalue()) is not None,
102
 
                        'We cleared the stderr without anything to put there')
103
 
        finally:
104
 
            pb.finished()
105
 
 
106
 
    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(''),
113
 
            stdout=stdout, stderr=stderr)
114
 
        self.assertIsInstance(ui_factory._progress_view,
115
 
                              _mod_ui_text.TextProgressView)
116
 
        pb = ui_factory.nested_progress_bar()
117
 
        try:
118
 
            # Create a progress update that isn't throttled
119
 
            pb.update('x', 1, 1)
120
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
121
 
                pb.note, 't')
122
 
            self.assertEqual(None, result)
123
 
            self.assertEqual("t\n", stdout.getvalue())
124
 
            # the exact contents will depend on the terminal width and we don't
125
 
            # care about that right now - but you're probably running it on at
126
 
            # least a 10-character wide terminal :)
127
 
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
128
 
        finally:
129
 
            pb.finished()
 
76
 
 
77
    def test_text_factory_unicode_password(self):
 
78
        """Test a unicode password."""
 
79
        ui = ui_testing.TextUIFactory(u'baz\u1234')
 
80
        password = ui.get_password(u'Hello \u1234 %(user)s', user=u'some\u1234')
 
81
        self.assertEqual(u'baz\u1234', password)
 
82
        self.assertEqual(u'Hello \u1234 some\u1234: ', ui.stderr.getvalue())
 
83
        # stdin and stdout should be empty
 
84
        self.assertEqual('', ui.stdin.readline())
 
85
        self.assertEqual('', ui.stdout.getvalue())
130
86
 
131
87
    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(""))
147
 
        self.assertEqual(False, factory.get_boolean(""))
148
 
        self.assertEqual("foo\n", factory.stdin.read())
149
 
        # stdin should be empty
150
 
        self.assertEqual('', factory.stdin.readline())
 
88
        stdin_text = (
 
89
            "y\n" # True
 
90
            "n\n" # False
 
91
            " \n y \n" # True
 
92
            " no \n" # False
 
93
            "yes with garbage\nY\n" # True
 
94
            "not an answer\nno\n" # False
 
95
            "I'm sure!\nyes\n" # True
 
96
            "NO\n" # False
 
97
            "foo\n")
 
98
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
99
            self.assertEqual(True, factory.get_boolean(u""))
 
100
            self.assertEqual(False, factory.get_boolean(u""))
 
101
            self.assertEqual(True, factory.get_boolean(u""))
 
102
            self.assertEqual(False, factory.get_boolean(u""))
 
103
            self.assertEqual(True, factory.get_boolean(u""))
 
104
            self.assertEqual(False, factory.get_boolean(u""))
 
105
            self.assertEqual(True, factory.get_boolean(u""))
 
106
            self.assertEqual(False, factory.get_boolean(u""))
 
107
            self.assertEqual("foo\n", factory.stdin.read())
 
108
            # stdin should be empty
 
109
            self.assertEqual('', factory.stdin.readline())
 
110
            # return false on EOF
 
111
            self.assertEqual(False, factory.get_boolean(u""))
 
112
 
 
113
    def test_text_ui_choose_bad_parameters(self):
 
114
        with ui_testing.TextUIFactory(u"") as factory:
 
115
            # invalid default index
 
116
            self.assertRaises(ValueError, factory.choose, u"", u"&Yes\n&No", 3)
 
117
            # duplicated choice
 
118
            self.assertRaises(
 
119
                ValueError, factory.choose, u"", u"&choice\n&ChOiCe")
 
120
            # duplicated shortcut
 
121
            self.assertRaises(
 
122
                ValueError, factory.choose, u"", u"&choice1\nchoi&ce2")
 
123
 
 
124
    def test_text_ui_choose_prompt_explicit(self):
 
125
        # choices with explicit shortcuts
 
126
        with ui_testing.TextUIFactory(u"") as factory:
 
127
            factory.choose(u"prompt", u"&yes\n&No\nmore &info")
 
128
            self.assertEqual(
 
129
                "prompt ([y]es, [N]o, more [i]nfo): \n",
 
130
                factory.stderr.getvalue())
 
131
 
 
132
    def test_text_ui_choose_prompt_automatic(self):
 
133
        # automatic shortcuts
 
134
        with ui_testing.TextUIFactory(u"") as factory:
 
135
            factory.choose(u"prompt", u"yes\nNo\nmore info")
 
136
            self.assertEqual(
 
137
                "prompt ([y]es, [N]o, [m]ore info): \n",
 
138
                factory.stderr.getvalue())
 
139
 
 
140
    def test_text_ui_choose_return_values(self):
 
141
        def choose():
 
142
            return factory.choose(u"", u"&Yes\n&No\nMaybe\nmore &info", 3)
 
143
        stdin_text = (
 
144
            "y\n" # 0
 
145
            "n\n" # 1
 
146
            " \n" # default: 3
 
147
            " no \n" # 1
 
148
            "b\na\nd \n" # bad shortcuts, all ignored
 
149
            "yes with garbage\nY\n" # 0
 
150
            "not an answer\nno\n" # 1
 
151
            "info\nmore info\n" # 3
 
152
            "Maybe\n" # 2
 
153
            "foo\n")
 
154
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
155
            self.assertEqual(0, choose())
 
156
            self.assertEqual(1, choose())
 
157
            self.assertEqual(3, choose())
 
158
            self.assertEqual(1, choose())
 
159
            self.assertEqual(0, choose())
 
160
            self.assertEqual(1, choose())
 
161
            self.assertEqual(3, choose())
 
162
            self.assertEqual(2, choose())
 
163
            self.assertEqual("foo\n", factory.stdin.read())
 
164
            # stdin should be empty
 
165
            self.assertEqual('', factory.stdin.readline())
 
166
            # return None on EOF
 
167
            self.assertEqual(None, choose())
 
168
 
 
169
    def test_text_ui_choose_no_default(self):
 
170
        stdin_text = (
 
171
            " \n" # no default, invalid!
 
172
            " yes \n" # 0
 
173
            "foo\n")
 
174
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
175
            self.assertEqual(0, factory.choose(u"", u"&Yes\n&No"))
 
176
            self.assertEqual("foo\n", factory.stdin.read())
151
177
 
152
178
    def test_text_ui_get_integer(self):
153
 
        stdin = tests.StringIOWrapper(
 
179
        stdin_text = (
154
180
            "1\n"
155
181
            "  -2  \n"
156
182
            "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(""))
 
183
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
184
            self.assertEqual(1, factory.get_integer(u""))
 
185
            self.assertEqual(-2, factory.get_integer(u""))
 
186
            self.assertEqual(42, factory.get_integer(u""))
163
187
 
164
188
    def test_text_factory_prompt(self):
165
189
        # see <https://launchpad.net/bugs/365891>
166
 
        StringIO = tests.StringIOWrapper
167
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
168
 
        factory.prompt('foo %2e')
169
 
        self.assertEqual('', factory.stdout.getvalue())
170
 
        self.assertEqual('foo %2e', factory.stderr.getvalue())
 
190
        with ui_testing.TextUIFactory() as factory:
 
191
            factory.prompt(u'foo %2e')
 
192
            self.assertEqual('', factory.stdout.getvalue())
 
193
            self.assertEqual('foo %2e', factory.stderr.getvalue())
171
194
 
172
195
    def test_text_factory_prompts_and_clears(self):
173
196
        # 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)
179
 
        pb = factory.nested_progress_bar()
180
 
        pb.show_bar = False
181
 
        pb.show_spinner = False
182
 
        pb.show_count = False
183
 
        pb.update("foo", 0, 1)
184
 
        self.assertEqual(True,
185
 
                         self.apply_redirected(None, factory.stdout,
186
 
                                               factory.stdout,
187
 
                                               factory.get_boolean,
188
 
                                               "what do you want"))
189
 
        output = out.getvalue()
190
 
        self.assertContainsRe(factory.stdout.getvalue(),
191
 
            "foo *\r\r  *\r*")
192
 
        self.assertContainsRe(factory.stdout.getvalue(),
193
 
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
194
 
        # stdin should have been totally consumed
195
 
        self.assertEqual('', factory.stdin.readline())
 
197
        out = ui_testing.StringIOAsTTY()
 
198
        self.overrideEnv('TERM', 'xterm')
 
199
        factory = ui_testing.TextUIFactory("yada\ny\n", stdout=out, stderr=out)
 
200
        with factory:
 
201
            pb = factory.nested_progress_bar()
 
202
            pb._avail_width = lambda: 79
 
203
            pb.show_bar = False
 
204
            pb.show_spinner = False
 
205
            pb.show_count = False
 
206
            pb.update("foo", 0, 1)
 
207
            self.assertEqual(
 
208
                True,
 
209
                self.apply_redirected(
 
210
                    None, factory.stdout, factory.stdout, factory.get_boolean,
 
211
                    u"what do you want"))
 
212
            output = out.getvalue()
 
213
            self.assertContainsRe(output,
 
214
                "| foo *\r\r  *\r*")
 
215
            self.assertContainsString(output,
 
216
                r"what do you want? ([y]es, [n]o): what do you want? ([y]es, [n]o): ")
 
217
            # stdin should have been totally consumed
 
218
            self.assertEqual('', factory.stdin.readline())
196
219
 
197
220
    def test_text_tick_after_update(self):
198
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
199
 
                                                stderr=tests.StringIOWrapper())
200
 
        pb = ui_factory.nested_progress_bar()
201
 
        try:
 
221
        ui_factory = ui_testing.TextUIFactory()
 
222
        with ui_factory.nested_progress_bar() as pb:
202
223
            pb.update('task', 0, 3)
203
224
            # Reset the clock, so that it actually tries to repaint itself
204
225
            ui_factory._progress_view._last_repaint = time.time() - 1.0
205
226
            pb.tick()
206
 
        finally:
207
 
            pb.finished()
208
227
 
209
228
    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()
214
 
        factory.stdout.encoding = "utf8"
215
 
        # 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())
220
 
        self.assertEqual("", factory.get_username("Gebruiker"))
 
229
        ui = ui_testing.TextUIFactory('someuser\n\n')
 
230
        self.assertEqual('someuser',
 
231
                         ui.get_username(u'Hello %(host)s', host='some'))
 
232
        self.assertEqual('Hello some: ', ui.stderr.getvalue())
 
233
        self.assertEqual('', ui.stdout.getvalue())
 
234
        self.assertEqual('', ui.get_username(u"Gebruiker"))
221
235
        # stdin should be empty
222
 
        self.assertEqual('', factory.stdin.readline())
 
236
        self.assertEqual('', ui.stdin.readline())
223
237
 
224
 
    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"
229
 
        pb = ui.nested_progress_bar()
230
 
        try:
231
 
            # there is no output from the base factory
232
 
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
233
 
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
234
 
            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())
238
 
        finally:
239
 
            pb.finished()
 
238
    def test_text_ui_getusername_unicode(self):
 
239
        ui = ui_testing.TextUIFactory(u'someuser\u1234')
 
240
        username = ui.get_username(u'Hello %(host)s', host=u'some\u1234')
 
241
        self.assertEqual(u"someuser\u1234", username)
 
242
        self.assertEqual(u"Hello some\u1234: ", ui.stderr.getvalue())
 
243
        self.assertEqual('', ui.stdout.getvalue())
240
244
 
241
245
    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)
 
246
        self.overrideEnv('BRZ_PROGRESS_BAR', 'text')
 
247
        ui_factory = ui_testing.TextUIFactory(
 
248
            stderr=ui_testing.StringIOAsTTY())
 
249
        with ui_factory:
 
250
            self.assertIsInstance(ui_factory._progress_view,
 
251
                _mod_ui_text.TextProgressView)
 
252
            ui_factory.be_quiet(True)
 
253
            self.assertIsInstance(ui_factory._progress_view,
 
254
                _mod_ui_text.NullProgressView)
251
255
 
252
256
    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)
 
257
        from ..bzr.groupcompress_repo import RepositoryFormat2a
 
258
        from ..bzr.knitpack_repo import RepositoryFormatKnitPack5
 
259
        ui = ui_testing.TextUIFactory()
258
260
        remote_fmt = remote.RemoteRepositoryFormat()
259
261
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
260
262
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
261
263
            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())
 
264
        self.assertEqual('', ui.stdout.getvalue())
 
265
        self.assertContainsRe(
 
266
            ui.stderr.getvalue(),
 
267
            "^Doing on-the-fly conversion from RepositoryFormat2a\\(\\) to "
 
268
                "RemoteRepositoryFormat\\(_network_name="
 
269
                "b?'Bazaar RepositoryFormatKnitPack5 \\(bzr 1.6\\)\\\\n'\\)\\.\n"
 
270
            "This may take some time. Upgrade the repositories to "
 
271
                "the same format for better performance\\.\n$")
268
272
        # and now with it suppressed please
269
 
        err = StringIO()
270
 
        out = StringIO()
271
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
 
273
        ui = ui_testing.TextUIFactory()
272
274
        ui.suppressed_warnings.add('cross_format_fetch')
273
275
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
274
276
            to_format=remote_fmt)
275
 
        self.assertEquals('', out.getvalue())
276
 
        self.assertEquals('', err.getvalue())
 
277
        self.assertEqual('', ui.stdout.getvalue())
 
278
        self.assertEqual('', ui.stderr.getvalue())
277
279
 
278
280
 
279
281
class TestTextUIOutputStream(tests.TestCase):
280
282
    """Tests for output stream that synchronizes with progress bar."""
281
283
 
282
284
    def test_output_clears_terminal(self):
283
 
        stdout = tests.StringIOWrapper()
284
 
        stderr = tests.StringIOWrapper()
285
285
        clear_calls = []
286
286
 
287
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
 
287
        uif =  ui_testing.TextUIFactory()
288
288
        uif.clear_term = lambda: clear_calls.append('clear')
289
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"])
 
290
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout, 'utf-8', 'strict')
 
291
        stream.write(u"Hello world!\n")
 
292
        stream.write(u"there's more...\n")
 
293
        stream.writelines([u"1\n", u"2\n", u"3\n"])
294
294
 
295
 
        self.assertEqual(stdout.getvalue(),
296
 
            "Hello world!\n"
297
 
            "there's more...\n"
298
 
            "1\n2\n3\n")
 
295
        self.assertEqual(uif.stdout.getvalue(),
 
296
            u"Hello world!\n"
 
297
            u"there's more...\n"
 
298
            u"1\n2\n3\n")
299
299
        self.assertEqual(['clear', 'clear', 'clear'],
300
300
            clear_calls)
301
301
 
307
307
    def test_progress_construction(self):
308
308
        """TextUIFactory constructs the right progress view.
309
309
        """
310
 
        TTYStringIO = test_progress._TTYStringIO
311
 
        FileStringIO = tests.StringIOWrapper
 
310
        FileStringIO = ui_testing.StringIOWithEncoding
 
311
        TTYStringIO = ui_testing.StringIOAsTTY
312
312
        for (file_class, term, pb, expected_pb_class) in (
313
313
            # on an xterm, either use them or not as the user requests,
314
314
            # otherwise default on
326
326
            # however, it can still be forced on
327
327
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
328
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('')
 
329
            self.overrideEnv('TERM', term)
 
330
            self.overrideEnv('BRZ_PROGRESS_BAR', pb)
 
331
            stdin = file_class(u'')
336
332
            stderr = file_class()
337
333
            stdout = file_class()
338
334
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
339
335
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
340
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
336
                "TERM=%s BRZ_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
341
337
            self.assertIsInstance(uif.make_progress_view(),
342
338
                expected_pb_class,
343
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
339
                "TERM=%s BRZ_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
344
340
 
345
341
    def test_text_ui_non_terminal(self):
346
342
        """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()
 
343
        stdin = stderr = stdout = ui_testing.StringIOWithEncoding()
350
344
        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
 
345
            self.overrideEnv('TERM', term_type)
355
346
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
356
347
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
357
348
                'TERM=%r' % (term_type,))
364
355
        # password.  Possibly it should raise a more specific error but it
365
356
        # can't succeed.
366
357
        ui = _mod_ui.SilentUIFactory()
367
 
        stdout = tests.StringIOWrapper()
 
358
        stdout = ui_testing.StringIOWithEncoding()
368
359
        self.assertRaises(
369
360
            NotImplementedError,
370
361
            self.apply_redirected,
374
365
 
375
366
    def test_silent_ui_getbool(self):
376
367
        factory = _mod_ui.SilentUIFactory()
377
 
        stdout = tests.StringIOWrapper()
 
368
        stdout = ui_testing.StringIOWithEncoding()
378
369
        self.assertRaises(
379
370
            NotImplementedError,
380
371
            self.apply_redirected,
381
 
            None, stdout, stdout, factory.get_boolean, "foo")
 
372
            None, stdout, stdout, factory.get_boolean, u"foo")
382
373
 
383
374
 
384
375
class TestUIFactoryTests(tests.TestCase):
385
376
 
386
377
    def test_test_ui_factory_progress(self):
387
378
        # 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()
 
379
        # see https://bugs.launchpad.net/bzr/+bug/408201
 
380
        ui = ui_testing.TestUIFactory()
 
381
        with ui.nested_progress_bar() as pb:
 
382
            pb.update('hello')
 
383
            pb.tick()
394
384
 
395
385
 
396
386
class CannedInputUIFactoryTests(tests.TestCase):
397
387
 
398
388
    def test_canned_input_get_input(self):
399
389
        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'))
 
390
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
 
391
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
402
392
        self.assertEqual('password',
403
 
                         uif.get_password('Password for %(host)s',
 
393
                         uif.get_password(u'Password for %(host)s',
404
394
                                          host='example.com'))
405
 
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
 
395
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
406
396
 
407
397
 
408
398
class TestBoolFromString(tests.TestCase):
409
399
 
410
400
    def assertIsTrue(self, s, accepted_values=None):
411
401
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
412
 
        self.assertEquals(True, res)
 
402
        self.assertEqual(True, res)
413
403
 
414
404
    def assertIsFalse(self, s, accepted_values=None):
415
405
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
416
 
        self.assertEquals(False, res)
 
406
        self.assertEqual(False, res)
417
407
 
418
408
    def assertIsNone(self, s, accepted_values=None):
419
409
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
459
449
        self.assertIsNone('0', av)
460
450
        self.assertIsNone('on', av)
461
451
        self.assertIsNone('off', av)
 
452
 
 
453
 
 
454
class TestConfirmationUserInterfacePolicy(tests.TestCase):
 
455
 
 
456
    def test_confirm_action_default(self):
 
457
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
458
        for answer in [True, False]:
 
459
            self.assertEqual(
 
460
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
 
461
                .confirm_action("Do something?",
 
462
                    "breezy.tests.do_something", {}),
 
463
                answer)
 
464
 
 
465
    def test_confirm_action_specific(self):
 
466
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
467
        for default_answer in [True, False]:
 
468
            for specific_answer in [True, False]:
 
469
                for conf_id in ['given_id', 'other_id']:
 
470
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
 
471
                        base_ui, default_answer, dict(given_id=specific_answer))
 
472
                    result = wrapper.confirm_action("Do something?", conf_id, {})
 
473
                    if conf_id == 'given_id':
 
474
                        self.assertEqual(result, specific_answer)
 
475
                    else:
 
476
                        self.assertEqual(result, default_answer)
 
477
 
 
478
    def test_repr(self):
 
479
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
480
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
 
481
            base_ui, True, dict(a=2))
 
482
        self.assertThat(repr(wrapper),
 
483
            Equals("ConfirmationUserInterfacePolicy("
 
484
                "NoninteractiveUIFactory(), True, {'a': 2})"))
 
485
 
 
486
 
 
487
class TestProgressRecordingUI(tests.TestCase):
 
488
    """Test test-oriented UIFactory that records progress updates"""
 
489
 
 
490
    def test_nested_ignore_depth_beyond_one(self):
 
491
        # we only want to capture the first level out progress, not
 
492
        # want sub-components might do. So we have nested bars ignored.
 
493
        factory = ProgressRecordingUIFactory()
 
494
        pb1 = factory.nested_progress_bar()
 
495
        pb1.update('foo', 0, 1)
 
496
        pb2 = factory.nested_progress_bar()
 
497
        pb2.update('foo', 0, 1)
 
498
        pb2.finished()
 
499
        pb1.finished()
 
500
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)