← 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: Martin Pool
  • Date: 2010-07-21 09:58:42 UTC
  • mfrom: (4797.58.7 2.1)
  • mto: (5050.3.13 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: mbp@canonical.com-20100721095842-hz0obu8gl0x05nty
merge up 2.1 to 2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
1
 
# Copyright (C) 2006, 2007, 2009 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
17
18
import os
18
19
from StringIO import StringIO
19
20
 
20
21
from bzrlib import errors
21
 
from bzrlib.tests import TestCase
 
22
from bzrlib.progress import (
 
23
    ProgressTask,
 
24
    )
22
25
from bzrlib.symbol_versioning import (
23
26
    deprecated_in,
24
27
    )
 
28
from bzrlib.tests import TestCase
 
29
from bzrlib.ui.text import (
 
30
    TextProgressView,
 
31
    )
25
32
 
26
33
 
27
34
class _TTYStringIO(StringIO):
36
43
 
37
44
    def isatty(self):
38
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._avail_width = lambda: 79
 
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
'[####-               ] 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
'[#########\          ] 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
'[####|               ] a:b:c 1/2                                               '
 
127
            , view._render_line())
 
128
 
 
129
    def test_render_truncated(self):
 
130
        # when the bar is too long for the terminal, we prefer not to truncate
 
131
        # the counters because they might be interesting, and because
 
132
        # truncating the numbers might be misleading
 
133
        out, view = self.make_view()
 
134
        task_a = ProgressTask(None, progress_view=view)
 
135
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
136
        line = view._render_line()
 
137
        self.assertEqual(
 
138
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
139
           line) 
 
140
        self.assertEqual(len(line), 79)
 
141
 
 
142
 
 
143
    def test_render_with_activity(self):
 
144
        # if the progress view has activity, it's shown before the spinner
 
145
        out, view = self.make_view()
 
146
        task_a = ProgressTask(None, progress_view=view)
 
147
        view._last_transport_msg = '   123kB   100kB/s '
 
148
        line = view._render_line()
 
149
        self.assertEqual(
 
150
'   123kB   100kB/s /                                                           ',
 
151
           line) 
 
152
        self.assertEqual(len(line), 79)
 
153
 
 
154
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
155
        view._last_transport_msg = '   123kB   100kB/s '
 
156
        line = view._render_line()
 
157
        self.assertEqual(
 
158
'   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
159
           line) 
 
160
        self.assertEqual(len(line), 79)