forked from fgmacedo/python-statemachine
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_callbacks.py
More file actions
482 lines (362 loc) · 15.3 KB
/
Copy pathtest_callbacks.py
File metadata and controls
482 lines (362 loc) · 15.3 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
from unittest import mock
import pytest
from statemachine.callbacks import CallbackGroup
from statemachine.callbacks import CallbacksExecutor
from statemachine.callbacks import CallbackSpec
from statemachine.callbacks import CallbackSpecList
from statemachine.callbacks import CallbacksRegistry
from statemachine.dispatcher import resolver_factory_from_objects
from statemachine.exceptions import InvalidDefinition
from statemachine import State
from statemachine import StateChart
@pytest.fixture()
def ObjectWithCallbacks():
class ObjectWithCallbacks:
def __init__(self):
super().__init__()
self.name = "statemachine"
self.callbacks = CallbackSpecList().add(
["life_meaning", "name", "a_method"],
group=CallbackGroup.ON,
)
self.can_be_called = self.callbacks.grouper(CallbackGroup.ON)
self.registry = CallbacksRegistry()
resolver_factory_from_objects(self).resolve(self.callbacks, registry=self.registry)
@property
def life_meaning(self):
return 42
def a_method(self, *args, **kwargs):
return args, kwargs
return ObjectWithCallbacks
class TestCallbacksMachinery:
def test_callback_meta_is_hashable(self):
wrapper = CallbackSpec("something", group=CallbackGroup.ON)
set().add(wrapper)
def test_can_add_callback_that_is_a_string(self):
specs = CallbackSpecList()
func = mock.Mock()
registry = CallbacksRegistry()
class MyObject:
def my_method(self, *args, **kwargs):
return func("my_method", *args, **kwargs)
def other_method(self, *args, **kwargs):
return func("other_method", *args, **kwargs)
def last_one(self, *args, **kwargs):
return func("last_one", *args, **kwargs)
obj = MyObject()
specs.add("my_method", group=CallbackGroup.ON).add("other_method", group=CallbackGroup.ON)
specs.add("last_one", group=CallbackGroup.ON)
resolver_factory_from_objects(obj).resolve(specs, registry)
registry[CallbackGroup.ON.build_key(specs)].call(1, 2, 3, a="x", b="y")
assert func.call_args_list == [
mock.call("my_method", 1, 2, 3, a="x", b="y"),
mock.call("other_method", 1, 2, 3, a="x", b="y"),
mock.call("last_one", 1, 2, 3, a="x", b="y"),
]
def test_callbacks_are_iterable(self):
specs = CallbackSpecList()
specs.add("my_method", 1).add("other_method", 1)
specs.add("last_one", 1)
assert [c.func for c in specs] == ["my_method", "other_method", "last_one"]
def test_add_many_callbacks_at_once(self):
specs = CallbackSpecList()
method_names = ["my_method", "other_method", "last_one"]
specs.add(method_names, group=CallbackGroup.ON)
assert [c.func for c in specs] == method_names
@pytest.mark.parametrize("is_convention", [False, True])
def test_raise_error_if_didnt_found_attr(self, is_convention):
specs = CallbackSpecList()
registry = CallbacksRegistry()
specs.add(
"this_does_no_exist",
group=CallbackGroup.ON,
is_convention=is_convention,
)
resolver_factory_from_objects(self).resolve(specs, registry=registry)
if is_convention:
registry.check(specs)
else:
with pytest.raises(InvalidDefinition):
registry.check(specs)
def test_collect_results(self):
specs = CallbackSpecList()
registry = CallbacksRegistry()
def func1():
return 10
def func2():
return ("a", True)
def func3():
return {"key": "value"}
specs.add([func1, func2, func3], group=CallbackGroup.ON)
resolver_factory_from_objects(object()).resolve(specs, registry=registry)
results = registry[CallbackGroup.ON.build_key(specs)].call(1, 2, 3, a="x", b="y")
assert results == [
10,
("a", True),
{"key": "value"},
]
def test_callbacks_values_resolution(self, ObjectWithCallbacks):
x = ObjectWithCallbacks()
assert x.registry[CallbackGroup.ON.build_key(x.callbacks)].call(xablau=True) == [
42,
"statemachine",
((), {"xablau": True}),
]
class TestCallbacksAsDecorator:
def test_decorate_unbounded_function(self, ObjectWithCallbacks):
x = ObjectWithCallbacks()
@x.can_be_called
def hero_lowercase(hero):
return hero.lower()
@x.can_be_called
def race_uppercase(race):
return race.upper()
resolver_factory_from_objects(x).resolve(x.callbacks, registry=x.registry)
assert x.registry[CallbackGroup.ON.build_key(x.callbacks)].call(
hero="Gandalf", race="Maia"
) == [
42,
"statemachine",
((), {"hero": "Gandalf", "race": "Maia"}),
"gandalf",
"MAIA",
]
assert race_uppercase("Hobbit") == "HOBBIT"
def test_decorate_unbounded_machine_methods(self):
class MiniHeroJourneyMachine(StateChart):
ordinary_world = State(initial=True)
call_to_adventure = State(final=True)
refusal_of_call = State(final=True)
adventure_called = ordinary_world.to(call_to_adventure)
def __init__(self, *args, **kwargs):
self.spy = mock.Mock(side_effect=lambda *x: x)
super().__init__(*args, **kwargs)
@ordinary_world.enter
def enter_ordinary_world(self):
"""This is the hero's life before they begin their journey. It is their "normal"
world, where they are comfortable and familiar.
"""
self.spy("enter_ordinary_world")
@call_to_adventure.enter
def enter_call_to_adventure(self, request):
"""Something happens that forces the hero to leave their ordinary world and embark
on a journey. This might be a direct call, like a prophecy or a request for help,
or it might be a more subtle nudge, like a feeling of restlessness or a sense of
something missing in their life."""
self.spy("call_to_adventure", request)
@ordinary_world.to(refusal_of_call)
def refuse_call(self, reason):
self.spy("refuse_call", reason)
sm = MiniHeroJourneyMachine()
sm.adventure_called(request="The darkness is coming")
assert sm.spy.call_args_list == [
mock.call("enter_ordinary_world"),
mock.call("call_to_adventure", "The darkness is coming"),
]
sm = MiniHeroJourneyMachine()
sm.refuse_call(reason="Not prepared yet")
assert sm.spy.call_args_list == [
mock.call("enter_ordinary_world"),
mock.call("refuse_call", "Not prepared yet"),
]
class TestIssue406:
"""
A StateMachine that exercises the example given on issue
#[406](https://github.com/fgmacedo/python-statemachine/issues/406).
In this example, the event callback must be registered only once.
"""
def test_issue_406(self, mocker):
mock = mocker.Mock()
class ExampleStateMachine(StateChart):
created = State(initial=True)
inited = State(final=True)
initialize = created.to(inited)
@initialize.before
def before_initialize(self):
mock("before init")
@initialize.on
def on_initialize(self):
mock("on init")
sm = ExampleStateMachine()
sm.initialize()
assert mock.call_args_list == [
mocker.call("before init"),
mocker.call("on init"),
]
class TestIssue417:
"""
A StateMachine that exercises the example given on issue
#[417](https://github.com/fgmacedo/python-statemachine/issues/417).
"""
@pytest.fixture()
def mock_calls(self, mocker):
return mocker.Mock()
@pytest.fixture()
def model_class(self):
class Model:
def __init__(self, counter: int = 0):
self.state = None
self.counter = counter
def can_be_started_on_model(self) -> bool:
return self.counter > 0
@property
def can_be_started_as_property_on_model(self) -> bool:
return self.counter > 1
@property
def can_be_started_as_property_str_on_model(self) -> bool:
return self.counter > 2
return Model
@pytest.fixture()
def sm_class(self, model_class, mock_calls):
class ExampleStateMachine(StateChart):
allow_event_without_transition = False
catch_errors_as_events = False
created = State(initial=True)
started = State(final=True)
def can_be_started(self) -> bool:
return self.counter > 0
@property
def can_be_started_as_property(self) -> bool:
return self.counter > 1
@property
def can_be_started_as_property_str(self) -> bool:
return self.counter > 2
start = created.to(
started,
cond=[
can_be_started,
can_be_started_as_property,
"can_be_started_as_property_str",
model_class.can_be_started_on_model,
model_class.can_be_started_as_property_on_model,
"can_be_started_as_property_str_on_model",
],
)
def __init__(self, model=None, counter: int = 0):
self.counter = counter
super().__init__(model=model)
def on_start(self):
mock_calls("started")
return ExampleStateMachine
def test_issue_417_cannot_start(self, model_class, sm_class, mock_calls):
model = model_class(0)
sm = sm_class(model, 0)
with pytest.raises(sm.TransitionNotAllowed, match="Can't Start when in Created"):
sm.start()
mock_calls.assert_not_called()
def test_issue_417_can_start(self, model_class, sm_class, mock_calls, mocker):
model = model_class(3)
sm = sm_class(model, 3)
sm.start()
assert mock_calls.call_args_list == [
mocker.call("started"),
]
def test_raise_exception_if_property_is_not_found(self):
class StrangeObject:
@property
def this_cannot_resolve(self) -> bool:
return True
class ExampleStateMachine(StateChart):
catch_errors_as_events = False
created = State(initial=True)
started = State(final=True)
start = created.to(started, cond=[StrangeObject.this_cannot_resolve])
with pytest.raises(
InvalidDefinition,
match="Error on transition start from Created to Started when resolving callbacks",
):
ExampleStateMachine()
class TestIssue638:
"""Guards passed as plain callables (e.g. lambdas) are resolved unbound.
Dependency injection works by parameter name, so ``self`` is only injected when
the callable is an attribute of the class and gets resolved to a bound method.
Plain callables must declare injectable names (e.g. ``machine``) instead.
See: https://github.com/fgmacedo/python-statemachine/issues/638
"""
def test_lambda_cond_with_machine_param(self):
class ExampleStateMachine(StateChart):
created = State(initial=True)
started = State(final=True)
start = created.to(started, cond=lambda machine: machine.can_start)
def __init__(self, can_start: bool):
self.can_start = can_start
super().__init__()
sm = ExampleStateMachine(can_start=False)
sm.send("start")
assert "created" in sm.configuration_values
sm = ExampleStateMachine(can_start=True)
sm.send("start")
assert "started" in sm.configuration_values
def test_lambda_cond_without_params(self):
flags = {"can_start": False}
class ExampleStateMachine(StateChart):
created = State(initial=True)
started = State(final=True)
start = created.to(started, cond=lambda: flags["can_start"])
sm = ExampleStateMachine()
sm.send("start")
assert "created" in sm.configuration_values
flags["can_start"] = True
sm.send("start")
assert "started" in sm.configuration_values
def test_lambda_cond_with_event_kwargs(self):
class ExampleStateMachine(StateChart):
created = State(initial=True)
started = State(final=True)
start = created.to(started, cond=lambda priority=0: priority > 5)
sm = ExampleStateMachine()
sm.send("start", priority=1)
assert "created" in sm.configuration_values
sm.send("start", priority=9)
assert "started" in sm.configuration_values
def test_lambda_cond_with_self_param_is_called_unbound(self):
class ExampleStateMachine(StateChart):
catch_errors_as_events = False
created = State(initial=True)
started = State(final=True)
start = created.to(started, cond=lambda self: True)
sm = ExampleStateMachine()
with pytest.raises(TypeError, match="missing 1 required positional argument: 'self'"):
sm.send("start")
def test_class_body_function_cond_by_reference_is_bound(self):
class ExampleStateMachine(StateChart):
created = State(initial=True)
started = State(final=True)
def can_start(self) -> bool:
return self.flag
start = created.to(started, cond=can_start)
def __init__(self, flag: bool):
self.flag = flag
super().__init__()
sm = ExampleStateMachine(flag=False)
sm.send("start")
assert "created" in sm.configuration_values
sm = ExampleStateMachine(flag=True)
sm.send("start")
assert "started" in sm.configuration_values
class TestVisitConditionFalse:
"""visit/async_visit skip callbacks whose condition returns False."""
def test_visit_skips_when_condition_is_false(self):
visited = []
spec = CallbackSpec(
"never_called",
group=CallbackGroup.INVOKE,
is_convention=True,
cond=lambda *a, **kw: False,
)
executor = CallbacksExecutor()
executor.add("test_key", spec, lambda: lambda **kw: True)
executor.visit(lambda cb, *a, **kw: visited.append(str(cb)))
assert visited == []
async def test_async_visit_skips_when_condition_is_false(self):
visited = []
spec = CallbackSpec(
"never_called",
group=CallbackGroup.INVOKE,
is_convention=True,
cond=lambda *a, **kw: False,
)
executor = CallbacksExecutor()
executor.add("test_key", spec, lambda: lambda **kw: True)
await executor.async_visit(lambda cb, *a, **kw: visited.append(str(cb)))
assert visited == []