← 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: Canonical.com Patch Queue Manager
  • Date: 2006-07-02 00:49:15 UTC
  • mfrom: (1706.2.8 bzr.dev.lsprof)
  • Revision ID: pqm@pqm.ubuntu.com-20060702004915-501855cc9fc14e10
(robey) updates for lsprof

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 by 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
import os
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
19
17
from StringIO import StringIO
20
18
 
21
 
from bzrlib import errors
22
19
from bzrlib.progress import (
23
 
    ProgressTask,
24
 
    )
25
 
from bzrlib.symbol_versioning import (
26
 
    deprecated_in,
27
 
    )
 
20
        DummyProgress, ChildProgress,
 
21
        TTYProgressBar,
 
22
        DotsProgressBar,
 
23
        ProgressBarStack,
 
24
        )
28
25
from bzrlib.tests import TestCase
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())
 
26
 
 
27
class FakeStack:
 
28
    def __init__(self, top):
 
29
        self.__top = top
 
30
 
 
31
    def top(self):
 
32
        return self.__top
 
33
 
 
34
class InstrumentedProgress(TTYProgressBar):
 
35
    """TTYProgress variant that tracks outcomes"""
 
36
 
 
37
    def __init__(self, *args, **kwargs):
 
38
        self.always_throttled = True
 
39
        TTYProgressBar.__init__(self, *args, **kwargs)
 
40
 
 
41
    def throttle(self, old_message):
 
42
        result = TTYProgressBar.throttle(self, old_message)
 
43
        if result is False:
 
44
            self.always_throttled = False
 
45
        
 
46
 
 
47
class TestProgress(TestCase):
 
48
    def setUp(self):
 
49
        q = DummyProgress()
 
50
        self.top = ChildProgress(_stack=FakeStack(q))
 
51
 
 
52
    def test_propogation(self):
 
53
        self.top.update('foobles', 1, 2)
 
54
        self.assertEqual(self.top.message, 'foobles')
 
55
        self.assertEqual(self.top.current, 1)
 
56
        self.assertEqual(self.top.total, 2)
 
57
        self.assertEqual(self.top.child_fraction, 0)
 
58
        child = ChildProgress(_stack=FakeStack(self.top))
 
59
        child.update('baubles', 2, 4)
 
60
        self.assertEqual(self.top.message, 'foobles')
 
61
        self.assertEqual(self.top.current, 1)
 
62
        self.assertEqual(self.top.total, 2)
 
63
        self.assertEqual(self.top.child_fraction, 0.5)
 
64
        grandchild = ChildProgress(_stack=FakeStack(child))
 
65
        grandchild.update('barbells', 1, 2)
 
66
        self.assertEqual(self.top.child_fraction, 0.625)
 
67
        self.assertEqual(child.child_fraction, 0.5)
 
68
        child.update('baubles', 3, 4)
 
69
        self.assertEqual(child.child_fraction, 0)
 
70
        self.assertEqual(self.top.child_fraction, 0.75)
 
71
        grandchild.update('barbells', 1, 2)
 
72
        self.assertEqual(self.top.child_fraction, 0.875)
 
73
        grandchild.update('barbells', 2, 2)
 
74
        self.assertEqual(self.top.child_fraction, 1)
 
75
        child.update('baubles', 4, 4)
 
76
        self.assertEqual(self.top.child_fraction, 1)
 
77
        #test clamping
 
78
        grandchild.update('barbells', 2, 2)
 
79
        self.assertEqual(self.top.child_fraction, 1)
 
80
 
 
81
    def test_implementations(self):
 
82
        for implementation in (TTYProgressBar, DotsProgressBar, 
 
83
                               DummyProgress):
 
84
            self.check_parent_handling(implementation)
 
85
 
 
86
    def check_parent_handling(self, parentclass):
 
87
        top = parentclass(to_file=StringIO())
 
88
        top.update('foobles', 1, 2)
 
89
        child = ChildProgress(_stack=FakeStack(top))
 
90
        child.update('baubles', 4, 4)
 
91
        top.update('lala', 2, 2)
 
92
        child.update('baubles', 4, 4)
 
93
 
 
94
    def test_stacking(self):
 
95
        self.check_stack(TTYProgressBar, ChildProgress)
 
96
        self.check_stack(DotsProgressBar, ChildProgress)
 
97
        self.check_stack(DummyProgress, DummyProgress)
 
98
 
 
99
    def check_stack(self, parent_class, child_class):
 
100
        stack = ProgressBarStack(klass=parent_class, to_file=StringIO())
 
101
        parent = stack.get_nested()
 
102
        try:
 
103
            self.assertIs(parent.__class__, parent_class)
 
104
            child = stack.get_nested()
 
105
            try:
 
106
                self.assertIs(child.__class__, child_class)
 
107
            finally:
 
108
                child.finished()
 
109
        finally:
 
110
            parent.finished()
 
111
 
 
112
    def test_throttling(self):
 
113
        pb = InstrumentedProgress(to_file=StringIO())
 
114
        # instantaneous updates should be squelched
 
115
        pb.update('me', 1, 1)
 
116
        self.assertTrue(pb.always_throttled)
 
117
        pb = InstrumentedProgress(to_file=StringIO())
 
118
        # It's like an instant sleep(1)!
 
119
        pb.start_time -= 1
 
120
        # Updates after a second should not be squelched
 
121
        pb.update('me', 1, 1)
 
122
        self.assertFalse(pb.always_throttled)