/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: 2017-08-27 13:57:26 UTC
  • mto: This revision was merged to the branch mainline in revision 6773.
  • Revision ID: jelmer@jelmer.uk-20170827135726-o6k0a4j205zdh8k0
Fix some tests.

Show diffs side-by-side

added added

removed removed

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