class TestUnitWorkflow(TestCase):
def setUp(self):
self.private = State('private', is_default=True)
self.pending = State('pending')
self.published = State('published')
self.submit = Transition('private', 'pending')
self.publish = Transition('pending', 'published')
self.reject = Transition('pending', 'private')
self.retract = Retract()
self.workflow = Workflow([
self.private, self.pending, self.published
], [
self.submit, self.publish, self.reject, self.retract
])
def test_transition_string_representation(self):
self.assertEqual('<Transition "private-pending">', str(self.submit))
self.assertEqual('<Transition "private-pending">', repr(self.submit))
def test_state_string_representation(self):
self.assertEqual('<State "pending">', str(self.pending))
self.assertEqual('<State "pending">', repr(self.pending))
def test_state_equality(self):
self.assertEqual(self.private, self.private)
self.assertEqual(self.private, State('private'))
self.assertNotEqual(self.private, self.pending)
self.assertNotEqual(self.pending, None)
self.assertNotEqual(self.pending, object())
def test_default_workflow_is_set(self):
self.assertEqual(self.private, self.workflow.default_state)
def test_fails_without_default_workflow(self):
with self.assertRaises(AssertionError):
Workflow([self.pending], [])
def test_fails_with_duplicate_state(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.private], [])
def test_fails_with_duplicate_transition(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.pending], [self.submit, self.submit])
def test_fails_with_invalid_transition(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.pending],
[Transition('private', 'invalid_identifier')])
def test_get_state_returns_correct_state(self):
self.assertEqual(self.private, self.workflow.get_state('private'))
def test_get_state_fails_with_invalid_state(self):
with self.assertRaises(KeyError):
self.workflow.get_state('invalid_identifier')
def test_can_execute_available_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertTrue(
self.workflow.can_execute_transition(obj, self.submit.name))
def test_cannot_perform_unavailable_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertFalse(
self.workflow.can_execute_transition(obj, self.retract.name))
def test_cannot_perform_invalid_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertFalse(
self.workflow.can_execute_transition(obj, 'invalid_name'))
def test_performs_available_transition(self):
obj = SomethingWithWorkflow(initial_state=self.pending.name)
self.workflow.execute_transition(None, obj, self.publish.name)
self.assertEqual(self.published.name, obj.workflow_state)
def test_transitions_handle_kwargs(self):
""" As the workflow passes kwargs to the transition execute method,
these whould handle kwargs
"""
obj = SomethingWithWorkflow(initial_state=self.pending.name)
self.workflow.execute_transition(None, obj, self.publish.name, useless=True)
self.assertEqual(self.published.name, obj.workflow_state)
def test_workflow_handles_kwargs(self):
""" Workflows needs to handle kwargs as some transitions have
take additional arguments when executed (e.g. Proposal transitions
also take a comment that is added to the history)
"""
obj = SomethingWithWorkflow(initial_state=self.published.name)
self.workflow.execute_transition(None, obj, self.retract.name, useless=True, reason="A comment")
self.assertEqual(self.pending.name, obj.workflow_state)
self.assertListEqual(["A comment"], obj.history)
def test_does_not_perform_unavailable_transition(self):
obj = SomethingWithWorkflow(initial_state=self.pending.name)
with self.assertRaises(CannotExecuteTransition):
self.workflow.execute_transition(None, obj, self.submit.name)
def test_does_not_perform_invalid_transition(self):
obj = SomethingWithWorkflow(initial_state=self.published.name)
with self.assertRaises(AssertionError):
self.workflow.execute_transition(None, obj, 'invalid_identifier')
def test_transitions_are_registered_with_their_state(self):
self.assertEqual([self.submit], self.private.get_transitions())
self.assertEqual([self.publish, self.reject],
self.pending.get_transitions())
self.assertEqual([self.retract], self.published.get_transitions())
class TestUnitWorkflow(TestCase):
def setUp(self):
self.private = State('private', is_default=True)
self.pending = State('pending')
self.published = State('published')
self.submit = Transition('private', 'pending')
self.publish = Transition('pending', 'published')
self.reject = Transition('pending', 'private')
self.retract = Transition('published', 'pending')
self.workflow = Workflow(
[self.private, self.pending, self.published],
[self.submit, self.publish, self.reject, self.retract])
def test_transition_string_representation(self):
self.assertEqual('<Transition "private-pending">', str(self.submit))
self.assertEqual('<Transition "private-pending">', repr(self.submit))
def test_state_string_representation(self):
self.assertEqual('<State "pending">', str(self.pending))
self.assertEqual('<State "pending">', repr(self.pending))
def test_state_equality(self):
self.assertEqual(self.private, self.private)
self.assertEqual(self.private, State('private'))
self.assertNotEqual(self.private, self.pending)
self.assertNotEqual(self.pending, None)
self.assertNotEqual(self.pending, object())
def test_default_workflow_is_set(self):
self.assertEqual(self.private, self.workflow.default_state)
def test_fails_without_default_workflow(self):
with self.assertRaises(AssertionError):
Workflow([self.pending], [])
def test_fails_with_duplicate_state(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.private], [])
def test_fails_with_duplicate_transition(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.pending], [self.submit, self.submit])
def test_fails_with_invalid_transition(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.pending],
[Transition('private', 'invalid_identifier')])
def test_get_state_returns_correct_state(self):
self.assertEqual(self.private, self.workflow.get_state('private'))
def test_get_state_fails_with_invalid_state(self):
with self.assertRaises(KeyError):
self.workflow.get_state('invalid_identifier')
def test_can_execute_available_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertTrue(
self.workflow.can_execute_transition(obj, self.submit.name))
def test_cannot_perform_unavailable_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertFalse(
self.workflow.can_execute_transition(obj, self.retract.name))
def test_cannot_perform_invalid_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertFalse(
self.workflow.can_execute_transition(obj, 'invalid_name'))
def test_performs_available_transition(self):
obj = SomethingWithWorkflow(initial_state=self.pending.name)
self.workflow.execute_transition(None, obj, self.publish.name)
self.assertEqual(self.published.name, obj.workflow_state)
def test_does_not_perform_unavailable_transition(self):
obj = SomethingWithWorkflow(initial_state=self.pending.name)
with self.assertRaises(AssertionError):
self.workflow.execute_transition(None, obj, self.submit.name)
def test_does_not_perform_invalid_transition(self):
obj = SomethingWithWorkflow(initial_state=self.published.name)
with self.assertRaises(AssertionError):
self.workflow.execute_transition(None, obj, 'invalid_identifier')
def test_transitions_are_registered_with_their_state(self):
self.assertEqual([self.submit], self.private.get_transitions())
self.assertEqual([self.publish, self.reject],
self.pending.get_transitions())
self.assertEqual([self.retract], self.published.get_transitions())
class TestUnitWorkflow(TestCase):
def setUp(self):
self.private = State('private', is_default=True)
self.pending = State('pending')
self.published = State('published')
self.submit = Transition('private', 'pending')
self.publish = Transition('pending', 'published')
self.reject = Transition('pending', 'private')
self.retract = Transition('published', 'pending')
self.workflow = Workflow([
self.private, self.pending, self.published
], [
self.submit, self.publish, self.reject, self.retract
])
def test_transition_string_representation(self):
self.assertEqual('<Transition "private-pending">', str(self.submit))
self.assertEqual('<Transition "private-pending">', repr(self.submit))
def test_state_string_representation(self):
self.assertEqual('<State "pending">', str(self.pending))
self.assertEqual('<State "pending">', repr(self.pending))
def test_state_equality(self):
self.assertEqual(self.private, self.private)
self.assertEqual(self.private, State('private'))
self.assertNotEqual(self.private, self.pending)
self.assertNotEqual(self.pending, None)
self.assertNotEqual(self.pending, object())
def test_default_workflow_is_set(self):
self.assertEqual(self.private, self.workflow.default_state)
def test_fails_without_default_workflow(self):
with self.assertRaises(AssertionError):
Workflow([self.pending], [])
def test_fails_with_duplicate_state(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.private], [])
def test_fails_with_duplicate_transition(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.pending], [self.submit, self.submit])
def test_fails_with_invalid_transition(self):
with self.assertRaises(AssertionError):
Workflow([self.private, self.pending],
[Transition('private', 'invalid_identifier')])
def test_get_state_returns_correct_state(self):
self.assertEqual(self.private, self.workflow.get_state('private'))
def test_get_state_fails_with_invalid_state(self):
with self.assertRaises(KeyError):
self.workflow.get_state('invalid_identifier')
def test_can_execute_available_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertTrue(
self.workflow.can_execute_transition(obj, self.submit.name))
def test_cannot_perform_unavailable_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertFalse(
self.workflow.can_execute_transition(obj, self.retract.name))
def test_cannot_perform_invalid_transition(self):
obj = SomethingWithWorkflow(initial_state=self.private.name)
self.assertFalse(
self.workflow.can_execute_transition(obj, 'invalid_name'))
def test_performs_available_transition(self):
obj = SomethingWithWorkflow(initial_state=self.pending.name)
self.workflow.execute_transition(None, obj, self.publish.name)
self.assertEqual(self.published.name, obj.workflow_state)
def test_does_not_perform_unavailable_transition(self):
obj = SomethingWithWorkflow(initial_state=self.pending.name)
with self.assertRaises(AssertionError):
self.workflow.execute_transition(None, obj, self.submit.name)
def test_does_not_perform_invalid_transition(self):
obj = SomethingWithWorkflow(initial_state=self.published.name)
with self.assertRaises(AssertionError):
self.workflow.execute_transition(None, obj, 'invalid_identifier')
def test_transitions_are_registered_with_their_state(self):
self.assertEqual([self.submit], self.private.get_transitions())
self.assertEqual([self.publish, self.reject],
self.pending.get_transitions())
self.assertEqual([self.retract], self.published.get_transitions())
