Reviewed integration tests, found a few failures and walked back some code changes I'd made in a prior commit. All tests pass now.

Author: blorp-goes-the-derp

src/main/java/net/twasi/obsremotejava/OBSCommunicator.java

@@ -149,7 +149,7 @@ public void await() throws InterruptedException {
     @OnWebSocketError
     public void onError(Session session, Throwable throwable) {
         // do nothing for now, this should at least repress "OnWebsocketError not registered" messages
-        //runOnError("Websocket error occurred with session " + session, throwable);
+        runOnConnectionFailed("Websocket error occurred with session " + session, throwable);
     }
 
     @OnWebSocketClose
@@ -159,7 +159,7 @@ public void onClose(int statusCode, String reason) {
         try {
             this.onDisconnect.run(null);
         } catch (Throwable t) {
-            runOnError("Could not close websocket connection", t);
+            log.error("Unable to disconnect OBS Client", t);
         }
     }
 
@@ -245,7 +245,7 @@ private void processIncomingResponse(ResponseBase responseBase, Class type) {
                 if ("ok".equals(authenticateResponse.getStatus())) {
                     runOnConnect(versionInfo);
                 } else {
-                    runOnConnectionFailed("Failed to authenticate with password. Error: " + authenticateResponse.getError());
+                    runOnConnectionFailed("Failed to authenticate with password. Error: " + authenticateResponse.getError(), null);
                 }
 
                 break;
@@ -323,7 +323,7 @@ private void processIncomingEvent(String msg, EventType eventType) {
 
     private void authenticateWithServer(String challenge, String salt) {
         if (password == null) {
-            runOnConnectionFailed("Authentication required by server but no password set by client");
+            runOnConnectionFailed("Authentication required by server but no password set by client", null);
             return;
         }
 
@@ -344,7 +344,7 @@ private String generateAuthenticationResponseString(String challenge, String sal
         try {
             digest = MessageDigest.getInstance("SHA-256");
         } catch (NoSuchAlgorithmException e) {
-            runOnConnectionFailed("Failed to perform password authentication with server");
+            runOnConnectionFailed("Failed to perform password authentication with server", null);
             return null;
         }
 
@@ -648,7 +648,7 @@ private void runOnError(String message, Throwable throwable) {
         }
     }
 
-    private void runOnConnectionFailed(String message) {
+    private void runOnConnectionFailed(String message, Throwable throwable) {
         log.debug("Running onConnectionFailed, with message: " + message);
         if (onConnectionFailed == null) {
             log.debug("No onConnectionFailed callback was registered");

src/test/java/net/twasi/obsremotejava/test/OBSRemoteControllerIT.java

@@ -18,7 +18,7 @@
 public class OBSRemoteControllerIT {
 
     /**
-     * - Set these two values before running these tests
+     * - Setup OBS with the below address, and disable authentication
      * - Make sure your OBS is running and available for connection
      */
     private final String obsAddress = "ws://localhost:4444";
@@ -324,50 +324,72 @@ void testConnectAndDisconnect() {
     }
 
     @Test
-    void testConnectWithNoCallbacksRegistered() {
+    void disconnectShouldNotHaveErrorsWhenNoConnectDisconnectCallbacksRegistered() {
         AtomicReference<String> testFailedReason = new AtomicReference<>();
 
+        // Given a controller that auto-connects...When connected
         final OBSRemoteController controller = new OBSRemoteController(obsAddress, true,
                                                                        obsPassword, true);
 
+        // Then no errors should have occurred
         if (controller.isFailed()) {
             fail("Failed to connect to websocket");
         }
 
+        // And given no callbacks registered for connect/disconnect
         controller.registerDisconnectCallback(null);
         controller.registerConnectCallback(null);
-        controller.registerConnectionFailedCallback(message -> testFailedReason.set("ConnectionFailedCallback called unexpectedly"));
-        controller.registerOnError((message, throwable) -> testFailedReason.set("OnError called unexpectedly"));
 
+        // And given on connection failure and on error callbacks are set
+        controller.registerConnectionFailedCallback(message ->
+                testFailedReason.set("ConnectionFailedCallback called unexpectedly")
+        );
+        controller.registerOnError((message, throwable) ->
+                testFailedReason.set("OnError called unexpectedly")
+        );
+
+        // When disconnected
         controller.disconnect();
 
+        // Then the error or connection failure callbacks should not have been called
         if (testFailedReason.get() != null) {
             fail(testFailedReason.get());
         }
     }
 
     @Test
-    void testConnectWithInvalidCallbacksRegistered() {
+    void disconnectShouldNotHaveErrorsWhenConnectDisconnectCallbacksThrowErrors() {
         AtomicReference<String> testFailedReason = new AtomicReference<>();
 
+        // Given controller that auto-connects...When connected
         final OBSRemoteController controller = new OBSRemoteController(obsAddress, true,
                                                                        obsPassword, true);
 
+        // Then no failure was expected on connection
         if (controller.isFailed()) {
             fail("Failed to connect to websocket");
         }
 
+        // And given (invalid) connect and disconnect callbacks are registered
         controller.registerDisconnectCallback(response -> {
             throw new Error("Disconnect callback error");
         });
         controller.registerConnectCallback(response -> {
             throw new Error("Connect callback error");
         });
-        controller.registerConnectionFailedCallback(message -> testFailedReason.set("ConnectionFailedCallback called unexpectedly"));
-        controller.registerOnError((message, throwable) -> testFailedReason.set("OnError called unexpectedly"));
 
+        // And given on connection failure and on error callbacks are set
+        controller.registerConnectionFailedCallback(message ->
+                testFailedReason.set("ConnectionFailedCallback called unexpectedly")
+        );
+        controller.registerOnError((message, throwable) ->
+                testFailedReason.set("OnError called unexpectedly")
+        );
+
+        // When the controller is disconnected
         controller.disconnect();
 
+        // Then the connection failure and error callbacks should NOT have been called
         if (testFailedReason.get() != null) {
             fail(testFailedReason.get());
         }

src/test/resources/simplelogger.properties

@@ -4,4 +4,4 @@ org.eclipse.jetty.LEVEL=OFF
 
 # Default levels for the project
 org.slf4j.simpleLogger.defaultLogLevel=info
-org.slf4j.simpleLogger.log.net.twasi.obsremotejava=off
+org.slf4j.simpleLogger.log.net.twasi.obsremotejava=debuggi