-
Notifications
You must be signed in to change notification settings - Fork 568
Expand file tree
/
Copy pathtest_async.py
More file actions
845 lines (690 loc) · 32.9 KB
/
test_async.py
File metadata and controls
845 lines (690 loc) · 32.9 KB
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
from asyncio import CancelledError
import sys
from transitions.extensions.factory import AsyncGraphMachine, HierarchicalAsyncGraphMachine
from transitions.extensions.states import add_state_features
try:
import asyncio
from transitions.extensions.asyncio import AsyncMachine, HierarchicalAsyncMachine, AsyncEventData, \
AsyncTransition, AsyncTimeout
except (ImportError, SyntaxError):
asyncio = None # type: ignore
from unittest.mock import MagicMock
from unittest import skipIf
from functools import partial
import weakref
from .test_core import TestTransitions, MachineError, TYPE_CHECKING
from .utils import DummyModel, Stuff
from .test_graphviz import pgv as gv
from .test_pygraphviz import pgv
if TYPE_CHECKING:
from typing import Type, Sequence, List
from transitions.extensions.asyncio import AsyncTransitionConfig
@skipIf(asyncio is None, "AsyncMachine requires asyncio and contextvars suppport")
class TestAsync(TestTransitions):
@staticmethod
async def await_false():
await asyncio.sleep(0.1)
return False
@staticmethod
async def await_true():
await asyncio.sleep(0.1)
return True
@staticmethod
async def cancel_soon():
await asyncio.sleep(1)
raise TimeoutError("Callback was not cancelled!")
@staticmethod
def raise_value_error():
raise ValueError("ValueError raised.")
@staticmethod
def synced_true():
return True
@staticmethod
async def call_delayed(func, time):
await asyncio.sleep(time)
await func()
def setUp(self):
super(TestAsync, self).setUp()
self.machine_cls = AsyncMachine # type: Type[AsyncMachine]
self.machine = self.machine_cls(states=['A', 'B', 'C'], transitions=[['go', 'A', 'B']], initial='A')
def test_new_state_in_enter_callback(self):
machine = self.machine_cls(states=['A', 'B'], initial='A')
async def on_enter_B():
state = self.machine_cls.state_cls(name='C')
machine.add_state(state)
await machine.to_C()
machine.on_enter_B(on_enter_B)
asyncio.run(machine.to_B())
def test_dynamic_model_state_attribute(self):
class Model:
def __init__(self):
self.status = None
self.state = 'some_value'
m = self.machine_cls(Model(), states=['A', 'B'], initial='A', model_attribute='status')
self.assertEqual(m.model.status, 'A')
self.assertEqual(m.model.state, 'some_value')
m.add_transition('move', 'A', 'B')
asyncio.run(m.model.move())
self.assertEqual(m.model.status, 'B')
self.assertEqual(m.model.state, 'some_value')
def test_async_machine_cb(self):
mock = MagicMock()
async def async_process():
await asyncio.sleep(0.1)
mock()
m = self.machine
m.after_state_change = [async_process]
asyncio.run(m.go())
self.assertEqual(m.state, 'B')
self.assertTrue(mock.called)
def test_async_condition(self):
m = self.machine
m.add_transition('proceed', 'A', 'C', conditions=self.await_true, unless=self.await_false)
asyncio.run(m.proceed())
self.assertEqual(m.state, 'C')
def test_async_enter_exit(self):
enter_mock = MagicMock()
exit_mock = MagicMock()
async def async_enter():
await asyncio.sleep(0.1)
enter_mock()
async def async_exit():
await asyncio.sleep(0.1)
exit_mock()
m = self.machine
m.on_exit_A(async_exit)
m.on_enter_B(async_enter)
asyncio.run(m.go())
self.assertTrue(exit_mock.called)
self.assertTrue(enter_mock.called)
def test_sync_conditions(self):
mock = MagicMock()
def sync_process():
mock()
m = self.machine
m.add_transition('proceed', 'A', 'C', conditions=self.synced_true, after=sync_process)
asyncio.run(m.proceed())
self.assertEqual(m.state, 'C')
self.assertTrue(mock.called)
def test_multiple_models(self):
m1 = self.machine_cls(states=['A', 'B', 'C'], initial='A', name="m1")
m2 = self.machine_cls(states=['A'], initial='A', name='m2')
m1.add_transition(trigger='go', source='A', dest='B', before=self.cancel_soon)
m1.add_transition(trigger='fix', source='A', dest='C', after=self.cancel_soon)
m1.add_transition(trigger='check', source='C', dest='B', conditions=self.await_false)
m1.add_transition(trigger='reset', source='C', dest='A')
m2.add_transition(trigger='go', source='A', dest=None, conditions=m1.is_C, after=m1.reset)
async def run():
_ = asyncio.gather(m1.go(), # should block before B
self.call_delayed(m1.fix, 0.05), # should cancel task and go to C
self.call_delayed(m1.check, 0.07), # should exit before m1.fix
self.call_delayed(m2.go, 0.1)) # should cancel m1.fix
assert m1.is_A()
asyncio.run(run())
def test_async_callback_arguments(self):
async def process(should_fail=True):
if should_fail is not False:
raise ValueError("should_fail has been set")
self.machine.on_enter_B(process)
with self.assertRaises(ValueError):
asyncio.run(self.machine.go())
asyncio.run(self.machine.to_A())
asyncio.run(self.machine.go(should_fail=False))
def test_async_callback_event_data(self):
state_a = self.machine_cls.state_cls('A')
state_b = self.machine_cls.state_cls('B')
def sync_condition(event_data):
return event_data.state == state_a
async def async_conditions(event_data):
return event_data.state == state_a
async def async_callback(event_data):
self.assertEqual(event_data.state, state_b)
def sync_callback(event_data):
self.assertEqual(event_data.state, state_b)
m = self.machine_cls(states=[state_a, state_b], initial='A', send_event=True)
m.add_transition('go', 'A', 'B', conditions=[sync_condition, async_conditions],
after=[sync_callback, async_callback])
m.add_transition('go', 'B', 'A', conditions=sync_condition)
asyncio.run(m.go())
self.assertTrue(m.is_B())
asyncio.run(m.go())
self.assertTrue(m.is_B())
def test_async_invalid_triggers(self):
asyncio.run(self.machine.to_B())
with self.assertRaises(MachineError):
asyncio.run(self.machine.go())
self.machine.ignore_invalid_triggers = True
asyncio.run(self.machine.go())
self.assertTrue(self.machine.is_B())
def test_async_dispatch(self):
model1 = DummyModel()
model2 = DummyModel()
model3 = DummyModel()
machine = self.machine_cls(model=None, states=['A', 'B', 'C'], transitions=[['go', 'A', 'B'],
['go', 'B', 'C'],
['go', 'C', 'A']], initial='A')
machine.add_model(model1)
machine.add_model(model2, initial='B')
machine.add_model(model3, initial='C')
asyncio.run(machine.dispatch('go'))
self.assertTrue(model1.is_B())
self.assertEqual('C', model2.state)
self.assertEqual(machine.initial, model3.state)
def test_queued(self):
states = ['A', 'B', 'C', 'D']
# Define with list of dictionaries
async def change_state(machine):
# type: (AsyncMachine) -> None
self.assertEqual(machine.state, 'A')
if machine.has_queue:
await machine.run(machine=machine)
self.assertEqual(machine.state, 'A')
else:
with self.assertRaises(MachineError):
await machine.run(machine=machine)
async def raise_machine_error(event_data):
# type: (AsyncEventData) -> None
self.assertTrue(event_data.machine.has_queue)
await event_data.model.to_A()
event_data.machine._queued = False
await event_data.model.to_C()
async def raise_exception(event_data):
# type: (AsyncEventData) -> None
await event_data.model.to_C()
raise ValueError("Clears queue")
transitions = [
{'trigger': 'walk', 'source': 'A', 'dest': 'B', 'before': change_state},
{'trigger': 'run', 'source': 'B', 'dest': 'C'},
{'trigger': 'sprint', 'source': 'C', 'dest': 'D'}
] # type: Sequence[AsyncTransitionConfig]
m = self.machine_cls(states=states, transitions=transitions, initial='A')
asyncio.run(m.walk(machine=m))
self.assertEqual('B', m.state)
m = self.machine_cls(states=states, transitions=transitions, initial='A', queued=True)
asyncio.run(m.walk(machine=m))
self.assertEqual('C', m.state)
m = self.machine_cls(states=states, initial='A', queued=True, send_event=True,
before_state_change=raise_machine_error)
with self.assertRaises(MachineError):
asyncio.run(m.to_C())
m = self.machine_cls(states=states, initial='A', queued=True, send_event=True)
m.add_transition('go', 'A', 'B', after='go')
m.add_transition('go', 'B', 'C', before=raise_exception)
with self.assertRaises(ValueError):
asyncio.run(m.go())
self.assertEqual('B', m.state)
def test_model_queue(self):
mock = MagicMock()
def check_mock():
self.assertTrue(mock.called)
m1 = DummyModel()
m2 = DummyModel()
async def run():
transitions = [
{'trigger': 'mock', 'source': ['A', 'B'], 'dest': 'B', 'after': mock},
{'trigger': 'delayed', 'source': 'A', 'dest': 'B', 'before': partial(asyncio.sleep, 0.1)},
{'trigger': 'check', 'source': 'B', 'dest': 'A', 'after': check_mock},
{'trigger': 'error', 'source': 'B', 'dest': 'C', 'before': self.raise_value_error}
] # type: Sequence[AsyncTransitionConfig]
m = self.machine_cls(model=[m1, m2], states=['A', 'B', 'C'], transitions=transitions, initial='A',
queued='model')
# call m1.delayed and m2.mock should be called immediately
# m1.check should be delayed until after m1.delayed
await asyncio.gather(m1.delayed(), self.call_delayed(m1.check, 0.02), self.call_delayed(m2.mock, 0.04))
self.assertTrue(m1.is_A())
self.assertTrue(m2.is_B())
mock.reset_mock()
with self.assertRaises(ValueError):
# m1.error raises an error which should cancel m1.to_A but not m2.mock and m2.check
await asyncio.gather(m1.to_A(), m2.to_A(),
self.call_delayed(m1.delayed, 0.01), self.call_delayed(m2.delayed, 0.01),
self.call_delayed(m1.error, 0.02), self.call_delayed(m1.to_A, 0.03),
self.call_delayed(m2.mock, 0.03), self.call_delayed(m2.check, 0.04))
await asyncio.sleep(0.05) # give m2 events time to finish
self.assertTrue(m1.is_B())
self.assertTrue(m2.is_A())
asyncio.run(run())
def test_queued_remove(self):
def remove_model(event_data):
event_data.machine.remove_model(event_data.model)
def check_queue(expect, event_data):
self.assertEqual(expect, len(event_data.machine._transition_queue_dict[id(event_data.model)]))
transitions = [
{'trigger': 'go', 'source': 'A', 'dest': 'B', 'after': partial(asyncio.sleep, 0.1)},
{'trigger': 'go', 'source': 'B', 'dest': 'C'},
{'trigger': 'remove', 'source': 'B', 'dest': None, 'prepare': ['to_A', 'to_C'],
'before': partial(check_queue, 4), 'after': remove_model},
{'trigger': 'remove_queue', 'source': 'B', 'dest': None, 'prepare': ['to_A', 'to_C'],
'before': partial(check_queue, 3), 'after': remove_model}
] # type: Sequence[AsyncTransitionConfig]
async def run():
m1 = DummyModel()
m2 = DummyModel()
self.machine_cls = HierarchicalAsyncMachine
m = self.machine_cls(model=[m1, m2], states=['A', 'B', 'C'], transitions=transitions,
initial='A', queued=True, send_event=True)
await asyncio.gather(m1.go(), m2.go(),
self.call_delayed(m1.remove, 0.02), self.call_delayed(m2.go, 0.04))
_ = repr(m._transition_queue_dict) # check whether _DictionaryMock returns a valid representation
self.assertTrue(m1.is_B())
self.assertTrue(m2.is_C())
m.remove_model(m2)
self.assertNotIn(id(m1), m._transition_queue_dict)
self.assertNotIn(id(m2), m._transition_queue_dict)
m1 = DummyModel()
m2 = DummyModel()
m = self.machine_cls(model=[m1, m2], states=['A', 'B', 'C'], transitions=transitions,
initial='A', queued='model', send_event=True)
await asyncio.gather(m1.go(), m2.go(),
self.call_delayed(m1.remove_queue, 0.02), self.call_delayed(m2.go, 0.04))
self.assertTrue(m1.is_B())
self.assertTrue(m2.is_C())
m.remove_model(m2)
asyncio.run(run())
def test_async_timeout(self):
timeout_called = MagicMock()
@add_state_features(AsyncTimeout)
class TimeoutMachine(self.machine_cls): # type: ignore
pass
states = ['A',
{'name': 'B', 'timeout': 0.2, 'on_timeout': ['to_C', timeout_called]},
{'name': 'C', 'timeout': 0, 'on_timeout': 'to_D'}, 'D']
m = TimeoutMachine(states=states, initial='A')
with self.assertRaises(AttributeError):
m.add_state('Fail', timeout=1)
async def run():
await m.to_B()
await asyncio.sleep(0.1)
self.assertTrue(m.is_B()) # timeout shouldn't be triggered
await m.to_A() # cancel timeout
self.assertTrue(m.is_A())
await m.to_B()
await asyncio.sleep(0.3)
self.assertTrue(m.is_C()) # now timeout should have been processed
self.assertTrue(timeout_called.called)
m.get_state('C').timeout = 0.05
await m.to_B()
await asyncio.sleep(0.3)
self.assertTrue(m.is_D())
self.assertEqual(2, timeout_called.call_count)
asyncio.run(run())
def test_timeout_cancel(self):
error_mock = MagicMock()
timout_mock = MagicMock()
long_op_mock = MagicMock()
@add_state_features(AsyncTimeout)
class TimeoutMachine(self.machine_cls): # type: ignore
async def on_enter_B(self):
await asyncio.sleep(0.2)
long_op_mock() # should never be called
async def handle_timeout(self):
timout_mock()
await self.to_A()
machine = TimeoutMachine(states=["A", {"name": "B", "timeout": 0.1, "on_timeout": "handle_timeout"}],
initial="A", on_exception=error_mock)
async def run():
await machine.to_B()
assert timout_mock.called
assert error_mock.call_count == 1 # should only be one CancelledError
assert not long_op_mock.called
assert machine.is_A()
asyncio.run(run())
@skipIf(sys.version_info < (3, 11), "Cancel requires Python 3.11+")
def test_user_cancel(self):
machine = self.machine_cls(states=['A', 'B'], initial='A', before_state_change=self.cancel_soon)
async def run1():
try:
await asyncio.wait_for(machine.to_B(), timeout=0.5)
except asyncio.TimeoutError:
return # expected case
assert False, "Expected a TimeoutError"
async def run2():
async def raise_timeout():
raise asyncio.TimeoutError("My custom timeout")
try:
machine.add_transition('cancelled', 'A', 'B', before=raise_timeout)
await machine.cancelled()
except asyncio.TimeoutError:
return # expected case
assert False, "Expected a TimeoutError"
asyncio.run(run1())
assert machine.is_A()
asyncio.run(run2())
def test_queued_timeout_cancel(self):
error_mock = MagicMock()
timout_mock = MagicMock()
long_op_mock = MagicMock()
@add_state_features(AsyncTimeout)
class TimeoutMachine(self.machine_cls): # type: ignore
async def long_op(self, event_data):
await self.to_C()
await self.to_D()
await self.to_E()
await asyncio.sleep(1)
long_op_mock()
async def handle_timeout(self, event_data):
timout_mock()
raise TimeoutError()
async def handle_error(self, event_data):
if isinstance(event_data.error, CancelledError):
if error_mock.called:
raise RuntimeError()
error_mock()
raise event_data.error
machine = TimeoutMachine(states=["A", "C", "D", "E",
{"name": "B", "timeout": 0.1, "on_timeout": "handle_timeout",
"on_enter": "long_op"}],
initial="A", queued=True, send_event=True, on_exception="handle_error")
async def run():
await machine.to_B()
assert timout_mock.called
assert error_mock.called
assert not long_op_mock.called
assert machine.is_B()
with self.assertRaises(RuntimeError):
await machine.to_B()
asyncio.run(run())
def test_callback_order(self):
finished = []
class Model:
async def before(self):
await asyncio.sleep(0.1)
finished.append(2)
async def after(self):
await asyncio.sleep(0.1)
finished.append(3)
async def after_state_change():
finished.append(4)
async def before_state_change():
finished.append(1)
model = Model()
m = self.machine_cls(
model=model,
states=['start', 'end'],
after_state_change=after_state_change,
before_state_change=before_state_change,
initial='start',
)
m.add_transition('transit', 'start', 'end', after='after', before='before')
asyncio.run(model.transit())
assert finished == [1, 2, 3, 4]
def test_task_cleanup(self):
models = [DummyModel() for i in range(100)]
m = self.machine_cls(model=models, states=['A', 'B'], initial='A')
self.assertEqual(0, len(m.async_tasks)) # check whether other tests were already leaking tasks
async def run():
for model in m.models:
await model.to_B()
asyncio.run(run())
self.assertEqual(0, len(m.async_tasks))
def test_on_exception_callback(self):
mock = MagicMock()
def on_exception(event_data):
self.assertIsInstance(event_data.error, (ValueError, MachineError))
mock()
m = self.machine_cls(states=['A', 'B'], initial='A', transitions=[['go', 'A', 'B']], send_event=True,
after_state_change=partial(self.stuff.this_raises, ValueError))
async def run():
with self.assertRaises(ValueError):
await m.to_B()
m.on_exception.append(on_exception)
await m.to_B()
await m.go()
self.assertTrue(mock.called)
self.assertEqual(2, mock.call_count)
self.assertTrue(mock.called)
asyncio.run(run())
def test_on_exception_finalize(self):
mock = MagicMock()
def finalize():
mock()
raise RuntimeError("Could not finalize")
m = self.machine_cls(states=['A', 'B'], initial='A', finalize_event=finalize)
async def run():
self.assertTrue(await m.to_B())
self.assertTrue(mock.called)
asyncio.run(run())
def test_weakproxy_model(self):
d = DummyModel()
pr = weakref.proxy(d)
self.machine_cls(pr, states=['A', 'B'], transitions=[['go', 'A', 'B']], initial='A')
asyncio.run(pr.go())
self.assertTrue(pr.is_B())
def test_may_transition_with_auto_transitions(self):
states = ['A', 'B', 'C']
d = DummyModel()
self.machine_cls(model=d, states=states, initial='A')
async def run():
assert await d.may_to_A()
assert await d.may_trigger("to_A")
assert await d.may_to_B()
assert await d.may_trigger("to_B")
assert await d.may_to_C()
assert await d.may_trigger("to_C")
asyncio.run(run())
def test_machine_may_transitions(self):
states = ['A', 'B', 'C']
m = self.machine_cls(states=states, initial='A', auto_transitions=False)
m.add_transition('walk', 'A', 'B', conditions=[lambda: False])
m.add_transition('stop', 'B', 'C')
m.add_transition('run', 'A', 'C')
async def run():
assert not await m.may_walk()
assert not await m.may_trigger("walk")
assert not await m.may_stop()
assert not await m.may_trigger("stop")
assert await m.may_run()
assert await m.may_trigger("run")
await m.run()
assert not await m.may_run()
assert not await m.may_trigger("run")
assert not await m.may_stop()
assert not await m.may_trigger("stop")
assert not await m.may_walk()
assert not await m.may_trigger("walk")
asyncio.run(run())
def test_may_transition_with_invalid_state(self):
states = ['A', 'B', 'C']
d = DummyModel()
m = self.machine_cls(model=d, states=states, initial='A', auto_transitions=False)
m.add_transition('walk', 'A', 'UNKNOWN')
async def run():
assert not await d.may_walk()
assert not await d.may_trigger("walk")
asyncio.run(run())
def test_may_transition_internal(self):
states = ['A', 'B', 'C']
d = DummyModel()
_ = self.machine_cls(model=d, states=states, transitions=[["go", "A", "B"], ["wait", "B", None]],
initial='A', auto_transitions=False)
async def run():
assert await d.may_go()
assert await d.may_trigger("go")
assert not await d.may_wait()
assert not await d.may_trigger("wait")
await d.go()
assert not await d.may_go()
assert not await d.may_trigger("go")
assert await d.may_wait()
assert await d.may_trigger("wait")
asyncio.run(run())
def test_may_transition_with_exception(self):
stuff = Stuff(machine_cls=self.machine_cls, extra_kwargs={"send_event": True})
stuff.machine.add_transition(trigger="raises", source="A", dest="B", prepare=partial(stuff.this_raises, RuntimeError("Prepare Exception")))
stuff.machine.add_transition(trigger="raises", source="B", dest="C", conditions=partial(stuff.this_raises, ValueError("Condition Exception")))
stuff.machine.add_transition(trigger="works", source="A", dest="B")
def process_exception(event_data):
assert event_data.error is not None
assert event_data.transition is not None
assert event_data.event.name == "raises"
assert event_data.machine == stuff.machine
async def run():
with self.assertRaises(RuntimeError):
await stuff.may_raises()
with self.assertRaises(RuntimeError):
await stuff.may_trigger("raises")
assert stuff.is_A()
assert await stuff.may_works()
assert await stuff.may_trigger("works")
assert await stuff.works()
with self.assertRaises(ValueError):
await stuff.may_raises()
with self.assertRaises(ValueError):
await stuff.may_trigger("raises")
assert stuff.is_B()
stuff.machine.on_exception.append(process_exception)
assert not await stuff.may_raises()
assert not await stuff.may_trigger("raises")
assert await stuff.to_A()
assert not await stuff.may_raises()
assert not await stuff.may_trigger("raises")
asyncio.run(run())
def test_on_final(self):
final_mock = MagicMock()
machine = self.machine_cls(states=['A', {'name': 'B', 'final': True}], on_final=final_mock, initial='A')
async def run():
self.assertFalse(final_mock.called)
await machine.to_B()
self.assertTrue(final_mock.called)
await machine.to_A()
self.assertEqual(1, final_mock.call_count)
await machine.to_B()
self.assertEqual(2, final_mock.call_count)
asyncio.run(run())
def test_custom_transition(self):
class MyTransition(self.machine_cls.transition_cls): # type: ignore
def __init__(self, source, dest, conditions=None, unless=None, before=None,
after=None, prepare=None, my_int=None, my_none=None, my_str=None, my_dict=None):
super(MyTransition, self).__init__(source, dest, conditions, unless, before, after, prepare)
self.my_int = my_int
self.my_none = my_none
self.my_str = my_str
self.my_dict = my_dict
class MyMachine(self.machine_cls): # type: ignore
transition_cls = MyTransition
a_transition = {
"trigger": "go", "source": "B", "dest": "A",
"my_int": 42, "my_str": "foo", "my_dict": {"bar": "baz"}
}
transitions = [
["go", "A", "B"],
a_transition
]
m = MyMachine(states=["A", "B"], transitions=transitions, initial="A")
m.add_transition("reset", "*", "A",
my_int=23, my_str="foo2", my_none=None, my_dict={"baz": "bar"})
async def run():
assert await m.go()
trans = m.get_transitions("go", "B") # type: List[MyTransition]
assert len(trans) == 1
assert trans[0].my_str == a_transition["my_str"]
assert trans[0].my_int == a_transition["my_int"]
assert trans[0].my_dict == a_transition["my_dict"]
assert trans[0].my_none is None
trans = m.get_transitions("reset", "A")
assert len(trans) == 1
assert trans[0].my_str == "foo2"
assert trans[0].my_int == 23
assert trans[0].my_dict == {"baz": "bar"}
assert trans[0].my_none is None
asyncio.run(run())
def test_deprecation_warnings(self):
import warnings
async def run():
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
machine = self.machine_cls(states=['A', 'B'], initial='A')
await machine.cancel_running_transitions(self)
self.assertEqual(len(w), 0)
# msg is deprecated, should not be used
await machine.cancel_running_transitions(self, msg="Custom message")
self.assertEqual(len(w), 1)
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
self.assertEqual(len(w), 0)
# should use cancel_running_transitions instead
await machine.switch_model_context(self)
self.assertEqual(len(w), 1)
asyncio.run(run())
@skipIf(asyncio is None or (pgv is None and gv is None), "AsyncGraphMachine requires asyncio and (py)gaphviz")
class TestAsyncGraphMachine(TestAsync):
def setUp(self):
super(TestAsync, self).setUp()
self.machine_cls = AsyncGraphMachine # type: Type[AsyncGraphMachine]
self.machine = self.machine_cls(states=['A', 'B', 'C'], transitions=[['go', 'A', 'B']], initial='A')
class TestHierarchicalAsync(TestAsync):
def setUp(self):
super(TestAsync, self).setUp()
self.machine_cls = HierarchicalAsyncMachine # type: Type[HierarchicalAsyncMachine]
self.machine = self.machine_cls(states=['A', 'B', 'C'], transitions=[['go', 'A', 'B']], initial='A')
def test_nested_async(self):
mock = MagicMock()
async def sleep_mock():
# type: () -> None
await asyncio.sleep(0.1)
mock()
states = ['A', 'B', {'name': 'C', 'children': ['1', {'name': '2', 'children': ['a', 'b'], 'initial': 'a'},
'3'], 'initial': '2'}]
transitions = [
{'trigger': 'go', 'source': 'A', 'dest': 'C', 'after': [sleep_mock] * 100}
] # type: Sequence[AsyncTransitionConfig]
machine = self.machine_cls(states=states, transitions=transitions, initial='A')
asyncio.run(machine.go())
self.assertEqual('C{0}2{0}a'.format(machine.state_cls.separator), machine.state)
self.assertEqual(100, mock.call_count)
def test_parallel_async(self):
states = ['A', 'B', {'name': 'P',
'parallel': [
{'name': '1', 'children': ['a'], 'initial': 'a'},
{'name': '2', 'children': ['b', 'c'], 'initial': 'b'},
{'name': '3', 'children': ['x', 'y', 'z'], 'initial': 'y'}]}]
machine = self.machine_cls(states=states, initial='A')
asyncio.run(machine.to_P())
self.assertEqual(['P{0}1{0}a'.format(machine.state_cls.separator),
'P{0}2{0}b'.format(machine.state_cls.separator),
'P{0}3{0}y'.format(machine.state_cls.separator)], machine.state)
asyncio.run(machine.to_B())
self.assertTrue(machine.is_B())
def test_final_state_nested(self):
final_mock_B = MagicMock()
final_mock_Y = MagicMock()
final_mock_Z = MagicMock()
final_mock_machine = MagicMock()
mocks = [final_mock_B, final_mock_Y, final_mock_Z, final_mock_machine]
states = ['A', {'name': 'B', 'parallel': [{'name': 'X', 'final': True},
{'name': 'Y', 'transitions': [['final_Y', 'yI', 'yII']],
'initial': 'yI',
'on_final': final_mock_Y,
'states':
['yI', {'name': 'yII', 'final': True}]
},
{'name': 'Z', 'transitions': [['final_Z', 'zI', 'zII']],
'initial': 'zI',
'on_final': final_mock_Z,
'states':
['zI', {'name': 'zII', 'final': True}]
},
],
"on_final": final_mock_B}]
machine = self.machine_cls(states=states, on_final=final_mock_machine, initial='A')
async def run():
self.assertFalse(any(mock.called for mock in mocks))
await machine.to_B()
self.assertFalse(any(mock.called for mock in mocks))
await machine.final_Y()
self.assertTrue(final_mock_Y.called)
self.assertFalse(final_mock_Z.called)
self.assertFalse(final_mock_B.called)
self.assertFalse(final_mock_machine.called)
await machine.final_Z()
self.assertEqual(1, final_mock_Y.call_count)
self.assertEqual(1, final_mock_Z.call_count)
self.assertEqual(1, final_mock_B.call_count)
self.assertEqual(1, final_mock_machine.call_count)
asyncio.run(run())
@skipIf(asyncio is None or (pgv is None and gv is None), "AsyncGraphMachine requires asyncio and (py)gaphviz")
class TestAsyncHierarchicalGraphMachine(TestHierarchicalAsync):
def setUp(self):
super(TestHierarchicalAsync, self).setUp()
self.machine_cls = HierarchicalAsyncGraphMachine # type: Type[HierarchicalAsyncGraphMachine]
self.machine = self.machine_cls(states=['A', 'B', 'C'], transitions=[['go', 'A', 'B']], initial='A')