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
|
# coding=utf-8
#
# fysom - pYthOn Finite State Machine - this is a port of Jake
# Gordon's javascript-state-machine to python
# https://github.com/jakesgordon/javascript-state-machine
#
# Copyright (C) 2011 Mansour Behabadi <mansour@oxplot.com>, Jake Gordon
# and other contributors
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
import unittest
from fysom import Fysom
class FysomCallbackTests(unittest.TestCase):
def before_foo(self, e):
self.before_foo_event = e
self.fired_callbacks.append('before_foo')
def before_bar(self, e):
self.before_bar_event = e
self.fired_callbacks.append('before_bar')
def before_wait(self, e):
self.before_wait_event = e
self.fired_callbacks.append('before_wait')
return False
def on_foo(self, e):
self.foo_event = e
self.fired_callbacks.append('after_foo')
def on_bar(self, e):
self.bar_event = e
self.fired_callbacks.append('after_bar')
def on_baz(self, e):
raise ValueError('Baz-inga!')
def on_enter_fooed(self, e):
self.enter_fooed_event = e
def on_enter_bared(self, e):
self.enter_bared_event = e
def on_leave_sleeping(self, e):
self.leave_sleeping_event = e
def on_leave_fooed(self, e):
self.leave_fooed_event = e
def setUp(self):
self.fired_callbacks = []
self.fsm = Fysom({
'initial': 'sleeping',
'events': [
{'name': 'foo', 'src': 'sleeping', 'dst': 'fooed'},
{'name': 'bar', 'src': 'fooed', 'dst': 'bared'},
{'name': 'baz', 'src': 'bared', 'dst': 'bazed'},
{'name': 'wait', 'src': 'sleeping', 'dst': 'waiting'}
],
'callbacks': {
'onfoo': self.on_foo,
'onbar': self.on_bar,
'onbaz': self.on_baz,
'onbeforefoo': self.before_foo,
'onbeforebar': self.before_bar,
'onbeforewait': self.before_wait,
'onenterfooed': self.on_enter_fooed,
'onenterbared': self.on_enter_bared,
'onleavesleeping': self.on_leave_sleeping,
'onleavefooed': self.on_leave_fooed
}
})
def test_onafter_event_callbacks_should_fire_with_keyword_arguments_when_events_occur(self):
self.fsm.foo(attribute='test')
self.assertTrue(
hasattr(self, 'foo_event'), 'Callback on_foo did not fire.')
self.assertTrue(self.foo_event is not None)
self.assertEqual(self.foo_event.attribute, 'test')
self.fsm.bar(id=123)
self.assertTrue(
hasattr(self, 'bar_event'), 'Callback on_bar did not fire.')
self.assertTrue(self.bar_event is not None)
self.assertEqual(self.bar_event.id, 123)
def test_onafter_event_callbacks_raising_exceptions_should_not_be_eaten(self):
self.fsm.foo()
self.fsm.bar()
self.assertRaises(ValueError, self.fsm.baz)
def test_onbefore_event_callbacks_should_fire_before_onafter_callbacks_with_keyword_arguments_when_events_occur(
self):
self.fsm.foo(attribute='test')
self.assertTrue(
hasattr(self, 'before_foo_event'), 'Callback onbeforefoo did not fire.')
self.assertTrue(self.before_foo_event is not None)
self.assertEqual(self.before_foo_event.attribute, 'test')
self.fsm.bar(id=123)
self.assertTrue(
hasattr(self, 'before_bar_event'), 'Callback onbeforebar did not fire.')
self.assertTrue(self.before_bar_event is not None)
self.assertEqual(self.before_bar_event.id, 123)
self.assertEqual(
['before_foo', 'after_foo', 'before_bar', 'after_bar'], self.fired_callbacks)
def test_fsm_cancel_transition_when_onbefore_event_callbacks_return_false(self):
self.fsm.wait()
self.assertEqual(self.fsm.current, 'sleeping')
def test_onenter_state_callbacks_should_fire_with_keyword_arguments_when_state_transitions_occur(self):
self.fsm.foo(attribute='test')
self.assertTrue(
hasattr(self, 'enter_fooed_event'), 'Callback onenterfooed did not fire.')
self.assertTrue(self.enter_fooed_event is not None)
self.assertEqual(self.enter_fooed_event.attribute, 'test')
self.fsm.bar(id=123)
self.assertTrue(
hasattr(self, 'enter_bared_event'), 'Callback onenterbared did not fire.')
self.assertTrue(self.enter_bared_event is not None)
self.assertEqual(self.enter_bared_event.id, 123)
def test_onleave_state_callbacks_should_fire_with_keyword_arguments_when_state_transitions_occur(self):
self.fsm.foo(attribute='test')
self.assertTrue(hasattr(self, 'leave_sleeping_event'),
'Callback onleavesleeping did not fire.')
self.assertTrue(self.leave_sleeping_event is not None)
self.assertEqual(self.leave_sleeping_event.attribute, 'test')
self.fsm.bar(id=123)
self.assertTrue(
hasattr(self, 'leave_fooed_event'), 'Callback onleavefooed did not fire.')
self.assertTrue(self.leave_fooed_event is not None)
self.assertEqual(self.leave_fooed_event.id, 123)
def test_onchangestate_should_fire_for_all_state_changes(self):
def on_change_state(e):
self.current_event = e
fsm = Fysom({
'initial': 'foo',
'events': [
{'name': 'footobar', 'src': 'foo', 'dst': 'bar'},
{'name': 'bartobaz', 'src': 'bar', 'dst': 'baz'},
],
'callbacks': {
'onchangestate': on_change_state
}
})
fsm.footobar(id=123)
self.assertEqual(self.current_event.event, 'footobar')
self.assertEqual(self.current_event.src, 'foo')
self.assertEqual(self.current_event.dst, 'bar')
self.assertEqual(self.current_event.id, 123)
self.assertTrue(self.current_event.fsm is fsm)
fsm.bartobaz('positional', named_attribute='test')
self.assertEqual(self.current_event.event, 'bartobaz')
self.assertEqual(self.current_event.src, 'bar')
self.assertEqual(self.current_event.dst, 'baz')
self.assertEqual(self.current_event.named_attribute, 'test')
self.assertEqual(self.current_event.args[0], 'positional')
self.assertTrue(self.current_event.fsm is fsm)
|