(LP 352437) Core : Completed basic serializer interactions with core

(actions, event filters) - needs tests
Also, merged branch 'mike' into jc_support

Conflicts:

	source/external/source/sugar-toolkit/src/sugar/tutorius/actions.py
	source/external/source/sugar-toolkit/src/sugar/tutorius/bundler.py
	source/external/source/sugar-toolkit/src/sugar/tutorius/tests/run-tests.py
	source/external/source/sugar-toolkit/src/sugar/tutorius/tests/serializertests.py

6 files changed, 190 insertions, 38 deletions

diff --git a/src/sugar/tutorius/tests/actiontests.py b/src/sugar/tutorius/tests/actiontests.py
index ab9cdba..6001ec7 100644
--- a/src/sugar/tutorius/tests/actiontests.py
+++ b/src/sugar/tutorius/tests/actiontests.py
@@ -27,24 +27,83 @@ import gtk
 from sugar.tutorius.actions import *
 from sugar.tutorius.services import ObjectStore
 
+test_props = {"prop_a":8, "prop_b":3, "prop_c":"Hi"}
+
 class PropertyAction(Action):
     def __init__(self, na):
-        self._a = na
+        Action.__init__(self)
+        self.prop_a = TIntProperty(test_props["prop_a"])
+        self.prop_b = TIntProperty(test_props["prop_b"])
+        self.prop_c = TStringProperty(test_props["prop_c"])
+
+def has_function(obj, function_name):
+        """
+        Checks whether the object has a function by that name.
+        """
+        if hasattr(obj, function_name) and hasattr(obj.__getattribute__(function_name), "__call__"):
+            return True
+        return False
+
+class PropsTest(unittest.TestCase):
+    def test_get_properties(self):
+        act = PropertyAction(8)
+        
+        assert act.get_properties() == test_props.keys(), "Action does not contain property 'a'"
+        
+        for prop_name in act.get_properties():
+            assert act.properties[prop_name].value == test_props[prop_name], "Wrong initial value for property %s : %s"%(prop_name,str(act.properties[prop_name]))
+        
     
-    def set_a(self, na):
-        self._a = na
+class OnceWrapperTests(unittest.TestCase):
+    def validate_wrapper(self, wrapper_instance):
+        """
+        Ensures that a given instance of a wrapper implements the Action
+        interface.
+        """
+        assert has_function(wrapper_instance, "do"),\
+            "The wrapper does not have the 'do' function"
+            
+        assert has_function(wrapper_instance, "undo"),\
+            "The wrapper does not have the 'undo' function."
+            
+        assert has_function(wrapper_instance, "get_properties"),\
+            "The wrapper does not have the 'get_properties' function."
+    
+    def test_once_wrapper_interface(self):
+        """
+        Tests that the interface of the OnceWrapper actually conforms to the of
+        the Action.
+        """
+        prop = PropertyAction(7)
         
-    def get_a(self):
-        return self._a
+        onceWrap = OnceWrapper(prop)
+        
+        self.validate_wrapper(onceWrap)
+        
+        assert onceWrap.get_properties() == test_props.keys(), "OnceWrapper should give access to properties of the contained action"
     
-    a = property(fget=get_a, fset=set_a)
+class DialogMessageTest(unittest.TestCase):
+    def setUp(self):
+        self.dial = DialogMessage("Message text", [200, 300])
     
-class PropsTest(unittest.TestCase):
+    def test_properties(self):
+        assert self.dial.message.value == "Message text", "Wrong start value for the message"
+        
+        assert self.dial.position.value == [200, 300], "Wrong start value for the position"
     
-    def test_get_properties(self):
-        prop = PropertyAction(8)
+class BubbleMessageTest(unittest.TestCase):
+    def setUp(self):
+        self.bubble = BubbleMessage(message="Message text", pos=[200, 300], tailpos=[-15, -25])
+        
+    def test_properties(self):
+        props = self.bubble.get_properties()
+        
+        assert "message" in props, 'No message property of BubbleMessage'
+        
+        assert "position" in props, 'No position property in BubbleMessage'
+        
+        assert "tail_pos" in props, 'No tail position property in BubbleMessage'
         
-        assert prop.get_properties() == ['a'], "Action does not contain property 'a'"
     
 class CountAction(Action):
     """
diff --git a/src/sugar/tutorius/tests/constraintstests.py b/src/sugar/tutorius/tests/constraintstests.py
index 407cc24..b7b0a47 100644
--- a/src/sugar/tutorius/tests/constraintstests.py
+++ b/src/sugar/tutorius/tests/constraintstests.py
@@ -77,28 +77,50 @@ class LowerLimitConstraintTest(unittest.TestCase):
         except LowerLimitConstraintError:
             assert True, "Validation of LowerLimit(10) on 20 should not raise an exception"
 
-class SizeConstraintTest(unittest.TestCase):
+class MaxSizeConstraintTest(unittest.TestCase):
     def test_empty_constraint(self):
-        cons = SizeConstraint(None)
+        cons = MaxSizeConstraint(None)
         try:
             cons.validate(20)
-        except SizeConstraintError:
+        except MaxSizeConstraintError:
             assert False, "Empty contraint should not raise an exception"
     
     def test_validate(self):
-        cons = SizeConstraint(10)
+        cons = MaxSizeConstraint(10)
         
         try:
             cons.validate(range(0, 20))
-            assert False, "Validation of SizeLimit(10) on list of length 20 should raise an exception"
-        except SizeConstraintError:
+            assert False, "Validation of MaxSizeConstraint(10) on list of length 20 should raise an exception"
+        except MaxSizeConstraintError:
             pass
         
         try:
             cons.validate(range(0,5))
-        except SizeConstraintError:
-            assert True, "Validation of SizeLimit(10) on list of length 5 should not raise an exception"
+        except MaxSizeConstraintError:
+            assert True, "Validation of MaxSizeConstraint(10) on list of length 5 should not raise an exception"
     
+class MinSizeConstraintTest(unittest.TestCase):
+    def test_empty_constraint(self):
+        cons = MinSizeConstraint(None)
+        try:
+            cons.validate(20)
+        except MinSizeConstraintError:
+            assert False, "Empty contraint should not raise an exception"
+    
+    def test_validate(self):
+        cons = MinSizeConstraint(10)
+        
+        try:
+            cons.validate(range(0, 5))
+            assert False, "Validation of MinSizeConstraint(10) on list of length 20 should raise an exception"
+        except MinSizeConstraintError:
+            pass
+        
+        try:
+            cons.validate(range(0,20))
+        except MinSizeConstraintError:
+            assert True, "Validation of MinSizeConstraint(10) on list of length 5 should not raise an exception"
+
 class ColorConstraintTest(unittest.TestCase):
     def test_validate(self):
         cons = ColorConstraint()
diff --git a/src/sugar/tutorius/tests/coretests.py b/src/sugar/tutorius/tests/coretests.py
index 5f91a64..c27846d 100644
--- a/src/sugar/tutorius/tests/coretests.py
+++ b/src/sugar/tutorius/tests/coretests.py
@@ -18,7 +18,7 @@
 Core Tests
 
 This module contains all the tests that pertain to the usage of the Tutorius
-Core. This means that the the Finite State Machine, States and all the 
+Core. This means that the Event Filters, the Finite State Machine and all the 
 related elements and interfaces are tested here.
 
 Usage of actions and event filters is tested, but not the concrete actions
@@ -29,7 +29,7 @@ and event filters. Those are in their separate test module
 import unittest
 
 import logging
-from sugar.tutorius.actions import Action, ClickAction, TypeTextAction
+from sugar.tutorius.actions import Action, OnceWrapper, ClickAction, TypeTextAction
 from sugar.tutorius.core import *
 from sugar.tutorius.filters import *
 
@@ -49,6 +49,14 @@ class SimpleTutorial(Tutorial):
     def set_state(self, name):
         self.current_state_name = name
 
+class TutorialWithFSM(Tutorial):
+    """
+    Fake tutorial, but associated with a FSM.
+    """
+    def __init__(self, start_name="INIT", fsm=None):
+        Tutorial.__init__(self, start_name, fsm)
+        self.activity = activity.Activity()
+    
 class TrueWhileActiveAction(Action):
     """
     This action's active member is set to True after a do and to False after
@@ -483,7 +491,6 @@ class FSMTest(unittest.TestCase):
         except Exception:
             assert False, "Removing a non-existing state dit not throw the right kind of exception"
         
-        
         # Now try removing the second state
         fsm.remove_state("second")
         
@@ -502,6 +509,33 @@ class FSMTest(unittest.TestCase):
         assert "second" not in fsm.get_following_states("third"),\
             "The link to second from third still exists after removal"
     
+    def test_set_same_state(self):
+        fsm = FiniteStateMachine("Set same state")
+        
+        st1 = State("INIT")
+        st1.add_action(CountAction())
+        
+        fsm.add_state(st1)
+        
+        tut = SimpleTutorial()
+        
+        fsm.set_tutorial(tut)
+        
+        fsm.set_state("INIT")
+        
+        assert fsm.get_state_by_name("INIT").get_action_list()[0].do_count == 1, \
+            "The action was not triggered on 'INIT'"
+        
+        fsm.set_state("INIT")
+        
+        do_count = fsm.get_state_by_name("INIT").get_action_list()[0].do_count
+        assert fsm.get_state_by_name("INIT").get_action_list()[0].do_count == 1, \
+            "The action was triggered a second time, do_count = %d"%do_count
+        
+        undo_count = fsm.get_state_by_name("INIT").get_action_list()[0].undo_count
+        assert fsm.get_state_by_name("INIT").get_action_list()[0].undo_count == 0,\
+            "The action has been undone unappropriately, undo_count = %d"%undo_count
+    
 class FSMExplorationTests(unittest.TestCase):
     def setUp(self):
         self.buildFSM()
@@ -556,6 +590,7 @@ class FSMExplorationTests(unittest.TestCase):
         self.validate_previous_states("Third", ("INIT", "Second"))
         
         self.validate_previous_states("Fourth", ("Second"))
+        
 
 if __name__ == "__main__":
     unittest.main()
diff --git a/src/sugar/tutorius/tests/propertiestests.py b/src/sugar/tutorius/tests/propertiestests.py
index 52a9a75..45ba264 100644
--- a/src/sugar/tutorius/tests/propertiestests.py
+++ b/src/sugar/tutorius/tests/propertiestests.py
@@ -204,7 +204,7 @@ class TStringPropertyTest(unittest.TestCase):
         try:
             prop.set("My string is too big!")
             assert False, "String should not set to longer than max size"
-        except SizeConstraintError:
+        except MaxSizeConstraintError:
             pass
         except:
             assert False, "Wrong exception type thrown"
@@ -218,7 +218,7 @@ class TStringPropertyTest(unittest.TestCase):
         try:
             prop = TStringProperty("This is normal", 5)
             assert False, "Creation of the property should fail."
-        except SizeConstraintError:
+        except MaxSizeConstraintError:
             pass
         except:
             assert False, "Wrong exception type on failed constructor"
@@ -236,26 +236,34 @@ class TArrayPropertyTest(unittest.TestCase):
         
         try_wrong_values(prop)
         
-    def test_size_limit(self):
-        prop = TArrayProperty([1,2], 4)
+    def test_size_limits(self):
+        prop = TArrayProperty([1,2], None, 4)
         
         try:
             prop.set([1,2,4,5,6,7])
-            assert False, "Size limit constraint was not properly applied"
-        except SizeConstraintError:
+            assert False, "Maximum size limit constraint was not properly applied"
+        except MaxSizeConstraintError:
+            pass
+        
+        prop = TArrayProperty([1,2,3,4], 2)
+        
+        try:
+            prop.set([1])
+            assert False, "Minimum size limit constraint was not properly applied"
+        except MinSizeConstraintError:
             pass
-        except:
-            assert False, "Wrong type of exception thrown"
-            
     
     def test_failing_constructor(self):
         try:
-            prop = TArrayProperty([100, 0, 20], 2)
+            prop = TArrayProperty([100, 0, 20], None, 2)
             assert False, "Creation of the property should fail."
-        except SizeConstraintError:
+        except MaxSizeConstraintError:
+            pass
+        try:
+            prop = TArrayProperty([100, 0, 20], 4, None)
+            assert False, "Creation of the property should fail."
+        except MinSizeConstraintError:
             pass
-        except:
-            assert False, "Wrong exception type on failed constructor"
     
 class TColorPropertyTest(unittest.TestCase):
     def test_basic_color(self):
@@ -286,6 +294,8 @@ class TBooleanPropertyTest(unittest.TestCase):
     def test_basic_boolean(self):
         assert self.prop.value == False, "Could not set initial value via constructor"
         
+        assert self.prop.type == "boolean", "Wrong type for TBooleanProperty : %s"%self.prop.type
+        
         self.prop.set(True)
         
         assert self.prop.value == True, "Could not change the value via set"
@@ -313,6 +323,8 @@ class TEnumPropertyTest(unittest.TestCase):
     def test_basic_enum(self):
         assert self.prop.value == "hello", "Could not set initial value on property"
         
+        assert self.prop.type == "enum", "Wrong type for TEnumProperty : %s"%self.prop.type
+        
         self.prop.set(True)
         
         assert self.prop.value, "Could not change the value via set"
@@ -333,6 +345,8 @@ class TFilePropertyTest(unittest.TestCase):
     def test_basic_file(self):
         assert self.prop.value == "propertiestests.py", "Could not set initial value"
         
+        assert self.prop.type == "file", "Wrong type for TFileProperty : %s"%self.prop.type
+        
         self.prop.set("run-tests.py")
         
         assert self.prop.value == "run-tests.py", "Could not change value"
diff --git a/src/sugar/tutorius/tests/run-tests.py b/src/sugar/tutorius/tests/run-tests.py
index 97665f7..042b10e 100755
--- a/src/sugar/tutorius/tests/run-tests.py
+++ b/src/sugar/tutorius/tests/run-tests.py
@@ -14,7 +14,6 @@ SUBDIRS = ["uam"]
 GLOB_PATH = os.path.join(FULL_PATH,"*.py")
 import unittest
 from glob import glob
-
 def report_files():
     ret = glob(GLOB_PATH)
     for dir in SUBDIRS:
diff --git a/src/sugar/tutorius/tests/serializertests.py b/src/sugar/tutorius/tests/serializertests.py
index 75fe8eb..2a743e1 100644
--- a/src/sugar/tutorius/tests/serializertests.py
+++ b/src/sugar/tutorius/tests/serializertests.py
@@ -39,6 +39,28 @@ from sugar.tutorius.bundler import *
 from uuid import *
 import rpdb2
 
+class SerializerInterfaceTest(unittest.TestCase):
+    """
+    For completeness' sake.
+    """
+    def test_save(self):
+        ser = Serializer()
+        
+        try:
+            ser.save_fsm(None)
+            assert False, "save_fsm() should throw an unimplemented error"
+        except:
+            pass
+            
+    def test_load(self):
+        ser = Serializer()
+        
+        try:
+            ser.load_fsm(str(uuid.uuid1))
+            assert False, "load_fsm() should throw an unimplemented error"
+        except:
+            pass
+
 class XMLSerializerTest(unittest.TestCase):
     """
     Tests the transformation of XML to FSM, then back.
@@ -104,10 +126,11 @@ class XMLSerializerTest(unittest.TestCase):
             'FSM underlying dictionary differ from original to pickled/reformed one'
         assert loaded_fsm._states.get("Second").name == self.fsm._states.get("Second").name, \
             'FSM underlying dictionary differ from original to pickled/reformed one'
-        assert loaded_fsm._states.get("INIT").get_action_list()[0].get_message() == \
-            self.fsm._states.get("INIT").get_action_list()[0].get_message(), \
+        assert loaded_fsm._states.get("INIT").get_action_list()[0].message.value == \
+            self.fsm._states.get("INIT").get_action_list()[0].message.value, \
             'FSM underlying State underlying Action differ from original to reformed one'
-            
+        assert len(loaded_fsm.get_action_list()) == 0, "FSM should not have any actions on itself"
+        
         os.remove(os.path.join(sugar.tutorius.bundler._get_store_root(), str(self.uuid)) + "/fsm.xml")
         if os.path.isdir(testpath):
             shutil.rmtree(testpath)