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_reenter_fooed(self, e):
self.reenter_fooed_event = e
def on_reenter_bared(self, e):
self.reenter_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': 'foo', 'src': 'fooed', 'dst': 'fooed'},
{'name': 'bar', 'src': 'fooed', 'dst': 'bared'},
{'name': 'bar', 'src': 'bared', '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,
'onreenterfooed': self.on_reenter_fooed,
'onreenterbared': self.on_reenter_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.assertRaises(Canceled, 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_onreenter_state_callbacks_should_fire_with_keyword_arguments_when_state_transitions_occur(self):
self.fsm.foo(attribute='testfail')
self.fsm.foo(attribute='testpass')
self.assertTrue(
hasattr(self, 'reenter_fooed_event'), 'Callback onreenterfooed did not fire.')
self.assertTrue(self.reenter_fooed_event is not None)
self.assertEqual(self.reenter_fooed_event.attribute, 'testpass')
self.fsm.bar(id=1234)
self.fsm.bar(id=4321)
self.assertTrue(
hasattr(self, 'reenter_bared_event'), 'Callback onreenterbared did not fire.')
self.assertTrue(self.reenter_bared_event is not None)
self.assertEqual(self.reenter_bared_event.id, 4321)
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)
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_reenter_fooed(self, e):
self.reenter_fooed_event = e
def on_reenter_bared(self, e):
self.reenter_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': 'foo', 'src': 'fooed', 'dst': 'fooed'},
{'name': 'bar', 'src': 'fooed', 'dst': 'bared'},
{'name': 'bar', 'src': 'bared', '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,
'onreenterfooed': self.on_reenter_fooed,
'onreenterbared': self.on_reenter_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.assertRaises(Canceled, 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_onreenter_state_callbacks_should_fire_with_keyword_arguments_when_state_transitions_occur(self):
self.fsm.foo(attribute='testfail')
self.fsm.foo(attribute='testpass')
self.assertTrue(
hasattr(self, 'reenter_fooed_event'), 'Callback onreenterfooed did not fire.')
self.assertTrue(self.reenter_fooed_event is not None)
self.assertEqual(self.reenter_fooed_event.attribute, 'testpass')
self.fsm.bar(id=1234)
self.fsm.bar(id=4321)
self.assertTrue(
hasattr(self, 'reenter_bared_event'), 'Callback onreenterbared did not fire.')
self.assertTrue(self.reenter_bared_event is not None)
self.assertEqual(self.reenter_bared_event.id, 4321)
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)
