seleniumQuery is a feature-rich cross-driver Java library that brings a jQuery-like interface for Selenium WebDriver.
It is designed to be a thin layer over Selenium. You can use seleniumQuery to manage the WebDriver for you, or you can use seleniumQuery on top of your favorite selenium framework just to make some cases simpler when needed.
// Regular Selenium
WebElement el = driver.findElement(By.cssSelector(".street"));
String oldStreet = element.getAttribute("value"); // what if ".street" is a <select>? this won't work
element.setAttribute("value", "4th St!")
// seleniumQuery
// getting the value
String oldStreet = $(".street").val(); // works even if it is a <select>, <textarea>, etc.
// setting the value
$("input.street").val("4th St!"); // also would work for a <select>And much more. The example above is of something that has an equivalent in Selenium. Not everything does (many things would require tons of boilerplate in vanilla Selenium).
On a regular WebElement...
// an existing WebElement...
WebElement existingWebElement = driver.findElement(By.id("myId"));
// call jQuery functions
String elementVal = $(existingWebElement).val();
boolean isButton = $(existingWebElement).is(":button"); // enhanced selector!
for (WebElement child: $(existingWebElement).children()) {
System.out.println("That element's child: "+child);
}Or an existing WebDriver...
// an existing WebDriver...
WebDriver driver = new FirefoxDriver();
// set it up
$.driver().use(driver);
// and use all the goods
for (WebElement e: $(".myClass:contains('My Text!'):not(:button)")) {
System.out.println("That element: " + e);
}Allows querying elements by:
- CSS3 Selectors -
$(".myClass"),$("#table tr:nth-child(3n+1)"); - jQuery enhanced selectors -
$(":text:eq(3)"),$(".myClass:contains('My Text!')"); - XPath -
$("//div/*/label/preceding::*"); - and even some own seleniumQuery selectors:
$("#myOldDiv").is(":not(:present)").
Built using Selenium WebDriver's capabilities, no jQuery.js is embedded at the page, no side-effects are generated.
Try it out now with the running example below:
import static io.github.seleniumquery.SeleniumQuery.$; // this will allow the short syntax
public class SeleniumQueryExample {
public static void main(String[] args) {
// The WebDriver will be instantiated only when first used
$.driver()
.useChrome() // sets Chrome as the driver (this is optional, if omitted, will default to HtmlUnit)
.headless() // configures chrome to be headless
.autoDriverDownload() // automatically downloads and configures chromedriver.exe
.autoQuitDriver(); // automatically quits the driver when the JVM shuts down
// or, instead, use any previously existing driver
// $.driver().use(myExistingInstanceOfWebDriver);
// starts the driver (if not started already) and opens the URL
$.url("http://www.google.com/?hl=en");
// interact with the page
$(":text[name='q']").val("seleniumQuery"); // the keys are actually typed!
// Besides the short syntax and the jQuery behavior you already know,
// other very useful function in seleniumQuery is .waitUntil(),
// handy for dealing with user-waiting actions (specially in Ajax enabled pages):
// the command below waits until the button is visible and then performs a real user click (not just the JS event)
$(":button[value='Google Search']").waitUntil().isVisible().then().click();
// this waits for the #resultStats to be visible using a selector and, when it is visible, returns its text content
String resultsText = $("#resultStats").waitUntil().is(":visible").then().text();
// .assertThat() functions: fluently asserts that the text contains the string "seconds", ignoring case
$("#resultStats").assertThat().text().containsIgnoreCase("seconds");
System.out.println(resultsText);
// should print something like: About 4,100 results (0.42 seconds)
// $.quit(); // would quit the driver, but it is not needed as .autoQuitDriver() was used
}
}To get the latest version of seleniumQuery, add to your pom.xml:
<dependency>
<groupId>io.github.seleniumquery</groupId>
<artifactId>seleniumquery</artifactId>
<version>0.20.0</version>
</dependency>Download and execute the seleniumQuery showcase project. It contains many demonstrations of what seleniumQuery is capable of.
seleniumQuery implements all jQuery functions that are useful to browser manipulation.
On top of it, we add many other useful functions (see $("selector").waitUntil() and $("selector").assertThat() below).
Our main goal is to make emulating user actions and reading the state of pages easier than ever, with a consistent behavior across drivers.
Make your code/tests more readable and easier to maintain. Leverage your knowledge of jQuery.
// Instead of regular Selenium code:
WebElement element = driver.findElement(By.id("mySelect"));
new Select(element).selectByValue("ford");
// You can have the same effect writing just:
$("#mySelect").val("ford");Get to know what jQuery functions seleniumQuery supports and what else it brings to the table on our seleniumQuery API wiki page.
WebDriver's FluentWait is great, but it requires too much boilerplate code. Enters the .waitUntil() function:
// Below is an example of a <div> that should be hidden as effect of an Ajax call.
// The code will hold until the modal is gone. If it is never gone, seleniumQuery will throw a timeout exception
$("#modalDiv :button:contains('OK')").click();
$("#modalDiv :button:contains('OK')").waitUntil().is(":not(:visible)");
// Or the two commands above, fluently:
$("#modalDivOkButton").click().waitUntil().is(":not(:visible)");You can also assert directly into the seleniumQuery object using .assertThat():
$("#modalDiv :button:contains('OK')").assertThat().is(":not(:visible)");
$("#myInput").assertThat().val().isBlank();Any function that can be used with $().waitUntil() can also be used with $().assertThat() and vice-versa.
See below, expand (click on the arrow) each item for more details.
| $(). function | Property/Evaluation Function | Evaluation Function |
|---|---|---|
|
|
|
|
||
You can also chain calls using .and():
$("span").assertThat().size().isGreaterThan(5).and().text().isEqualTo("a b c d e");
Or use functions after waiting/asserting using .then():
$("#div").waitUntil().isVisible().then().click();
How to setup the WebDriver? Simply use our builder. You can download their executables before or you can
let seleniumQuery automatically download and configure them. Setup in seleniumQuery is all too easy:
// Using Chrome, general example:
$.driver()
.useChrome() // configures Chrome as the driver
.headless() // configures Chrome to run in headless mode
.autoDriverDownload() // automatically downloads and configures chromedriver.exe
.autoQuitDriver(); // automatically quits the driver when the JVM shuts down
// Using Firefox
$.driver()
.useFirefox() // configures Firefox as the driver
.headless() // configures Firefox to run in headless mode
.autoDriverDownload() // automatically downloads and configures geckodriver.exe
.autoQuitDriver(); // automatically quits the driver when the JVM shuts downFor more examples, options and all supported drivers, see table below.
|
|
The driver builder functions are a bonus, you don't have to use them. For seleniumQuery, it makes no difference. If you want to create the WebDriver myExistingDriverInstance = ...; // created elsewhere by whoever
$.driver().use(myExistingDriverInstance); // from now on, $ will work on myExistingDriverInstance
// now you can use all of seleniumQuery's power!
$("#phone").assertThat().val().isEqualTo("99887766"); |
|
|
Here's how seleniumQuery can simplify a Headless mode available. Automatic driver download available.
|
|
|
Easy Headless mode available. Automatic driver download available.
|
|
|
Automatic driver download available.
|
|
|
Always headless, webkit-based. Automatic executable download available.
|
|
|
Always headless, java-based. No need to download anything.
|
|
|
seleniumQuery tests Safari as a remote driver. $.driver().useDriver(new SafariDriver()); |
|
|
Automatic driver download available.
|
|
|
Automatic driver download available. Additional info about configuration can be found in our IE Driver wiki.
|
Check the javadocs for our $().functions.
More info also in our API wiki page.
Check the javadocs for our $.functions.
Read about our global functions in the API wiki page.
Let the tool do the hard work and find elements easily:
- CSS3 Selectors -
$(".myClass"),$("#table tr:nth-child(3n+1)") - jQuery/Sizzle enhancements -
$(".claz:eq(3)"),$(".claz:contains('My Text!')") - XPath -
$("//div/*/label/preceding::*") - and even some own seleniumQuery selectors:
$("#myOldDiv").is(":not(:present)").
You pick your style. Whatever is more interesting at the moment. Mixing is OK:
$("#tab tr:nth-child(3n+1)").find("/img[@alt='calendar']/preceding::input").val("2014-11-12")Find more about them in seleniumQuery Selectors wiki page.
So there is a important aspect of it: Although our functions yield the same result as if you were using jQuery, remember we always execute them from the user perspective. In other words, when you call:
$(":input[name='email']").val("seleniumQuery@example.com");We don't change the value attribute directly like jQuery does. We actually do as a user would: We clear the input
and type, key by key, the string provided as argument!
And we go the extra mile whenever possible:
- Our
$().val()even works oncontenteditableelements ANDdocumentMode=on <iframe>s: They don't havevalue, but we type the text in them, again, key by key, as an user would; - If it is an
<input type="file">we select the file; - When the element is a
<select>, we choose the<option>by the value given (same as$("selector").as().select().selectByValue("123")).
On the same tone, when selecting/checking <option>s or checkboxes or radios, try not to use $().prop("selected", true) directly to them (which to work, of course, would need JS to be enabled on the driver).
Do as an user would: call .click()! Or, better yet, use seleniumQuery's .as().select() functions: $().as().select().selectByVisibleText("My Option") or $().as().select().selectByValue("123").
Typically, the $ is a static variable, thus every command you issue only affects the one same instance of WebDriver.
But... what if you want/need to use two WebDrivers at the same time?
We've got your back, see the example:
public static void main(String[] args) {
String demoPage = "https://cdn.rawgit.com/seleniumQuery/seleniumQuery-showcase/master/Agent.html";
// using two drivers (chrome and firefox) at the same time
SeleniumQueryBrowser chrome = new SeleniumQueryBrowser();
chrome.$.driver().useHtmlUnit().emulatingChrome().autoQuitDriver();
chrome.$.url(demoPage);
SeleniumQueryBrowser firefox = new SeleniumQueryBrowser();
firefox.$.driver().useHtmlUnit().emulatingFirefox().autoQuitDriver();
firefox.$.url(demoPage);
chrome.$("#agent").assertThat().text().contains("Chrome");
firefox.$("#agent").assertThat().text().contains("Firefox");
}seleniumQuery supports plugins through the .as(PLUGIN) function, such as:
$("div").as(YOURPLUGIN).someMethodFromYourPlugin();There are some default plugins. To check them out, call .as() without arguments. Example:
// the .select() plugin
$("#citiesSelect").as().select().selectByVisibleText("New York");
// picks an <option> in the <select> based in the <option>'s visible textFor an example of how to create your own plugin, check the seleniumQuery Plugin wiki page.
If the dollar symbol, $, gives you the yikes -- we know, it is used for internal class names --, it is important to notice that the $ symbol in seleniumQuery is not a class name, but a static method (and field). Still, if you don't feel like using it, you can resort to sQ() or good ol' jQuery() and benefit from all the same goodies:
import static io.github.seleniumquery.SeleniumQuery.sQ;
import static io.github.seleniumquery.SeleniumQuery.jQuery;
...
String oldStreet = sQ("input.street").val();
sQ("input.street").val("4th St!");
String oldStreetz = jQuery("input.street").val();
jQuery("input.street").val("5th St!");Find more on our wiki.
See releases.
The tool quite simple, so there's a lot of room for improvement. If you think something would be useful for you, it would probably be useful to us all, tell us what you're thinking!