# Copyright (C) 2009, Tutorius.org
# Copyright (C) 2009, Michael Janelle-Montcalm <michael.jmontcalm@gmail.com>
# Copyright (C) 2009, Vincent Vinet <vince.vinet@gmail.com>
#
# 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
"""
Action tests

The behavior of the actions must be tested here.
"""

import unittest
import gtk

from sugar.tutorius.actions import *
from sugar.tutorius.services import ObjectStore

class PropertyAction(Action):
    def __init__(self, na):
        self._a = na
    
    def set_a(self, na):
        self._a = na
        
    def get_a(self):
        return self._a
    
    a = property(fget=get_a, fset=set_a)
    
class PropsTest(unittest.TestCase):
    
    def test_get_properties(self):
        prop = PropertyAction(8)
        
        assert prop.get_properties() == ['a'], "Action does not contain property 'a'"
    
class CountAction(Action):
    """
    This action counts how many times it's do and undo methods get called
    """
    def __init__(self):
        self.do_count = 0
        self.undo_count = 0

    def do(self):
        self.do_count += 1

    def undo(self):
        self.undo_count += 1


class BaseActionTests(unittest.TestCase):
    def test_do_unimplemented(self):
        act = Action()
        try:
            act.do()
            assert False, "do() should trigger a NotImplemented"
        except NotImplementedError:
            assert True, "do() should trigger a NotImplemented"

    def test_undo(self):
        act = Action()
        act.undo()
        assert True, "undo() should never fail on the base action"


class OnceWrapperTests(unittest.TestCase):
    def test_onceaction_toggle(self):
        """
        Validate that the OnceWrapper wrapper works properly using the
        CountAction
        """
        act = CountAction()
        wrap = OnceWrapper(act)

        assert act.do_count == 0, "do() should not have been called in __init__()"
        assert act.undo_count == 0, "undo() should not have been called in __init__()"

        wrap.undo()

        assert act.undo_count == 0, "undo() should not be called if do() has not been called"

        wrap.do()
        assert act.do_count == 1, "do() should have been called once"

        wrap.do()
        assert act.do_count == 1, "do() should have been called only once"

        wrap.undo()
        assert act.undo_count == 1, "undo() should have been called once"

        wrap.undo()
        assert act.undo_count == 1, "undo() should have been called only once"

class ChainTester(Action):
    def __init__(self, witness):
        self._witness = witness

    def do(self, **kwargs):
        self._witness.append([self,"do"])

    def undo(self):
        self._witness.append([self,"undo"])

class ChainActionTest(unittest.TestCase):
    """Tester for ChainAction"""
    def test_empty(self):
        """If the expected empty behavior (do nothing) changes 
        and starts throwing exceptions, this will flag it"""
        a = ChainAction()
        a.do()
        a.undo()

    def test_order(self):
        witness = []
        first = ChainTester(witness)
        second = ChainTester(witness)

        c = ChainAction(first, second)
        assert witness == [], "Actions should not be triggered on init"""
        c.do()

        assert witness[0][0] is first, "First triggered action must be 'first'"
        assert witness[0][1] is "do", "Action do() should be triggered"

        assert witness[1][0] is second, "second triggered action must be 'second'"
        assert witness[1][1] is "do", "Action do() should be triggered"

        assert len(witness) is 2, "Two actions should give 2 do's"

        #empty the witness list
        while len(witness):
            rm = witness.pop()

        c.undo()
        assert witness[1][0] is first, "second triggered action must be 'first'"
        assert witness[1][1] is "undo", "Action undo() should be triggered"

        assert witness[0][0] is second, "first triggered action must be 'second'"
        assert witness[0][1] is "undo", "Action undo() should be triggered"

        assert len(witness) is 2, "Two actions should give 2 undo's"

        
if __name__ == "__main__":
    unittest.main()