forked from MycroftAI/mycroft-core
-
Notifications
You must be signed in to change notification settings - Fork 18
/
test_workshop.py
273 lines (227 loc) · 11.4 KB
/
test_workshop.py
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
import json
import unittest
from os.path import dirname
from time import sleep
from ovos_workshop.skills import OVOSSkill, MycroftSkill
from mycroft.skills.skill_loader import SkillLoader
from ovos_utils.messagebus import FakeBus, Message
# tests taken from ovos_workshop
class TestSkill(unittest.TestCase):
def setUp(self):
self.bus = FakeBus()
self.bus.emitted_msgs = []
def get_msg(msg):
msg = json.loads(msg)
self.bus.emitted_msgs.append(msg)
self.bus.on("message", get_msg)
self.skill = SkillLoader(self.bus, f"{dirname(__file__)}/ovos_tskill_abort")
self.skill.skill_id = "abort.test"
self.bus.emitted_msgs = []
self.skill.load()
def test_skill_id(self):
self.assertTrue(isinstance(self.skill.instance, OVOSSkill))
self.assertTrue(isinstance(self.skill.instance, MycroftSkill))
self.assertEqual(self.skill.skill_id, "abort.test")
# if running in ovos-core every message will have the skill_id in context
for msg in self.bus.emitted_msgs:
if msg["type"] == 'mycroft.skills.loaded': # emitted by SkillLoader, not by skill
continue
self.assertEqual(msg["context"]["skill_id"], "abort.test")
def test_intent_register(self):
padatious_intents = ["abort.test:test.intent",
"abort.test:test2.intent",
"abort.test:test3.intent"]
for msg in self.bus.emitted_msgs:
if msg["type"] == "padatious:register_intent":
self.assertTrue(msg["data"]["name"] in padatious_intents)
def test_registered_events(self):
registered_events = [e[0] for e in self.skill.instance.events]
# intent events
intent_triggers = [f"{self.skill.skill_id}:test.intent",
f"{self.skill.skill_id}:test2.intent",
f"{self.skill.skill_id}:test3.intent"
]
for event in intent_triggers:
self.assertTrue(event in registered_events)
# base skill class events shared with mycroft-core
default_skill = ["mycroft.skill.enable_intent",
"mycroft.skill.disable_intent",
"mycroft.skill.set_cross_context",
"mycroft.skill.remove_cross_context",
"mycroft.skills.settings.changed"]
for event in default_skill:
self.assertTrue(event in registered_events)
# base skill class events exclusive to ovos-core
default_ovos = ["skill.converse.ping",
"skill.converse.request",
"intent.service.skills.activated",
"intent.service.skills.deactivated",
f"{self.skill.skill_id}.activate",
f"{self.skill.skill_id}.deactivate"]
for event in default_ovos:
self.assertTrue(event in registered_events)
def tearDown(self) -> None:
self.skill.unload()
class TestKillableIntents(unittest.TestCase):
def setUp(self):
self.bus = FakeBus()
self.bus.emitted_msgs = []
def get_msg(msg):
m = json.loads(msg)
m.pop("context")
self.bus.emitted_msgs.append(m)
self.bus.on("message", get_msg)
self.skill = SkillLoader(self.bus, f"{dirname(__file__)}/ovos_tskill_abort")
self.skill.skill_id = "abort.test"
self.skill.load()
def test_skills_abort_event(self):
self.bus.emitted_msgs = []
# skill will enter a infinite loop unless aborted
self.assertTrue(self.skill.instance.my_special_var == "default")
self.bus.emit(Message(f"{self.skill.skill_id}:test.intent"))
sleep(2)
# check that intent triggered
start_msg = {'type': 'mycroft.skill.handler.start',
'data': {'name': 'KillableSkill.handle_test_abort_intent'}}
speak_msg = {'type': 'speak',
'data': {'utterance': 'still here', 'expect_response': False,
'meta': {'skill': 'abort.test'},
'lang': 'en-us'}}
self.assertIn(start_msg, self.bus.emitted_msgs)
self.assertIn(speak_msg, self.bus.emitted_msgs)
self.assertTrue(self.skill.instance.my_special_var == "changed")
# check that intent reacts to mycroft.skills.abort_execution
# eg, gui can emit this event if some option was selected
# on screen to abort the current voice interaction
self.bus.emitted_msgs = []
self.bus.emit(Message(f"mycroft.skills.abort_execution"))
sleep(2)
# check that stop method was called
self.assertTrue(self.skill.instance.stop_called)
# check that TTS stop message was emmited
tts_stop = {'type': 'mycroft.audio.speech.stop', 'data': {}}
self.assertIn(tts_stop, self.bus.emitted_msgs)
# check that cleanup callback was called
speak_msg = {'type': 'speak',
'data': {'utterance': 'I am dead', 'expect_response': False,
'meta': {'skill': 'abort.test'},
'lang': 'en-us'}}
self.assertIn(speak_msg, self.bus.emitted_msgs)
self.assertTrue(self.skill.instance.my_special_var == "default")
# check that we are not getting speak messages anymore
self.bus.emitted_msgs = []
sleep(2)
self.assertTrue(self.bus.emitted_msgs == [])
def test_skill_stop(self):
self.bus.emitted_msgs = []
# skill will enter a infinite loop unless aborted
self.assertTrue(self.skill.instance.my_special_var == "default")
self.bus.emit(Message(f"{self.skill.skill_id}:test.intent"))
sleep(2)
# check that intent triggered
start_msg = {'type': 'mycroft.skill.handler.start',
'data': {'name': 'KillableSkill.handle_test_abort_intent'}}
speak_msg = {'type': 'speak',
'data': {'utterance': 'still here', 'expect_response': False,
'meta': {'skill': 'abort.test'}, 'lang': 'en-us'}}
self.assertIn(start_msg, self.bus.emitted_msgs)
self.assertIn(speak_msg, self.bus.emitted_msgs)
self.assertTrue(self.skill.instance.my_special_var == "changed")
# check that intent reacts to skill specific stop message
# this is also emitted on mycroft.stop if using OvosSkill class
self.bus.emitted_msgs = []
self.bus.emit(Message(f"{self.skill.skill_id}.stop"))
sleep(2)
# check that stop method was called
self.assertTrue(self.skill.instance.stop_called)
# check that TTS stop message was emmited
tts_stop = {'type': 'mycroft.audio.speech.stop', 'data': {}}
self.assertIn(tts_stop, self.bus.emitted_msgs)
# check that cleanup callback was called
speak_msg = {'type': 'speak',
'data': {'utterance': 'I am dead', 'expect_response': False,
'meta': {'skill': 'abort.test'},
'lang': 'en-us'}}
self.assertIn(speak_msg, self.bus.emitted_msgs)
self.assertTrue(self.skill.instance.my_special_var == "default")
# check that we are not getting speak messages anymore
self.bus.emitted_msgs = []
sleep(2)
self.assertTrue(self.bus.emitted_msgs == [])
def test_get_response(self):
""" send "mycroft.skills.abort_question" and
confirm only get_response is aborted, speech after is still spoken"""
self.bus.emitted_msgs = []
# skill will enter a infinite loop unless aborted
self.bus.emit(Message(f"{self.skill.skill_id}:test2.intent"))
sleep(2)
# check that intent triggered
start_msg = {'type': 'mycroft.skill.handler.start',
'data': {'name': 'KillableSkill.handle_test_get_response_intent'}}
speak_msg = {'type': 'speak',
'data': {'utterance': 'this is a question',
'expect_response': True,
'meta': {'dialog': 'question', 'data': {}, 'skill': 'abort.test'},
'lang': 'en-us'}}
activate_msg = {'type': 'intent.service.skills.activate', 'data': {'skill_id': 'abort.test'}}
self.assertIn(start_msg, self.bus.emitted_msgs)
self.assertIn(speak_msg, self.bus.emitted_msgs)
self.assertIn(activate_msg, self.bus.emitted_msgs)
# check that get_response loop is aborted
# but intent continues executing
self.bus.emitted_msgs = []
self.bus.emit(Message(f"mycroft.skills.abort_question"))
sleep(1)
# check that stop method was NOT called
self.assertFalse(self.skill.instance.stop_called)
# check that speak message after get_response loop was spoken
speak_msg = {'type': 'speak',
'data': {'utterance': 'question aborted',
'expect_response': False,
'meta': {'skill': 'abort.test'},
'lang': 'en-us'}}
self.assertIn(speak_msg, self.bus.emitted_msgs)
def test_developer_stop_msg(self):
""" send "my.own.abort.msg" and confirm intent3 is aborted
send "mycroft.skills.abort_execution" and confirm intent3 ignores it"""
self.bus.emitted_msgs = []
# skill will enter a infinite loop unless aborted
self.bus.emit(Message(f"{self.skill.skill_id}:test3.intent"))
sleep(2)
# check that intent triggered
start_msg = {'type': 'mycroft.skill.handler.start',
'data': {'name': 'KillableSkill.handle_test_msg_intent'}}
speak_msg = {'type': 'speak',
'data': {'utterance': "you can't abort me",
'expect_response': False,
'meta': {'skill': 'abort.test'},
'lang': 'en-us'}}
self.assertIn(start_msg, self.bus.emitted_msgs)
self.assertIn(speak_msg, self.bus.emitted_msgs)
# check that intent does NOT react to mycroft.skills.abort_execution
# developer requested a dedicated abort message
self.bus.emitted_msgs = []
self.bus.emit(Message(f"mycroft.skills.abort_execution"))
sleep(1)
# check that stop method was NOT called
self.assertFalse(self.skill.instance.stop_called)
# check that intent reacts to my.own.abort.msg
self.bus.emitted_msgs = []
self.bus.emit(Message(f"my.own.abort.msg"))
sleep(2)
# check that stop method was called
self.assertTrue(self.skill.instance.stop_called)
# check that TTS stop message was emmited
tts_stop = {'type': 'mycroft.audio.speech.stop', 'data': {}}
self.assertIn(tts_stop, self.bus.emitted_msgs)
# check that cleanup callback was called
speak_msg = {'type': 'speak',
'data': {'utterance': 'I am dead', 'expect_response': False,
'meta': {'skill': 'abort.test'},
'lang': 'en-us'}}
self.assertIn(speak_msg, self.bus.emitted_msgs)
self.assertTrue(self.skill.instance.my_special_var == "default")
# check that we are not getting speak messages anymore
self.bus.emitted_msgs = []
sleep(2)
self.assertTrue(self.bus.emitted_msgs == [])