← 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: Vincent Ladeuil
  • Date: 2016-01-21 11:42:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6610.
  • Revision ID: v.ladeuil+lp@free.fr-20160121114223-ngcvndi02ydiqs5z
Allow hyphens in option names to unbreak compatibility.

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-2011 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
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
 
import os
19
 
from StringIO import StringIO
 
18
from cStringIO import StringIO
20
19
 
21
 
from bzrlib import errors
 
20
from bzrlib import (
 
21
    tests,
 
22
    )
22
23
from bzrlib.progress import (
23
24
    ProgressTask,
24
25
    )
25
 
from bzrlib.symbol_versioning import (
26
 
    deprecated_in,
27
 
    )
28
 
from bzrlib.tests import TestCase
29
26
from bzrlib.ui.text import (
30
27
    TextProgressView,
31
28
    )
32
29
 
33
30
 
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):
 
31
class TestTextProgressView(tests.TestCase):
49
32
    """Tests for text display of progress bars.
50
33
 
51
34
    These try to exercise the progressview independently of its construction,
54
37
    # The ProgressTask now connects directly to the ProgressView, so we can
55
38
    # check them independently of the factory or of the determination of what
56
39
    # view to use.
57
 
    
 
40
 
 
41
    def make_view_only(self, out, width=79):
 
42
        view = TextProgressView(out)
 
43
        view._avail_width = lambda: width
 
44
        return view
 
45
 
58
46
    def make_view(self):
59
47
        out = StringIO()
60
 
        view = TextProgressView(out)
61
 
        view._width = 80
62
 
        return out, view
63
 
    
 
48
        return out, self.make_view_only(out)
 
49
 
64
50
    def make_task(self, parent_task, view, msg, curr, total):
65
51
        # would normally be done by UIFactory; is done here so that we don't
66
52
        # have to have one.
70
56
        task.total_cnt = total
71
57
        return task
72
58
 
 
59
    def test_clear(self):
 
60
        # <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
 
61
        # send spaces to clear the line
 
62
        out, view = self.make_view()
 
63
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
64
        view.show_progress(task)
 
65
        self.assertEqual(
 
66
'\r/ reticulating splines 5/20                                                    \r'
 
67
            , out.getvalue())
 
68
        view.clear()
 
69
        self.assertEqual(
 
70
'\r/ reticulating splines 5/20                                                    \r'
 
71
            + '\r' + 79 * ' ' + '\r',
 
72
            out.getvalue())
 
73
 
73
74
    def test_render_progress_no_bar(self):
74
75
        """The default view now has a spinner but no bar."""
75
76
        out, view = self.make_view()
100
101
        # so we're in the first half of the main task, and half way through
101
102
        # that
102
103
        self.assertEqual(
103
 
r'[####-               ] reticulating splines:stage2 1/2'
 
104
'[####-               ] reticulating splines:stage2 1/2                         '
104
105
            , view._render_line())
105
106
        # if the nested task is complete, then we're all the way through the
106
107
        # first half of the overall work
107
108
        task2.update('stage2', 2, 2)
108
109
        self.assertEqual(
109
 
r'[#########\          ] reticulating splines:stage2 2/2'
 
110
'[#########\          ] reticulating splines:stage2 2/2                         '
110
111
            , view._render_line())
111
112
 
112
113
    def test_render_progress_sub_nested(self):
123
124
        # progress indication, just a label; and the bottom one is half done,
124
125
        # so the overall fraction is 1/4
125
126
        self.assertEqual(
126
 
            r'[####|               ] a:b:c 1/2'
 
127
'[####|               ] a:b:c 1/2                                               '
127
128
            , view._render_line())
 
129
 
 
130
    def test_render_truncated(self):
 
131
        # when the bar is too long for the terminal, we prefer not to truncate
 
132
        # the counters because they might be interesting, and because
 
133
        # truncating the numbers might be misleading
 
134
        out, view = self.make_view()
 
135
        task_a = ProgressTask(None, progress_view=view)
 
136
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
137
        line = view._render_line()
 
138
        self.assertEqual(
 
139
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
140
           line) 
 
141
        self.assertEqual(len(line), 79)
 
142
 
 
143
 
 
144
    def test_render_with_activity(self):
 
145
        # if the progress view has activity, it's shown before the spinner
 
146
        out, view = self.make_view()
 
147
        task_a = ProgressTask(None, progress_view=view)
 
148
        view._last_transport_msg = '   123kB   100kB/s '
 
149
        line = view._render_line()
 
150
        self.assertEqual(
 
151
'   123kB   100kB/s /                                                           ',
 
152
           line) 
 
153
        self.assertEqual(len(line), 79)
 
154
 
 
155
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
156
        view._last_transport_msg = '   123kB   100kB/s '
 
157
        line = view._render_line()
 
158
        self.assertEqual(
 
159
'   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
160
           line) 
 
161
        self.assertEqual(len(line), 79)
 
162
 
 
163
    def test_render_progress_unicode_enc_utf8(self):
 
164
        out = tests.StringIOWrapper()
 
165
        out.encoding = "utf-8"
 
166
        view = self.make_view_only(out, 20)
 
167
        task = self.make_task(None, view, u"\xa7", 0, 1)
 
168
        view.show_progress(task)
 
169
        self.assertEqual('\r/ \xc2\xa7 0/1            \r',
 
170
            out.getvalue())
 
171
 
 
172
    def test_render_progress_unicode_enc_missing(self):
 
173
        out = StringIO()
 
174
        self.assertRaises(AttributeError, getattr, out, "encoding")
 
175
        view = self.make_view_only(out, 20)
 
176
        task = self.make_task(None, view, u"\xa7", 0, 1)
 
177
        view.show_progress(task)
 
178
        self.assertEqual('\r/ ? 0/1             \r',
 
179
            out.getvalue())
 
180
 
 
181
    def test_render_progress_unicode_enc_none(self):
 
182
        out = tests.StringIOWrapper()
 
183
        out.encoding = None
 
184
        view = self.make_view_only(out, 20)
 
185
        task = self.make_task(None, view, u"\xa7", 0, 1)
 
186
        view.show_progress(task)
 
187
        self.assertEqual('\r/ ? 0/1             \r',
 
188
            out.getvalue())