Merge pull request #127 from spokestack/jz-testy-threads

fix: thread cleanup in test suites

Author: brentspell

pom.xml

@@ -260,8 +260,6 @@
                <useSystemClassLoader>false</useSystemClassLoader>
                <argLine>${argLine} -Djava.library.path=./target -XX:-OmitStackTraceInFastThrow</argLine>
                <trimStackTrace>false</trimStackTrace>
-               <forkCount>4</forkCount>
-               <reuseForks>false</reuseForks>
             </configuration>
          </plugin>
 

src/main/java/io/spokestack/spokestack/SpeechPipeline.java

@@ -72,11 +72,11 @@ public final class SpeechPipeline implements AutoCloseable {
     private final List<String> stageClasses;
     private final SpeechConfig config;
     private final SpeechContext context;
+    private volatile boolean running;
+    private volatile boolean paused;
     private SpeechInput input;
     private List<SpeechProcessor> stages;
     private Thread thread;
-    private boolean running;
-    private boolean paused;
     private boolean managed;
 
     /**
@@ -227,7 +227,7 @@ private void attachBuffer() throws Exception {
     }
 
     private void startThread() throws Exception {
-        this.thread = new Thread(this::run);
+        this.thread = new Thread(this::run, "Spokestack-speech-pipeline");
         this.running = true;
         this.thread.start();
     }
@@ -300,6 +300,9 @@ private void step() {
         } else {
             dispatch();
         }
+        if (Thread.currentThread().isInterrupted()) {
+            this.running = false;
+        }
     }
 
     private void dispatch() {

src/test/java/io/spokestack/spokestack/SpeechPipelineTest.java

@@ -8,6 +8,7 @@
 import androidx.annotation.NonNull;
 import io.spokestack.spokestack.android.AudioRecordError;
 import io.spokestack.spokestack.util.EventTracer;
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.jupiter.api.function.Executable;
@@ -37,6 +38,16 @@ public void before() {
         this.events.clear();
     }
 
+    @After
+    public void after() {
+        // shut down any stray speech pipeline background threads
+        for (Thread thread : Thread.getAllStackTraces().keySet()) {
+            if (thread.getName().contains("Spokestack")) {
+                thread.interrupt();
+            }
+        }
+    }
+
     @Test
     public void testBuilder() throws Exception {
         // default config

src/test/java/io/spokestack/spokestack/SpokestackTest.java

@@ -11,12 +11,12 @@
 import io.spokestack.spokestack.tts.TTSTestUtils;
 import io.spokestack.spokestack.util.EventTracer;
 import org.jetbrains.annotations.NotNull;
+import org.junit.After;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.powermock.core.classloader.annotations.PrepareForTest;
 import org.powermock.modules.junit4.PowerMockRunner;
 
-import java.nio.ByteBuffer;
 import java.util.ArrayList;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
@@ -30,6 +30,16 @@
 @PrepareForTest({SystemClock.class})
 public class SpokestackTest {
 
+    @After
+    public void after() {
+        // shut down any stray speech pipeline background threads
+        for (Thread thread : Thread.getAllStackTraces().keySet()) {
+            if (thread.getName().contains("Spokestack")) {
+                thread.interrupt();
+            }
+        }
+    }
+
     @Test
     public void testBuild() throws Exception {
         // missing all required config