[java] Implementing commands to get timeouts

Author: barancev

java/client/src/org/openqa/selenium/WebDriver.java

@@ -344,6 +344,15 @@ default Timeouts implicitlyWait(Duration duration) {
       return implicitlyWait(duration.toMillis(), TimeUnit.MILLISECONDS);
     }
 
+    /**
+     * Gets the amount of time the driver should wait when searching for an element if it is
+     * not immediately present.
+     *
+     * @return The amount of time the driver should wait when searching for an element.
+     * @see <a href="https://www.w3.org/TR/webdriver/#get-timeouts">W3C WebDriver</a>
+     */
+    Duration getImplicitWaitTimeout();
+
     /**
      * @deprecated Use {@link #setScriptTimeout(Duration)}
      *
@@ -372,6 +381,16 @@ default Timeouts setScriptTimeout(Duration duration) {
       return setScriptTimeout(duration.toMillis(), TimeUnit.MILLISECONDS);
     }
 
+    /**
+     * Gets the amount of time to wait for an asynchronous script to finish execution before
+     * throwing an error. If the timeout is negative, then the script will be allowed to run
+     * indefinitely.
+     *
+     * @return The amount of time to wait for an asynchronous script to finish execution.
+     * @see <a href="https://www.w3.org/TR/webdriver/#get-timeouts">W3C WebDriver</a>
+     */
+    Duration getScriptTimeout();
+
     /**
      * @deprecated Use {@link #pageLoadTimeout(Duration)}
      *
@@ -395,6 +414,15 @@ default Timeouts setScriptTimeout(Duration duration) {
     default Timeouts pageLoadTimeout(Duration duration) {
       return pageLoadTimeout(duration.toMillis(), TimeUnit.MILLISECONDS);
     }
+
+    /**
+     * Gets the amount of time to wait for a page load to complete before throwing an error.
+     * If the timeout is negative, page loads can be indefinite.
+     *
+     * @return The amount of time to wait for a page load to complete.
+     * @see <a href="https://www.w3.org/TR/webdriver/#get-timeouts">W3C WebDriver</a>
+     */
+    Duration getPageLoadTimeout();
   }
 
   /**

java/client/src/org/openqa/selenium/remote/DriverCommand.java

@@ -226,6 +226,7 @@ static CommandPayload SET_ALERT_VALUE(String keysToSend) {
   }
   String SET_ALERT_CREDENTIALS = "setAlertCredentials";
 
+  String GET_TIMEOUTS = "getTimeouts";
   String SET_TIMEOUT = "setTimeout";
 
   String PRINT_PAGE = "printPage";

java/client/src/org/openqa/selenium/remote/RemoteWebDriver.java

@@ -866,6 +866,14 @@ public Timeouts implicitlyWait(Duration duration) {
         return this;
       }
 
+      @Override
+      public Duration getImplicitWaitTimeout() {
+        Response response = execute(DriverCommand.GET_TIMEOUTS);
+        Map<String, Object> rawSize = (Map<String, Object>) response.getValue();
+        long timeout = ((Number) rawSize.get("implicit")).longValue();
+        return Duration.ofMillis(timeout);
+      }
+
       @Deprecated
       @Override
       public Timeouts setScriptTimeout(long time, TimeUnit unit) {
@@ -878,6 +886,14 @@ public Timeouts setScriptTimeout(Duration duration) {
         return this;
       }
 
+      @Override
+      public Duration getScriptTimeout() {
+        Response response = execute(DriverCommand.GET_TIMEOUTS);
+        Map<String, Object> rawSize = (Map<String, Object>) response.getValue();
+        long timeout = ((Number) rawSize.get("script")).longValue();
+        return Duration.ofMillis(timeout);
+      }
+
       @Deprecated
       @Override
       public Timeouts pageLoadTimeout(long time, TimeUnit unit) {
@@ -889,6 +905,14 @@ public Timeouts pageLoadTimeout(Duration duration) {
         execute(DriverCommand.SET_PAGE_LOAD_TIMEOUT(duration));
         return this;
       }
+
+      @Override
+      public Duration getPageLoadTimeout() {
+        Response response = execute(DriverCommand.GET_TIMEOUTS);
+        Map<String, Object> rawSize = (Map<String, Object>) response.getValue();
+        long timeout = ((Number) rawSize.get("pageLoad")).longValue();
+        return Duration.ofMillis(timeout);
+      }
     } // timeouts class.
 
     @Beta

java/client/src/org/openqa/selenium/remote/codec/AbstractHttpCommandCodec.java

@@ -61,6 +61,7 @@
 import static org.openqa.selenium.remote.DriverCommand.GET_SCREEN_ORIENTATION;
 import static org.openqa.selenium.remote.DriverCommand.GET_SCREEN_ROTATION;
 import static org.openqa.selenium.remote.DriverCommand.GET_SESSION_LOGS;
+import static org.openqa.selenium.remote.DriverCommand.GET_TIMEOUTS;
 import static org.openqa.selenium.remote.DriverCommand.GET_TITLE;
 import static org.openqa.selenium.remote.DriverCommand.GO_BACK;
 import static org.openqa.selenium.remote.DriverCommand.GO_FORWARD;
@@ -193,6 +194,7 @@ public AbstractHttpCommandCodec() {
     defineCommand(DELETE_COOKIE, delete(cookie + "/:name"));
 
     String timeouts = sessionId + "/timeouts";
+    defineCommand(GET_TIMEOUTS, get(timeouts));
     defineCommand(SET_TIMEOUT, post(timeouts));
     defineCommand(SET_SCRIPT_TIMEOUT, post(timeouts + "/async_script"));
     defineCommand(IMPLICITLY_WAIT, post(timeouts + "/implicit_wait"));

java/client/src/org/openqa/selenium/support/events/EventFiringWebDriver.java

@@ -685,6 +685,11 @@ public Timeouts implicitlyWait(Duration duration) {
       return this;
     }
 
+    @Override
+    public Duration getImplicitWaitTimeout() {
+      return timeouts.getImplicitWaitTimeout();
+    }
+
     @Deprecated
     @Override
     public Timeouts setScriptTimeout(long time, TimeUnit unit) {
@@ -697,6 +702,11 @@ public Timeouts setScriptTimeout(Duration duration) {
       return this;
     }
 
+    @Override
+    public Duration getScriptTimeout() {
+      return timeouts.getScriptTimeout();
+    }
+
     @Deprecated
     @Override
     public Timeouts pageLoadTimeout(long time, TimeUnit unit) {
@@ -708,6 +718,11 @@ public Timeouts pageLoadTimeout(Duration duration) {
       timeouts.pageLoadTimeout(duration);
       return this;
     }
+
+    @Override
+    public Duration getPageLoadTimeout() {
+      return timeouts.getPageLoadTimeout();
+    }
   }
 
   private class EventFiringTargetLocator implements TargetLocator {

java/client/test/org/openqa/selenium/ExecutingAsyncJavascriptTest.java

@@ -52,6 +52,18 @@ public void setUp() {
     driver.manage().timeouts().setScriptTimeout(Duration.ofMillis(5000));
   }
 
+  @Test
+  @NotYetImplemented(value = CHROME, reason = "Default to 5s")
+  @NotYetImplemented(value = FIREFOX, reason = "Default to 5s")
+  @NotYetImplemented(value = SAFARI, reason = "Default to 5s")
+  public void shouldSetAndGetScriptTimeout() {
+    Duration timeout = driver.manage().timeouts().getScriptTimeout();
+    assertThat(timeout).hasMillis(30000);
+    driver.manage().timeouts().setScriptTimeout(Duration.ofMillis(3000));
+    Duration timeout2 = driver.manage().timeouts().getScriptTimeout();
+    assertThat(timeout2).hasMillis(3000);
+  }
+
   @Test
   public void shouldNotTimeoutIfCallbackInvokedImmediately() {
     driver.get(pages.ajaxyPage);

java/client/test/org/openqa/selenium/ImplicitWaitTest.java

@@ -51,6 +51,15 @@ public void tearDown() {
     driver.manage().timeouts().implicitlyWait(Duration.ofMillis(0));
   }
 
+  @Test
+  public void shouldSetAndGetImplicitWaitTimeout() {
+    Duration timeout = driver.manage().timeouts().getImplicitWaitTimeout();
+    assertThat(timeout).hasMillis(0);
+    driver.manage().timeouts().implicitlyWait(Duration.ofMillis(3000));
+    Duration timeout2 = driver.manage().timeouts().getImplicitWaitTimeout();
+    assertThat(timeout2).hasMillis(3000);
+  }
+
   @Test
   public void testShouldImplicitlyWaitForASingleElement() {
     driver.get(pages.dynamicPage);

java/client/test/org/openqa/selenium/PageLoadingTest.java

@@ -58,6 +58,15 @@ private void initDriverWithLoadStrategy(String strategy) {
     createNewDriver(new ImmutableCapabilities(CapabilityType.PAGE_LOAD_STRATEGY, strategy));
   }
 
+  @Test
+  public void shouldSetAndGetPageLoadTimeout() {
+    Duration timeout = driver.manage().timeouts().getPageLoadTimeout();
+    assertThat(timeout).hasMillis(300000);
+    driver.manage().timeouts().pageLoadTimeout(Duration.ofMillis(3000));
+    Duration timeout2 = driver.manage().timeouts().getPageLoadTimeout();
+    assertThat(timeout2).hasMillis(3000);
+  }
+
   @Test
   @NeedsLocalEnvironment
   @NoDriverBeforeTest

java/client/test/org/openqa/selenium/remote/RemoteWebDriverUnitTest.java

@@ -630,6 +630,18 @@ public void canHandleSetImplicitWaitCommand() {
       new CommandPayload(DriverCommand.SET_TIMEOUT, ImmutableMap.of("implicit", 10000L)));
   }
 
+  @Test
+  public void canHandleGetTimeoutsCommand() {
+    WebDriverFixture fixture = new WebDriverFixture(
+      echoCapabilities,
+      valueResponder(ImmutableMap.of("implicit", 100, "script", 200, "pageLoad", 300)));
+
+    fixture.driver.manage().timeouts().getImplicitWaitTimeout();
+
+    fixture.verifyCommands(
+      new CommandPayload(DriverCommand.GET_TIMEOUTS, emptyMap()));
+  }
+
   @Test
   public void canHandleSetScriptTimeoutCommand() {
     WebDriverFixture fixture = new WebDriverFixture(echoCapabilities, nullValueResponder);