/brz/remove-bazaar

# Copyright (C) 2006 by Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

from StringIO import StringIO

from bzrlib.progress import (

        DummyProgress, ChildProgress,

        TTYProgressBar,

        DotsProgressBar,

        ProgressBarStack,

        )

from bzrlib.tests import TestCase

class FakeStack:

    def __init__(self, top):

        self.__top = top

    def top(self):

        return self.__top

class InstrumentedProgress(TTYProgressBar):

    """TTYProgress variant that tracks outcomes"""

    def __init__(self, *args, **kwargs):

        self.always_throttled = True

        TTYProgressBar.__init__(self, *args, **kwargs)

    def throttle(self, old_message):

        result = TTYProgressBar.throttle(self, old_message)

        if result is False:

            self.always_throttled = False

class TestProgress(TestCase):

    def setUp(self):

        q = DummyProgress()

        self.top = ChildProgress(_stack=FakeStack(q))

    def test_propogation(self):

        self.top.update('foobles', 1, 2)

        self.assertEqual(self.top.message, 'foobles')

        self.assertEqual(self.top.current, 1)

        self.assertEqual(self.top.total, 2)

        self.assertEqual(self.top.child_fraction, 0)

        child = ChildProgress(_stack=FakeStack(self.top))

        child.update('baubles', 2, 4)

        self.assertEqual(self.top.message, 'foobles')

        self.assertEqual(self.top.current, 1)

        self.assertEqual(self.top.total, 2)

        self.assertEqual(self.top.child_fraction, 0.5)

        grandchild = ChildProgress(_stack=FakeStack(child))

        grandchild.update('barbells', 1, 2)

        self.assertEqual(self.top.child_fraction, 0.625)

        self.assertEqual(child.child_fraction, 0.5)

        child.update('baubles', 3, 4)

        self.assertEqual(child.child_fraction, 0)

        self.assertEqual(self.top.child_fraction, 0.75)

        grandchild.update('barbells', 1, 2)

        self.assertEqual(self.top.child_fraction, 0.875)

        grandchild.update('barbells', 2, 2)

        self.assertEqual(self.top.child_fraction, 1)

        child.update('baubles', 4, 4)

        self.assertEqual(self.top.child_fraction, 1)

        #test clamping

        grandchild.update('barbells', 2, 2)

        self.assertEqual(self.top.child_fraction, 1)

    def test_implementations(self):

        for implementation in (TTYProgressBar, DotsProgressBar, 

                               DummyProgress):

            self.check_parent_handling(implementation)

    def check_parent_handling(self, parentclass):

        top = parentclass(to_file=StringIO())

        top.update('foobles', 1, 2)

        child = ChildProgress(_stack=FakeStack(top))

        child.update('baubles', 4, 4)

        top.update('lala', 2, 2)

        child.update('baubles', 4, 4)

    def test_stacking(self):

        self.check_stack(TTYProgressBar, ChildProgress)

        self.check_stack(DotsProgressBar, ChildProgress)

        self.check_stack(DummyProgress, DummyProgress)

    def check_stack(self, parent_class, child_class):

        stack = ProgressBarStack(klass=parent_class, to_file=StringIO())

        parent = stack.get_nested()

        try:

            self.assertIs(parent.__class__, parent_class)

            child = stack.get_nested()

            try:

                self.assertIs(child.__class__, child_class)

            finally:

                child.finished()

        finally:

            parent.finished()

    def test_throttling(self):

        pb = InstrumentedProgress(to_file=StringIO())

        # instantaneous updates should be squelched

        pb.update('me', 1, 1)

        self.assertTrue(pb.always_throttled)

        pb = InstrumentedProgress(to_file=StringIO())

        # It's like an instant sleep(1)!

        pb.start_time -= 1

        # Updates after a second should not be squelched

        pb.update('me', 1, 1)

        self.assertFalse(pb.always_throttled)