No description or website provided.
Java
Latest commit 8dfd844 May 22, 2016 @paul-hammant paul-hammant release notes
Failed to load latest commit information.
java [maven-release-plugin] prepare for next development iteration May 22, 2016
.gitignore tbody and nav added Sep 12, 2013
COPYING add copyright headers Aug 19, 2011
README.md release notes May 22, 2016

README.md

FluentSelenium

FluentSelenium is a layer on top of Selenium 2.0 (WebDriver) that adds a fluent interface style for working with the browser. For now, it is for the Java binding to WebDriver.

Basic Use

HTML elements have Java methods that are named for them. Locators are optional, and are from WebDriver's regular set:

WebDriver wd = new FirefoxDriver();
FluentWebDriver fwd = new FluentWebDriver(wd);

fwd.div(id("foo")).div(className("bar")).button().click();

fwd.span(id("results")).getText().shouldBe("1 result");

Hyperlinks are marked as 'a' (anchor) in HTML, but we have represented those as link() in the fluent API.

As with all fluent interfaces, there is no point looking at strict API documentation (JavaDoc for Java), and you're better looking at example code, and this page is it (perhaps the blog entries of others too).

Situations where the DOM is changing slowly

within()

There's a "within" capability in the fluent language. It will keep retrying a locator for a given period of time. The fluent expression (the locator) is given a chance to get past a slowly appearing element in the page:

fwd.div(id("foo")).div(className("bar")).within(secs(5)).button().click();

fwd.span(id("results").within(millis(200)).getText().shouldBe("123");

This will throw an exception after the elapsed time, if the element still hasn't appeared in the page's DOM.

without()

The opposite of "within", the "without" capability is going to wait for something to disappear. If the element is still in the page, it will keep waiting upto a given period of time, for it to disappear:

fwd.div(id("foo")).div(className("bar")).without(secs(5)).button();

The element disappearing in the page means that the fluent expression stops there. Also, disappear means that the locator used to find the element does not find it. Thus the following does not mean that there's no span element, it just means that there is no span element with a class of "baz":

fwd.div(id("foo")).div(className("bar")).without(secs(5)).span(className("baz"));

This will throw an exception after the elapsed time, if it still hasn't disappeared from the page's DOM.

Selenium 1.0 had an API function isElementPresent. The 'without' functionality is akin to isElementNotPresent, or rather waitForElementToNotBePresent.

Elements in the DOM, but not visible 'yet'

Sometimes elements are within the DOM, but they are invisible for a period of time after an action of some sort. You can wait for elements to become visible, before fluently progressing:

fwd.input(id("textArea")).sendKeys("Mary Had A Little Lamb...");
fwd.div(id("discardChanges")).ifInvisibleWaitUpTo(millis(500)).click();

Locators for Advanced JavaScript Frameworks

AngularJS 1.x

AngularJS is an example of framework that does a huge amount of the heavy lifting in browser. While it's doing its magic, you are going to encounter timing issues. If you prefer, the 'within' and 'without' fluent methods above will help you overcome those issues, but there is a way of being smarter about waiting for Angular's magic to stop:

There's another library you can use in conjunction with Selenium/WebDriver and/or FluentSelenium called ngWebDriver that makes it far easier to test Angular applications.

Other frameworks

Backbone, Knockout (etc) may have similar tricks, that you can use 'executeScript' to invoke, but we've not done the research to hook into them.

Stale Elements

WebDriver, by default, does not handle findElement traversals from elements that have gone stale transparently. It prefers to throw StaleElementReferenceException, which you have to catch and then do something with. Retry is one option. FluentSelenium has retry capability:

new RetryAfterStaleElement() {
    public void toRetry() {
        div(id("thirdAddress")).div(className("fromto-column")).getText().toString();
    }
}.stopAfter(secs(8));

In this example, the element can go stale any amount of times in eight seconds, and the whole traversal is restarted again and again. If you're trying to store values, you'll have a problem with Java's inner-class rules, and have to use member fields or do dirty tricks like:

final String selectedFlight[] = new String[1];
new RetryAfterStaleElement() {
    public void toRetry() {
        selectedFlight[0] = div(className("fromto-column")).getText().toString();
    }
}.stopAfter(secs(8));

Use of the one element array is the dirty trick, because of the need for final.

FluentSelenium can recover from a subset of StaleElementReferenceException situations. If the item going stale is the one that is leaf-most in your fluent expression, then it can be recovered automatically (and silently). This is a one-time deal though - if it persistent in its staleness after recovery, then the exception is throw. Recovery means finding it again in the DOM, relative to its parent with the same locator. In the case above, the "fromto-column" div being stale can be recovered automatically - even during the getText(). The "thirdAddress" div cannot be, at least when execution has transferred to the next div().

Built-in Assertions

String Assertions

Many things return a string (actually a TestableString). Some elements of a page are designed to have a string representation. Input fields and spans are obvious, but any element supports getText() and WebDriver will try to make a chunk of text that represents that (often with carriage returns).

fwd.div(id("foo")).getText().shouldBe("1 bar");
fwd.div(id("foo")).getText().shouldNotBe("0 bars");
fwd.div(id("foo")).getText().shouldContain("bar");
fwd.div(id("foo")).getText().shouldNotContain("error");

Regex is possible too, and it will ignore carriage returns (which Java pre-processes like so \n -> \\n)

fwd.div(id("foo")).getText().shouldMatch("\d bar");
fwd.div(id("foo")).getText().shouldMatch("[1-9] bar");
fwd.div(id("formErrors")).getText().shouldNotMatch("\d errors");

As shown above, you can transparently wait for the thing to become true:

fwd.div(id("foo")).getText().within(secs(10)).shouldBe("1 bar");

The assertion is retried for the advised period.

Non-String Assertions

Any element has a location via getLocation(), which yields a Point Any element has a size via getSize(), which yields a Dimension Some elements have boolean from isDisplayed(), isEnabled() and isSelected()

All of these have assertions:

fwd.div(id("foo")).getLocation().shouldBe(new Point(1, 1));
fwd.div(id("foo")).getLocation().shouldNotBe(new Point(1, 1));

fwd.div(id("foo")).getSize().shouldBe(new Dimension(640, 480));
fwd.div(id("foo")).getSize().shouldNotBe(new Dimension(640, 480));

fwd.div(id("foo")).isEnabled().shouldBe(true);
fwd.div(id("foo")).isDisplayed().shouldBe(false);

Like for Strings, you can transparently wait for the thing to become true:

fwd.div(id("foo")).isDisplayed().within(secs(10)).shouldBe(true);

The assertion is retried for the advised period.

Locating Elements

WebDriver's own "By" locator mechanism is what is used. Here are examples using that:

by = By.id("id")
by = By.className("name")
by = By.tagName("table")

Class FluentBy adds a few more:

by = FluentBy.attribute("ng-model")
by = FluentBy.attribute("ng-model", "shopperSelection.payPalPreferred") {
by = FluentBy.composite(tagName("table"), className("paymentType"))
by = FluentBy.composite(tagName("table"), attribute("ng-click")) {

One more strictClassName is used like so:

by = FluentBy.strictClassName("name")

Strict is where there is only one class for that element. The built-in WebDriver one allows for many classes for an element, with the one specified amongst them.

If an locator cannot find the element in the DOM, then an exception - 'FluentExecutionStopped' - is thrown (see below).

Multiple elements

Just like WebDriver, FluentSelenium can return a collection of Elements matching a locator:

FluentWebElements elems = fwd.div(id("foo")).div(className("bar")).buttons();
elems = fwd.div(id("foo")).divs(className("bar"));
elems = fwd.divs(id("foo");

Look at the pluralization of the methods above, and that it only makes sense if it's the last in the fluent expression.

Fluently matching/filtering over multiple elements

Use a FluentMatcher instance (which is just a predicate)

class MyIntricateFluentMatcher implements FluentMatcher {
  public boolean matches(FluentWebElement webElement, int ix) {
    // do what you like here as long as it return true/false.
  }
}


FluentMatcher fm = new MyIntricateFluentMatcher();
// click on first matching one...
fwd.inputs(className("bar").first(fm).click();

// click on last matching one...
fwd.inputs(className("bar").last(fm).click();

// click on all matching matching ones...
listofMatching elements = fwd.inputs(className("bar").filter(fm)
listofMatching.click() // click them all

There are no instances of FluentMatcher built in, other than CompositeFluentMatcher which allows you to build up a larger matcher, and has 'both', 'any', 'all', 'either' functionality. There's also 'and' & 'or' cabailities to CompositeFluentMatcher.

Visit each element to do something custom

class MyFluentWebElementVistor implements FluentWebElementVistor {
  public void visit(FluentWebElement webElement, int ix) {
    // do what you like here
  }
}

FluentWebElementVistor v = new MyFluentWebElementVistor();
// do something on each element in a list, then click on them
fwd.inputs(className("bar").each(v).click();

Make a map from the matching elements

class MyFluentWebElementMap<String,String> implements FluentWebElementMap<String,String> {
  public void map(FluentWebElement webElement, int ix) {
    // note: <String,String> is only an example
    String key == webElement. // something
    String value == webElement. // something
    put(key,value);
  }
}

MyFluentWebElementMap m = new MyFluentWebElementMap();
Map<String,String> myMap = fwd.inputs(className("bar").map(m);
// map() effectively stops fluency, here.

Exceptions

Obviously you want tests using FluentSelenium to pass. Getting tests to be stable has also been a historical challenge for the Selenium world, but a real failure of previously working test, is worth debugging (before or after a developer commit that may have broken the build).

Fluent-Selenium throws 'FluentExecutionStopped' like so:

"WebDriver exception during invocation of : ?.div(By.className: item-treasury-info-box')).h3()"

That exception's getCause() will be the WebDriverException derivative that happened during the h3() invocation - implicitly before any subsequent operation like click(). That could well be 'NoSuchElementException' for when an element was not found.

Alternate boolean handling of missing elements.

Normal operation is for FluentSelenium to throw 'FluentExecutionStopped' wrapping WebDriver's 'NoSuchElementException' for the root cause.

With 'has()' and 'hasMissing()' you can receive true/false instead of getting exceptions like so:

boolean isMissing = fwd.hasMissing().div(id("foo"))
boolean isPresent = fwd.has().div(id("foo"))

As mentioned before, Selenium 1.0 had an API function called 'isElementPresent'. With FluentSelenium we're getting close to that again, as 'has' and 'hasMissing' preceding a thing that should or should not be there, are functionally equivalent.

Monitoring

Fluent Selenium can generate monitors failing interactions with the browser. It can also see what fluent operation were started/ended. Refer the Monitor interface.

You specify a monitor choice by using the right constructor for FluentWebDriver (and pass in a Monitor instance). There's a default monitor that does nothing, so you don't have to choose a constructor that uses a monitor.

We have three implementations presently, and if you want to use more than one, wrap them in a CompositeMonitor:

new FluentWebDriver(new FirefoxDriver(), new CompositeMonitor(one, two, three));

Takes a Screenshot (on error)

When a 'FluentExecutionStopped' failure happens, you can get automatic screenshots. In the case of running from JUnit or TestNG under Maven control do the following, to get automatic Test-Class name & Method name in the file-name of the PNG:

ffd = new FirefoxDriver();
myScreenShotOnError = new ScreenShotOnError.WithUnitTestFrameWorkContext(ffd, OneOfYourClasses.class, "test-classes", "surefire-reports/");
fwd = new FluentWebDriver(ffd, myScreenShotOnError);

If you're not wanting that JUnit/TestNG automatic file naming, do this instead:

ffd = new FirefoxDriver();
myScreenShotOnError = new ScreenShotOnError(ffd, OneOfYourClasses.class, "test-classes", "surefire-reports/");
fwd = new FluentWebDriver(ffd, myScreenShotOnError);

myScreenShotOnError.setContext("something_that_has_meaning_in_a_file_name")
div(id("foo")).click();
myScreenShotOnError.setContext("something_else_that_has_meaning_in_a_file_name")
input(id("bar")).sendKeys("abc");

Highlights on error

This draws a red dotted two-pixel line around the relevant part of the page, when an FluentExecutionStopped is thrown. You'd use it in conjunction with ScreenShotOnError above:

ffd = new FirefoxDriver();
myScreenShotOnError = ...
fwd = new FluentWebDriver(ffd, new CompositeMonitor(new HighlightOnError(ffd), myScreenShotOnError));

If you don't want a red dashed two-pixel line, subclass HighlightOnError and override one of executeScript(), highlightOperation() or highlightValue().

Coda Hale's Metrics library

Also shown here is how to hook that up to a JUnit4 suite running under Maven.

The separate listener class:

public class MyRunListener extends RunListener {
    public static final CodaHaleMetricsMonitor codahaleMetricsMonitor = new CodaHaleMetricsMonitor("com.paulhammant.fluentSeleniumExamples.");
    @Override
    public void testRunFinished(Result result) throws Exception {
        super.testRunFinished(result);
        final ConsoleReporter reporter = ConsoleReporter.forRegistry(codahaleMetricsMonitor.getMetrics())
                .convertRatesTo(TimeUnit.MILLISECONDS)
                .convertDurationsTo(TimeUnit.MILLISECONDS)
                .outputTo(System.out)
                .build();
        reporter.report();
    }
    // More likely, you'd send stats to Graphite (etc).
}

Hooking that into each/all FluentWebDriver usages:

public class Home extends FluentWebDriver {
    public Home(WebDriver delegate) {
        super(delegate, MyRunListener.codahaleMetricsMonitor);
    }
    // etc
}

// or the more conventional non inner-class style:

fwd = new FluentWebDriver(webDriver, MyRunListener.codahaleMetricsMonitor);

And in Maven's pom.xml:

<build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <configuration>
          <properties>
            <property>
              <name>listener</name>
              <value>com.example.MyRunListener</value>
            </property>
          </properties>
        </configuration>
      </plugin>
    </plugins>
  </build>

This will spit our stats in the log like so, that require some interpretation:

package.MyClass.aMethod:div(By.className: aClassName)
             count = 2
         mean rate = 0.00 calls/millisecond
     1-minute rate = 0.00 calls/millisecond
     5-minute rate = 0.00 calls/millisecond
    15-minute rate = 0.00 calls/millisecond
               min = 31.95 milliseconds
               max = 36.66 milliseconds
              mean = 34.31 milliseconds
            stddev = 3.33 milliseconds
            median = 34.31 milliseconds
              75% <= 36.66 milliseconds
              95% <= 36.66 milliseconds
              98% <= 36.66 milliseconds
              99% <= 36.66 milliseconds
            99.9% <= 36.66 milliseconds

There's a fuller example of stats in the 'Fluent Selenium Examples' project

Coda Hale's Metrics library has other reporters you could attach.

Including it in your project

Maven

<dependency>
   <groupId>org.seleniumhq.selenium.fluent</groupId>
   <artifactId>fluent-selenium</artifactId>
   <version>1.14.2</version>
   <scope>test</scope>
</dependency>

<!-- you need to choose a hamcrest version that works for you too -->
<dependency>
   <groupId>org.hamcrest</groupId>
   <artifactId>hamcrest-all</artifactId>
   <version>1.3</version>
   <scope>test</scope>
</dependency>

<!-- If you're needing Coda Hale's Metrics integration (optional) -->
<dependency>
   <groupId>com.codahale.metrics</groupId>
   <artifactId>metrics-core</artifactId>
   <version>3.0.0</version>
</dependency>

Bear in mind that the FluentSelenium maven module has a transitive dependency on Selenium 2.x. You may want to override the version for your project. You'll need an exclusion for FluentSelenium, and an explicit dependency for Selenium 2.x. ...

<dependency>
  <groupId>org.seleniumhq.selenium.fluent</groupId>
  <artifactId>fluent-selenium</artifactId>
  <version>1.14.6</version>
  <scope>test</scope>
  <exclusions>
    <exclusion>
      <groupId>org.seleniumhq.selenium</groupId>
      <artifactId>selenium-java</artifactId>
    </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>org.seleniumhq.selenium</groupId>
  <artifactId>selenium-java</artifactId>
  <version>2.99.3</version>
  <scope>test</scope>
</dependency>

Non-Maven

For non-Maven build systems, download it yourself.

Here's what else you might need in your classpath, depending on your needs:

+- junit:junit:jar:4.12:test
+- org.hamcrest:hamcrest-all:jar:1.3:compile
+- org.mockito:mockito-core:jar:1.10.19:test
|  +- org.hamcrest:hamcrest-core:jar:1.1:test
|  \- org.objenesis:objenesis:jar:2.1:test
+- org.seleniumhq.selenium:selenium-java:jar:2.53.0:compile
|  +- org.seleniumhq.selenium:selenium-chrome-driver:jar:2.53.0:compile
|  |  \- org.seleniumhq.selenium:selenium-remote-driver:jar:2.53.0:compile
|  |     +- cglib:cglib-nodep:jar:2.1_3:compile
|  |     +- com.google.code.gson:gson:jar:2.3.1:compile
|  |     +- org.seleniumhq.selenium:selenium-api:jar:2.53.0:compile
|  |     +- org.apache.httpcomponents:httpclient:jar:4.5.1:compile
|  |     |  +- org.apache.httpcomponents:httpcore:jar:4.4.3:compile
|  |     |  +- commons-logging:commons-logging:jar:1.2:compile
|  |     |  \- commons-codec:commons-codec:jar:1.9:compile
|  |     \- com.google.guava:guava:jar:19.0:compile
|  +- org.seleniumhq.selenium:selenium-edge-driver:jar:2.53.0:compile
|  |  +- commons-io:commons-io:jar:2.4:compile
|  |  \- org.apache.commons:commons-exec:jar:1.3:compile
|  +- org.seleniumhq.selenium:selenium-firefox-driver:jar:2.53.0:compile
|  +- org.seleniumhq.selenium:selenium-ie-driver:jar:2.53.0:compile
|  |  +- net.java.dev.jna:jna:jar:4.1.0:compile
|  |  \- net.java.dev.jna:jna-platform:jar:4.1.0:compile
|  +- org.seleniumhq.selenium:selenium-safari-driver:jar:2.53.0:compile
|  |  \- io.netty:netty:jar:3.5.7.Final:compile
|  +- org.seleniumhq.selenium:selenium-support:jar:2.53.0:compile
|  \- org.seleniumhq.selenium:selenium-leg-rc:jar:2.53.0:compile
\- com.codahale.metrics:metrics-core:jar:3.0.2:compile
   \- org.slf4j:slf4j-api:jar:1.7.5:compile

Changes

1.16.1 (May 22, 2016)

  • Selenium upgrade to v2.53.0 - incl. the new getRect() from WebElement
  • Support for h5 and h6

1.16 (Nov 29, 2015)

  • map function and visitor added

1.15 (Nov 21, 2015)

  • Selenium upgrade to v2.48.2
  • Support for unordered lists (ul elements)
  • FluentWebDriver.element(..) method for finding generic elements (or ones outside the HTML spec)

More Reading

Refer Paul Hammant's Fluent Selenium Examples Blog Entry about this, or the project that showcases Fluent Selenium - Fluent Selenium Examples.