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
|
########################################################################
# File name: test_statemachine.py
# This file is part of: aioxmpp
#
# LICENSE
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program. If not, see
# <http://www.gnu.org/licenses/>.
#
########################################################################
import asyncio
import functools
import unittest
from enum import Enum
import aioxmpp.statemachine as statemachine
from aioxmpp.testutils import run_coroutine
@functools.total_ordering
class States(Enum):
STATE1 = 1
STATE2 = 2
STATE3 = 3
STATE4 = 4
def __lt__(self, other):
return self.value < other.value
class TestOrderedStateSkipped(unittest.TestCase):
def test_is_value_error(self):
self.assertTrue(issubclass(
statemachine.OrderedStateSkipped,
ValueError
))
def test_init(self):
exc = statemachine.OrderedStateSkipped(States.STATE1)
self.assertRegex(
str(exc),
r"state [^ ]+ has been skipped"
)
self.assertIs(exc.skipped_state, States.STATE1)
class TestOrderedStateMachine(unittest.TestCase):
def setUp(self):
self.loop = asyncio.get_event_loop()
self.osm = statemachine.OrderedStateMachine(
States.STATE1,
loop=self.loop)
def tearDown(self):
del self.osm
del self.loop
def test_init(self):
osm = statemachine.OrderedStateMachine(
States.STATE1)
self.assertEqual(
States.STATE1,
osm.state
)
def test_init_rejects_unordered_state_type(self):
class OtherStates(Enum):
FOO = 1
BAR = 2
with self.assertRaisesRegex(TypeError,
"states must be ordered"):
statemachine.OrderedStateMachine(OtherStates.FOO)
def test_wait_for_at_least(self):
state_tasks = {
state: asyncio.ensure_future(self.osm.wait_for_at_least(state),
loop=self.loop)
for state in States
}
run_coroutine(asyncio.sleep(0))
self.osm.state = States.STATE3
run_coroutine(asyncio.sleep(0.01))
for state, task in state_tasks.items():
if state <= States.STATE3:
self.assertTrue(task.done(), state)
self.assertIsNone(task.result())
else:
self.assertFalse(task.done(), state)
def test_wait_for_at_least_checks_current_state(self):
state_tasks = {
state: asyncio.ensure_future(self.osm.wait_for_at_least(state),
loop=self.loop)
for state in States
}
self.osm.state = States.STATE3
run_coroutine(asyncio.sleep(0))
for state, task in state_tasks.items():
if state <= States.STATE3:
self.assertTrue(task.done(), state)
self.assertIsNone(task.result())
else:
self.assertFalse(task.done(), state)
def test_wait_for_at_least_can_be_cancelled(self):
state_tasks = {
state: asyncio.ensure_future(self.osm.wait_for_at_least(state),
loop=self.loop)
for state in States
}
run_coroutine(asyncio.sleep(0))
for task in state_tasks.values():
task.cancel()
run_coroutine(asyncio.sleep(0))
self.osm.state = States.STATE3
run_coroutine(asyncio.sleep(0))
def test_state_rejects_rewinding(self):
self.osm.state = States.STATE2
with self.assertRaisesRegex(
ValueError,
"cannot rewind OrderedStateMachine"):
self.osm.state = States.STATE1
self.osm.state = States.STATE2
def test_wait_for(self):
state_tasks = {
state: asyncio.ensure_future(self.osm.wait_for(state),
loop=self.loop)
for state in States
}
run_coroutine(asyncio.sleep(0))
self.osm.state = States.STATE3
run_coroutine(asyncio.sleep(0.01))
for state, task in state_tasks.items():
# STATE1 triggers immediately, it is the current state when the
# coroutine is called
if state in [States.STATE3, States.STATE1]:
self.assertTrue(task.done(), state)
self.assertIsNone(task.result())
elif state < States.STATE3:
self.assertTrue(task.done(), state)
self.assertIsInstance(
task.exception(),
statemachine.OrderedStateSkipped,
state
)
else:
self.assertFalse(task.done(), state)
def test_wait_for_checks_immediately(self):
state_tasks = {
state: asyncio.ensure_future(self.osm.wait_for(state),
loop=self.loop)
for state in States
}
self.osm.state = States.STATE3
run_coroutine(asyncio.sleep(0.01))
for state, task in state_tasks.items():
if state == States.STATE3:
self.assertTrue(task.done(), state)
self.assertIsNone(task.result())
elif state < States.STATE3:
self.assertTrue(task.done(), state)
self.assertIsInstance(
task.exception(),
statemachine.OrderedStateSkipped,
state
)
else:
self.assertFalse(task.done(), state)
def test_rewind_allows_going_back(self):
self.osm.state = States.STATE3
self.osm.rewind(States.STATE2)
self.assertEqual(
States.STATE2,
self.osm.state
)
def test_rewind_rejects_going_forward(self):
self.osm.state = States.STATE3
with self.assertRaisesRegex(ValueError,
"cannot forward using rewind"):
self.osm.rewind(States.STATE4)
def test_wait_for_at_least_fails_if_state_is_unreachable(self):
self.osm.state
|
