- Notifications
You must be signed in to change notification settings - Fork133
A high-level API for programmatically interacting with web pages through WebDriver.
License
Apache-2.0, MIT licenses found
Licenses found
jonhoo/fantoccini
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A high-level API for programmatically interacting with web pages through WebDriver.
This crate uses theWebDriver protocol to drive a conforming (potentially headless) browserthrough relatively high-level operations such as "click this element", "submit this form", etc.
Most interactions are driven by usingCSS selectors. With most WebDriver-compatible browserbeing fairly recent, the more expressive levels of the CSS standard are also supported, givingfairlypowerfuloperators.
Forms are managed by first callingClient::form, and then using the methods onForm tomanipulate the form's fields and eventually submitting it.
For low-level access to the page,Client::source can be used to fetch the full page HTMLsource code, andClient::raw_client_for to build a raw HTTP request for a particular URL.
These examples all assume that you have aWebDriver compatible process running on port 4444.A quick way to get one is to rungeckodriver at the command line.
Let's start out clicking around on Wikipedia:
use fantoccini::{ClientBuilder,Locator};// let's set up the sequence of steps we want the browser to take#[tokio::main]asyncfnmain() ->Result<(), fantoccini::error::CmdError>{let c =ClientBuilder::native().connect("http://localhost:4444").await.expect("failed to connect to WebDriver");// first, go to the Wikipedia page for Foobar c.goto("https://en.wikipedia.org/wiki/Foobar").await?;let url = c.current_url().await?;assert_eq!(url.as_ref(),"https://en.wikipedia.org/wiki/Foobar");// click "Foo (disambiguation)" c.find(Locator::Css(".mw-disambig")).await?.click().await?;// click "Foo Lake" c.find(Locator::LinkText("Foo Lake")).await?.click().await?;let url = c.current_url().await?;assert_eq!(url.as_ref(),"https://en.wikipedia.org/wiki/Foo_Lake"); c.close().await}
How did we get to the Foobar page in the first place? We did a search!Let's make the program do that for us instead:
// -- snip wrapper code --// go to the Wikipedia frontpage this timec.goto("https://www.wikipedia.org/").await?;// find the search form, fill it out, and submit itlet f = c.form(Locator::Css("#search-form")).await?;f.set_by_name("search","foobar").await?.submit().await?;// we should now have ended up in the right placelet url = c.current_url().await?;assert_eq!(url.as_ref(),"https://en.wikipedia.org/wiki/Foobar");// -- snip wrapper code --
What if we want to download a raw file? Fantoccini has you covered:
// -- snip wrapper code --// go back to the frontpagec.goto("https://www.wikipedia.org/").await?;// find the source for the Wikipedia globelet img = c.find(Locator::Css("img.central-featured-logo")).await?;let src = img.attr("src").await?.expect("image should have a src");// now build a raw HTTP client request (which also has all current cookies)let raw = img.client().raw_client_for(http::Method::GET,&src).await?;// we then read out the image bytesuse futures_util::TryStreamExt;let pixels = raw.into_body().try_fold(Vec::new(), |mut data, chunk|asyncmove{ data.extend_from_slice(&chunk);Ok(data)}).await.map_err(fantoccini::error::CmdError::from)?;// and voilà, we now have the bytes for the Wikipedia logo!assert!(pixels.len() >0);println!("Wikipedia logo is {}b", pixels.len());// -- snip wrapper code --
For more examples, take a look at theexamples/ directory.
The following information applies only to developers interested in contributingto this project. If you simply want to use it to automate web browsers you canskip this section.
The tests assume that you havechromedriver andgeckodriver already running on your system.You can download them using the links above. Then run them from separate tabs in your terminal.They will stay running until terminated with Ctrl+C or until the terminal session is closed.
Then runcargo test from this project directory.
About
A high-level API for programmatically interacting with web pages through WebDriver.