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
|
# Copyright (C) 2009, Tutorius.org
# Copyright (C) 2009, Michael Janelle-Montcalm <michael.jmontcalm@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
"""
Core Tests
This module contains all the tests that pertain to the usage of the Tutorius
Core. This means that the Event Filters, the Finite State Machine and all the
related elements and interfaces are tested here.
"""
import unittest
import logging
from sugar.tutorius.actions import Action
from sugar.tutorius.core import *
from sugar.tutorius.filters import *
# Helper classes to help testing
class SimpleTutorial(Tutorial):
"""
Fake tutorial
"""
def __init__(self, start_name="INIT"):
#Tutorial.__init__(self, "Simple Tutorial", None)
self.current_state_name = start_name
self.activity = "TODO : This should be an activity"
def set_state(self, name):
self.current_state_name = name
class TrueWhileActiveAction(Action):
"""
This action's active member is set to True after a do and to False after
an undo.
Used to verify that a State correctly triggers the do and undo actions.
"""
def __init__(self):
self.active = False
def do(self):
self.active = True
def undo(self):
self.active = False
class TriggerEventFilter(EventFilter):
"""
This event filter can be triggered by simply calling its execute function.
Used to fake events and see the effect on the FSM.
"""
def __init__(self, next_state):
EventFilter.__init__(self, next_state)
self.toggle_on_callback = False
def install_handlers(self, callback, **kwargs):
"""
Forsakes the incoming callback function and just set the inner one.
"""
self._callback = self._inner_cb
def _inner_cb(self, event_filter):
self.toggle_on_callback = not self.toggle_on_callback
# State testing class
class StateTest(unittest.TestCase):
"""
This class has to test the State interface as well as the expected
functionality.
"""
def test_action_toggle(self):
"""
Validate that the actions are properly done on setup and undone on
teardown.
Pretty awesome.
"""
act = TrueWhileActiveAction()
state = State("action_test", action_list=[act])
assert act.active == False, "Action is not initialized properly"
state.setup()
assert act.active == True, "Action was not triggered properly"
state.teardown()
assert act.active == False, "Action was not undone properly"
def test_event_filter(self):
"""
Tests the fact that the event filters are correctly installed on setup
and uninstalled on teardown.
"""
event_filter = TriggerEventFilter("second_state")
state = State("event_test", event_filter_list=[event_filter])
state.set_tutorial(SimpleTutorial())
assert event_filter.toggle_on_callback == False, "Wrong init of event_filter"
assert event_filter._callback == None, "Event filter has a registered callback before installing handlers"
state.setup()
assert event_filter._callback != None, "Event filter did not register callback!"
# 'Trigger' the event - This is more like a EventFilter test.
event_filter.do_callback()
assert event_filter.toggle_on_callback == True, "Event filter did not execute callback"
state.teardown()
assert event_filter._callback == None, "Event filter did not remove callback properly"
def test_warning_set_tutorial_twice(self):
"""
Calls set_tutorial twice and expects a warning on the second.
"""
state = State("start_state")
tut = SimpleTutorial("First")
tut2 = SimpleTutorial("Second")
state.set_tutorial(tut)
try:
state.set_tutorial(tut2)
assert False, "No RuntimeWarning was raised on second set_tutorial"
except :
pass
if __name__ == "__main__":
unittest.main()
|
