/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: 2020-03-22 20:02:36 UTC
  • mto: (7490.7.7 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200322200236-fsbl91ktcn6fcbdd
Fix 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():
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(
 
81
            u'Hello \u1234 %(user)s', user=u'some\u1234')
 
82
        self.assertEqual(u'baz\u1234', password)
 
83
        self.assertEqual(u'Hello \u1234 some\u1234: ', ui.stderr.getvalue())
 
84
        # stdin and stdout should be empty
 
85
        self.assertEqual('', ui.stdin.readline())
 
86
        self.assertEqual('', ui.stdout.getvalue())
130
87
 
131
88
    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())
 
89
        stdin_text = (
 
90
            "y\n"  # True
 
91
            "n\n"  # False
 
92
            " \n y \n"  # True
 
93
            " no \n"  # False
 
94
            "yes with garbage\nY\n"  # True
 
95
            "not an answer\nno\n"  # False
 
96
            "I'm sure!\nyes\n"  # True
 
97
            "NO\n"  # False
 
98
            "foo\n")
 
99
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
100
            self.assertEqual(True, factory.get_boolean(u""))
 
101
            self.assertEqual(False, factory.get_boolean(u""))
 
102
            self.assertEqual(True, factory.get_boolean(u""))
 
103
            self.assertEqual(False, factory.get_boolean(u""))
 
104
            self.assertEqual(True, factory.get_boolean(u""))
 
105
            self.assertEqual(False, factory.get_boolean(u""))
 
106
            self.assertEqual(True, factory.get_boolean(u""))
 
107
            self.assertEqual(False, factory.get_boolean(u""))
 
108
            self.assertEqual("foo\n", factory.stdin.read())
 
109
            # stdin should be empty
 
110
            self.assertEqual('', factory.stdin.readline())
 
111
            # return false on EOF
 
112
            self.assertEqual(False, factory.get_boolean(u""))
 
113
 
 
114
    def test_text_ui_choose_bad_parameters(self):
 
115
        with ui_testing.TextUIFactory(u"") as factory:
 
116
            # invalid default index
 
117
            self.assertRaises(ValueError, factory.choose, u"", u"&Yes\n&No", 3)
 
118
            # duplicated choice
 
119
            self.assertRaises(
 
120
                ValueError, factory.choose, u"", u"&choice\n&ChOiCe")
 
121
            # duplicated shortcut
 
122
            self.assertRaises(
 
123
                ValueError, factory.choose, u"", u"&choice1\nchoi&ce2")
 
124
 
 
125
    def test_text_ui_choose_prompt_explicit(self):
 
126
        # choices with explicit shortcuts
 
127
        with ui_testing.TextUIFactory(u"") as factory:
 
128
            factory.choose(u"prompt", u"&yes\n&No\nmore &info")
 
129
            self.assertEqual(
 
130
                "prompt ([y]es, [N]o, more [i]nfo): \n",
 
131
                factory.stderr.getvalue())
 
132
 
 
133
    def test_text_ui_choose_prompt_automatic(self):
 
134
        # automatic shortcuts
 
135
        with ui_testing.TextUIFactory(u"") as factory:
 
136
            factory.choose(u"prompt", u"yes\nNo\nmore info")
 
137
            self.assertEqual(
 
138
                "prompt ([y]es, [N]o, [m]ore info): \n",
 
139
                factory.stderr.getvalue())
 
140
 
 
141
    def test_text_ui_choose_return_values(self):
 
142
        def choose():
 
143
            return factory.choose(u"", u"&Yes\n&No\nMaybe\nmore &info", 3)
 
144
        stdin_text = (
 
145
            "y\n"  # 0
 
146
            "n\n"  # 1
 
147
            " \n"  # default: 3
 
148
            " no \n"  # 1
 
149
            "b\na\nd \n"  # bad shortcuts, all ignored
 
150
            "yes with garbage\nY\n"  # 0
 
151
            "not an answer\nno\n"  # 1
 
152
            "info\nmore info\n"  # 3
 
153
            "Maybe\n"  # 2
 
154
            "foo\n")
 
155
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
156
            self.assertEqual(0, choose())
 
157
            self.assertEqual(1, choose())
 
158
            self.assertEqual(3, choose())
 
159
            self.assertEqual(1, choose())
 
160
            self.assertEqual(0, choose())
 
161
            self.assertEqual(1, choose())
 
162
            self.assertEqual(3, choose())
 
163
            self.assertEqual(2, choose())
 
164
            self.assertEqual("foo\n", factory.stdin.read())
 
165
            # stdin should be empty
 
166
            self.assertEqual('', factory.stdin.readline())
 
167
            # return None on EOF
 
168
            self.assertEqual(None, choose())
 
169
 
 
170
    def test_text_ui_choose_no_default(self):
 
171
        stdin_text = (
 
172
            " \n"  # no default, invalid!
 
173
            " yes \n"  # 0
 
174
            "foo\n")
 
175
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
176
            self.assertEqual(0, factory.choose(u"", u"&Yes\n&No"))
 
177
            self.assertEqual("foo\n", factory.stdin.read())
151
178
 
152
179
    def test_text_ui_get_integer(self):
153
 
        stdin = tests.StringIOWrapper(
 
180
        stdin_text = (
154
181
            "1\n"
155
182
            "  -2  \n"
156
183
            "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(""))
 
184
        with ui_testing.TextUIFactory(stdin_text) as factory:
 
185
            self.assertEqual(1, factory.get_integer(u""))
 
186
            self.assertEqual(-2, factory.get_integer(u""))
 
187
            self.assertEqual(42, factory.get_integer(u""))
163
188
 
164
189
    def test_text_factory_prompt(self):
165
190
        # 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())
 
191
        with ui_testing.TextUIFactory() as factory:
 
192
            factory.prompt(u'foo %2e')
 
193
            self.assertEqual('', factory.stdout.getvalue())
 
194
            self.assertEqual('foo %2e', factory.stderr.getvalue())
171
195
 
172
196
    def test_text_factory_prompts_and_clears(self):
173
197
        # 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())
 
198
        out = ui_testing.StringIOAsTTY()
 
199
        self.overrideEnv('TERM', 'xterm')
 
200
        factory = ui_testing.TextUIFactory("yada\ny\n", stdout=out, stderr=out)
 
201
        with factory:
 
202
            pb = factory.nested_progress_bar()
 
203
            pb._avail_width = lambda: 79
 
204
            pb.show_bar = False
 
205
            pb.show_spinner = False
 
206
            pb.show_count = False
 
207
            pb.update("foo", 0, 1)
 
208
            self.assertEqual(
 
209
                True,
 
210
                self.apply_redirected(
 
211
                    None, factory.stdout, factory.stdout, factory.get_boolean,
 
212
                    u"what do you want"))
 
213
            output = out.getvalue()
 
214
            self.assertContainsRe(output,
 
215
                                  "| foo *\r\r  *\r*")
 
216
            self.assertContainsString(
 
217
                output,
 
218
                r"what do you want? ([y]es, [n]o): what do you want? "
 
219
                r"([y]es, [n]o): ")
 
220
            # stdin should have been totally consumed
 
221
            self.assertEqual('', factory.stdin.readline())
196
222
 
197
223
    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:
 
224
        ui_factory = ui_testing.TextUIFactory()
 
225
        with ui_factory.nested_progress_bar() as pb:
202
226
            pb.update('task', 0, 3)
203
227
            # Reset the clock, so that it actually tries to repaint itself
204
228
            ui_factory._progress_view._last_repaint = time.time() - 1.0
205
229
            pb.tick()
206
 
        finally:
207
 
            pb.finished()
208
230
 
209
231
    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"))
 
232
        ui = ui_testing.TextUIFactory('someuser\n\n')
 
233
        self.assertEqual('someuser',
 
234
                         ui.get_username(u'Hello %(host)s', host='some'))
 
235
        self.assertEqual('Hello some: ', ui.stderr.getvalue())
 
236
        self.assertEqual('', ui.stdout.getvalue())
 
237
        self.assertEqual('', ui.get_username(u"Gebruiker"))
221
238
        # stdin should be empty
222
 
        self.assertEqual('', factory.stdin.readline())
 
239
        self.assertEqual('', ui.stdin.readline())
223
240
 
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()
 
241
    def test_text_ui_getusername_unicode(self):
 
242
        ui = ui_testing.TextUIFactory(u'someuser\u1234')
 
243
        username = ui.get_username(u'Hello %(host)s', host=u'some\u1234')
 
244
        self.assertEqual(u"someuser\u1234", username)
 
245
        self.assertEqual(u"Hello some\u1234: ", ui.stderr.getvalue())
 
246
        self.assertEqual('', ui.stdout.getvalue())
240
247
 
241
248
    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)
 
249
        self.overrideEnv('BRZ_PROGRESS_BAR', 'text')
 
250
        ui_factory = ui_testing.TextUIFactory(
 
251
            stderr=ui_testing.StringIOAsTTY())
 
252
        with ui_factory:
 
253
            self.assertIsInstance(ui_factory._progress_view,
 
254
                                  _mod_ui_text.TextProgressView)
 
255
            ui_factory.be_quiet(True)
 
256
            self.assertIsInstance(ui_factory._progress_view,
 
257
                                  _mod_ui_text.NullProgressView)
251
258
 
252
259
    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)
 
260
        from ..bzr.groupcompress_repo import RepositoryFormat2a
 
261
        from ..bzr.knitpack_repo import RepositoryFormatKnitPack5
 
262
        ui = ui_testing.TextUIFactory()
258
263
        remote_fmt = remote.RemoteRepositoryFormat()
259
264
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
260
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
 
265
        ui.show_user_warning(
 
266
            'cross_format_fetch', from_format=RepositoryFormat2a(),
261
267
            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
        self.assertEqual('', ui.stdout.getvalue())
 
269
        self.assertContainsRe(
 
270
            ui.stderr.getvalue(),
 
271
            "^Doing on-the-fly conversion from RepositoryFormat2a\\(\\) to "
 
272
            "RemoteRepositoryFormat\\(_network_name="
 
273
            "b?'Bazaar RepositoryFormatKnitPack5 \\(bzr 1.6\\)\\\\n'\\)\\.\n"
 
274
            "This may take some time. Upgrade the repositories to "
 
275
            "the same format for better performance\\.\n$")
268
276
        # and now with it suppressed please
269
 
        err = StringIO()
270
 
        out = StringIO()
271
 
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
 
277
        ui = ui_testing.TextUIFactory()
272
278
        ui.suppressed_warnings.add('cross_format_fetch')
273
 
        ui.show_user_warning('cross_format_fetch', from_format=RepositoryFormat2a(),
 
279
        ui.show_user_warning(
 
280
            'cross_format_fetch', from_format=RepositoryFormat2a(),
274
281
            to_format=remote_fmt)
275
 
        self.assertEquals('', out.getvalue())
276
 
        self.assertEquals('', err.getvalue())
 
282
        self.assertEqual('', ui.stdout.getvalue())
 
283
        self.assertEqual('', ui.stderr.getvalue())
277
284
 
278
285
 
279
286
class TestTextUIOutputStream(tests.TestCase):
280
287
    """Tests for output stream that synchronizes with progress bar."""
281
288
 
282
289
    def test_output_clears_terminal(self):
283
 
        stdout = tests.StringIOWrapper()
284
 
        stderr = tests.StringIOWrapper()
285
290
        clear_calls = []
286
291
 
287
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
 
292
        uif = ui_testing.TextUIFactory()
288
293
        uif.clear_term = lambda: clear_calls.append('clear')
289
294
 
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"])
 
295
        stream = _mod_ui_text.TextUIOutputStream(
 
296
            uif, uif.stdout, 'utf-8', 'strict')
 
297
        stream.write(u"Hello world!\n")
 
298
        stream.write(u"there's more...\n")
 
299
        stream.writelines([u"1\n", u"2\n", u"3\n"])
294
300
 
295
 
        self.assertEqual(stdout.getvalue(),
296
 
            "Hello world!\n"
297
 
            "there's more...\n"
298
 
            "1\n2\n3\n")
 
301
        self.assertEqual(uif.stdout.getvalue(),
 
302
                         u"Hello world!\n"
 
303
                         u"there's more...\n"
 
304
                         u"1\n2\n3\n")
299
305
        self.assertEqual(['clear', 'clear', 'clear'],
300
 
            clear_calls)
 
306
                         clear_calls)
301
307
 
302
308
        stream.flush()
303
309
 
307
313
    def test_progress_construction(self):
308
314
        """TextUIFactory constructs the right progress view.
309
315
        """
310
 
        TTYStringIO = test_progress._TTYStringIO
311
 
        FileStringIO = tests.StringIOWrapper
 
316
        FileStringIO = ui_testing.StringIOWithEncoding
 
317
        TTYStringIO = ui_testing.StringIOAsTTY
312
318
        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('')
 
319
                # on an xterm, either use them or not as the user requests,
 
320
                # otherwise default on
 
321
                (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
 
322
                (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
 
323
                (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
 
324
                # on a dumb terminal, again if there's explicit configuration
 
325
                # do it, otherwise default off
 
326
                (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
 
327
                (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
328
                (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
329
                # on a non-tty terminal, it's null regardless of $TERM
 
330
                (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
 
331
                (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
 
332
                # however, it can still be forced on
 
333
                (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
 
334
                ):
 
335
            self.overrideEnv('TERM', term)
 
336
            self.overrideEnv('BRZ_PROGRESS_BAR', pb)
 
337
            stdin = file_class(u'')
336
338
            stderr = file_class()
337
339
            stdout = file_class()
338
340
            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(),
 
341
            self.assertIsInstance(
 
342
                uif, _mod_ui_text.TextUIFactory,
 
343
                "TERM=%s BRZ_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
344
            self.assertIsInstance(
 
345
                uif.make_progress_view(),
342
346
                expected_pb_class,
343
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
347
                "TERM=%s BRZ_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
344
348
 
345
349
    def test_text_ui_non_terminal(self):
346
350
        """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()
 
351
        stdin = stderr = stdout = ui_testing.StringIOWithEncoding()
350
352
        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
 
353
            self.overrideEnv('TERM', term_type)
355
354
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
356
355
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
357
 
                'TERM=%r' % (term_type,))
 
356
                                  'TERM=%r' % (term_type,))
358
357
 
359
358
 
360
359
class SilentUITests(tests.TestCase):
364
363
        # password.  Possibly it should raise a more specific error but it
365
364
        # can't succeed.
366
365
        ui = _mod_ui.SilentUIFactory()
367
 
        stdout = tests.StringIOWrapper()
 
366
        stdout = ui_testing.StringIOWithEncoding()
368
367
        self.assertRaises(
369
368
            NotImplementedError,
370
369
            self.apply_redirected,
374
373
 
375
374
    def test_silent_ui_getbool(self):
376
375
        factory = _mod_ui.SilentUIFactory()
377
 
        stdout = tests.StringIOWrapper()
 
376
        stdout = ui_testing.StringIOWithEncoding()
378
377
        self.assertRaises(
379
378
            NotImplementedError,
380
379
            self.apply_redirected,
381
 
            None, stdout, stdout, factory.get_boolean, "foo")
 
380
            None, stdout, stdout, factory.get_boolean, u"foo")
382
381
 
383
382
 
384
383
class TestUIFactoryTests(tests.TestCase):
385
384
 
386
385
    def test_test_ui_factory_progress(self):
387
386
        # 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()
 
387
        # see https://bugs.launchpad.net/bzr/+bug/408201
 
388
        ui = ui_testing.TestUIFactory()
 
389
        with ui.nested_progress_bar() as pb:
 
390
            pb.update('hello')
 
391
            pb.tick()
394
392
 
395
393
 
396
394
class CannedInputUIFactoryTests(tests.TestCase):
397
395
 
398
396
    def test_canned_input_get_input(self):
399
397
        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'))
 
398
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
 
399
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
402
400
        self.assertEqual('password',
403
 
                         uif.get_password('Password for %(host)s',
 
401
                         uif.get_password(u'Password for %(host)s',
404
402
                                          host='example.com'))
405
 
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
 
403
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
406
404
 
407
405
 
408
406
class TestBoolFromString(tests.TestCase):
409
407
 
410
408
    def assertIsTrue(self, s, accepted_values=None):
411
409
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
412
 
        self.assertEquals(True, res)
 
410
        self.assertEqual(True, res)
413
411
 
414
412
    def assertIsFalse(self, s, accepted_values=None):
415
413
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
416
 
        self.assertEquals(False, res)
 
414
        self.assertEqual(False, res)
417
415
 
418
416
    def assertIsNone(self, s, accepted_values=None):
419
417
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
459
457
        self.assertIsNone('0', av)
460
458
        self.assertIsNone('on', av)
461
459
        self.assertIsNone('off', av)
 
460
 
 
461
 
 
462
class TestConfirmationUserInterfacePolicy(tests.TestCase):
 
463
 
 
464
    def test_confirm_action_default(self):
 
465
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
466
        for answer in [True, False]:
 
467
            self.assertEqual(
 
468
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
 
469
                .confirm_action("Do something?",
 
470
                                "breezy.tests.do_something", {}),
 
471
                answer)
 
472
 
 
473
    def test_confirm_action_specific(self):
 
474
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
475
        for default_answer in [True, False]:
 
476
            for specific_answer in [True, False]:
 
477
                for conf_id in ['given_id', 'other_id']:
 
478
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
 
479
                        base_ui, default_answer,
 
480
                        dict(given_id=specific_answer))
 
481
                    result = wrapper.confirm_action(
 
482
                        "Do something?", conf_id, {})
 
483
                    if conf_id == 'given_id':
 
484
                        self.assertEqual(result, specific_answer)
 
485
                    else:
 
486
                        self.assertEqual(result, default_answer)
 
487
 
 
488
    def test_repr(self):
 
489
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
490
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
 
491
            base_ui, True, dict(a=2))
 
492
        self.assertThat(repr(wrapper),
 
493
                        Equals("ConfirmationUserInterfacePolicy("
 
494
                               "NoninteractiveUIFactory(), True, {'a': 2})"))
 
495
 
 
496
 
 
497
class TestProgressRecordingUI(tests.TestCase):
 
498
    """Test test-oriented UIFactory that records progress updates"""
 
499
 
 
500
    def test_nested_ignore_depth_beyond_one(self):
 
501
        # we only want to capture the first level out progress, not
 
502
        # want sub-components might do. So we have nested bars ignored.
 
503
        factory = ProgressRecordingUIFactory()
 
504
        pb1 = factory.nested_progress_bar()
 
505
        pb1.update('foo', 0, 1)
 
506
        pb2 = factory.nested_progress_bar()
 
507
        pb2.update('foo', 0, 1)
 
508
        pb2.finished()
 
509
        pb1.finished()
 
510
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)