/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: Matthew Fuller
  • Date: 2009-07-25 15:21:25 UTC
  • mto: (4772.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4773.
  • Revision ID: fullermd@over-yonder.net-20090725152125-2mzil0setr85g0no
Adjust documentation in the user guide a bit to correspond to DWIM
revspecs.

This is untested, as I don't have the tools to build the docs.  It's
also really not as clean as it could be, and there are probably much
better ways to put this info in here.  But it's something.

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
 
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
import os
 
19
from StringIO import StringIO
 
20
 
 
21
from bzrlib import errors
 
22
from bzrlib.progress import (
 
23
    ProgressTask,
 
24
    )
 
25
from bzrlib.symbol_versioning import (
 
26
    deprecated_in,
 
27
    )
 
28
from bzrlib.tests import TestCase
 
29
from bzrlib.ui.text import (
 
30
    TextProgressView,
 
31
    )
 
32
 
 
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):
 
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._width = 80
 
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_easy(self):
 
74
        """Just one task and one quarter done"""
 
75
        out, view = self.make_view()
 
76
        task = self.make_task(None, view, 'reticulating splines', 5, 20)
 
77
        view.show_progress(task)
 
78
        self.assertEqual(
 
79
'\r[####/               ] reticulating splines 5/20                               \r'
 
80
            , out.getvalue())
 
81
 
 
82
    def test_render_progress_nested(self):
 
83
        """Tasks proportionally contribute to overall progress"""
 
84
        out, view = self.make_view()
 
85
        task = self.make_task(None, view, 'reticulating splines', 0, 2)
 
86
        task2 = self.make_task(task, view, 'stage2', 1, 2)
 
87
        view.show_progress(task2)
 
88
        # so we're in the first half of the main task, and half way through
 
89
        # that
 
90
        self.assertEqual(
 
91
r'[####-               ] reticulating splines:stage2 1/2'
 
92
            , view._render_line())
 
93
        # if the nested task is complete, then we're all the way through the
 
94
        # first half of the overall work
 
95
        task2.update('stage2', 2, 2)
 
96
        self.assertEqual(
 
97
r'[#########\          ] reticulating splines:stage2 2/2'
 
98
            , view._render_line())
 
99
 
 
100
    def test_render_progress_sub_nested(self):
 
101
        """Intermediate tasks don't mess up calculation."""
 
102
        out, view = self.make_view()
 
103
        task_a = ProgressTask(None, progress_view=view)
 
104
        task_a.update('a', 0, 2)
 
105
        task_b = ProgressTask(task_a, progress_view=view)
 
106
        task_b.update('b')
 
107
        task_c = ProgressTask(task_b, progress_view=view)
 
108
        task_c.update('c', 1, 2)
 
109
        # the top-level task is in its first half; the middle one has no
 
110
        # progress indication, just a label; and the bottom one is half done,
 
111
        # so the overall fraction is 1/4
 
112
        self.assertEqual(
 
113
            r'[####|               ] a:b:c 1/2'
 
114
            , view._render_line())