[Failing tests] Unit tests now terminate even if the bot thread dies due to assertion errors

Author: dgant

src/main/java/bwapi/BotWrapper.java

@@ -40,8 +40,8 @@ class BotWrapper {
     private Thread botThread;
     private boolean gameOver;
     private PerformanceMetrics performanceMetrics;
-    private Exception lastBotException;
-    private ReentrantLock lastBotExceptionLock = new ReentrantLock();
+    private Throwable lastBotThrow;
+    private ReentrantLock lastBotThrowLock = new ReentrantLock();
 
     BotWrapper(BWClientConfiguration configuration, BWEventListener eventListener) {
         this.configuration = configuration;
@@ -96,9 +96,9 @@ void onFrame() {
                 while (!frameBuffer.empty()) {
 
                     // Make bot exceptions fall through to the main thread.
-                    Exception lastBotException = getLastBotException();
-                    if (lastBotException != null) {
-                        throw new RuntimeException(lastBotException);
+                    Throwable lastThrow = getLastBotThrow();
+                    if (lastThrow != null) {
+                        throw new RuntimeException(lastThrow);
                     }
 
                     if (configuration.unlimitedFrameZero && isFrameZero) {
@@ -116,9 +116,6 @@ void onFrame() {
             }
         } else {
             handleEvents();
-            if (lastBotException != null) {
-                throw new RuntimeException(lastBotException);
-            }
         }
     }
 
@@ -133,10 +130,10 @@ void endGame() {
         }
     }
 
-    Exception getLastBotException() {
-        lastBotExceptionLock.lock();
-        Exception output = lastBotException;
-        lastBotExceptionLock.unlock();
+    Throwable getLastBotThrow() {
+        lastBotThrowLock.lock();
+        Throwable output = lastBotThrow;
+        lastBotThrowLock.unlock();
         return output;
     }
 
@@ -155,8 +152,12 @@ private Thread createBotThread() {
                 }
                 game.clientData().setBuffer(frameBuffer.peek());
                 performanceMetrics.frameBufferSize.record(frameBuffer.framesBuffered() - 1);
-                handleEvents();
-                frameBuffer.dequeue();
+                try {
+                    handleEvents();
+                } finally {
+                    // In the case where t
+                    frameBuffer.dequeue();
+                }
             }
         });
     }
@@ -166,19 +167,21 @@ private void handleEvents() {
         if (gameData.getFrameCount() > 0 || ! configuration.unlimitedFrameZero) {
             performanceMetrics.botResponse.startTiming();
         }
+        // Populate gameOver before invoking event handlers (in case the bot throws)
+        for (int i = 0; i < gameData.getEventCount(); i++) {
+            gameOver = gameOver || gameData.getEvents(i).getType() == EventType.MatchEnd;
+        }
         try {
             for (int i = 0; i < gameData.getEventCount(); i++) {
-                ClientData.Event event = gameData.getEvents(i);
-                EventHandler.operation(eventListener, game, event);
-                if (event.getType() == EventType.MatchEnd) {
-                    gameOver = true;
-                }
+                EventHandler.operation(eventListener, game, gameData.getEvents(i));
             }
-        } catch (Exception exception) {
-            lastBotExceptionLock.lock();
-            lastBotException = exception;
-            lastBotExceptionLock.unlock();
+        } catch (Throwable throwable) {
+            lastBotThrowLock.lock();
+            lastBotThrow = throwable;
+            lastBotThrowLock.unlock();
+            throw throwable;
+        } finally {
+            performanceMetrics.botResponse.stopTiming();
         }
-        performanceMetrics.botResponse.stopTiming();
     }
 }

src/main/java/bwapi/FrameBuffer.java

@@ -45,7 +45,6 @@ class FrameBuffer {
     private int stepGame = 0;
     private int stepBot = 0;
     private ArrayList<ByteBuffer> dataBuffer = new ArrayList<>();
-    private final String architecture;
 
     // Synchronization locks
     private final Lock lockWrite = new ReentrantLock();
@@ -55,10 +54,8 @@ class FrameBuffer {
     FrameBuffer(int size) {
         this.size = size;
         while(dataBuffer.size() < size) {
-            System.out.println("Allocating " + BUFFER_SIZE / 1024 / 1024 + "mb");
             dataBuffer.add(ByteBuffer.allocateDirect(BUFFER_SIZE));
         }
-        architecture = System.getProperty("sun.arch.data.model");
     }
 
     /**

src/test/java/bwapi/SynchronizationTest.java

@@ -66,11 +66,11 @@ public void async_IfDelay_ThenBuffer() throws InterruptedException {
         environment.configuration.async = true;
         environment.configuration.asyncFrameDurationMs = 1;
         environment.configuration.asyncFrameBufferSize = 3;
-        environment.onFrame(0, () -> {
+        environment.onFrame(1, () -> {
             sleepUnchecked(5);
-            assertEquals(2, environment.bwClient.framesBehind());
-            assertEquals(0, environment.bwClient.getGame().getFrameCount());
-            assertEquals(2, environment.liveGameData().getFrameCount());
+            assertEquals("Bot should be observing an old frame", 1, environment.bwClient.getGame().getFrameCount());
+            assertEquals("Bot should be behind the live game", 2, environment.bwClient.framesBehind());
+            assertEquals("Client should be as far ahead as the frame buffer allows", 3, environment.liveGameData().getFrameCount());
         });
         environment.runGame();
     }