adding ExpectedConditions for URLs (contains, toBe, and matches regex)

Adding tests for ExpectedConditions.urlToBe|urlContains|urlMatches
adding tests to ExpectedConditionsTest

Signed-off-by: Luke Inman-Semerau <[email protected]>

Author: ddavison

java/client/src/org/openqa/selenium/support/ui/ExpectedConditions.java

@@ -31,6 +31,8 @@
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /**
  * Canned {@link ExpectedCondition}s which are generally useful within webdriver
@@ -91,6 +93,79 @@ public String toString() {
     };
   }
 
+  /**
+   * An expectation for the URL of the current page to be a specific url.
+   *
+   * @param url the url that the page should be on
+   * @return <code>true</code> when the URL is what it should be
+   */
+  public static ExpectedCondition<Boolean> urlToBe(final String url) {
+    return new ExpectedCondition<Boolean>() {
+      private String currentUrl = "";
+
+      @Override
+      public Boolean apply(WebDriver driver) {
+        currentUrl = driver.getCurrentUrl();
+        return currentUrl != null && currentUrl.equals(url);
+      }
+
+      @Override
+      public String toString() {
+        return String.format("url to be \"%s\". Current url: \"%s\"", url, currentUrl);
+      }
+    };
+  }
+
+  /**
+   * An expectation for the URL of the current page to contain specific text.
+   *
+   * @param fraction the fraction of the url that the page should be on
+   * @return <code>true</code> when the URL contains the text
+   */
+  public static ExpectedCondition<Boolean> urlContains(final String fraction) {
+    return new ExpectedCondition<Boolean>() {
+      private String currentUrl = "";
+
+      @Override
+      public Boolean apply(WebDriver driver) {
+        currentUrl = driver.getCurrentUrl();
+        return currentUrl != null && currentUrl.contains(fraction);
+      }
+
+      @Override
+      public String toString() {
+        return String.format("url to contain \"%s\". Current url: \"%s\"", fraction, currentUrl);
+      }
+    };
+  }
+
+  /**
+   * Expectation for the URL to match a specific regular expression
+   *
+   * @param regex the regular expression that the URL should match
+   * @return <code>true</code> if the URL matches the specified regular expression
+   */
+  public static ExpectedCondition<Boolean> urlMatches(final String regex) {
+    return new ExpectedCondition<Boolean>() {
+      private String currentUrl;
+      private Pattern pattern;
+      private Matcher matcher;
+
+      @Override
+      public Boolean apply(WebDriver driver) {
+        currentUrl = driver.getCurrentUrl();
+        pattern = Pattern.compile(regex);
+        matcher = pattern.matcher(currentUrl);
+        return matcher.find();
+      }
+
+      @Override
+      public String toString() {
+        return String.format("url to match the regex \"%s\". Current url: \"%s\"", regex, currentUrl);
+      }
+    };
+  }
+
   /**
    * An expectation for checking that an element is present on the DOM of a
    * page. This does not necessarily mean that the element is visible.

java/client/test/org/openqa/selenium/support/ui/ExpectedConditionsTest.java

@@ -28,6 +28,9 @@
 import static org.openqa.selenium.support.ui.ExpectedConditions.elementSelectionStateToBe;
 import static org.openqa.selenium.support.ui.ExpectedConditions.not;
 import static org.openqa.selenium.support.ui.ExpectedConditions.textToBePresentInElementLocated;
+import static org.openqa.selenium.support.ui.ExpectedConditions.urlContains;
+import static org.openqa.selenium.support.ui.ExpectedConditions.urlMatches;
+import static org.openqa.selenium.support.ui.ExpectedConditions.urlToBe;
 import static org.openqa.selenium.support.ui.ExpectedConditions.visibilityOf;
 import static org.openqa.selenium.support.ui.ExpectedConditions.visibilityOfAllElements;
 import static org.openqa.selenium.support.ui.ExpectedConditions.visibilityOfAllElementsLocatedBy;
@@ -74,6 +77,66 @@ public void setUpMocks() {
         .pollingEvery(250, TimeUnit.MILLISECONDS);
   }
 
+  @Test
+  public void waitingForUrlToBeOpened_urlToBe() {
+    final String url = "http://some_url";
+    when(mockDriver.getCurrentUrl()).thenReturn(url);
+    wait.until(urlToBe(url));
+  }
+
+  @Test
+  public void waitingForUrlToBeOpened_urlContains() {
+    final String url = "http://some_url";
+    when(mockDriver.getCurrentUrl()).thenReturn(url);
+    wait.until(urlContains("some_url"));
+  }
+
+  @Test
+  public void waitingForUrlToBeOpened_urlMatches() {
+    final String url = "http://some-dynamic:4000/url";
+    when(mockDriver.getCurrentUrl()).thenReturn(url);
+    wait.until(urlMatches(".*:\\d{4}\\/url"));
+  }
+
+  @Test
+  public void negative_waitingForUrlToBeOpened_urlToBe() {
+    final String url = "http://some_url";
+    when(mockDriver.getCurrentUrl()).thenReturn(url);
+
+    try {
+      wait.until(urlToBe(url + "/malformed"));
+      fail();
+    } catch (TimeoutException ex) {
+      // do nothing
+    }
+  }
+
+  @Test
+  public void negative_waitingForUrlToBeOpened_urlContains() {
+    final String url = "http://some_url";
+    when(mockDriver.getCurrentUrl()).thenReturn(url);
+
+    try {
+      wait.until(urlContains("/malformed"));
+      fail();
+    } catch (TimeoutException ex) {
+      // do nothing
+    }
+  }
+
+  @Test
+  public void negative_waitingForUrlToBeOpened_urlMatches() {
+    final String url = "http://some-dynamic:4000/url";
+    when(mockDriver.getCurrentUrl()).thenReturn(url);
+
+    try {
+      wait.until(urlMatches(".*\\/malformed.*"));
+      fail();
+    } catch (TimeoutException ex) {
+      // do nothing
+    }
+  }
+
   @Test
   public void waitingForVisibilityOfElement_elementAlreadyVisible() {
     when(mockElement.isDisplayed()).thenReturn(true);