← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ui.py

  • Committer: Andrew Starr-Bochicchio
  • Date: 2015-07-31 01:04:41 UTC
  • mto: This revision was merged to the branch mainline in revision 6606.
  • Revision ID: a.starr.b@gmail.com-20150731010441-3domwjjtnjijxlr2
https://launchpad.net/bugs/1480015
Use hexlify() from binascii directly as paramiko removed hexify().

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
17
17
"""Tests for the bzrlib ui
18
18
"""
19
19
 
20
 
import os
21
 
import re
22
20
import time
23
21
 
24
22
from StringIO import StringIO
25
23
 
 
24
from testtools.matchers import *
 
25
 
26
26
from bzrlib import (
27
27
    config,
28
 
    errors,
29
28
    remote,
30
 
    repository,
31
29
    tests,
32
30
    ui as _mod_ui,
33
31
    )
34
 
from bzrlib.symbol_versioning import (
35
 
    deprecated_in,
36
 
    )
37
32
from bzrlib.tests import (
38
33
    fixtures,
39
 
    test_progress,
40
34
    )
41
35
from bzrlib.ui import text as _mod_ui_text
 
36
from bzrlib.tests.testui import (
 
37
    ProgressRecordingUIFactory,
 
38
    )
 
39
 
 
40
 
 
41
class TTYStringIO(StringIO):
 
42
    """A helper class which makes a StringIO look like a terminal"""
 
43
 
 
44
    def isatty(self):
 
45
        return True
 
46
 
 
47
 
 
48
class NonTTYStringIO(StringIO):
 
49
    """Helper that implements isatty() but returns False"""
 
50
 
 
51
    def isatty(self):
 
52
        return False
42
53
 
43
54
 
44
55
class TestUIConfiguration(tests.TestCaseWithTransport):
45
56
 
46
57
    def test_output_encoding_configuration(self):
47
58
        enc = fixtures.generate_unicode_encodings().next()
48
 
        config.GlobalConfig().set_user_option('output_encoding',
49
 
            enc)
 
59
        config.GlobalStack().set('output_encoding', enc)
50
60
        ui = tests.TestUIFactory(stdin=None,
51
61
            stdout=tests.StringIOWrapper(),
52
62
            stderr=tests.StringIOWrapper())
53
 
        os = ui.make_output_stream()
54
 
        self.assertEquals(os.encoding, enc)
 
63
        output = ui.make_output_stream()
 
64
        self.assertEquals(output.encoding, enc)
55
65
 
56
66
 
57
67
class TestTextUIFactory(tests.TestCase):
58
68
 
 
69
    def make_test_ui_factory(self, stdin_contents):
 
70
        ui = tests.TestUIFactory(stdin=stdin_contents,
 
71
                                 stdout=tests.StringIOWrapper(),
 
72
                                 stderr=tests.StringIOWrapper())
 
73
        return ui
 
74
 
 
75
    def test_text_factory_confirm(self):
 
76
        # turns into reading a regular boolean
 
77
        ui = self.make_test_ui_factory('n\n')
 
78
        self.assertEquals(ui.confirm_action(u'Should %(thing)s pass?',
 
79
            'bzrlib.tests.test_ui.confirmation',
 
80
            {'thing': 'this'},),
 
81
            False)
 
82
 
59
83
    def test_text_factory_ascii_password(self):
60
 
        ui = tests.TestUIFactory(stdin='secret\n',
61
 
                                 stdout=tests.StringIOWrapper(),
62
 
                                 stderr=tests.StringIOWrapper())
 
84
        ui = self.make_test_ui_factory('secret\n')
63
85
        pb = ui.nested_progress_bar()
64
86
        try:
65
87
            self.assertEqual('secret',
75
97
            pb.finished()
76
98
 
77
99
    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())
 
100
        """Test an utf8 password."""
 
101
        ui = _mod_ui_text.TextUIFactory(None, None, None)
 
102
        ui.stdin = tests.StringIOWrapper(u'baz\u1234'.encode('utf8'))
 
103
        ui.stdout = tests.StringIOWrapper()
 
104
        ui.stderr = tests.StringIOWrapper()
86
105
        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()
 
106
        password = ui.get_password(u'Hello \u1234 %(user)s', user=u'some\u1234')
 
107
        self.assertEqual(u'baz\u1234', password)
 
108
        self.assertEqual(u'Hello \u1234 some\u1234: ',
 
109
                         ui.stderr.getvalue().decode('utf8'))
 
110
        # stdin and stdout should be empty
 
111
        self.assertEqual('', ui.stdin.readline())
 
112
        self.assertEqual('', ui.stdout.getvalue())
102
113
 
103
114
    def test_text_ui_get_boolean(self):
104
115
        stdin = tests.StringIOWrapper("y\n" # True
105
116
                                      "n\n" # False
 
117
                                      " \n y \n" # True
 
118
                                      " no \n" # False
106
119
                                      "yes with garbage\nY\n" # True
107
120
                                      "not an answer\nno\n" # False
108
121
                                      "I'm sure!\nyes\n" # True
111
124
        stdout = tests.StringIOWrapper()
112
125
        stderr = tests.StringIOWrapper()
113
126
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
114
 
        self.assertEqual(True, factory.get_boolean(""))
115
 
        self.assertEqual(False, factory.get_boolean(""))
116
 
        self.assertEqual(True, factory.get_boolean(""))
117
 
        self.assertEqual(False, factory.get_boolean(""))
118
 
        self.assertEqual(True, factory.get_boolean(""))
119
 
        self.assertEqual(False, factory.get_boolean(""))
120
 
        self.assertEqual("foo\n", factory.stdin.read())
121
 
        # stdin should be empty
122
 
        self.assertEqual('', factory.stdin.readline())
 
127
        self.assertEqual(True, factory.get_boolean(u""))
 
128
        self.assertEqual(False, factory.get_boolean(u""))
 
129
        self.assertEqual(True, factory.get_boolean(u""))
 
130
        self.assertEqual(False, factory.get_boolean(u""))
 
131
        self.assertEqual(True, factory.get_boolean(u""))
 
132
        self.assertEqual(False, factory.get_boolean(u""))
 
133
        self.assertEqual(True, factory.get_boolean(u""))
 
134
        self.assertEqual(False, factory.get_boolean(u""))
 
135
        self.assertEqual("foo\n", factory.stdin.read())
 
136
        # stdin should be empty
 
137
        self.assertEqual('', factory.stdin.readline())
 
138
        # return false on EOF
 
139
        self.assertEqual(False, factory.get_boolean(u""))
 
140
 
 
141
    def test_text_ui_choose_bad_parameters(self):
 
142
        stdin = tests.StringIOWrapper()
 
143
        stdout = tests.StringIOWrapper()
 
144
        stderr = tests.StringIOWrapper()
 
145
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
146
        # invalid default index
 
147
        self.assertRaises(ValueError, factory.choose, u"", u"&Yes\n&No", 3)
 
148
        # duplicated choice
 
149
        self.assertRaises(ValueError, factory.choose, u"", u"&choice\n&ChOiCe")
 
150
        # duplicated shortcut
 
151
        self.assertRaises(ValueError, factory.choose, u"", u"&choice1\nchoi&ce2")
 
152
 
 
153
    def test_text_ui_choose_prompt(self):
 
154
        stdin = tests.StringIOWrapper()
 
155
        stdout = tests.StringIOWrapper()
 
156
        stderr = tests.StringIOWrapper()
 
157
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
158
        # choices with explicit shortcuts
 
159
        factory.choose(u"prompt", u"&yes\n&No\nmore &info")
 
160
        self.assertEqual("prompt ([y]es, [N]o, more [i]nfo): \n", factory.stderr.getvalue())
 
161
        # automatic shortcuts
 
162
        factory.stderr.truncate(0)
 
163
        factory.choose(u"prompt", u"yes\nNo\nmore info")
 
164
        self.assertEqual("prompt ([y]es, [N]o, [m]ore info): \n", factory.stderr.getvalue())
 
165
 
 
166
    def test_text_ui_choose_return_values(self):
 
167
        choose = lambda: factory.choose(u"", u"&Yes\n&No\nMaybe\nmore &info", 3)
 
168
        stdin = tests.StringIOWrapper("y\n" # 0
 
169
                                      "n\n" # 1
 
170
                                      " \n" # default: 3
 
171
                                      " no \n" # 1
 
172
                                      "b\na\nd \n" # bad shortcuts, all ignored
 
173
                                      "yes with garbage\nY\n" # 0
 
174
                                      "not an answer\nno\n" # 1
 
175
                                      "info\nmore info\n" # 3
 
176
                                      "Maybe\n" # 2
 
177
                                      "foo\n")
 
178
        stdout = tests.StringIOWrapper()
 
179
        stderr = tests.StringIOWrapper()
 
180
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
181
        self.assertEqual(0, choose())
 
182
        self.assertEqual(1, choose())
 
183
        self.assertEqual(3, choose())
 
184
        self.assertEqual(1, choose())
 
185
        self.assertEqual(0, choose())
 
186
        self.assertEqual(1, choose())
 
187
        self.assertEqual(3, choose())
 
188
        self.assertEqual(2, choose())
 
189
        self.assertEqual("foo\n", factory.stdin.read())
 
190
        # stdin should be empty
 
191
        self.assertEqual('', factory.stdin.readline())
 
192
        # return None on EOF
 
193
        self.assertEqual(None, choose())
 
194
 
 
195
    def test_text_ui_choose_no_default(self):
 
196
        stdin = tests.StringIOWrapper(" \n" # no default, invalid!
 
197
                                      " yes \n" # 0
 
198
                                      "foo\n")
 
199
        stdout = tests.StringIOWrapper()
 
200
        stderr = tests.StringIOWrapper()
 
201
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
 
202
        self.assertEqual(0, factory.choose(u"", u"&Yes\n&No"))
 
203
        self.assertEqual("foo\n", factory.stdin.read())
123
204
 
124
205
    def test_text_ui_get_integer(self):
125
206
        stdin = tests.StringIOWrapper(
129
210
        stdout = tests.StringIOWrapper()
130
211
        stderr = tests.StringIOWrapper()
131
212
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
132
 
        self.assertEqual(1, factory.get_integer(""))
133
 
        self.assertEqual(-2, factory.get_integer(""))
134
 
        self.assertEqual(42, factory.get_integer(""))
 
213
        self.assertEqual(1, factory.get_integer(u""))
 
214
        self.assertEqual(-2, factory.get_integer(u""))
 
215
        self.assertEqual(42, factory.get_integer(u""))
135
216
 
136
217
    def test_text_factory_prompt(self):
137
218
        # see <https://launchpad.net/bugs/365891>
138
219
        StringIO = tests.StringIOWrapper
139
220
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
140
 
        factory.prompt('foo %2e')
 
221
        factory.prompt(u'foo %2e')
141
222
        self.assertEqual('', factory.stdout.getvalue())
142
223
        self.assertEqual('foo %2e', factory.stderr.getvalue())
143
224
 
144
225
    def test_text_factory_prompts_and_clears(self):
145
226
        # a get_boolean call should clear the pb before prompting
146
 
        out = test_progress._TTYStringIO()
147
 
        os.environ['TERM'] = 'xterm'
 
227
        out = TTYStringIO()
 
228
        self.overrideEnv('TERM', 'xterm')
148
229
        factory = _mod_ui_text.TextUIFactory(
149
230
            stdin=tests.StringIOWrapper("yada\ny\n"),
150
231
            stdout=out, stderr=out)
158
239
                         self.apply_redirected(None, factory.stdout,
159
240
                                               factory.stdout,
160
241
                                               factory.get_boolean,
161
 
                                               "what do you want"))
 
242
                                               u"what do you want"))
162
243
        output = out.getvalue()
163
244
        self.assertContainsRe(output,
164
245
            "| foo *\r\r  *\r*")
165
 
        self.assertContainsRe(output,
166
 
            r"what do you want\? \[y/n\]: what do you want\? \[y/n\]: ")
 
246
        self.assertContainsString(output,
 
247
            r"what do you want? ([y]es, [n]o): what do you want? ([y]es, [n]o): ")
167
248
        # stdin should have been totally consumed
168
249
        self.assertEqual('', factory.stdin.readline())
169
250
 
180
261
            pb.finished()
181
262
 
182
263
    def test_text_ui_getusername(self):
183
 
        factory = _mod_ui_text.TextUIFactory(None, None, None)
184
 
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
185
 
        factory.stdout = tests.StringIOWrapper()
186
 
        factory.stderr = tests.StringIOWrapper()
187
 
        factory.stdout.encoding = "utf8"
188
 
        # there is no output from the base factory
189
 
        self.assertEqual("someuser",
190
 
                         factory.get_username('Hello %(host)s', host='some'))
191
 
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
192
 
        self.assertEquals('', factory.stdout.getvalue())
193
 
        self.assertEqual("", factory.get_username("Gebruiker"))
 
264
        ui = _mod_ui_text.TextUIFactory(None, None, None)
 
265
        ui.stdin = tests.StringIOWrapper('someuser\n\n')
 
266
        ui.stdout = tests.StringIOWrapper()
 
267
        ui.stderr = tests.StringIOWrapper()
 
268
        ui.stdout.encoding = 'utf8'
 
269
        self.assertEqual('someuser',
 
270
                         ui.get_username(u'Hello %(host)s', host='some'))
 
271
        self.assertEquals('Hello some: ', ui.stderr.getvalue())
 
272
        self.assertEquals('', ui.stdout.getvalue())
 
273
        self.assertEqual('', ui.get_username(u"Gebruiker"))
194
274
        # stdin should be empty
195
 
        self.assertEqual('', factory.stdin.readline())
 
275
        self.assertEqual('', ui.stdin.readline())
196
276
 
197
277
    def test_text_ui_getusername_utf8(self):
198
 
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
199
 
                                 stdout=tests.StringIOWrapper(),
200
 
                                 stderr=tests.StringIOWrapper())
 
278
        ui = _mod_ui_text.TextUIFactory(None, None, None)
 
279
        ui.stdin = tests.StringIOWrapper(u'someuser\u1234'.encode('utf8'))
 
280
        ui.stdout = tests.StringIOWrapper()
 
281
        ui.stderr = tests.StringIOWrapper()
201
282
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
202
 
        pb = ui.nested_progress_bar()
203
 
        try:
204
 
            # there is no output from the base factory
205
 
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
206
 
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
207
 
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
208
 
            self.assertEquals(u"Hello\u1234 some\u1234: ",
209
 
                              ui.stderr.getvalue().decode("utf8"))
210
 
            self.assertEquals('', ui.stdout.getvalue())
211
 
        finally:
212
 
            pb.finished()
 
283
        username = ui.get_username(u'Hello %(host)s', host=u'some\u1234')
 
284
        self.assertEquals(u"someuser\u1234", username)
 
285
        self.assertEquals(u"Hello some\u1234: ",
 
286
                          ui.stderr.getvalue().decode("utf8"))
 
287
        self.assertEquals('', ui.stdout.getvalue())
213
288
 
214
289
    def test_quietness(self):
215
 
        os.environ['BZR_PROGRESS_BAR'] = 'text'
 
290
        self.overrideEnv('BZR_PROGRESS_BAR', 'text')
216
291
        ui_factory = _mod_ui_text.TextUIFactory(None,
217
 
            test_progress._TTYStringIO(),
218
 
            test_progress._TTYStringIO())
 
292
            TTYStringIO(),
 
293
            TTYStringIO())
219
294
        self.assertIsInstance(ui_factory._progress_view,
220
295
            _mod_ui_text.TextProgressView)
221
296
        ui_factory.be_quiet(True)
224
299
 
225
300
    def test_text_ui_show_user_warning(self):
226
301
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormat2a
227
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5
 
302
        from bzrlib.repofmt.knitpack_repo import RepositoryFormatKnitPack5
228
303
        err = StringIO()
229
304
        out = StringIO()
230
305
        ui = tests.TextUIFactory(stdin=None, stdout=out, stderr=err)
280
355
    def test_progress_construction(self):
281
356
        """TextUIFactory constructs the right progress view.
282
357
        """
283
 
        TTYStringIO = test_progress._TTYStringIO
284
358
        FileStringIO = tests.StringIOWrapper
285
359
        for (file_class, term, pb, expected_pb_class) in (
286
360
            # on an xterm, either use them or not as the user requests,
299
373
            # however, it can still be forced on
300
374
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
301
375
            ):
302
 
            os.environ['TERM'] = term
303
 
            if pb is None:
304
 
                if 'BZR_PROGRESS_BAR' in os.environ:
305
 
                    del os.environ['BZR_PROGRESS_BAR']
306
 
            else:
307
 
                os.environ['BZR_PROGRESS_BAR'] = pb
 
376
            self.overrideEnv('TERM', term)
 
377
            self.overrideEnv('BZR_PROGRESS_BAR', pb)
308
378
            stdin = file_class('')
309
379
            stderr = file_class()
310
380
            stdout = file_class()
317
387
 
318
388
    def test_text_ui_non_terminal(self):
319
389
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
320
 
        stdin = test_progress._NonTTYStringIO('')
321
 
        stderr = test_progress._NonTTYStringIO()
322
 
        stdout = test_progress._NonTTYStringIO()
 
390
        stdin = NonTTYStringIO('')
 
391
        stderr = NonTTYStringIO()
 
392
        stdout = NonTTYStringIO()
323
393
        for term_type in ['dumb', None, 'xterm']:
324
 
            if term_type is None:
325
 
                del os.environ['TERM']
326
 
            else:
327
 
                os.environ['TERM'] = term_type
 
394
            self.overrideEnv('TERM', term_type)
328
395
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
329
396
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
330
397
                'TERM=%r' % (term_type,))
351
418
        self.assertRaises(
352
419
            NotImplementedError,
353
420
            self.apply_redirected,
354
 
            None, stdout, stdout, factory.get_boolean, "foo")
 
421
            None, stdout, stdout, factory.get_boolean, u"foo")
355
422
 
356
423
 
357
424
class TestUIFactoryTests(tests.TestCase):
370
437
 
371
438
    def test_canned_input_get_input(self):
372
439
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
373
 
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
374
 
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
 
440
        self.assertEqual(True, uif.get_boolean(u'Extra cheese?'))
 
441
        self.assertEqual('mbp', uif.get_username(u'Enter your user name'))
375
442
        self.assertEqual('password',
376
 
                         uif.get_password('Password for %(host)s',
 
443
                         uif.get_password(u'Password for %(host)s',
377
444
                                          host='example.com'))
378
 
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
 
445
        self.assertEqual(42, uif.get_integer(u'And all that jazz ?'))
379
446
 
380
447
 
381
448
class TestBoolFromString(tests.TestCase):
432
499
        self.assertIsNone('0', av)
433
500
        self.assertIsNone('on', av)
434
501
        self.assertIsNone('off', av)
 
502
 
 
503
 
 
504
class TestConfirmationUserInterfacePolicy(tests.TestCase):
 
505
 
 
506
    def test_confirm_action_default(self):
 
507
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
508
        for answer in [True, False]:
 
509
            self.assertEquals(
 
510
                _mod_ui.ConfirmationUserInterfacePolicy(base_ui, answer, {})
 
511
                .confirm_action("Do something?",
 
512
                    "bzrlib.tests.do_something", {}),
 
513
                answer)
 
514
 
 
515
    def test_confirm_action_specific(self):
 
516
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
517
        for default_answer in [True, False]:
 
518
            for specific_answer in [True, False]:
 
519
                for conf_id in ['given_id', 'other_id']:
 
520
                    wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
 
521
                        base_ui, default_answer, dict(given_id=specific_answer))
 
522
                    result = wrapper.confirm_action("Do something?", conf_id, {})
 
523
                    if conf_id == 'given_id':
 
524
                        self.assertEquals(result, specific_answer)
 
525
                    else:
 
526
                        self.assertEquals(result, default_answer)
 
527
 
 
528
    def test_repr(self):
 
529
        base_ui = _mod_ui.NoninteractiveUIFactory()
 
530
        wrapper = _mod_ui.ConfirmationUserInterfacePolicy(
 
531
            base_ui, True, dict(a=2))
 
532
        self.assertThat(repr(wrapper),
 
533
            Equals("ConfirmationUserInterfacePolicy("
 
534
                "NoninteractiveUIFactory(), True, {'a': 2})"))
 
535
 
 
536
 
 
537
class TestProgressRecordingUI(tests.TestCase):
 
538
    """Test test-oriented UIFactory that records progress updates"""
 
539
 
 
540
    def test_nested_ignore_depth_beyond_one(self):
 
541
        # we only want to capture the first level out progress, not
 
542
        # want sub-components might do. So we have nested bars ignored.
 
543
        factory = ProgressRecordingUIFactory()
 
544
        pb1 = factory.nested_progress_bar()
 
545
        pb1.update('foo', 0, 1)
 
546
        pb2 = factory.nested_progress_bar()
 
547
        pb2.update('foo', 0, 1)
 
548
        pb2.finished()
 
549
        pb1.finished()
 
550
        self.assertEqual([("update", 0, 1, 'foo')], factory._calls)