/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 bzrlib/tests/test_ui.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

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