Attempt to fix bug where speech could not be interrupted during some race conditions.

tests/test_piperfactory_rate_mapping.py

@@ -1,10 +1,13 @@
 import sys
+import threading
 import unittest
 from pathlib import Path
+from unittest import mock
 
 sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src"))
 
 from cthulhu import piperfactory
+from cthulhu import speechserver
 
 
 class PiperFactoryRateMappingTests(unittest.TestCase):
@@ -25,6 +28,51 @@ class PiperFactoryRateMappingTests(unittest.TestCase):
         self.assertEqual(2.0, self.server._mapRate(-1))
         self.assertEqual(0.25, self.server._mapRate(101))
 
+    def _make_say_all_server(self):
+        server = piperfactory.SpeechServer.__new__(piperfactory.SpeechServer)
+        server._lock = threading.Lock()
+        server._stopEvent = threading.Event()
+        server._speakGeneration = 1
+        server._currentFuture = None
+        server._executor = mock.Mock()
+        server._audioPlayer = None
+        return server
+
+    def _make_say_all_context(self, utterance):
+        return speechserver.SayAllContext(
+            mock.Mock(),
+            utterance,
+            0,
+            len(utterance),
+        )
+
+    def test_stop_invalidates_pending_say_all_worker(self):
+        server = self._make_say_all_server()
+        iterator = iter([[self._make_say_all_context("first"), None]])
+        callback = mock.Mock()
+
+        server.stop()
+        result = server._sayAllWorker(iterator, callback, 1)
+
+        self.assertFalse(result)
+        callback.assert_not_called()
+        server._executor.submit.assert_not_called()
+
+    def test_stale_say_all_completion_does_not_advance(self):
+        server = self._make_say_all_server()
+        first = self._make_say_all_context("first")
+        second = self._make_say_all_context("second")
+        iterator = iter([[first, None], [second, None]])
+        callback = mock.Mock()
+
+        server._sayAllWorker(iterator, callback, 1)
+        onComplete = server._executor.submit.call_args.args[3]
+        server.stop()
+        result = onComplete()
+
+        self.assertFalse(result)
+        self.assertEqual(1, server._executor.submit.call_count)
+
 
 if __name__ == "__main__":
     unittest.main()