/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: Canonical.com Patch Queue Manager
  • Date: 2009-06-10 06:25:56 UTC
  • mfrom: (4360.5.4 bzr.1.15.1)
  • Revision ID: pqm@pqm.ubuntu.com-20090610062556-r5szm3gdybs8w5nq
(tanner) Merge release 1.15.1 back to trunk

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