← 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: Martin Pool
  • Date: 2009-06-05 22:46:47 UTC
  • mto: This revision was merged to the branch mainline in revision 4418.
  • Revision ID: mbp@sourcefrog.net-20090605224647-k03yoq55uw1qhwvi
Remove ProgressBarStack and its tests deprecated since 1.12

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_progress.py
23
23
        ChildProgress,
24
24
        TTYProgressBar,
25
25
        DotsProgressBar,
26
 
        ProgressBarStack,
27
26
        InstrumentedProgress,
28
27
        )
29
28
from bzrlib.tests import TestCase
104
103
        top.update('lala', 2, 2)
105
104
        child.update('baubles', 4, 4)
106
105
 
107
 
    def test_stacking(self):
108
 
        self.check_stack(TTYProgressBar, ChildProgress)
109
 
        self.check_stack(DotsProgressBar, ChildProgress)
110
 
        self.check_stack(DummyProgress, DummyProgress)
111
 
 
112
 
    def check_stack(self, parent_class, child_class):
113
 
        stack = self.applyDeprecated(
114
 
            deprecated_in((1, 12, 0)),
115
 
            ProgressBarStack,
116
 
            klass=parent_class, to_file=StringIO())
117
 
        parent = stack.get_nested()
118
 
        try:
119
 
            self.assertIs(parent.__class__, parent_class)
120
 
            child = stack.get_nested()
121
 
            try:
122
 
                self.assertIs(child.__class__, child_class)
123
 
            finally:
124
 
                child.finished()
125
 
        finally:
126
 
            parent.finished()
127
 
 
128
106
    def test_throttling(self):
129
107
        pb = InstrumentedProgress(to_file=StringIO())
130
108
        # instantaneous updates should be squelched
189
167
            pb.update('x', count+100, 200)
190
168
 
191
169
        self.assertEqual(pb._max_last_updates, len(pb.last_updates))
192
 
 
193
 
 
194
 
class TestProgressTypes(TestCase):
195
 
    """Test that the right ProgressBar gets instantiated at the right time."""
196
 
 
197
 
    def get_nested(self, outf, term, env_progress=None):
198
 
        """Setup so that ProgressBar thinks we are in the supplied terminal."""
199
 
        orig_term = os.environ.get('TERM')
200
 
        orig_progress = os.environ.get('BZR_PROGRESS_BAR')
201
 
        os.environ['TERM'] = term
202
 
        if env_progress is not None:
203
 
            os.environ['BZR_PROGRESS_BAR'] = env_progress
204
 
        elif orig_progress is not None:
205
 
            del os.environ['BZR_PROGRESS_BAR']
206
 
 
207
 
        def reset():
208
 
            if orig_term is None:
209
 
                del os.environ['TERM']
210
 
            else:
211
 
                os.environ['TERM'] = orig_term
212
 
            # We may have never created BZR_PROGRESS_BAR
213
 
            # So we can't just delete like we can 'TERM' (which is always set)
214
 
            if orig_progress is None:
215
 
                if 'BZR_PROGRESS_BAR' in os.environ:
216
 
                    del os.environ['BZR_PROGRESS_BAR']
217
 
            else:
218
 
                os.environ['BZR_PROGRESS_BAR'] = orig_progress
219
 
 
220
 
        self.addCleanup(reset)
221
 
 
222
 
        stack = self.applyDeprecated(
223
 
            deprecated_in((1, 12, 0)),
224
 
            ProgressBarStack,
225
 
            to_file=outf)
226
 
        pb = stack.get_nested()
227
 
        pb.start_time -= 1 # Make sure it is ready to write
228
 
        pb.width = 20 # And it is of reasonable size
229
 
        return pb
230
 
 
231
 
    def test_tty_progress(self):
232
 
        # Make sure the ProgressBarStack thinks it is
233
 
        # writing out to a terminal, and thus uses a TTYProgressBar
234
 
        out = _TTYStringIO()
235
 
        pb = self.get_nested(out, 'xterm')
236
 
        self.assertIsInstance(pb, TTYProgressBar)
237
 
        try:
238
 
            pb.update('foo', 1, 2)
239
 
            pb.update('bar', 2, 2)
240
 
        finally:
241
 
            pb.finished()
242
 
 
243
 
        self.assertEqual('\r/ [====   ] foo 1/2'
244
 
                         '\r- [=======] bar 2/2'
245
 
                         '\r                   \r',
246
 
                         out.getvalue())
247
 
 
248
 
    def test_noninteractive_progress(self):
249
 
        out = _NonTTYStringIO()
250
 
        pb = self.get_nested(out, 'xterm')
251
 
        self.assertIsInstance(pb, DummyProgress)
252
 
        try:
253
 
            pb.update('foo', 1, 2)
254
 
            pb.update('bar', 2, 2)
255
 
        finally:
256
 
            pb.finished()
257
 
        self.assertEqual('', out.getvalue())
258
 
 
259
 
    def test_dots_progress(self):
260
 
        # make sure we get the right progress bar when not on a terminal
261
 
        out = _NonTTYStringIO()
262
 
        pb = self.get_nested(out, 'xterm', 'dots')
263
 
        self.assertIsInstance(pb, DotsProgressBar)
264
 
        try:
265
 
            pb.update('foo', 1, 2)
266
 
            pb.update('bar', 2, 2)
267
 
        finally:
268
 
            pb.finished()
269
 
        self.assertEqual('foo: .'
270
 
                         '\nbar: .'
271
 
                         '\n',
272
 
                         out.getvalue())
273
 
 
274
 
    def test_no_isatty_progress(self):
275
 
        # Make sure ProgressBarStack handles a plain StringIO()
276
 
        import cStringIO
277
 
        out = cStringIO.StringIO()
278
 
        pb = self.get_nested(out, 'xterm')
279
 
        pb.finished()
280
 
        self.assertIsInstance(pb, DummyProgress)
281
 
 
282
 
    def test_dumb_progress(self):
283
 
        # using a terminal that can't do cursor movement
284
 
        out = _TTYStringIO()
285
 
        pb = self.get_nested(out, 'dumb')
286
 
        pb.finished()
287
 
        self.assertIsInstance(pb, DummyProgress)
288
 
 
289
 
    def test_progress_env_tty(self):
290
 
        # The environ variable BZR_PROGRESS_BAR controls what type of
291
 
        # progress bar we will get, even if it wouldn't usually be that type
292
 
        import cStringIO
293
 
 
294
 
        # Usually, this would be a DotsProgressBar
295
 
        out = cStringIO.StringIO()
296
 
        pb = self.get_nested(out, 'dumb', 'tty')
297
 
        pb.finished()
298
 
        # Even though we are not a tty, the env_var will override
299
 
        self.assertIsInstance(pb, TTYProgressBar)
300
 
 
301
 
    def test_progress_env_none(self):
302
 
        # Even though we are in a valid tty, no progress
303
 
        out = _TTYStringIO()
304
 
        pb = self.get_nested(out, 'xterm', 'none')
305
 
        pb.finished()
306
 
        self.assertIsInstance(pb, DummyProgress)
307
 
 
308
 
    def test_progress_env_invalid(self):
309
 
        out = _TTYStringIO()
310
 
        self.assertRaises(errors.InvalidProgressBarType, self.get_nested,
311
 
            out, 'xterm', 'nonexistant')