Fix/e2e tests (#143)

* core: allow blocking calls,  events/responses have no @nonnull fields, fix Scene definition

* core: fix testcases

* core: include getters in response/event classes

* example: update to show blocking calls & convenience getters

* core: re-generate messages

* fix: expected scene type was incorrect

* fix: don't add multiple onControllerError handlers

* fix: cleanup after test

* core: describe what happens when the timeout occurs

* test: fix vlc todo

* test: fix other todo's

Author: nvdweem

.gitattributes

@@ -1 +1 @@
-* text=auto eol=lf
+* text=auto eol=lf encoding=utf-8

client/src/endToEndManualTest/java/io/obswebsocket/community/client/test/AbstractObsE2ETest.java

@@ -1,16 +1,13 @@
 package io.obswebsocket.community.client.test;
 
-import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.fail;
 
 import io.obswebsocket.community.client.OBSRemoteController;
-import java.util.concurrent.BlockingQueue;
-import java.util.concurrent.LinkedBlockingQueue;
 import java.util.function.Consumer;
 
 public abstract class AbstractObsE2ETest {
 
   protected static OBSRemoteController remote;
-  protected BlockingQueue resultQueue = new LinkedBlockingQueue();
 
   // Scenes
   protected final static String SCENE1 = "scene1";
@@ -32,8 +29,6 @@ public abstract class AbstractObsE2ETest {
   protected final static String TRANSITION_SLIDE = "Slide";
   protected final static String TRANSITION_CUT = "Cut";
   protected final static String TRANSITION_FADE = "Fade";
-  protected final static String SOURCE_OBS_MIC = "Mic/Aux";
-  protected final static String SOURCE_OBS_AUDIO = "Desktop Audio";
 
   // Test Helpers
   protected void obsShould(String expected) {
@@ -59,19 +54,10 @@ protected void countDownFrom(int seconds) {
   protected static void connectToObs() {
     remote = OBSRemoteController.builder()
         .lifecycle()
-        .onControllerError(((reasonThrowable) -> {
-          System.out.println("An error occurred: " + reasonThrowable.getReason());
-          reasonThrowable.getThrowable().printStackTrace();
-        }))
+        .onControllerError(((reasonThrowable) -> fail("An error occurred: " + reasonThrowable.getReason(), reasonThrowable)))
+        .onCommunicatorError(e -> fail("Unable to connect", e))
         .and()
         .build();
-//    remote = new OBSRemoteController("ws://localhost:4455", false);
-//    remote.registerConnectionFailedCallback(message -> {
-//      fail("Failed to connect to OBS: " + message);
-//    });
-//    remote.registerOnError((message, throwable) -> {
-//      fail("Failed to connect to OBS due to error: " + message);
-//    });
     remote.connect();
 
     try {
@@ -87,55 +73,34 @@ protected void setupObs() {
     cleanupScenes();
 
     // Change back to base scene
-//    remote.changeSceneWithTransition("scene1", "Cut", result -> {
-//      if(result.getError() != null && !result.getError().isEmpty()) {
-//        fail("Failed to switch to base scene");
-//      }
-//    });
+    remote.setCurrentProgramScene("scene1", result -> {
+      if (!result.isSuccessful()) {
+        fail("Failed to switch to base scene");
+      }
+    });
   }
 
   protected void cleanupScenes() {
-//    // Hide all visible elements in all scenes
-//    remote.getSceneList(sceneListResponse -> {
-//      sceneListResponse.getScenes().forEach(scene -> {
-//        scene.getSources().forEach(source -> {
-//          if(!source.getName().startsWith("scenename")) {
-//            remote.setSourceVisibility(scene.getName(), source.getName(), false, result -> {
-//              if(result.getError() != null && !result.getError().isEmpty()) {
-//                fail(String.format("Failed to hide source '%s' on scene '%s'", source.getName(), scene.getName()));
-//              }
-//            });
-//          }
-//        });
-//      });
-//    });
-  }
-
-  protected Consumer loggingCallback = (obj) -> {
-    System.out.println("Received response: " + obj);
-  };
-
-  protected void waitReasonably() {
-    waitReasonably(500);
-  }
-
-  protected void waitReasonably(long ms) {
-    try {
-      Thread.sleep(ms);
-    } catch (InterruptedException e) {
-      e.printStackTrace();
-    }
+    // Hide all visible elements in all scenes
+    remote.getSceneList(sceneListResponse -> {
+      sceneListResponse.getScenes().forEach(scene -> {
+        remote.getSceneItemList(scene.getSceneName(), getSceneItemListResponse -> {
+          getSceneItemListResponse.getSceneItems().forEach(sceneItem -> {
+            if (!sceneItem.getSourceName().startsWith("scenename")) {
+              remote.setSceneItemEnabled(scene.getSceneName(), sceneItem.getSceneItemId(), false, result -> {
+                if (!result.isSuccessful()) {
+                  fail(String.format("Failed to hide sceneItem '%s' on scene '%s'", sceneItem.getSourceName(),
+                      scene.getSceneName()));
+                }
+              });
+            }
+          });
+        });
+      });
+    });
   }
 
-  protected Consumer capturingCallback = (obj) -> {
-    System.out.println("Received response: " + obj + "(" + obj.getClass().getSimpleName() + ")");
-    resultQueue.add(obj);
-  };
-
-  protected <T> T getPreviousResponseAs(Class<T> clazz) {
-    Object previousResponse = resultQueue.remove();
-    assertThat(previousResponse).isInstanceOf(clazz);
-    return clazz.cast(previousResponse);
+  protected <T> Consumer<T> loggingCallback() {
+    return obj -> System.out.println("Received response: " + obj);
   }
-
 }

client/src/endToEndManualTest/java/io/obswebsocket/community/client/test/ObsRemoteE2eIT.java

@@ -27,7 +27,6 @@ static void beforeAll() {
   @BeforeEach
   public void beforeEach() {
     setupObs();
-    resultQueue.clear();
   }
 
   @AfterAll
@@ -49,14 +48,9 @@ void getScenes() {
         .currentProgramSceneName(SCENE1).scenes(expectedScenes).build();
 
     // When retrieved
-    remote.getSceneList(capturingCallback);
-    waitReasonably();
-
-    // Then scenes match as expected
-    GetSceneListResponse res = getPreviousResponseAs(GetSceneListResponse.class);
+    GetSceneListResponse res = remote.getSceneList(1000);
     assertThat(res.getMessageData().getResponseData())
             .usingRecursiveComparison().ignoringCollectionOrder().isEqualTo(expectedResponseData);
-
   }
 
   @Disabled
@@ -80,7 +74,6 @@ void getSourcesList() {
     // When retrieved
 //    remote.getSourcesList(capturingCallback);
     fail("getSourcesList not implemented");
-    waitReasonably();
 
     // Then it matches as expected
 //    GetSourcesListResponse res = getPreviousResponseAs(GetSourcesListResponse.class);