/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: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

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-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
 
import codecs
18
 
import io
19
 
 
20
 
from ..progress import (
 
17
 
 
18
import os
 
19
from StringIO import StringIO
 
20
 
 
21
from bzrlib import errors
 
22
from bzrlib.progress import (
21
23
    ProgressTask,
22
24
    )
23
 
from ..ui.text import (
 
25
from bzrlib.symbol_versioning import (
 
26
    deprecated_in,
 
27
    )
 
28
from bzrlib.tests import TestCase
 
29
from bzrlib.ui.text import (
24
30
    TextProgressView,
25
31
    )
26
32
 
27
 
from .. import (
28
 
    tests,
29
 
    )
30
 
from . import (
31
 
    ui_testing,
32
 
    )
33
 
 
34
 
 
35
 
class TestTextProgressView(tests.TestCase):
 
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):
36
49
    """Tests for text display of progress bars.
37
50
 
38
51
    These try to exercise the progressview independently of its construction,
41
54
    # The ProgressTask now connects directly to the ProgressView, so we can
42
55
    # check them independently of the factory or of the determination of what
43
56
    # view to use.
44
 
 
45
 
    def make_view_only(self, out, width=79):
 
57
    
 
58
    def make_view(self):
 
59
        out = StringIO()
46
60
        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
 
 
 
61
        view._width = 80
 
62
        return out, view
 
63
    
54
64
    def make_task(self, parent_task, view, msg, curr, total):
55
65
        # would normally be done by UIFactory; is done here so that we don't
56
66
        # have to have one.
60
70
        task.total_cnt = total
61
71
        return task
62
72
 
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
73
    def test_render_progress_no_bar(self):
78
74
        """The default view now has a spinner but no bar."""
79
75
        out, view = self.make_view()
81
77
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
82
78
        view.show_progress(task)
83
79
        self.assertEqual(
84
 
            '\r/ reticulating splines 5/20                                                    \r', out.getvalue())
 
80
'\r/ reticulating splines 5/20                                                    \r'
 
81
            , out.getvalue())
85
82
 
86
83
    def test_render_progress_easy(self):
87
84
        """Just one task and one quarter done"""
90
87
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
91
88
        view.show_progress(task)
92
89
        self.assertEqual(
93
 
            '\r[####/               ] reticulating splines 5/20                               \r', out.getvalue())
 
90
'\r[####/               ] reticulating splines 5/20                               \r'
 
91
            , out.getvalue())
94
92
 
95
93
    def test_render_progress_nested(self):
96
94
        """Tasks proportionally contribute to overall progress"""
102
100
        # so we're in the first half of the main task, and half way through
103
101
        # that
104
102
        self.assertEqual(
105
 
            '[####-               ] reticulating splines:stage2 1/2                         ', view._render_line())
 
103
r'[####-               ] reticulating splines:stage2 1/2'
 
104
            , view._render_line())
106
105
        # if the nested task is complete, then we're all the way through the
107
106
        # first half of the overall work
108
107
        task2.update('stage2', 2, 2)
109
108
        self.assertEqual(
110
 
            '[#########\\          ] reticulating splines:stage2 2/2                         ', view._render_line())
 
109
r'[#########\          ] reticulating splines:stage2 2/2'
 
110
            , view._render_line())
111
111
 
112
112
    def test_render_progress_sub_nested(self):
113
113
        """Intermediate tasks don't mess up calculation."""
123
123
        # progress indication, just a label; and the bottom one is half done,
124
124
        # so the overall fraction is 1/4
125
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())
 
126
            r'[####|               ] a:b:c 1/2'
 
127
            , view._render_line())