← 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: John Ferlito
  • Date: 2009-05-25 10:59:42 UTC
  • mto: (4665.4.1 ppa-doc)
  • mto: This revision was merged to the branch mainline in revision 4693.
  • Revision ID: johnf@inodes.org-20090525105942-5xkcbe37m1u5lp5z
Update packaging scripts to make deployment a bit easier
Update documentation for deploying to PPA

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_ui.py
1
 
# Copyright (C) 2005, 2008, 2009, 2010 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
18
18
"""
19
19
 
20
20
import os
 
21
from StringIO import StringIO
21
22
import re
 
23
import sys
22
24
import time
23
25
 
24
 
from bzrlib import (
25
 
    errors,
26
 
    tests,
27
 
    ui as _mod_ui,
 
26
import bzrlib
 
27
import bzrlib.errors as errors
 
28
from bzrlib.progress import (
 
29
    DotsProgressBar,
 
30
    ProgressBarStack,
 
31
    ProgressTask,
 
32
    TTYProgressBar,
28
33
    )
29
34
from bzrlib.symbol_versioning import (
30
35
    deprecated_in,
31
36
    )
32
 
from bzrlib.tests import test_progress
33
 
from bzrlib.ui import text as _mod_ui_text
34
 
 
35
 
 
36
 
class TestTextUIFactory(tests.TestCase):
 
37
from bzrlib.tests import (
 
38
    TestCase,
 
39
    TestUIFactory,
 
40
    StringIOWrapper,
 
41
    )
 
42
from bzrlib.tests.test_progress import _TTYStringIO
 
43
from bzrlib.ui import (
 
44
    CLIUIFactory,
 
45
    SilentUIFactory,
 
46
    )
 
47
from bzrlib.ui.text import (
 
48
    TextProgressView,
 
49
    TextUIFactory,
 
50
    )
 
51
 
 
52
 
 
53
class UITests(TestCase):
 
54
 
 
55
    def test_silent_factory(self):
 
56
        ui = SilentUIFactory()
 
57
        stdout = StringIO()
 
58
        self.assertEqual(None,
 
59
                         self.apply_redirected(None, stdout, stdout,
 
60
                                               ui.get_password))
 
61
        self.assertEqual('', stdout.getvalue())
 
62
        self.assertEqual(None,
 
63
                         self.apply_redirected(None, stdout, stdout,
 
64
                                               ui.get_password,
 
65
                                               u'Hello\u1234 %(user)s',
 
66
                                               user=u'some\u1234'))
 
67
        self.assertEqual('', stdout.getvalue())
37
68
 
38
69
    def test_text_factory_ascii_password(self):
39
 
        ui = tests.TestUIFactory(stdin='secret\n',
40
 
                                 stdout=tests.StringIOWrapper(),
41
 
                                 stderr=tests.StringIOWrapper())
 
70
        ui = TestUIFactory(stdin='secret\n', stdout=StringIOWrapper())
42
71
        pb = ui.nested_progress_bar()
43
72
        try:
44
73
            self.assertEqual('secret',
45
74
                             self.apply_redirected(ui.stdin, ui.stdout,
46
 
                                                   ui.stderr,
 
75
                                                   ui.stdout,
47
76
                                                   ui.get_password))
48
77
            # ': ' is appended to prompt
49
 
            self.assertEqual(': ', ui.stderr.getvalue())
50
 
            self.assertEqual('', ui.stdout.readline())
 
78
            self.assertEqual(': ', ui.stdout.getvalue())
51
79
            # stdin should be empty
52
80
            self.assertEqual('', ui.stdin.readline())
53
81
        finally:
59
87
        We can't predict what encoding users will have for stdin, so we force
60
88
        it to utf8 to test that we transport the password correctly.
61
89
        """
62
 
        ui = tests.TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
63
 
                                 stdout=tests.StringIOWrapper(),
64
 
                                 stderr=tests.StringIOWrapper())
65
 
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = 'utf8'
 
90
        ui = TestUIFactory(stdin=u'baz\u1234'.encode('utf8'),
 
91
                           stdout=StringIOWrapper())
 
92
        ui.stdin.encoding = 'utf8'
 
93
        ui.stdout.encoding = ui.stdin.encoding
66
94
        pb = ui.nested_progress_bar()
67
95
        try:
68
 
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
96
            password = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
69
97
                                             ui.get_password,
70
98
                                             u'Hello \u1234 %(user)s',
71
99
                                             user=u'some\u1234')
72
100
            # We use StringIO objects, we need to decode them
73
101
            self.assertEqual(u'baz\u1234', password.decode('utf8'))
74
102
            self.assertEqual(u'Hello \u1234 some\u1234: ',
75
 
                             ui.stderr.getvalue().decode('utf8'))
76
 
            # stdin and stdout should be empty
 
103
                             ui.stdout.getvalue().decode('utf8'))
 
104
            # stdin should be empty
77
105
            self.assertEqual('', ui.stdin.readline())
78
 
            self.assertEqual('', ui.stdout.readline())
79
106
        finally:
80
107
            pb.finished()
81
108
 
82
109
    def test_progress_note(self):
83
 
        stderr = tests.StringIOWrapper()
84
 
        stdout = tests.StringIOWrapper()
85
 
        ui_factory = _mod_ui_text.TextUIFactory(stdin=tests.StringIOWrapper(''),
86
 
                                                stderr=stderr,
87
 
                                                stdout=stdout)
 
110
        stderr = StringIO()
 
111
        stdout = StringIO()
 
112
        ui_factory = TextUIFactory(stdin=StringIO(''),
 
113
            stderr=stderr,
 
114
            stdout=stdout)
88
115
        pb = ui_factory.nested_progress_bar()
89
116
        try:
90
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
91
 
                pb.note,
92
 
                't')
 
117
            result = pb.note('t')
93
118
            self.assertEqual(None, result)
94
119
            self.assertEqual("t\n", stdout.getvalue())
95
120
            # Since there was no update() call, there should be no clear() call
100
125
            pb.finished()
101
126
 
102
127
    def test_progress_note_clears(self):
103
 
        stderr = test_progress._TTYStringIO()
104
 
        stdout = test_progress._TTYStringIO()
105
 
        # so that we get a TextProgressBar
106
 
        os.environ['TERM'] = 'xterm'
107
 
        ui_factory = _mod_ui_text.TextUIFactory(
108
 
            stdin=tests.StringIOWrapper(''),
 
128
        stderr = StringIO()
 
129
        stdout = StringIO()
 
130
        # The PQM redirects the output to a file, so it
 
131
        # defaults to creating a Dots progress bar. we
 
132
        # need to force it to believe we are a TTY
 
133
        ui_factory = TextUIFactory(
 
134
            stdin=StringIO(''),
109
135
            stdout=stdout, stderr=stderr)
110
 
        self.assertIsInstance(ui_factory._progress_view,
111
 
                              _mod_ui_text.TextProgressView)
112
136
        pb = ui_factory.nested_progress_bar()
113
137
        try:
114
138
            # Create a progress update that isn't throttled
115
139
            pb.update('x', 1, 1)
116
 
            result = self.applyDeprecated(deprecated_in((2, 1, 0)),
117
 
                pb.note, 't')
 
140
            result = pb.note('t')
118
141
            self.assertEqual(None, result)
119
142
            self.assertEqual("t\n", stdout.getvalue())
120
143
            # the exact contents will depend on the terminal width and we don't
126
149
 
127
150
    def test_progress_nested(self):
128
151
        # test factory based nested and popping.
129
 
        ui = _mod_ui_text.TextUIFactory(None, None, None)
 
152
        ui = TextUIFactory(None, None, None)
130
153
        pb1 = ui.nested_progress_bar()
131
154
        pb2 = ui.nested_progress_bar()
132
155
        # You do get a warning if the outermost progress bar wasn't finished
138
161
        pb2.finished()
139
162
        pb1.finished()
140
163
 
141
 
    def test_text_ui_get_boolean(self):
142
 
        stdin = tests.StringIOWrapper("y\n" # True
143
 
                                      "n\n" # False
144
 
                                      "yes with garbage\nY\n" # True
145
 
                                      "not an answer\nno\n" # False
146
 
                                      "I'm sure!\nyes\n" # True
147
 
                                      "NO\n" # False
148
 
                                      "foo\n")
149
 
        stdout = tests.StringIOWrapper()
150
 
        stderr = tests.StringIOWrapper()
151
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
152
 
        self.assertEqual(True, factory.get_boolean(""))
153
 
        self.assertEqual(False, factory.get_boolean(""))
154
 
        self.assertEqual(True, factory.get_boolean(""))
155
 
        self.assertEqual(False, factory.get_boolean(""))
156
 
        self.assertEqual(True, factory.get_boolean(""))
 
164
    def test_progress_stack(self):
 
165
        # test the progress bar stack which the default text factory
 
166
        # uses.
 
167
        stderr = StringIO()
 
168
        stdout = StringIO()
 
169
        # make a stack, which accepts parameters like a pb.
 
170
        stack = self.applyDeprecated(
 
171
            deprecated_in((1, 12, 0)),
 
172
            ProgressBarStack,
 
173
            to_file=stderr, to_messages_file=stdout)
 
174
        # but is not one
 
175
        self.assertFalse(getattr(stack, 'note', False))
 
176
        pb1 = stack.get_nested()
 
177
        pb2 = stack.get_nested()
 
178
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
179
        self.assertEqual(len(warnings), 1)
 
180
        pb2.finished()
 
181
        pb1.finished()
 
182
        # the text ui factory never actually removes the stack once its setup.
 
183
        # we need to be able to nest again correctly from here.
 
184
        pb1 = stack.get_nested()
 
185
        pb2 = stack.get_nested()
 
186
        warnings, _ = self.callCatchWarnings(pb1.finished)
 
187
        self.assertEqual(len(warnings), 1)
 
188
        pb2.finished()
 
189
        pb1.finished()
 
190
 
 
191
    def assert_get_bool_acceptance_of_user_input(self, factory):
 
192
        factory.stdin = StringIO("y\nyes with garbage\n"
 
193
                                 "yes\nn\nnot an answer\n"
 
194
                                 "no\nfoo\n")
 
195
        factory.stdout = StringIO()
 
196
        # there is no output from the base factory
 
197
        self.assertEqual(True, factory.get_boolean(""))
 
198
        self.assertEqual(True, factory.get_boolean(""))
 
199
        self.assertEqual(False, factory.get_boolean(""))
157
200
        self.assertEqual(False, factory.get_boolean(""))
158
201
        self.assertEqual("foo\n", factory.stdin.read())
159
202
        # stdin should be empty
160
203
        self.assertEqual('', factory.stdin.readline())
161
204
 
162
 
    def test_text_ui_get_integer(self):
163
 
        stdin = tests.StringIOWrapper(
164
 
            "1\n"
165
 
            "  -2  \n"
166
 
            "hmmm\nwhat else ?\nCome on\nok 42\n4.24\n42\n")
167
 
        stdout = tests.StringIOWrapper()
168
 
        stderr = tests.StringIOWrapper()
169
 
        factory = _mod_ui_text.TextUIFactory(stdin, stdout, stderr)
170
 
        self.assertEqual(1, factory.get_integer(""))
171
 
        self.assertEqual(-2, factory.get_integer(""))
172
 
        self.assertEqual(42, factory.get_integer(""))
 
205
    def test_silent_ui_getbool(self):
 
206
        factory = SilentUIFactory()
 
207
        self.assert_get_bool_acceptance_of_user_input(factory)
 
208
 
 
209
    def test_silent_factory_prompts_silently(self):
 
210
        factory = SilentUIFactory()
 
211
        stdout = StringIO()
 
212
        factory.stdin = StringIO("y\n")
 
213
        self.assertEqual(True,
 
214
                         self.apply_redirected(None, stdout, stdout,
 
215
                                               factory.get_boolean, "foo"))
 
216
        self.assertEqual("", stdout.getvalue())
 
217
        # stdin should be empty
 
218
        self.assertEqual('', factory.stdin.readline())
 
219
 
 
220
    def test_text_ui_getbool(self):
 
221
        factory = TextUIFactory(None, None, None)
 
222
        self.assert_get_bool_acceptance_of_user_input(factory)
173
223
 
174
224
    def test_text_factory_prompt(self):
175
225
        # see <https://launchpad.net/bugs/365891>
176
 
        StringIO = tests.StringIOWrapper
177
 
        factory = _mod_ui_text.TextUIFactory(StringIO(), StringIO(), StringIO())
 
226
        factory = TextUIFactory(None, StringIO(), StringIO())
178
227
        factory.prompt('foo %2e')
179
 
        self.assertEqual('', factory.stdout.getvalue())
180
 
        self.assertEqual('foo %2e', factory.stderr.getvalue())
181
228
 
182
229
    def test_text_factory_prompts_and_clears(self):
183
230
        # a get_boolean call should clear the pb before prompting
184
 
        out = test_progress._TTYStringIO()
185
 
        os.environ['TERM'] = 'xterm'
186
 
        factory = _mod_ui_text.TextUIFactory(
187
 
            stdin=tests.StringIOWrapper("yada\ny\n"),
188
 
            stdout=out, stderr=out)
 
231
        out = _TTYStringIO()
 
232
        factory = TextUIFactory(stdin=StringIO("yada\ny\n"), stdout=out, stderr=out)
189
233
        pb = factory.nested_progress_bar()
190
234
        pb.show_bar = False
191
235
        pb.show_spinner = False
205
249
        self.assertEqual('', factory.stdin.readline())
206
250
 
207
251
    def test_text_tick_after_update(self):
208
 
        ui_factory = _mod_ui_text.TextUIFactory(stdout=tests.StringIOWrapper(),
209
 
                                                stderr=tests.StringIOWrapper())
 
252
        ui_factory = TextUIFactory(stdout=StringIO(), stderr=StringIO())
210
253
        pb = ui_factory.nested_progress_bar()
211
254
        try:
212
255
            pb.update('task', 0, 3)
216
259
        finally:
217
260
            pb.finished()
218
261
 
 
262
    def test_silent_ui_getusername(self):
 
263
        factory = SilentUIFactory()
 
264
        factory.stdin = StringIO("someuser\n\n")
 
265
        factory.stdout = StringIO()
 
266
        self.assertEquals(None, 
 
267
            factory.get_username(u'Hello\u1234 %(host)s', host=u'some\u1234'))
 
268
        self.assertEquals("", factory.stdout.getvalue())
 
269
        self.assertEquals("someuser\n\n", factory.stdin.getvalue())
 
270
 
219
271
    def test_text_ui_getusername(self):
220
 
        factory = _mod_ui_text.TextUIFactory(None, None, None)
221
 
        factory.stdin = tests.StringIOWrapper("someuser\n\n")
222
 
        factory.stdout = tests.StringIOWrapper()
223
 
        factory.stderr = tests.StringIOWrapper()
 
272
        factory = TextUIFactory(None, None, None)
 
273
        factory.stdin = StringIO("someuser\n\n")
 
274
        factory.stdout = StringIO()
224
275
        factory.stdout.encoding = "utf8"
225
276
        # there is no output from the base factory
226
 
        self.assertEqual("someuser",
227
 
                         factory.get_username('Hello %(host)s', host='some'))
228
 
        self.assertEquals("Hello some: ", factory.stderr.getvalue())
229
 
        self.assertEquals('', factory.stdout.getvalue())
 
277
        self.assertEqual("someuser", 
 
278
            factory.get_username('Hello %(host)s', host='some'))
 
279
        self.assertEquals("Hello some: ", factory.stdout.getvalue())
230
280
        self.assertEqual("", factory.get_username("Gebruiker"))
231
281
        # stdin should be empty
232
282
        self.assertEqual('', factory.stdin.readline())
233
283
 
234
284
    def test_text_ui_getusername_utf8(self):
235
 
        ui = tests.TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
236
 
                                 stdout=tests.StringIOWrapper(),
237
 
                                 stderr=tests.StringIOWrapper())
238
 
        ui.stderr.encoding = ui.stdout.encoding = ui.stdin.encoding = "utf8"
 
285
        ui = TestUIFactory(stdin=u'someuser\u1234'.encode('utf8'),
 
286
                           stdout=StringIOWrapper())
 
287
        ui.stdin.encoding = "utf8"
 
288
        ui.stdout.encoding = ui.stdin.encoding
239
289
        pb = ui.nested_progress_bar()
240
290
        try:
241
291
            # there is no output from the base factory
242
 
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stderr,
 
292
            username = self.apply_redirected(ui.stdin, ui.stdout, ui.stdout,
243
293
                ui.get_username, u'Hello\u1234 %(host)s', host=u'some\u1234')
244
294
            self.assertEquals(u"someuser\u1234", username.decode('utf8'))
245
 
            self.assertEquals(u"Hello\u1234 some\u1234: ",
246
 
                              ui.stderr.getvalue().decode("utf8"))
247
 
            self.assertEquals('', ui.stdout.getvalue())
 
295
            self.assertEquals(u"Hello\u1234 some\u1234: ", 
 
296
                ui.stdout.getvalue().decode("utf8"))
248
297
        finally:
249
298
            pb.finished()
250
299
 
251
 
    def test_quietness(self):
252
 
        os.environ['BZR_PROGRESS_BAR'] = 'text'
253
 
        ui_factory = _mod_ui_text.TextUIFactory(None,
254
 
            test_progress._TTYStringIO(),
255
 
            test_progress._TTYStringIO())
256
 
        self.assertIsInstance(ui_factory._progress_view,
257
 
            _mod_ui_text.TextProgressView)
258
 
        ui_factory.be_quiet(True)
259
 
        self.assertIsInstance(ui_factory._progress_view,
260
 
            _mod_ui_text.NullProgressView)
261
 
 
262
 
 
263
 
class TestTextUIOutputStream(tests.TestCase):
264
 
    """Tests for output stream that synchronizes with progress bar."""
265
 
 
266
 
    def test_output_clears_terminal(self):
267
 
        stdout = tests.StringIOWrapper()
268
 
        stderr = tests.StringIOWrapper()
269
 
        clear_calls = []
270
 
 
271
 
        uif =  _mod_ui_text.TextUIFactory(None, stdout, stderr)
272
 
        uif.clear_term = lambda: clear_calls.append('clear')
273
 
 
274
 
        stream = _mod_ui_text.TextUIOutputStream(uif, uif.stdout)
275
 
        stream.write("Hello world!\n")
276
 
        stream.write("there's more...\n")
277
 
        stream.writelines(["1\n", "2\n", "3\n"])
278
 
 
279
 
        self.assertEqual(stdout.getvalue(),
280
 
            "Hello world!\n"
281
 
            "there's more...\n"
282
 
            "1\n2\n3\n")
283
 
        self.assertEqual(['clear', 'clear', 'clear'],
284
 
            clear_calls)
285
 
 
286
 
        stream.flush()
287
 
 
288
 
 
289
 
class UITests(tests.TestCase):
290
 
 
291
 
    def test_progress_construction(self):
292
 
        """TextUIFactory constructs the right progress view.
293
 
        """
294
 
        TTYStringIO = test_progress._TTYStringIO
295
 
        FileStringIO = tests.StringIOWrapper
296
 
        for (file_class, term, pb, expected_pb_class) in (
297
 
            # on an xterm, either use them or not as the user requests,
298
 
            # otherwise default on
299
 
            (TTYStringIO, 'xterm', 'none', _mod_ui_text.NullProgressView),
300
 
            (TTYStringIO, 'xterm', 'text', _mod_ui_text.TextProgressView),
301
 
            (TTYStringIO, 'xterm', None, _mod_ui_text.TextProgressView),
302
 
            # on a dumb terminal, again if there's explicit configuration do
303
 
            # it, otherwise default off
304
 
            (TTYStringIO, 'dumb', 'none', _mod_ui_text.NullProgressView),
305
 
            (TTYStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
306
 
            (TTYStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
307
 
            # on a non-tty terminal, it's null regardless of $TERM
308
 
            (FileStringIO, 'xterm', None, _mod_ui_text.NullProgressView),
309
 
            (FileStringIO, 'dumb', None, _mod_ui_text.NullProgressView),
310
 
            # however, it can still be forced on
311
 
            (FileStringIO, 'dumb', 'text', _mod_ui_text.TextProgressView),
312
 
            ):
313
 
            os.environ['TERM'] = term
314
 
            if pb is None:
315
 
                if 'BZR_PROGRESS_BAR' in os.environ:
316
 
                    del os.environ['BZR_PROGRESS_BAR']
317
 
            else:
318
 
                os.environ['BZR_PROGRESS_BAR'] = pb
319
 
            stdin = file_class('')
320
 
            stderr = file_class()
321
 
            stdout = file_class()
322
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
323
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
324
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
325
 
            self.assertIsInstance(uif.make_progress_view(),
326
 
                expected_pb_class,
327
 
                "TERM=%s BZR_PROGRESS_BAR=%s uif=%r" % (term, pb, uif,))
328
 
 
329
 
    def test_text_ui_non_terminal(self):
330
 
        """Even on non-ttys, make_ui_for_terminal gives a text ui."""
331
 
        stdin = test_progress._NonTTYStringIO('')
332
 
        stderr = test_progress._NonTTYStringIO()
333
 
        stdout = test_progress._NonTTYStringIO()
334
 
        for term_type in ['dumb', None, 'xterm']:
335
 
            if term_type is None:
336
 
                del os.environ['TERM']
337
 
            else:
338
 
                os.environ['TERM'] = term_type
339
 
            uif = _mod_ui.make_ui_for_terminal(stdin, stdout, stderr)
340
 
            self.assertIsInstance(uif, _mod_ui_text.TextUIFactory,
341
 
                'TERM=%r' % (term_type,))
342
 
 
343
 
 
344
 
class SilentUITests(tests.TestCase):
345
 
 
346
 
    def test_silent_factory_get_password(self):
347
 
        # A silent factory that can't do user interaction can't get a
348
 
        # password.  Possibly it should raise a more specific error but it
349
 
        # can't succeed.
350
 
        ui = _mod_ui.SilentUIFactory()
351
 
        stdout = tests.StringIOWrapper()
352
 
        self.assertRaises(
353
 
            NotImplementedError,
354
 
            self.apply_redirected,
355
 
            None, stdout, stdout, ui.get_password)
356
 
        # and it didn't write anything out either
357
 
        self.assertEqual('', stdout.getvalue())
358
 
 
359
 
    def test_silent_ui_getbool(self):
360
 
        factory = _mod_ui.SilentUIFactory()
361
 
        stdout = tests.StringIOWrapper()
362
 
        self.assertRaises(
363
 
            NotImplementedError,
364
 
            self.apply_redirected,
365
 
            None, stdout, stdout, factory.get_boolean, "foo")
366
 
 
367
 
 
368
 
class TestUIFactoryTests(tests.TestCase):
369
 
 
370
 
    def test_test_ui_factory_progress(self):
371
 
        # there's no output; we just want to make sure this doesn't crash -
372
 
        # see https://bugs.edge.launchpad.net/bzr/+bug/408201
373
 
        ui = tests.TestUIFactory()
374
 
        pb = ui.nested_progress_bar()
375
 
        pb.update('hello')
376
 
        pb.tick()
377
 
        pb.finished()
378
 
 
379
 
 
380
 
class CannedInputUIFactoryTests(tests.TestCase):
381
 
 
382
 
    def test_canned_input_get_input(self):
383
 
        uif = _mod_ui.CannedInputUIFactory([True, 'mbp', 'password', 42])
384
 
        self.assertEqual(True, uif.get_boolean('Extra cheese?'))
385
 
        self.assertEqual('mbp', uif.get_username('Enter your user name'))
386
 
        self.assertEqual('password',
387
 
                         uif.get_password('Password for %(host)s',
388
 
                                          host='example.com'))
389
 
        self.assertEqual(42, uif.get_integer('And all that jazz ?'))
390
 
 
391
 
 
392
 
class TestBoolFromString(tests.TestCase):
393
 
 
394
 
    def assertIsTrue(self, s, accepted_values=None):
395
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
396
 
        self.assertEquals(True, res)
397
 
 
398
 
    def assertIsFalse(self, s, accepted_values=None):
399
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
400
 
        self.assertEquals(False, res)
401
 
 
402
 
    def assertIsNone(self, s, accepted_values=None):
403
 
        res = _mod_ui.bool_from_string(s, accepted_values=accepted_values)
404
 
        self.assertIs(None, res)
405
 
 
406
 
    def test_know_valid_values(self):
407
 
        self.assertIsTrue('true')
408
 
        self.assertIsFalse('false')
409
 
        self.assertIsTrue('1')
410
 
        self.assertIsFalse('0')
411
 
        self.assertIsTrue('on')
412
 
        self.assertIsFalse('off')
413
 
        self.assertIsTrue('yes')
414
 
        self.assertIsFalse('no')
415
 
        self.assertIsTrue('y')
416
 
        self.assertIsFalse('n')
417
 
        # Also try some case variations
418
 
        self.assertIsTrue('True')
419
 
        self.assertIsFalse('False')
420
 
        self.assertIsTrue('On')
421
 
        self.assertIsFalse('Off')
422
 
        self.assertIsTrue('ON')
423
 
        self.assertIsFalse('OFF')
424
 
        self.assertIsTrue('oN')
425
 
        self.assertIsFalse('oFf')
426
 
 
427
 
    def test_invalid_values(self):
428
 
        self.assertIsNone(None)
429
 
        self.assertIsNone('doubt')
430
 
        self.assertIsNone('frue')
431
 
        self.assertIsNone('talse')
432
 
        self.assertIsNone('42')
433
 
 
434
 
    def test_provided_values(self):
435
 
        av = dict(y=True, n=False, yes=True, no=False)
436
 
        self.assertIsTrue('y', av)
437
 
        self.assertIsTrue('Y', av)
438
 
        self.assertIsTrue('Yes', av)
439
 
        self.assertIsFalse('n', av)
440
 
        self.assertIsFalse('N', av)
441
 
        self.assertIsFalse('No', av)
442
 
        self.assertIsNone('1', av)
443
 
        self.assertIsNone('0', av)
444
 
        self.assertIsNone('on', av)
445
 
        self.assertIsNone('off', av)
 
300
 
 
301
class TestTextProgressView(TestCase):
 
302
    """Tests for text display of progress bars.
 
303
    """
 
304
    # XXX: These might be a bit easier to write if the rendering and
 
305
    # state-maintaining parts of TextProgressView were more separate, and if
 
306
    # the progress task called back directly to its own view not to the ui
 
307
    # factory. -- mbp 20090312
 
308
    
 
309
    def _make_factory(self):
 
310
        out = StringIO()
 
311
        uif = TextUIFactory(stderr=out)
 
312
        uif._progress_view._width = 80
 
313
        return out, uif
 
314
 
 
315
    def test_render_progress_easy(self):
 
316
        """Just one task and one quarter done"""
 
317
        out, uif = self._make_factory()
 
318
        task = uif.nested_progress_bar()
 
319
        task.update('reticulating splines', 5, 20)
 
320
        self.assertEqual(
 
321
'\r[####/               ] reticulating splines 5/20                               \r'
 
322
            , out.getvalue())
 
323
 
 
324
    def test_render_progress_nested(self):
 
325
        """Tasks proportionally contribute to overall progress"""
 
326
        out, uif = self._make_factory()
 
327
        task = uif.nested_progress_bar()
 
328
        task.update('reticulating splines', 0, 2)
 
329
        task2 = uif.nested_progress_bar()
 
330
        task2.update('stage2', 1, 2)
 
331
        # so we're in the first half of the main task, and half way through
 
332
        # that
 
333
        self.assertEqual(
 
334
r'[####\               ] reticulating splines:stage2 1/2'
 
335
            , uif._progress_view._render_line())
 
336
        # if the nested task is complete, then we're all the way through the
 
337
        # first half of the overall work
 
338
        task2.update('stage2', 2, 2)
 
339
        self.assertEqual(
 
340
r'[#########|          ] reticulating splines:stage2 2/2'
 
341
            , uif._progress_view._render_line())
 
342
 
 
343
    def test_render_progress_sub_nested(self):
 
344
        """Intermediate tasks don't mess up calculation."""
 
345
        out, uif = self._make_factory()
 
346
        task_a = uif.nested_progress_bar()
 
347
        task_a.update('a', 0, 2)
 
348
        task_b = uif.nested_progress_bar()
 
349
        task_b.update('b')
 
350
        task_c = uif.nested_progress_bar()
 
351
        task_c.update('c', 1, 2)
 
352
        # the top-level task is in its first half; the middle one has no
 
353
        # progress indication, just a label; and the bottom one is half done,
 
354
        # so the overall fraction is 1/4
 
355
        self.assertEqual(
 
356
            r'[####|               ] a:b:c 1/2'
 
357
            , uif._progress_view._render_line())
 
358