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
|
from typing import TYPE_CHECKING
from unittest import TestCase
from types import ModuleType
from unittest.mock import MagicMock
from transitions import Machine
from transitions.experimental.utils import generate_base_model
from transitions.experimental.utils import add_transitions, transition, event, with_model_definitions
from transitions.extensions import HierarchicalMachine
from .utils import Stuff
if TYPE_CHECKING:
from transitions.core import MachineConfig
from typing import Type
def import_code(code: str, name: str) -> ModuleType:
module = ModuleType(name)
exec(code, module.__dict__)
return module
class TestExperimental(TestCase):
def setUp(self) -> None:
self.machine_cls = Machine # type: Type[Machine]
self.create_trigger_class()
def create_trigger_class(self):
@with_model_definitions
class TriggerMachine(self.machine_cls): # type: ignore
pass
self.trigger_machine = TriggerMachine
def test_model_override(self):
class Model:
def trigger(self, name: str) -> bool:
raise RuntimeError("Should be overridden")
def is_A(self) -> bool:
raise RuntimeError("Should be overridden")
def is_C(self) -> bool:
raise RuntimeError("Should be overridden")
model = Model()
machine = self.machine_cls(model, states=["A", "B"], initial="A", model_override=True)
self.assertTrue(model.is_A())
with self.assertRaises(AttributeError):
model.to_B() # type: ignore # Should not be assigned to model since its not declared
self.assertTrue(model.trigger("to_B"))
self.assertFalse(model.is_A())
with self.assertRaises(RuntimeError):
model.is_C() # not overridden yet
machine.add_state("C")
self.assertFalse(model.is_C()) # now it is!
self.assertTrue(model.trigger("to_C"))
self.assertTrue(model.is_C())
def test_generate_base_model(self):
simple_config = {
"states": ["A", "B"],
"transitions": [
["go", "A", "B"],
["back", "*", "A"]
],
"initial": "A",
"model_override": True
} # type: MachineConfig
mod = import_code(generate_base_model(simple_config), "base_module")
model = mod.BaseModel()
machine = self.machine_cls(model, **simple_config)
self.assertTrue(model.is_A())
self.assertTrue(model.go())
self.assertTrue(model.is_B())
self.assertTrue(model.back())
self.assertTrue(model.state == "A")
with self.assertRaises(AttributeError):
model.is_C()
def test_generate_base_model_callbacks(self):
simple_config = {
"states": ["A", "B"],
"transitions": [
["go", "A", "B"],
],
"initial": "A",
"model_override": True,
"before_state_change": "call_this"
} # type: MachineConfig
mod = import_code(generate_base_model(simple_config), "base_module")
mock = MagicMock()
class Model(mod.BaseModel): # type: ignore
@staticmethod
def call_this() -> None:
mock()
model = Model()
machine = self.machine_cls(model, **simple_config)
self.assertTrue(model.is_A())
self.assertTrue(model.go())
self.assertTrue(mock.called)
def test_generate_model_no_auto(self):
simple_config: MachineConfig = {
"states": ["A", "B"],
"auto_transitions": False,
"model_override": True,
"transitions": [
["go", "A", "B"],
["back", "*", "A"]
],
"initial": "A"
}
mod = import_code(generate_base_model(simple_config), "base_module")
model = mod.BaseModel()
machine = self.machine_cls(model, **simple_config)
self.assertTrue(model.is_A())
self.assertTrue(model.go())
with self.assertRaises(AttributeError):
model.to_B()
def test_decorator(self):
class Model:
state: str = ""
def is_B(self) -> bool:
return False
@add_transitions(transition(source="A", dest="B"))
@add_transitions([["A", "B"], "C"])
def go(self) -> bool:
raise RuntimeError("Should be overridden!")
model = Model()
machine = self.trigger_machine(model, states=["A", "B", "C"], initial="A")
self.assertEqual("A", model.state)
self.assertTrue(machine.is_state("A", model))
self.assertTrue(model.go())
with self.assertRaises(AttributeError):
model.is_A() # type: ignore
self.assertEqual("B", model.state)
self.assertTrue(model.is_B())
self.assertTrue(model.go())
self.assertFalse(model.is_B())
self.assertEqual("C", model.state)
def test_decorator_complex(self):
class Model:
state: str = ""
def check_param(self, param: bool) -> bool:
return param
@add_transitions(transition(source="A", dest="B"),
transition(source="B", dest="C", unless=Stuff.this_passes),
transition(source="B", dest="A", conditions=Stuff.this_passes, unless=Stuff.this_fails))
def go(self) -> bool:
raise RuntimeError("Should be overridden")
@add_transitions({"source": "A", "dest": "B", "conditions": "check_param"})
def event(self, param) -> bool:
raise RuntimeError("Should be overridden")
model = Model()
machine = self.trigger_machine(model, states=["A", "B"], initial="A")
self.assertTrue(model.go())
self.assertTrue(model.state == "B")
self.assertTrue(model.go())
self.assertTrue(model.state == "A")
self.assertFalse(model.event(param=False))
self.assertTrue(model.state == "A")
self.assertTrue(model.event(param=True))
self.assertTrue(model.state == "B")
def test_event_definition(self):
class Model:
state: str = ""
def is_B(self) -> bool:
return False
go = event(transition(source="A", dest="B"), [["A", "B"], "C"])
model = Model()
machine = self.trigger_machine(model, states=["A", "B", "C"], initial="A")
self.assertEqual("A", model.state)
self.assertTrue(machine.is_state("A", model))
self.assertTrue(model.go())
with self.assertRaises(AttributeError):
model.is_A() # type: ignore
self.assertEqual("B", model.state)
self.assertTrue(model.is_B())
self.assertTrue(model.go())
self.assertFalse(model.is_B())
self.assertEqual("C", model.state)
def test_event_definition_complex(self):
class Model:
state: str = ""
go = event(transition(source="A", dest="B"),
transition(source="B", dest="C", unless=Stuff.this_passes),
transition(source="B", dest="A", conditions=Stuff.this_passes, unless=Stuff.this_fails))
event = event({"source": "A", "dest": "B", "conditions": "check_param"})
def check_param(self, param: bool) -> bool:
return param
model = Model()
machine = self.trigger_machine(model, states=["A", "B"], initial="A")
self.assertTrue(model.go())
self.assertTrue(model.state == "B")
self.assertTrue(model.go())
self.assertTrue(model.state == "A")
self.assertFalse(model.event(param=False))
self.assertTrue(model.state == "A")
self.assertTrue(model.event(param=True))
self.assertTrue(model.state == "B")
class TestHSMExperimental(TestExperimental):
def setUp(self):
self.machine_cls = HierarchicalMachine # type: Type[HierarchicalMachine]
self.create_trigger_class()
|
