Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/tests/tutorialtests.py
blob: cd0ef6fa10522fdcfe36f76676ea15f7d7d00cb9 (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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# Copyright (C) 2009, Tutorius.org
# Copyright (C) 2009, Erick Lavoie <erick.lavoie@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
"""
Tutorial Tests
"""

# TODO: Add tests for 47, 52, 55, 109, 132, 175, 209, 229, 233, 271, 274, 292, 295, 318, 337, 375, 394, 411, 428, 446, 480, 491, 624, 637, 698 

# TODO: Use doc strings for test names that are too long
# TODO: Use helper functions for common checks

import unittest

from sugar.tutorius.tutorial import *

# The following tests are organized around 4 classes:
#
# Black box tests:
#     Those tests should limit themselves to exercise the
#     interface of the object so everything should be tested
#     only through the interface the object offers. This will
#     ease test maintenance since we anticipate most changes
#     will be about the implementation of an object and not
#     its interface.
#
#     Tests definitions are written assuming the previous tests
#     did complete correctly so the number of things to assert 
#     is minimal.
#
#     Basic interface cases:
#        Test the interface of the object for trivial cases
#        just to assert that the functionality this object
#        offers really works
#    
#     Limit cases:
#        Test edge cases that cover more obscure usage
#        scenarios but that should be valid nonetheless
#    
#     Error cases:
#        Test wrong inputs to make sure that the object is hard
#        to misuse and do generate proper errors
# 
# White box tests:
#     Those should be used only for really important algorithms
#     to make sure they behave correctly in every cases, otherwise 
#     the tests will break each time we change something in the 
#     implementation

from sugar.tutorius.properties import *

class MockAction(TPropContainer):
    i = TIntProperty(0, 0, 9)

class MockEvent(TPropContainer):
    i = TIntProperty(0, 0, 9)

class StateTest(unittest.TestCase):
    """Test basic functionalities of states used by tutorials"""
    
    def setUp(self):
        self.state = State("State1")
        self.action = MockAction()
        self.event = MockEvent()

    def tearDown(self):
        pass

    ######################### Basic interface cases #########################

    #### Action
    def test_add_dummy_action(self):
        action_name = self.state.add_action("action1")
        assert action_name
        assert len(self.state.get_action_dict()) == 1
        assert self.state.get_action_dict().has_key(action_name)
        assert self.state.get_action_dict()[action_name] == "action1"

    def test_add_generate_unique_action_names(self):
        action_name1 = self.state.add_action("action1")
        action_name2 = self.state.add_action("action2")
        assert action_name1 and action_name2
        assert action_name1 != action_name2
        
    def test_update_dummy_action(self):
        action_name = self.state.add_action(self.action)
        assert self.action.i == 0
        
        prop = self.action.get_properties_dict_copy()
        prop["i"] = 2
        self.state.update_action(action_name, prop) 

        assert len(self.state.get_action_dict()) == 1
        assert self.state.get_action_dict().has_key(action_name)
        assert self.state.get_action_dict()[action_name].get_properties_dict_copy() == prop
  
    def test_delete_dummy_action(self):
        action_name = self.state.add_action("action1")
        assert len(self.state.get_action_dict()) == 1
        assert self.state.get_action_dict().has_key(action_name)
        assert self.state.get_action_dict()[action_name] == "action1"

        self.state.delete_action(action_name)
        assert len(self.state.get_action_dict()) == 0

    def test_delete_all_dummy_actions(self):
        action_name = self.state.add_action("action1")
        assert len(self.state.get_action_dict()) == 1
        assert self.state.get_action_dict().has_key(action_name)
        assert self.state.get_action_dict()[action_name] == "action1"

        self.state.delete_actions()
        assert len(self.state.get_action_dict()) == 0

    #### Transition
    def test_add_dummy_transition(self):
        transition_name = self.state.add_transition("transition1")
        assert len(self.state.get_transition_dict()) == 1
        assert self.state.get_transition_dict().has_key(transition_name)
        assert self.state.get_transition_dict()[transition_name] == "transition1"

    def test_add_generate_unique_transition_names(self):
        transition_name1 = self.state.add_transition("transition1")
        transition_name2 = self.state.add_transition("transition2")
        assert transition_name1 != transition_name2
      
    def test_update_dummy_transition(self):
        transition_name = self.state.add_transition((self.event, Tutorial.END))
        assert self.event.i == 0
        
        prop = self.event.get_properties_dict_copy()
        prop["i"] = 2
        self.state.update_transition(transition_name, prop) 

        assert len(self.state.get_transition_dict()) == 1
        assert self.state.get_transition_dict().has_key(transition_name)
        assert self.state.get_transition_dict()[transition_name][0].get_properties_dict_copy() == prop
        assert self.state.get_transition_dict()[transition_name][1] == Tutorial.END

        # Now update only the transition
        self.state.update_transition(transition_name, new_state=Tutorial.INIT) 
        assert self.state.get_transition_dict()[transition_name][0].get_properties_dict_copy() == prop
        assert self.state.get_transition_dict()[transition_name][1] == Tutorial.INIT
  
    def test_delete_dummy_transition(self):
        transition_name = self.state.add_transition("transition1")
        assert len(self.state.get_transition_dict()) == 1
        assert self.state.get_transition_dict().has_key(transition_name)
        assert self.state.get_transition_dict()[transition_name] == "transition1"

        self.state.delete_transition(transition_name)
        assert len(self.state.get_transition_dict()) == 0

    def test_delete_all_dummy_transitions(self):
        transition_name = self.state.add_transition("transition1")
        assert len(self.state.get_transition_dict()) == 1
        assert self.state.get_transition_dict().has_key(transition_name)
        assert self.state.get_transition_dict()[transition_name] == "transition1"

        self.state.delete_transitions()
        assert len(self.state.get_transition_dict()) == 0

        

    ######################### Limit cases ###################################
    #### Action

    #### Transition

    ######################### Error cases ###################################
    #### Action
    def test_update_unknown_action(self):
        try:
            self.state.update_action("unknown_name", "action")
            assert False
        except LookupError:
            pass

    def test_delete_unknown_action(self):
        try:
            self.state.delete_action("unknown_name")
            assert False
        except LookupError:
            pass

    #### Transition
    def test_add_existing_transition(self):
        self.state.add_transition("transition")
        try:
            self.state.add_transition("transition")
            assert False
        except TransitionAlreadyExists:
            pass
        
class TutorialTest(unittest.TestCase):
    """Test tutorial functionality"""
    
    def setUp(self):
        self.tutorial = Tutorial("Tutorial Test")
        self.action = MockAction()
        self.event = MockEvent()

    def tearDown(self):
        pass

    ######################### Basic interface cases #########################

    #### Tutorial
    def test_default_initial_value_in_tutorial(self):
        assert len(self.tutorial.get_state_dict()) == 2
        assert set(self.tutorial.get_state_dict().keys()) == set([Tutorial.INIT,Tutorial.END])
        assert len(self.tutorial.get_action_dict()) == 0
        assert len(self.tutorial.get_transition_dict()) == 1
        assert self.tutorial.get_previous_states_dict(Tutorial.INIT) == {}
        assert self.tutorial.get_following_states_dict(Tutorial.INIT).keys() == [Tutorial.END]
        assert self.tutorial.get_previous_states_dict(Tutorial.END).keys() == [Tutorial.INIT]
        assert self.tutorial.get_following_states_dict(Tutorial.END) == {}

    #### State
    def test_add_default_state(self):
        state_name = self.tutorial.add_state()
        assert state_name
        assert len(self.tutorial.get_state_dict()) == 3
        assert set(self.tutorial.get_state_dict().keys()) == set([Tutorial.INIT,Tutorial.END, state_name])
        assert len(self.tutorial.get_action_dict()) == 0
        assert len(self.tutorial.get_transition_dict()) == 1

    def test_add_state_with_action(self):
        state_name = self.tutorial.add_state(action_list=["action1"])
        assert state_name
        assert len(self.tutorial.get_state_dict()) == 3
        assert set(self.tutorial.get_state_dict().keys()) == set([Tutorial.INIT,Tutorial.END, state_name])
        assert len(self.tutorial.get_action_dict()) == 1
        assert len(self.tutorial.get_transition_dict()) == 1

    def test_add_state_with_transition(self):
        state_name = self.tutorial.add_state(transition_list=[("event1",Tutorial.END)])
        assert state_name
        assert len(self.tutorial.get_state_dict()) == 3
        assert set(self.tutorial.get_state_dict().keys()) == set([Tutorial.INIT,Tutorial.END, state_name])
        assert len(self.tutorial.get_action_dict()) == 0
        assert len(self.tutorial.get_transition_dict()) == 2

    def test_add_generate_unique_state_names(self):
        state_name1 = self.tutorial.add_state()
        state_name2 = self.tutorial.add_state()
        assert state_name1 and state_name2
        assert state_name1 != state_name2

    def test_delete_lone_state(self):
        state_name1 = self.tutorial.add_state()
        self.tutorial.delete_state(state_name1)
        assert len(self.tutorial.get_state_dict()) == 2
        assert set(self.tutorial.get_state_dict().keys()) == set([Tutorial.INIT,Tutorial.END])
        assert len(self.tutorial.get_action_dict()) == 0
        assert len(self.tutorial.get_transition_dict()) == 1
        assert self.tutorial.get_previous_states_dict(Tutorial.INIT) == {}
        assert self.tutorial.get_following_states_dict(Tutorial.INIT).keys() == [Tutorial.END]
        assert self.tutorial.get_previous_states_dict(Tutorial.END).keys() == [Tutorial.INIT]
        assert self.tutorial.get_following_states_dict(Tutorial.END) == {}

    def test_delete_linked_state(self):
        state_name1 = self.tutorial.add_state()
        self.tutorial.update_transition(Tutorial.INITIAL_TRANSITION_NAME, \
                                        None, state_name1)
        transition_name1 = self.tutorial.add_transition(state_name1,("event1", Tutorial.END))
        self.tutorial.delete_state(state_name1)
        assert len(self.tutorial.get_state_dict()) == 2
        assert set(self.tutorial.get_state_dict().keys()) == set([Tutorial.INIT,Tutorial.END])
        assert len(self.tutorial.get_action_dict()) == 0
        assert len(self.tutorial.get_transition_dict()) == 1
        assert self.tutorial.get_previous_states_dict(Tutorial.INIT) == {}
        assert self.tutorial.get_following_states_dict(Tutorial.INIT).keys() == [Tutorial.END]
        assert self.tutorial.get_previous_states_dict(Tutorial.END).keys() == [Tutorial.INIT]
        assert self.tutorial.get_following_states_dict(Tutorial.END) == {}

    #### Action
    def test_add_dummy_action(self):
        state_name = self.tutorial.add_state()
        action_name = self.tutorial.add_action(state_name,"action1")
        assert action_name
        assert len(self.tutorial.get_action_dict()) == 1
        assert self.tutorial.get_action_dict().has_key(action_name)
        assert self.tutorial.get_action_dict()[action_name] == "action1"

    def test_add_generate_unique_action_names(self):
        state_name = self.tutorial.add_state()
        action_name1 = self.tutorial.add_action(state_name,"action1")
        action_name2 = self.tutorial.add_action(state_name,"action2")
        assert action_name1 and action_name2
        assert action_name1 != action_name2
        
    def test_update_dummy_action(self):
        state_name = self.tutorial.add_state()
        action_name = self.tutorial.add_action(state_name,self.action)

        prop = self.action.get_properties_dict_copy()
        prop["i"] = 2
        self.tutorial.update_action(action_name, prop) 

        assert len(self.tutorial.get_action_dict()) == 1
        assert self.tutorial.get_action_dict().has_key(action_name)
        assert self.tutorial.get_action_dict()[action_name].get_properties_dict_copy() == prop
  
    def test_delete_dummy_action(self):
        state_name = self.tutorial.add_state()
        action_name = self.tutorial.add_action(state_name,"action1")
        assert len(self.tutorial.get_action_dict()) == 1
        assert self.tutorial.get_action_dict().has_key(action_name)
        assert self.tutorial.get_action_dict()[action_name] == "action1"

        self.tutorial.delete_action(action_name)
        assert len(self.tutorial.get_action_dict()) == 0

    #### Transition
    def test_add_dummy_transition(self):
        state_name = self.tutorial.add_state()
        transition_name = self.tutorial.add_transition(state_name,"transition1")
        assert len(self.tutorial.get_transition_dict()) == 2
        assert self.tutorial.get_transition_dict().has_key(transition_name)
        assert self.tutorial.get_transition_dict()[transition_name] == "transition1"

    def test_add_generate_unique_transition_names(self):
        state_name = self.tutorial.add_state()
        transition_name1 = self.tutorial.add_transition(state_name,"transition1")
        transition_name2 = self.tutorial.add_transition(state_name,"transition2")
        assert transition_name1 and transition_name2
        assert transition_name1 != transition_name2
      
    def test_update_dummy_transition(self):
        state_name = self.tutorial.add_state()
        transition_name = self.tutorial.add_transition(state_name,(self.event, Tutorial.END))

        prop = self.event.get_properties_dict_copy()
        prop["i"] = 2
        self.tutorial.update_transition(transition_name, prop) 

        assert len(self.tutorial.get_transition_dict()) == 2
        assert self.tutorial.get_transition_dict().has_key(transition_name)
        assert self.tutorial.get_transition_dict()[transition_name][0].get_properties_dict_copy() == prop
        assert self.tutorial.get_transition_dict()[transition_name][1] == Tutorial.END

        # Now update only the transition
        self.tutorial.update_transition(transition_name, new_state=Tutorial.INIT) 
        assert self.tutorial.get_transition_dict()[transition_name][0].get_properties_dict_copy() == prop
        assert self.tutorial.get_transition_dict()[transition_name][1] == Tutorial.INIT
  
    def test_delete_dummy_transition(self):
        state_name = self.tutorial.add_state()
        transition_name = self.tutorial.add_transition(state_name,"transition1")
        assert len(self.tutorial.get_transition_dict()) == 2
        assert self.tutorial.get_transition_dict().has_key(transition_name)
        assert self.tutorial.get_transition_dict()[transition_name] == "transition1"

        self.tutorial.delete_transition(transition_name)
        assert len(self.tutorial.get_transition_dict()) == 1
        

    ######################### Limit cases ###################################
    #### Tutorial
 
    #### State

    #### Action

    #### Transition

    ######################### Error cases ###################################
    #### Tutorial

    #### State

    #### Action
    def test_update_unknown_action(self):
        lookup_error = None
        try:
            self.tutorial.update_action("unknown_name", "action")
        except LookupError, e:
            lookup_error = e

        assert lookup_error
     

    def test_delete_unknown_action(self):
        lookup_error = None
        try:
            self.tutorial.delete_action("unknown_name")
        except LookupError, e:
            lookup_error = e

        assert lookup_error

    #### Transition
    def test_add_existing_transition(self):
        self.tutorial.add_transition(Tutorial.INIT,("event","transition"))
        transition_exists_error = None
        try:
            self.tutorial.add_transition(Tutorial.INIT,("event","transition"))
        except TransitionAlreadyExists, e:
            transition_exists_error = e

        assert transition_exists_error 


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