/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: Martin Pool
  • Date: 2009-07-27 06:28:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4587.
  • Revision ID: mbp@sourcefrog.net-20090727062835-o66p8it658tq1sma
Add CountedLock.get_physical_lock_status

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, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
from StringIO import StringIO
 
22
import re
 
23
import sys
19
24
import time
20
25
 
21
 
from testtools.matchers import *
22
 
 
23
 
from .. import (
24
 
    config,
 
26
from bzrlib import (
 
27
    errors,
25
28
    tests,
26
29
    ui as _mod_ui,
27
30
    )
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)
50
 
 
51
 
 
52
 
class TestTextUIFactory(tests.TestCase):
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'}))
 
31
from bzrlib.symbol_versioning import (
 
32
    deprecated_in,
 
33
    )
 
34
from bzrlib.tests import (
 
35
    TestCase,
 
36
    TestUIFactory,
 
37
    StringIOWrapper,
 
38
    )
 
39
from bzrlib.tests.test_progress import (
 
40
    _NonTTYStringIO,
 
41
    _TTYStringIO,
 
42
    )
 
43
from bzrlib.ui import (
 
44
    CannedInputUIFactory,
 
45
    CLIUIFactory,
 
46
    SilentUIFactory,
 
47
    UIFactory,
 
48
    make_ui_for_terminal,
 
49
    )
 
50
from bzrlib.ui.text import (
 
51
    NullProgressView,
 
52
    TextProgressView,
 
53
    TextUIFactory,
 
54
    )
 
55
 
 
56
 
 
57
class UITests(tests.TestCase):
63
58
 
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_construction(self):
 
104
        """TextUIFactory constructs the right progress view.
 
105
        """
 
106
        for (file_class, term, pb, expected_pb_class) in (
 
107
            # on an xterm, either use them or not as the user requests,
 
108
            # otherwise default on
 
109
            (_TTYStringIO, 'xterm', 'none', NullProgressView),
 
110
            (_TTYStringIO, 'xterm', 'text', TextProgressView),
 
111
            (_TTYStringIO, 'xterm', None, TextProgressView),
 
112
            # on a dumb terminal, again if there's explicit configuration do
 
113
            # it, otherwise default off
 
114
            (_TTYStringIO, 'dumb', 'none', NullProgressView),
 
115
            (_TTYStringIO, 'dumb', 'text', TextProgressView),
 
116
            (_TTYStringIO, 'dumb', None, NullProgressView),
 
117
            # on a non-tty terminal, it's null regardless of $TERM
 
118
            (StringIO, 'xterm', None, NullProgressView),
 
119
            (StringIO, 'dumb', None, NullProgressView),
 
120
            # however, it can still be forced on
 
121
            (StringIO, 'dumb', 'text', TextProgressView),
 
122
            ):
 
123
            os.environ['TERM'] = term
 
124
            if pb is None:
 
125
                if 'BZR_PROGRESS_BAR' in os.environ:
 
126
                    del os.environ['BZR_PROGRESS_BAR']
 
127
            else:
 
128
                os.environ['BZR_PROGRESS_BAR'] = pb
 
129
            stdin = file_class('')
 
130
            stderr = file_class()
 
131
            stdout = file_class()
 
132
            uif = make_ui_for_terminal(stdin, stdout, stderr)
 
133
            self.assertIsInstance(uif, TextUIFactory,
 
134
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
135
            self.assertIsInstance(uif.make_progress_view(),
 
136
                expected_pb_class,
 
137
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
 
138
 
 
139
    def test_text_ui_non_terminal(self):
 
140
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
 
141
        stdin = _NonTTYStringIO('')
 
142
        stderr = _NonTTYStringIO()
 
143
        stdout = _NonTTYStringIO()
 
144
        for term_type in ['dumb', None, 'xterm']:
 
145
            if term_type is None:
 
146
                del os.environ['TERM']
 
147
            else:
 
148
                os.environ['TERM'] = term_type
 
149
            uif = make_ui_for_terminal(stdin, stdout, stderr)
 
150
            self.assertIsInstance(uif, TextUIFactory,
 
151
                'TERM=%r' % (term_type,))
 
152
 
 
153
    def test_progress_note(self):
 
154
        stderr = StringIO()
 
155
        stdout = StringIO()
 
156
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
157
            stderr=stderr,
 
158
            stdout=stdout)
 
159
        pb = ui_factory.nested_progress_bar()
 
160
        try:
 
161
            result = pb.note('t')
 
162
            self.assertEqual(None, result)
 
163
            self.assertEqual("t\n", stdout.getvalue())
 
164
            # Since there was no update() call, there should be no clear() call
 
165
            self.failIf(re.search(r'^\r {10,}\r$',
 
166
                                  stderr.getvalue()) is not None,
 
167
                        'We cleared the stderr without anything to put there')
 
168
        finally:
 
169
            pb.finished()
 
170
 
 
171
    def test_progress_note_clears(self):
 
172
        stderr = _TTYStringIO()
 
173
        stdout = _TTYStringIO()
 
174
        # so that we get a TextProgressBar
 
175
        os.environ['TERM'] = 'xterm'
 
176
        ui_factory = TextUIFactory(
 
177
            stdin=StringIO(''),
 
178
            stdout=stdout, stderr=stderr)
 
179
        self.assertIsInstance(ui_factory._progress_view,
 
180
            TextProgressView)
 
181
        pb = ui_factory.nested_progress_bar()
 
182
        try:
 
183
            # Create a progress update that isn't throttled
 
184
            pb.update('x', 1, 1)
 
185
            result = pb.note('t')
 
186
            self.assertEqual(None, result)
 
187
            self.assertEqual("t\n", stdout.getvalue())
 
188
            # the exact contents will depend on the terminal width and we don't
 
189
            # care about that right now - but you're probably running it on at
 
190
            # least a 10-character wide terminal :)
 
191
            self.assertContainsRe(stderr.getvalue(), r'\r {10,}\r$')
 
192
        finally:
 
193
            pb.finished()
 
194
 
 
195
    def test_progress_nested(self):
 
196
        # test factory based nested and popping.
 
197
        ui = TextUIFactory(None, None, None)
 
198
        pb1 = ui.nested_progress_bar()
 
199
        pb2 = ui.nested_progress_bar()
 
200
        # You do get a warning if the outermost progress bar wasn't finished
 
201
        # first - it's not clear if this is really useful or if it should just
 
202
        # become orphaned -- mbp 20090120
 
203
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
204
        if len(warnings) != 1:
 
205
            self.fail("unexpected warnings: %r" % (warnings,))
 
206
        pb2.finished()
 
207
        pb1.finished()
87
208
 
88
209
    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())
178
 
 
179
 
    def test_text_ui_get_integer(self):
180
 
        stdin_text = (
181
 
            "1\n"
182
 
            "  -2  \n"
183
 
            "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""))
 
210
        stdin = StringIO("y\n" # True
 
211
                         "n\n" # False
 
212
                         "yes with garbage\nY\n" # True
 
213
                         "not an answer\nno\n" # False
 
214
                         "I'm sure!\nyes\n" # True
 
215
                         "NO\n" # False
 
216
                         "foo\n")
 
217
        stdout = StringIO()
 
218
        stderr = StringIO()
 
219
        factory = TextUIFactory(stdin, stdout, stderr)
 
220
        self.assertEqual(True, factory.get_boolean(""))
 
221
        self.assertEqual(False, factory.get_boolean(""))
 
222
        self.assertEqual(True, factory.get_boolean(""))
 
223
        self.assertEqual(False, factory.get_boolean(""))
 
224
        self.assertEqual(True, factory.get_boolean(""))
 
225
        self.assertEqual(False, factory.get_boolean(""))
 
226
        self.assertEqual("foo\n", factory.stdin.read())
 
227
        # stdin should be empty
 
228
        self.assertEqual('', factory.stdin.readline())
188
229
 
189
230
    def test_text_factory_prompt(self):
190
231
        # 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())
 
232
        factory = TextUIFactory(StringIO(), StringIO(), StringIO())
 
233
        factory.prompt('foo %2e')
 
234
        self.assertEqual('', factory.stdout.getvalue())
 
235
        self.assertEqual('foo %2e', factory.stderr.getvalue())
195
236
 
196
237
    def test_text_factory_prompts_and_clears(self):
197
238
        # 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())
 
239
        out = _TTYStringIO()
 
240
        os.environ['TERM'] = 'xterm'
 
241
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
 
242
        pb = factory.nested_progress_bar()
 
243
        pb.show_bar = False
 
244
        pb.show_spinner = False
 
245
        pb.show_count = False
 
246
        pb.update("foo", 0, 1)
 
247
        self.assertEqual(True,
 
248
                         self.apply_redirected(None, factory.stdout,
 
249
                                               factory.stdout,
 
250
                                               factory.get_boolean,
 
251
                                               "what do you want"))
 
252
        output = out.getvalue()
 
253
        self.assertContainsRe(factory.stdout.getvalue(),
 
254
            "foo *\r\r  *\r*")
 
255
        self.assertContainsRe(factory.stdout.getvalue(),
 
256
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
 
257
        # stdin should have been totally consumed
 
258
        self.assertEqual('', factory.stdin.readline())
222
259
 
223
260
    def test_text_tick_after_update(self):
224
 
        ui_factory = ui_testing.TextUIFactory()
225
 
        with ui_factory.nested_progress_bar() as pb:
 
261
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
 
262
        pb = ui_factory.nested_progress_bar()
 
263
        try:
226
264
            pb.update('task', 0, 3)
227
265
            # Reset the clock, so that it actually tries to repaint itself
228
266
            ui_factory._progress_view._last_repaint = time.time() - 1.0
229
267
            pb.tick()
 
268
        finally:
 
269
            pb.finished()
230
270
 
231
271
    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"))
 
272
        factory = TextUIFactory(None, None, None)
 
273
        factory.stdin = StringIO("someuser\n\n")
 
274
        factory.stdout = StringIO()
 
275
        factory.stderr = StringIO()
 
276
        factory.stdout.encoding = "utf8"
 
277
        # there is no output from the base factory
 
278
        self.assertEqual("someuser",
 
279
                         factory.get_username('Hello %(host)s', host='some'))
 
280
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
 
281
        self.assertEquals('', factory.stdout.getvalue())
 
282
        self.assertEqual("", factory.get_username("Gebruiker"))
238
283
        # stdin should be empty
239
 
        self.assertEqual('', ui.stdin.readline())
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())
247
 
 
248
 
    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)
258
 
 
259
 
    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()
263
 
        remote_fmt = remote.RemoteRepositoryFormat()
264
 
        remote_fmt._network_name = RepositoryFormatKnitPack5().network_name()
265
 
        ui.show_user_warning(
266
 
            'cross_format_fetch', from_format=RepositoryFormat2a(),
267
 
            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$")
276
 
        # and now with it suppressed please
277
 
        ui = ui_testing.TextUIFactory()
278
 
        ui.suppressed_warnings.add('cross_format_fetch')
279
 
        ui.show_user_warning(
280
 
            'cross_format_fetch', from_format=RepositoryFormat2a(),
281
 
            to_format=remote_fmt)
282
 
        self.assertEqual('', ui.stdout.getvalue())
283
 
        self.assertEqual('', ui.stderr.getvalue())
284
 
 
285
 
 
286
 
class TestTextUIOutputStream(tests.TestCase):
287
 
    """Tests for output stream that synchronizes with progress bar."""
288
 
 
289
 
    def test_output_clears_terminal(self):
290
 
        clear_calls = []
291
 
 
292
 
        uif = ui_testing.TextUIFactory()
293
 
        uif.clear_term = lambda: clear_calls.append('clear')
294
 
 
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"])
300
 
 
301
 
        self.assertEqual(uif.stdout.getvalue(),
302
 
                         u"Hello world!\n"
303
 
                         u"there's more...\n"
304
 
                         u"1\n2\n3\n")
305
 
        self.assertEqual(['clear', 'clear', 'clear'],
306
 
                         clear_calls)
307
 
 
308
 
        stream.flush()
309
 
 
310
 
 
311
 
class UITests(tests.TestCase):
312
 
 
313
 
    def test_progress_construction(self):
314
 
        """TextUIFactory constructs the right progress view.
315
 
        """
316
 
        FileStringIO = ui_testing.StringIOWithEncoding
317
 
        TTYStringIO = ui_testing.StringIOAsTTY
318
 
        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'')
338
 
            stderr = file_class()
339
 
            stdout = file_class()
340
 
            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(),
346
 
                expected_pb_class,
347
 
                "TERM=%s BRZ_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
348
 
 
349
 
    def test_text_ui_non_terminal(self):
350
 
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
351
 
        stdin = stderr = stdout = ui_testing.StringIOWithEncoding()
352
 
        for term_type in ['dumb', None, 'xterm']:
353
 
            self.overrideEnv('TERM', term_type)
354
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
355
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
356
 
                                  'TERM=%r' % (term_type,))
357
 
 
358
 
 
359
 
class SilentUITests(tests.TestCase):
 
284
        self.assertEqual('', factory.stdin.readline())
 
285
 
 
286
    def test_text_ui_getusername_utf8(self):
 
287
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
288
                                 stdout=tests.StringIOWrapper(),
 
289
                                 stderr=tests.StringIOWrapper())
 
290
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
291
        pb = ui.nested_progress_bar()
 
292
        try:
 
293
            # there is no output from the base factory
 
294
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
295
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
 
296
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
 
297
            self.assertEquals(u"Hello\u1234 some\u1234: ",
 
298
                              ui.stderr.getvalue().decode("utf8"))
 
299
            self.assertEquals('', ui.stdout.getvalue())
 
300
        finally:
 
301
            pb.finished()
 
302
 
 
303
 
 
304
class CLIUITests(TestCase):
 
305
 
 
306
    def test_cli_factory_deprecated(self):
 
307
        uif = self.applyDeprecated(deprecated_in((1, 18, 0)),
 
308
            CLIUIFactory,
 
309
            StringIO(), StringIO(), StringIO())
 
310
        self.assertIsInstance(uif, UIFactory)
 
311
 
 
312
 
 
313
class SilentUITests(TestCase):
360
314
 
361
315
    def test_silent_factory_get_password(self):
362
316
        # A silent factory that can't do user interaction can't get a
363
317
        # password.  Possibly it should raise a more specific error but it
364
318
        # can't succeed.
365
 
        ui = _mod_ui.SilentUIFactory()
366
 
        stdout = ui_testing.StringIOWithEncoding()
 
319
        ui = SilentUIFactory()
 
320
        stdout = StringIO()
367
321
        self.assertRaises(
368
322
            NotImplementedError,
369
323
            self.apply_redirected,
372
326
        self.assertEqual('', stdout.getvalue())
373
327
 
374
328
    def test_silent_ui_getbool(self):
375
 
        factory = _mod_ui.SilentUIFactory()
376
 
        stdout = ui_testing.StringIOWithEncoding()
 
329
        factory = SilentUIFactory()
 
330
        stdout = StringIO()
377
331
        self.assertRaises(
378
332
            NotImplementedError,
379
333
            self.apply_redirected,
380
 
            None, stdout, stdout, factory.get_boolean, u"foo")
381
 
 
382
 
 
383
 
class TestUIFactoryTests(tests.TestCase):
384
 
 
385
 
    def test_test_ui_factory_progress(self):
386
 
        # there's no output; we just want to make sure this doesn't crash -
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()
392
 
 
393
 
 
394
 
class CannedInputUIFactoryTests(tests.TestCase):
395
 
 
 
334
            None, stdout, stdout, factory.get_boolean, "foo")
 
335
 
 
336
 
 
337
class CannedInputUIFactoryTests(TestCase):
 
338
    
396
339
    def test_canned_input_get_input(self):
397
 
        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'))
400
 
        self.assertEqual('password',
401
 
                         uif.get_password(u'Password for %(host)s',
402
 
                                          host='example.com'))
403
 
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
 
340
        uif = CannedInputUIFactory([True, 'mbp', 'password'])
 
341
        self.assertEqual(uif.get_boolean('Extra cheese?'), True)
 
342
        self.assertEqual(uif.get_username('Enter your user name'), 'mbp')
 
343
        self.assertEqual(uif.get_password('Password for %(host)s', host='example.com'),
 
344
            'password')
404
345
 
405
346
 
406
347
class TestBoolFromString(tests.TestCase):
407
348
 
408
349
    def assertIsTrue(self, s, accepted_values=None):
409
350
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
410
 
        self.assertEqual(True, res)
 
351
        self.assertEquals(True, res)
411
352
 
412
353
    def assertIsFalse(self, s, accepted_values=None):
413
354
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
414
 
        self.assertEqual(False, res)
 
355
        self.assertEquals(False, res)
415
356
 
416
357
    def assertIsNone(self, s, accepted_values=None):
417
358
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
457
398
        self.assertIsNone('0', av)
458
399
        self.assertIsNone('on', av)
459
400
        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)