/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 breezy/tests/test_progress.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-19 13:16:11 UTC
  • mto: (6968.4.3 git-archive)
  • mto: This revision was merged to the branch mainline in revision 6972.
  • Revision ID: jelmer@jelmer.uk-20180519131611-l9h9ud41j7qg1m03
Move tar/zip to breezy.archive.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_progress.py
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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'
 
71
            , out.getvalue())
 
72
        view.clear()
 
73
        self.assertEqual(
 
74
'\r/ reticulating splines 5/20                                                    \r'
 
75
            + '\r' + 79 * ' ' + '\r',
 
76
            out.getvalue())
 
77
 
 
78
    def test_render_progress_no_bar(self):
 
79
        """The default view now has a spinner but no bar."""
 
80
        out, view = self.make_view()
 
81
        # view.enable_bar = False
 
82
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
83
        view.show_progress(task)
 
84
        self.assertEqual(
 
85
'\r/ reticulating splines 5/20                                                    \r'
 
86
            , out.getvalue())
 
87
 
 
88
    def test_render_progress_easy(self):
 
89
        """Just one task and one quarter done"""
 
90
        out, view = self.make_view()
 
91
        view.enable_bar = True
 
92
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
93
        view.show_progress(task)
 
94
        self.assertEqual(
 
95
'\r[####/               ] reticulating splines 5/20                               \r'
 
96
            , out.getvalue())
 
97
 
 
98
    def test_render_progress_nested(self):
 
99
        """Tasks proportionally contribute to overall progress"""
 
100
        out, view = self.make_view()
 
101
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
 
102
        task2 = self.make_task(task, view, 'stage2', 1, 2)
 
103
        view.show_progress(task2)
 
104
        view.enable_bar = True
 
105
        # so we're in the first half of the main task, and half way through
 
106
        # that
 
107
        self.assertEqual(
 
108
'[####-               ] reticulating splines:stage2 1/2                         '
 
109
            , view._render_line())
 
110
        # if the nested task is complete, then we're all the way through the
 
111
        # first half of the overall work
 
112
        task2.update('stage2', 2, 2)
 
113
        self.assertEqual(
 
114
'[#########\\          ] reticulating splines:stage2 2/2                         '
 
115
            , view._render_line())
 
116
 
 
117
    def test_render_progress_sub_nested(self):
 
118
        """Intermediate tasks don't mess up calculation."""
 
119
        out, view = self.make_view()
 
120
        view.enable_bar = True
 
121
        task_a = ProgressTask(None, progress_view=view)
 
122
        task_a.update('a', 0, 2)
 
123
        task_b = ProgressTask(task_a, progress_view=view)
 
124
        task_b.update('b')
 
125
        task_c = ProgressTask(task_b, progress_view=view)
 
126
        task_c.update('c', 1, 2)
 
127
        # the top-level task is in its first half; the middle one has no
 
128
        # progress indication, just a label; and the bottom one is half done,
 
129
        # so the overall fraction is 1/4
 
130
        self.assertEqual(
 
131
'[####|               ] a:b:c 1/2                                               '
 
132
            , view._render_line())
 
133
 
 
134
    def test_render_truncated(self):
 
135
        # when the bar is too long for the terminal, we prefer not to truncate
 
136
        # the counters because they might be interesting, and because
 
137
        # truncating the numbers might be misleading
 
138
        out, view = self.make_view()
 
139
        task_a = ProgressTask(None, progress_view=view)
 
140
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
141
        line = view._render_line()
 
142
        self.assertEqual(
 
143
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
144
           line) 
 
145
        self.assertEqual(len(line), 79)
 
146
 
 
147
 
 
148
    def test_render_with_activity(self):
 
149
        # if the progress view has activity, it's shown before the spinner
 
150
        out, view = self.make_view()
 
151
        task_a = ProgressTask(None, progress_view=view)
 
152
        view._last_transport_msg = '   123kB   100kB/s '
 
153
        line = view._render_line()
 
154
        self.assertEqual(
 
155
'   123kB   100kB/s /                                                           ',
 
156
           line) 
 
157
        self.assertEqual(len(line), 79)
 
158
 
 
159
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
160
        view._last_transport_msg = '   123kB   100kB/s '
 
161
        line = view._render_line()
 
162
        self.assertEqual(
 
163
'   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
164
           line) 
 
165
        self.assertEqual(len(line), 79)
 
166
 
 
167
    def test_render_progress_unicode_enc_utf8(self):
 
168
        out = ui_testing.StringIOWithEncoding()
 
169
        out.encoding = "utf-8"
 
170
        view = self.make_view_only(out, 20)
 
171
        task = self.make_task(None, view, u"\xa7", 0, 1)
 
172
        view.show_progress(task)
 
173
        self.assertEqual(u'\r/ \xa7 0/1            \r', out.getvalue())
 
174
 
 
175
    def test_render_progress_unicode_enc_missing(self):
 
176
        out = codecs.getwriter("ascii")(io.BytesIO())
 
177
        self.assertRaises(AttributeError, getattr, out, "encoding")
 
178
        view = self.make_view_only(out, 20)
 
179
        task = self.make_task(None, view, u"\xa7", 0, 1)
 
180
        view.show_progress(task)
 
181
        self.assertEqual(b'\r/ ? 0/1             \r', out.getvalue())
 
182
 
 
183
    def test_render_progress_unicode_enc_none(self):
 
184
        out = ui_testing.StringIOWithEncoding()
 
185
        out.encoding = None
 
186
        view = self.make_view_only(out, 20)
 
187
        task = self.make_task(None, view, u"\xa7", 0, 1)
 
188
        view.show_progress(task)
 
189
        self.assertEqual(u'\r/ ? 0/1             \r', out.getvalue())