/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_progress.py

  • Committer: Alexander Belchenko
  • Date: 2006-06-29 08:41:31 UTC
  • mto: (1860.1.1 win32.installer)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060629084131-3ea4d44e3204e36f
win32 installer for bzr.dev.0.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
1
 
# Copyright (C) 2006-2011 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
 
import codecs
18
 
import io
19
 
 
20
 
from ..progress import (
21
 
    ProgressTask,
22
 
    )
23
 
from ..ui.text import (
24
 
    TextProgressView,
25
 
    )
26
 
 
27
 
from .. import (
28
 
    tests,
29
 
    )
30
 
from . import (
31
 
    ui_testing,
32
 
    )
33
 
 
34
 
 
35
 
class TestTextProgressView(tests.TestCase):
36
 
    """Tests for text display of progress bars.
37
 
 
38
 
    These try to exercise the progressview independently of its construction,
39
 
    which is arranged by the TextUIFactory.
40
 
    """
41
 
    # The ProgressTask now connects directly to the ProgressView, so we can
42
 
    # check them independently of the factory or of the determination of what
43
 
    # view to use.
44
 
 
45
 
    def make_view_only(self, out, width=79):
46
 
        view = TextProgressView(out)
47
 
        view._avail_width = lambda: width
48
 
        return view
49
 
 
50
 
    def make_view(self):
51
 
        out = ui_testing.StringIOWithEncoding()
52
 
        return out, self.make_view_only(out)
53
 
 
54
 
    def make_task(self, parent_task, view, msg, curr, total):
55
 
        # would normally be done by UIFactory; is done here so that we don't
56
 
        # have to have one.
57
 
        task = ProgressTask(parent_task, progress_view=view)
58
 
        task.msg = msg
59
 
        task.current_cnt = curr
60
 
        task.total_cnt = total
61
 
        return task
62
 
 
63
 
    def test_clear(self):
64
 
        # <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
65
 
        # send spaces to clear the line
66
 
        out, view = self.make_view()
67
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
68
 
        view.show_progress(task)
69
 
        self.assertEqual(
70
 
            '\r/ reticulating splines 5/20                                                    \r', out.getvalue())
71
 
        view.clear()
72
 
        self.assertEqual(
73
 
            '\r/ reticulating splines 5/20                                                    \r' +
74
 
            '\r' + 79 * ' ' + '\r',
75
 
            out.getvalue())
76
 
 
77
 
    def test_render_progress_no_bar(self):
78
 
        """The default view now has a spinner but no bar."""
79
 
        out, view = self.make_view()
80
 
        # view.enable_bar = False
81
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
82
 
        view.show_progress(task)
83
 
        self.assertEqual(
84
 
            '\r/ reticulating splines 5/20                                                    \r', out.getvalue())
85
 
 
86
 
    def test_render_progress_easy(self):
87
 
        """Just one task and one quarter done"""
88
 
        out, view = self.make_view()
89
 
        view.enable_bar = True
90
 
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
91
 
        view.show_progress(task)
92
 
        self.assertEqual(
93
 
            '\r[####/               ] reticulating splines 5/20                               \r', out.getvalue())
94
 
 
95
 
    def test_render_progress_nested(self):
96
 
        """Tasks proportionally contribute to overall progress"""
97
 
        out, view = self.make_view()
98
 
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
99
 
        task2 = self.make_task(task, view, 'stage2', 1, 2)
100
 
        view.show_progress(task2)
101
 
        view.enable_bar = True
102
 
        # so we're in the first half of the main task, and half way through
103
 
        # that
104
 
        self.assertEqual(
105
 
            '[####-               ] reticulating splines:stage2 1/2                         ', view._render_line())
106
 
        # if the nested task is complete, then we're all the way through the
107
 
        # first half of the overall work
108
 
        task2.update('stage2', 2, 2)
109
 
        self.assertEqual(
110
 
            '[#########\\          ] reticulating splines:stage2 2/2                         ', 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
 
            '[####|               ] a:b:c 1/2                                               ', view._render_line())
127
 
 
128
 
    def test_render_truncated(self):
129
 
        # when the bar is too long for the terminal, we prefer not to truncate
130
 
        # the counters because they might be interesting, and because
131
 
        # truncating the numbers might be misleading
132
 
        out, view = self.make_view()
133
 
        task_a = ProgressTask(None, progress_view=view)
134
 
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
135
 
        line = view._render_line()
136
 
        self.assertEqual(
137
 
            '- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
138
 
            line)
139
 
        self.assertEqual(len(line), 79)
140
 
 
141
 
    def test_render_with_activity(self):
142
 
        # if the progress view has activity, it's shown before the spinner
143
 
        out, view = self.make_view()
144
 
        task_a = ProgressTask(None, progress_view=view)
145
 
        view._last_transport_msg = '   123kB   100kB/s '
146
 
        line = view._render_line()
147
 
        self.assertEqual(
148
 
            '   123kB   100kB/s /                                                           ',
149
 
            line)
150
 
        self.assertEqual(len(line), 79)
151
 
 
152
 
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
153
 
        view._last_transport_msg = '   123kB   100kB/s '
154
 
        line = view._render_line()
155
 
        self.assertEqual(
156
 
            '   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
157
 
            line)
158
 
        self.assertEqual(len(line), 79)
159
 
 
160
 
    def test_render_progress_unicode_enc_utf8(self):
161
 
        out = ui_testing.StringIOWithEncoding()
162
 
        out.encoding = "utf-8"
163
 
        view = self.make_view_only(out, 20)
164
 
        task = self.make_task(None, view, u"\xa7", 0, 1)
165
 
        view.show_progress(task)
166
 
        self.assertEqual(u'\r/ \xa7 0/1            \r', out.getvalue())
167
 
 
168
 
    def test_render_progress_unicode_enc_missing(self):
169
 
        out = codecs.getwriter("ascii")(io.BytesIO())
170
 
        self.assertRaises(AttributeError, getattr, out, "encoding")
171
 
        view = self.make_view_only(out, 20)
172
 
        task = self.make_task(None, view, u"\xa7", 0, 1)
173
 
        view.show_progress(task)
174
 
        self.assertEqual(b'\r/ ? 0/1             \r', out.getvalue())
175
 
 
176
 
    def test_render_progress_unicode_enc_none(self):
177
 
        out = ui_testing.StringIOWithEncoding()
178
 
        out.encoding = None
179
 
        view = self.make_view_only(out, 20)
180
 
        task = self.make_task(None, view, u"\xa7", 0, 1)
181
 
        view.show_progress(task)
182
 
        self.assertEqual(u'\r/ ? 0/1             \r', out.getvalue())
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from StringIO import StringIO
 
18
 
 
19
from bzrlib.progress import (
 
20
        DummyProgress, ChildProgress,
 
21
        TTYProgressBar,
 
22
        DotsProgressBar,
 
23
        ProgressBarStack,
 
24
        )
 
25
from bzrlib.tests import TestCase
 
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)