def test_many_side_effects(self):
transition = Transition('test',
sources=[],
target='cancelled',
side_effects=[disable_invoice, enable_invoice])
self.assertTrue(self.invoice.is_available)
state = State(self.invoice, 'status')
transition.change_state(state)
self.assertEqual(self.invoice.status, transition.target)
self.assertTrue(self.invoice.is_available)
self.assertFalse(state.is_locked())
def test_one_callback(self):
transition = Transition('test',
sources=[],
target='cancelled',
callbacks=[disable_invoice])
self.assertTrue(self.invoice.is_available)
state = State(self.invoice, 'status')
transition.change_state(state)
self.assertEqual(self.invoice.status, transition.target)
self.assertFalse(self.invoice.is_available)
self.assertFalse(state.is_locked())
def test_one_callback(self):
action = Action('test',
side_effects=[fail_invoice],
sources=['draft'],
failure_callbacks=[disable_invoice],
failed_state='failed')
self.assertTrue(self.invoice.is_available)
state = State(self.invoice, 'status')
action.change_state(state)
self.assertEqual(self.invoice.status, 'failed')
self.assertFalse(self.invoice.is_available)
self.assertFalse(state.is_locked())
def test_failure_during_side_effect_with_failed_state(self):
action = Action(
'test',
sources=['draft'],
failed_state='failed',
side_effects=[disable_invoice, fail_invoice, enable_invoice])
self.assertTrue(self.invoice.is_available)
state = State(self.invoice, 'status')
action.change_state(state)
self.assertEqual(self.invoice.status, 'failed')
self.assertFalse(self.invoice.is_available)
self.assertFalse(state.is_locked())
def test_failure_during_side_effect_with_failed_state(self):
transition = Transition(
'test',
sources=[],
target='cancelled',
failed_state='failed',
side_effects=[disable_invoice, fail_invoice, enable_invoice])
self.assertTrue(self.invoice.is_available)
state = State(self.invoice, 'status')
transition.change_state(state)
self.assertEqual(self.invoice.status, 'failed')
self.assertFalse(self.invoice.is_available)
self.assertFalse(state.is_locked())
def test_one_callback(self):
transition = Transition('test',
sources=[],
target='success',
side_effects=[fail_invoice],
failure_callbacks=[disable_invoice],
failed_state='failed')
self.assertTrue(self.invoice.is_available)
state = State(self.invoice, 'status')
transition.change_state(state)
self.assertEqual(self.invoice.status, 'failed')
self.assertFalse(self.invoice.is_available)
self.assertFalse(state.is_locked())
def test_callbacks_with_parameters(self):
update_invoice(self.invoice, is_available=True, customer_received=True)
action = Action('test',
failed_state='failed',
sources=['draft'],
callbacks=[update_invoice])
self.invoice.refresh_from_db()
self.assertTrue(self.invoice.is_available)
self.assertTrue(self.invoice.customer_received)
state = State(self.invoice, 'status')
action.change_state(state, is_available=False, customer_received=False)
self.invoice.refresh_from_db()
self.assertFalse(self.invoice.is_available)
self.assertFalse(self.invoice.customer_received)
self.assertFalse(state.is_locked())
def test_side_effect_with_parameters(self):
update_invoice(self.invoice, is_available=True, customer_received=True)
transition = Transition('test',
sources=[],
target='cancelled',
failed_state='failed',
side_effects=[update_invoice])
self.invoice.refresh_from_db()
self.assertTrue(self.invoice.is_available)
self.assertTrue(self.invoice.customer_received)
state = State(self.invoice, 'status')
transition.change_state(state,
is_available=False,
customer_received=False)
self.invoice.refresh_from_db()
self.assertFalse(self.invoice.is_available)
self.assertFalse(self.invoice.customer_received)
self.assertFalse(state.is_locked())
def change_state(self, state: State, **kwargs):
"""
This method changes a state by the following algorithm:
- Lock state
- Change state to `in progress` if such exists
- Run side effects which should run `complete_transition` in case of success
or `fail_transition` in case of failure.
:param state: State object
"""
if state.is_locked():
logging.info(f'{state.instance_key} is locked')
raise TransitionNotAllowed("State is locked")
state.lock()
logging.info(f'{state.instance_key} has been locked')
if self.in_progress_state:
state.set_state(self.in_progress_state)
logging.info(
f'{state.instance_key} state changed to {self.in_progress_state}'
)
self.side_effects.execute(state, **kwargs)