[java, node] Adds new desktop cast command for Chromium #10190 (#10191)

gpt14 · web-flow · commit 66b14c5578a9 · 2021-12-29T11:13:20.000-06:00
[java, node] Adds new desktop cast command for Chromium
diff --git a/java/src/org/openqa/selenium/chrome/AddHasCasting.java b/java/src/org/openqa/selenium/chrome/AddHasCasting.java
@@ -38,6 +38,7 @@ public Map<String, CommandInfo> getAdditionalCommands() {
     return ImmutableMap.of(
       GET_CAST_SINKS, new CommandInfo("session/:sessionId/goog/cast/get_sinks", HttpMethod.GET),
       SET_CAST_SINK_TO_USE, new CommandInfo("session/:sessionId/goog/cast/set_sink_to_use", HttpMethod.POST),
+      START_CAST_DESKTOP_MIRRORING, new CommandInfo("session/:sessionId/goog/cast/start_desktop_mirroring", HttpMethod.POST),
       START_CAST_TAB_MIRRORING, new CommandInfo("session/:sessionId/goog/cast/start_tab_mirroring", HttpMethod.POST),
       GET_CAST_ISSUE_MESSAGE, new CommandInfo("session/:sessionId/goog/cast/get_issue_message", HttpMethod.GET),
       STOP_CASTING, new CommandInfo("session/:sessionId/goog/cast/stop_casting", HttpMethod.POST));
diff --git a/java/src/org/openqa/selenium/chromium/AddHasCasting.java b/java/src/org/openqa/selenium/chromium/AddHasCasting.java
@@ -34,6 +34,7 @@ public abstract class AddHasCasting implements AugmenterProvider<HasCasting>, Ad
   public static final String GET_CAST_SINKS = "getCastSinks";
   public static final String SET_CAST_SINK_TO_USE = "selectCastSink";
   public static final String START_CAST_TAB_MIRRORING = "startCastTabMirroring";
+  public static final String START_CAST_DESKTOP_MIRRORING = "startDesktopMirroring";
   public static final String GET_CAST_ISSUE_MESSAGE = "getCastIssueMessage";
   public static final String STOP_CASTING = "stopCasting";
 
@@ -64,6 +65,13 @@ public void selectCastSink(String deviceName) {
         executeMethod.execute(SET_CAST_SINK_TO_USE, ImmutableMap.of("sinkName", deviceName));
       }
 
+      @Override
+      public void startDesktopMirroring(String deviceName) {
+        Require.nonNull("Device Name", deviceName);
+
+        executeMethod.execute(START_CAST_DESKTOP_MIRRORING, ImmutableMap.of("sinkName", deviceName));
+      }
+
       @Override
       public void startTabMirroring(String deviceName) {
         Require.nonNull("Device Name", deviceName);
diff --git a/java/src/org/openqa/selenium/chromium/ChromiumDriver.java b/java/src/org/openqa/selenium/chromium/ChromiumDriver.java
@@ -246,6 +246,12 @@ public void selectCastSink(String deviceName) {
     casting.selectCastSink(deviceName);
   }
 
+  @Override
+  public void startDesktopMirroring(String deviceName) {
+    Require.nonNull("Device Name", deviceName);
+    casting.startDesktopMirroring(deviceName);
+  }
+
   @Override
   public void startTabMirroring(String deviceName) {
     Require.nonNull("Device Name", deviceName);
diff --git a/java/src/org/openqa/selenium/chromium/HasCasting.java b/java/src/org/openqa/selenium/chromium/HasCasting.java
@@ -43,6 +43,13 @@ public interface HasCasting {
    */
   void selectCastSink(String deviceName);
 
+  /**
+   * Initiates desktop mirroring for the current browser tab on the specified device.
+   *
+   * @param deviceName name of the target device.
+   */
+  void startDesktopMirroring(String deviceName);
+
   /**
    * Initiates tab mirroring for the current browser tab on the specified device.
    *
diff --git a/java/test/org/openqa/selenium/chrome/ChromeDriverFunctionalTest.java b/java/test/org/openqa/selenium/chrome/ChromeDriverFunctionalTest.java
@@ -111,6 +111,25 @@ public void canCast() throws InterruptedException {
     }
   }
 
+  @Test
+  @Ignore(gitHubActions = true)
+  public void canCastOnDesktop() throws InterruptedException {
+    HasCasting caster = (HasCasting) driver;
+
+    // Does not get list the first time it is called
+    caster.getCastSinks();
+    Thread.sleep(1500);
+    List<Map<String, String>> castSinks = caster.getCastSinks();
+
+    // Can not call these commands if there are no sinks available
+    if (castSinks.size() > 0) {
+      String deviceName = castSinks.get(0).get("name");
+
+      caster.startDesktopMirroring(deviceName);
+      caster.stopCasting(deviceName);
+    }
+  }
+
   @Test
   public void canManageNetworkConditions() {
     HasNetworkConditions conditions = (HasNetworkConditions) driver;
diff --git a/javascript/node/selenium-webdriver/chromium.js b/javascript/node/selenium-webdriver/chromium.js
@@ -97,6 +97,7 @@ const Command = {
   SET_PERMISSION: 'setPermission',
   GET_CAST_SINKS: 'getCastSinks',
   SET_CAST_SINK_TO_USE: 'setCastSinkToUse',
+  START_CAST_DESKTOP_MIRRORING: 'startDesktopMirroring',
   START_CAST_TAB_MIRRORING: 'setCastTabMirroring',
   GET_CAST_ISSUE_MESSAGE: 'getCastIssueMessage',
   STOP_CASTING: 'stopCasting',
@@ -161,6 +162,11 @@ function configureExecutor(executor, vendorPrefix) {
     'POST',
     `/session/:sessionId/${vendorPrefix}/cast/set_sink_to_use`
   )
+  executor.defineCommand(
+    Command.START_CAST_DESKTOP_MIRRORING,
+    'POST',
+    `/session/:sessionId/${vendorPrefix}/cast/start_desktop_mirroring`
+  )
   executor.defineCommand(
     Command.START_CAST_TAB_MIRRORING,
     'POST',
@@ -834,6 +840,23 @@ class Driver extends webdriver.WebDriver {
     )
   }
 
+  /**
+   * Initiates desktop mirroring for the current browser tab on the specified device.
+   *
+   * @param {String} deviceName name of the target device.
+   * @return {!promise.Thenable<void>} A promise that will be resolved
+   *     when the mirror command has been issued to the device.
+   */
+   startDesktopMirroring(deviceName) {
+    return this.schedule(
+      new command.Command(Command.START_CAST_DESKTOP_MIRRORING).setParameter(
+        'sinkName',
+        deviceName
+      ),
+      'Driver.startDesktopMirroring(' + deviceName + ')'
+    )
+  }
+
   /**
    * Initiates tab mirroring for the current browser tab on the specified device.
    *
