Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/src/sugar/tutorius/tests/serializertests.py
blob: 64e467e031f10e81ffc00015bdf37c710f8363b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# Copyright (C) 2009, Tutorius.org
# Copyright (C) 2009, Jean-Christophe Savard <savard.jean.christophe@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
"""
Serialization Tests

This module contains all the tests that pertain to the usage of the Tutorius
Serializer object. This means testing saving a tutorial dictionary to a .tml
file, loading the list of tutorials for this activity and building chosen
tutorial.
"""

import unittest

import logging
import linecache
import os
import cPickle as pickle

from sugar.tutorius import gtkutils, overlayer
from sugar.tutorius.core import Tutorial, State, FiniteStateMachine
from sugar.tutorius.actions import DialogMessage, OnceWrapper, BubbleMessage
from sugar.tutorius.filters import GtkWidgetEventFilter, TimerEvent
from sugar.tutorius.bundler import *

from uuid import *
import rpdb2

class XMLSerializerTest(unittest.TestCase):
    """
    Tests the transformation of XML to FSM, then back.
    """
    def setUp(self):
        # Create the sample FSM
        self.fsm = FiniteStateMachine("testingMachine")
        
        # Add a few states
        act1 = BubbleMessage(message="Hi", pos=[300, 450])
        ev1 = GtkWidgetEventFilter("0.12.31.2.2", "clicked", "Second")
        act2 = BubbleMessage(message="Second message", pos=[250, 150], tailpos=[1,2])
        
        st1 = State("INIT")
        st1.add_action(act1)
        
        st2 = State("Second")
        
        st2.add_action(act2)
        
        self.fsm.add_state(st1)
        self.fsm.add_state(st2)
        
        self.uuid = uuid1()
    
    def test_save(self):
        """
        Writes an FSM to disk, then compares the file to the expected results.
        """ 
        # Make the serializer believe the test is in a activity path
        testpath = "/tmp/testdata/"
        os.environ["SUGAR_BUNDLE_PATH"] = testpath
        os.environ["SUGAR_PREFIX"] = testpath
##        os.mkdir(sugar.tutorius.bundler._get_store_root())
        xml_ser = XMLSerializer()
        os.makedirs(os.path.join(sugar.tutorius.bundler._get_store_root(), str(self.uuid)))
        #rpdb2.start_embedded_debugger('flakyPass')
        xml_ser.save_fsm(self.fsm, "fsm.xml", os.path.join(sugar.tutorius.bundler._get_store_root(), str(self.uuid)))
        
        # Compare the two files
        
        
        #Remove test file and path (commented for testing, to uncomment)
##        os.remove(testpath +  os.path.join(sugar.tutorius.bundler._get_store_root(), str(self.uuid)) + "/fsm.xml")
##        os.removedirs(testpath)
  
    def test_save_and_load(self):
        """
        Load up the written FSM and compare it with the object representation.
        """
        self.test_save()
        
        #rpdb2.start_embedded_debugger('flakyPass')
        xml_ser = XMLSerializer()
        
        # This interface needs to be redone... It's not clean because there is 
        # a responsibility mixup between the XML reader and the bundler.
        loaded_fsm = xml_ser.load_fsm(str(self.uuid))
        
        # Compare the two FSMs
        assert loaded_fsm._states.get("INIT").name == self.fsm._states.get("INIT").name, \
            'FSM underlying dictionary differ from original to pickled/reformed one'
        assert loaded_fsm._states.get("LOST").name == self.fsm._states.get("Second").name, \
            'FSM underlying dictionary differ from original to pickled/reformed one'

# Helper classes to help testing
class SerializerTest(unittest.TestCase):
    """
    This class has to test the Serializer methods as well as the expected 
    functionality.
    """
        
    # Voiding test as it is meant to be used with the pickle serializer,
    # that was deprecated
##    def test_pickle_integrity(self):
##        """
##        Validates content is uncorrupted trough a pickle file save/load.
##        """
##        
##        # Sample valid FSM dict
##        sampleDict = {
##            "INIT":State("INIT",
##                action_list=[
##                    OnceWrapper(BubbleMessage(message="Welcome to the text editor tutorial!\n\n Click on the canvas and type a letter.", pos=[100,100], tailpos=[-10,-20])),
##                ],
##                event_filter_list=[
##                    GtkWidgetEventFilter("TEXT","0.0.0.1.0.0.0","key-press-event"),
##                    TimerEvent("LOST",15),
##                ],
##            ),
##            "LOST":State("LOST",
##                action_list=[BubbleMessage("Click in the canvas and type on your keyboard", [400, 400]),],
##                event_filter_list=[
##                    GtkWidgetEventFilter("TEXT","0.0.0.1.0.0.0","key-press-event"),
##                    TimerEvent("INIT",5),
##                ],
##            ),
##            "TEXT":State("TEXT",
##                action_list=[OnceWrapper(BubbleMessage("  You can type more letters if you want!\n\n" +
##                        "To proceed to the next step, select your text.\n\n  Click and drag over the text!", [200,150])),],
##                event_filter_list=[
##                    GtkWidgetEventFilter("SELECTED","0.0.0.1.0.0","text-selected"),
##                ],
##            ),
##        }
##
##        testpath = "/tmp/testdata/"
##        
##        # Create testdata/ folder if no exists
##        if not os.path.exists(testpath):
##            os.mkdir(testpath)
##        
##        serialize = TutoSerializer()
##        
##        # Make the class believe the test is in a activity path
##        os.environ["SUGAR_ACTIVITY_ROOT"] = testpath
##        
##        fsm = FiniteStateMachine("Test", state_dict=sampleDict)
##        
##        serialize.save_tutorial("Test", "Test", fsm, "serializeTest")
##        
##        fileDict = serialize.load_tuto_list()
##        
##        for filekey, tutorial in fileDict.items():
##            if filekey == "Test":
##                reformedTuto = serialize.build_tutorial(filekey)
##                
##        reformedfsm = reformedTuto.get("Test").state_machine
##        
##        #Tests
##        assert reformedfsm._states.get("INIT").name == fsm._states.get("INIT").name, \
##            'FSM underlying dictionary differ from original to pickled/reformed one'
##        assert reformedfsm._states.get("LOST").name == fsm._states.get("LOST").name, \
##            'FSM underlying dictionary differ from original to pickled/reformed one'
##        assert reformedfsm._states.get("TEXT").name == fsm._states.get("TEXT").name, \
##            'FSM underlying dictionary differ from original to pickled/reformed one'
##        
##        
##        os.remove(testpath + "serializeTest.tml")
##        os.rmdir(testpath)
##        os.rmdir("/tmp")


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