← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_progress.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-16 16:08:40 UTC
  • mfrom: (4797.2.15 2.1)
  • mto: (4797.2.16 2.1)
  • mto: This revision was merged to the branch mainline in revision 5037.
  • Revision ID: john@arbash-meinel.com-20100216160840-xwbpuu0v89gq8lej
Tags: bzr-2.1.0
bring in the latest 2.1 changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
1
 
# Copyright (C) 2006 by Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
import os
17
19
from StringIO import StringIO
18
20
 
19
 
from bzrlib.progress import *
 
21
from bzrlib import errors
 
22
from bzrlib.progress import (
 
23
    ProgressTask,
 
24
    )
 
25
from bzrlib.symbol_versioning import (
 
26
    deprecated_in,
 
27
    )
20
28
from bzrlib.tests import TestCase
21
 
 
22
 
class FakeStack:
23
 
    def __init__(self, top):
24
 
        self.__top = top
25
 
 
26
 
    def top(self):
27
 
        return self.__top
28
 
 
29
 
class TestProgress(TestCase):
30
 
    def setUp(self):
31
 
        q = DummyProgress()
32
 
        self.top = ChildProgress(_stack=FakeStack(q))
33
 
 
34
 
    def test_propogation(self):
35
 
        self.top.update('foobles', 1, 2)
36
 
        self.assertEqual(self.top.message, 'foobles')
37
 
        self.assertEqual(self.top.current, 1)
38
 
        self.assertEqual(self.top.total, 2)
39
 
        self.assertEqual(self.top.child_fraction, 0)
40
 
        child = ChildProgress(_stack=FakeStack(self.top))
41
 
        child.update('baubles', 2, 4)
42
 
        self.assertEqual(self.top.message, 'foobles')
43
 
        self.assertEqual(self.top.current, 1)
44
 
        self.assertEqual(self.top.total, 2)
45
 
        self.assertEqual(self.top.child_fraction, 0.5)
46
 
        grandchild = ChildProgress(_stack=FakeStack(child))
47
 
        grandchild.update('barbells', 1, 2)
48
 
        self.assertEqual(self.top.child_fraction, 0.625)
49
 
        self.assertEqual(child.child_fraction, 0.5)
50
 
        child.update('baubles', 3, 4)
51
 
        self.assertEqual(child.child_fraction, 0)
52
 
        self.assertEqual(self.top.child_fraction, 0.75)
53
 
        grandchild.update('barbells', 1, 2)
54
 
        self.assertEqual(self.top.child_fraction, 0.875)
55
 
        grandchild.update('barbells', 2, 2)
56
 
        self.assertEqual(self.top.child_fraction, 1)
57
 
        child.update('baubles', 4, 4)
58
 
        self.assertEqual(self.top.child_fraction, 1)
59
 
        #test clamping
60
 
        grandchild.update('barbells', 2, 2)
61
 
        self.assertEqual(self.top.child_fraction, 1)
62
 
 
63
 
    def test_implementations(self):
64
 
        for implementation in (TTYProgressBar, DotsProgressBar, 
65
 
                               DummyProgress):
66
 
            self.check_parent_handling(implementation)
67
 
 
68
 
    def check_parent_handling(self, parentclass):
69
 
        top = parentclass(to_file=StringIO())
70
 
        top.update('foobles', 1, 2)
71
 
        child = ChildProgress(_stack=FakeStack(top))
72
 
        child.update('baubles', 4, 4)
73
 
        top.update('lala', 2, 2)
74
 
        child.update('baubles', 4, 4)
75
 
 
76
 
    def test_stacking(self):
77
 
        self.check_stack(TTYProgressBar, ChildProgress)
78
 
        self.check_stack(DotsProgressBar, ChildProgress)
79
 
        self.check_stack(DummyProgress, DummyProgress)
80
 
 
81
 
    def check_stack(self, parent_class, child_class):
82
 
        stack = ProgressBarStack(klass=parent_class, to_file=StringIO())
83
 
        parent = stack.get_nested()
84
 
        try:
85
 
            self.assertIs(parent.__class__, parent_class)
86
 
            child = stack.get_nested()
87
 
            try:
88
 
                self.assertIs(child.__class__, child_class)
89
 
            finally:
90
 
                child.finished()
91
 
        finally:
92
 
            parent.finished()
 
29
from bzrlib.ui.text import (
 
30
    TextProgressView,
 
31
    )
 
32
 
 
33
 
 
34
class _TTYStringIO(StringIO):
 
35
    """A helper class which makes a StringIO look like a terminal"""
 
36
 
 
37
    def isatty(self):
 
38
        return True
 
39
 
 
40
 
 
41
class _NonTTYStringIO(StringIO):
 
42
    """Helper that implements isatty() but returns False"""
 
43
 
 
44
    def isatty(self):
 
45
        return False
 
46
 
 
47
 
 
48
class TestTextProgressView(TestCase):
 
49
    """Tests for text display of progress bars.
 
50
 
 
51
    These try to exercise the progressview independently of its construction,
 
52
    which is arranged by the TextUIFactory.
 
53
    """
 
54
    # The ProgressTask now connects directly to the ProgressView, so we can
 
55
    # check them independently of the factory or of the determination of what
 
56
    # view to use.
 
57
    
 
58
    def make_view(self):
 
59
        out = StringIO()
 
60
        view = TextProgressView(out)
 
61
        view._width = 80
 
62
        return out, view
 
63
    
 
64
    def make_task(self, parent_task, view, msg, curr, total):
 
65
        # would normally be done by UIFactory; is done here so that we don't
 
66
        # have to have one.
 
67
        task = ProgressTask(parent_task, progress_view=view)
 
68
        task.msg = msg
 
69
        task.current_cnt = curr
 
70
        task.total_cnt = total
 
71
        return task
 
72
 
 
73
    def test_render_progress_no_bar(self):
 
74
        """The default view now has a spinner but no bar."""
 
75
        out, view = self.make_view()
 
76
        # view.enable_bar = False
 
77
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
78
        view.show_progress(task)
 
79
        self.assertEqual(
 
80
'\r/ reticulating splines 5/20                                                    \r'
 
81
            , out.getvalue())
 
82
 
 
83
    def test_render_progress_easy(self):
 
84
        """Just one task and one quarter done"""
 
85
        out, view = self.make_view()
 
86
        view.enable_bar = True
 
87
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
88
        view.show_progress(task)
 
89
        self.assertEqual(
 
90
'\r[####/               ] reticulating splines 5/20                               \r'
 
91
            , out.getvalue())
 
92
 
 
93
    def test_render_progress_nested(self):
 
94
        """Tasks proportionally contribute to overall progress"""
 
95
        out, view = self.make_view()
 
96
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
 
97
        task2 = self.make_task(task, view, 'stage2', 1, 2)
 
98
        view.show_progress(task2)
 
99
        view.enable_bar = True
 
100
        # so we're in the first half of the main task, and half way through
 
101
        # that
 
102
        self.assertEqual(
 
103
r'[####-               ] reticulating splines:stage2 1/2'
 
104
            , view._render_line())
 
105
        # if the nested task is complete, then we're all the way through the
 
106
        # first half of the overall work
 
107
        task2.update('stage2', 2, 2)
 
108
        self.assertEqual(
 
109
r'[#########\          ] reticulating splines:stage2 2/2'
 
110
            , view._render_line())
 
111
 
 
112
    def test_render_progress_sub_nested(self):
 
113
        """Intermediate tasks don't mess up calculation."""
 
114
        out, view = self.make_view()
 
115
        view.enable_bar = True
 
116
        task_a = ProgressTask(None, progress_view=view)
 
117
        task_a.update('a', 0, 2)
 
118
        task_b = ProgressTask(task_a, progress_view=view)
 
119
        task_b.update('b')
 
120
        task_c = ProgressTask(task_b, progress_view=view)
 
121
        task_c.update('c', 1, 2)
 
122
        # the top-level task is in its first half; the middle one has no
 
123
        # progress indication, just a label; and the bottom one is half done,
 
124
        # so the overall fraction is 1/4
 
125
        self.assertEqual(
 
126
            r'[####|               ] a:b:c 1/2'
 
127
            , view._render_line())