/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: Vincent Ladeuil
  • Date: 2012-01-18 14:09:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6468.
  • Revision ID: v.ladeuil+lp@free.fr-20120118140919-rlvdrhpc0nq1lbwi
Change set/remove to require a lock for the branch config files.

This means that tests (or any plugin for that matter) do not requires an
explicit lock on the branch anymore to change a single option. This also
means the optimisation becomes "opt-in" and as such won't be as
spectacular as it may be and/or harder to get right (nothing fails
anymore).

This reduces the diff by ~300 lines.

Code/tests that were updating more than one config option is still taking
a lock to at least avoid some IOs and demonstrate the benefits through
the decreased number of hpss calls.

The duplication between BranchStack and BranchOnlyStack will be removed
once the same sharing is in place for local config files, at which point
the Stack class itself may be able to host the changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/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
 
 
18
from StringIO import StringIO
 
19
 
 
20
from bzrlib.progress import (
 
21
    ProgressTask,
 
22
    )
 
23
from bzrlib.tests import TestCase
 
24
from bzrlib.ui.text import (
 
25
    TextProgressView,
 
26
    )
 
27
 
 
28
 
 
29
class _TTYStringIO(StringIO):
 
30
    """A helper class which makes a StringIO look like a terminal"""
 
31
 
 
32
    def isatty(self):
 
33
        return True
 
34
 
 
35
 
 
36
class _NonTTYStringIO(StringIO):
 
37
    """Helper that implements isatty() but returns False"""
 
38
 
 
39
    def isatty(self):
 
40
        return False
 
41
 
 
42
 
 
43
class TestTextProgressView(TestCase):
 
44
    """Tests for text display of progress bars.
 
45
 
 
46
    These try to exercise the progressview independently of its construction,
 
47
    which is arranged by the TextUIFactory.
 
48
    """
 
49
    # The ProgressTask now connects directly to the ProgressView, so we can
 
50
    # check them independently of the factory or of the determination of what
 
51
    # view to use.
 
52
    
 
53
    def make_view(self):
 
54
        out = StringIO()
 
55
        view = TextProgressView(out)
 
56
        view._avail_width = lambda: 79
 
57
        return out, view
 
58
    
 
59
    def make_task(self, parent_task, view, msg, curr, total):
 
60
        # would normally be done by UIFactory; is done here so that we don't
 
61
        # have to have one.
 
62
        task = ProgressTask(parent_task, progress_view=view)
 
63
        task.msg = msg
 
64
        task.current_cnt = curr
 
65
        task.total_cnt = total
 
66
        return task
 
67
 
 
68
    def test_clear(self):
 
69
        # <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
 
70
        # send spaces to clear the line
 
71
        out, view = self.make_view()
 
72
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
73
        view.show_progress(task)
 
74
        self.assertEqual(
 
75
'\r/ reticulating splines 5/20                                                    \r'
 
76
            , out.getvalue())
 
77
        view.clear()
 
78
        self.assertEqual(
 
79
'\r/ reticulating splines 5/20                                                    \r'
 
80
            + '\r' + 79 * ' ' + '\r',
 
81
            out.getvalue())
 
82
 
 
83
    def test_render_progress_no_bar(self):
 
84
        """The default view now has a spinner but no bar."""
 
85
        out, view = self.make_view()
 
86
        # view.enable_bar = False
 
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_easy(self):
 
94
        """Just one task and one quarter done"""
 
95
        out, view = self.make_view()
 
96
        view.enable_bar = True
 
97
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
98
        view.show_progress(task)
 
99
        self.assertEqual(
 
100
'\r[####/               ] reticulating splines 5/20                               \r'
 
101
            , out.getvalue())
 
102
 
 
103
    def test_render_progress_nested(self):
 
104
        """Tasks proportionally contribute to overall progress"""
 
105
        out, view = self.make_view()
 
106
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
 
107
        task2 = self.make_task(task, view, 'stage2', 1, 2)
 
108
        view.show_progress(task2)
 
109
        view.enable_bar = True
 
110
        # so we're in the first half of the main task, and half way through
 
111
        # that
 
112
        self.assertEqual(
 
113
'[####-               ] reticulating splines:stage2 1/2                         '
 
114
            , view._render_line())
 
115
        # if the nested task is complete, then we're all the way through the
 
116
        # first half of the overall work
 
117
        task2.update('stage2', 2, 2)
 
118
        self.assertEqual(
 
119
'[#########\          ] reticulating splines:stage2 2/2                         '
 
120
            , view._render_line())
 
121
 
 
122
    def test_render_progress_sub_nested(self):
 
123
        """Intermediate tasks don't mess up calculation."""
 
124
        out, view = self.make_view()
 
125
        view.enable_bar = True
 
126
        task_a = ProgressTask(None, progress_view=view)
 
127
        task_a.update('a', 0, 2)
 
128
        task_b = ProgressTask(task_a, progress_view=view)
 
129
        task_b.update('b')
 
130
        task_c = ProgressTask(task_b, progress_view=view)
 
131
        task_c.update('c', 1, 2)
 
132
        # the top-level task is in its first half; the middle one has no
 
133
        # progress indication, just a label; and the bottom one is half done,
 
134
        # so the overall fraction is 1/4
 
135
        self.assertEqual(
 
136
'[####|               ] a:b:c 1/2                                               '
 
137
            , view._render_line())
 
138
 
 
139
    def test_render_truncated(self):
 
140
        # when the bar is too long for the terminal, we prefer not to truncate
 
141
        # the counters because they might be interesting, and because
 
142
        # truncating the numbers might be misleading
 
143
        out, view = self.make_view()
 
144
        task_a = ProgressTask(None, progress_view=view)
 
145
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
146
        line = view._render_line()
 
147
        self.assertEqual(
 
148
'- start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
149
           line) 
 
150
        self.assertEqual(len(line), 79)
 
151
 
 
152
 
 
153
    def test_render_with_activity(self):
 
154
        # if the progress view has activity, it's shown before the spinner
 
155
        out, view = self.make_view()
 
156
        task_a = ProgressTask(None, progress_view=view)
 
157
        view._last_transport_msg = '   123kB   100kB/s '
 
158
        line = view._render_line()
 
159
        self.assertEqual(
 
160
'   123kB   100kB/s /                                                           ',
 
161
           line) 
 
162
        self.assertEqual(len(line), 79)
 
163
 
 
164
        task_a.update('start_' + 'a' * 200 + '_end', 2000, 5000)
 
165
        view._last_transport_msg = '   123kB   100kB/s '
 
166
        line = view._render_line()
 
167
        self.assertEqual(
 
168
'   123kB   100kB/s \\ start_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.. 2000/5000',
 
169
           line) 
 
170
        self.assertEqual(len(line), 79)