234

RSelenium

R Bindings for 'Selenium WebDriver'

Provides a set of R bindings for the 'Selenium 2.0 WebDriver' (see < https://selenium.dev/documentation/en/> for more information) using the 'JsonWireProtocol' (see < https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol> for more information). 'Selenium 2.0 WebDriver' allows driving a web browser natively as a user would either locally or on a remote machine using the Selenium server it marks a leap forward in terms of web browser automation. Selenium automates web browsers (commonly referred to as browsers). Using RSelenium you can automate browsers locally or remotely.

Build Status codecov

This is a set of R Bindings for Selenium 2.0 Remote WebDriver, which you can download from http://selenium-release.storage.googleapis.com/index.html. This binding will not work with the 1.0 version of Selenium.

To install RSelenium from CRAN, run:

install.packages("RSelenium")

To install the development version from GitHub, run:

# install.packages("devtools")
devtools::install_github("ropensci/RSelenium")

To get started using RSelenium you can look at the introduction vignette located in /doc/basics.html once RSelenium is installed or run

vignette("basics", package = "RSelenium")

or the basic vignette can be viewed here.

There is a second vignette dealing with running RSelenium on different browsers/OS locally and remotely which can be viewed at Driving OS/Browsers Local and Remote. Finally, you can read all about running a headless browser or running a normal browser on a headless server at Headless Browsing.

Summary of Vignettes

  1. Basics
  2. Driving OS/Browsers Local and Remote
  3. Testing Shiny Apps
  4. Headless Browsing
  5. Docker
  6. Internet Explorer
  7. Orange County R Users Group Webinar

Test Shiny Apps

Use RSelenium to test your Shiny Apps. Read the introductory tutorial here.

Use Sauce Labs and BrowserStack

Sauce Labs

user <- "rselenium0"
pass <- "*******************************"
port <- 80
ip <- paste0(user, ':', pass, "@ondemand.saucelabs.com")
browser <- "firefox"
version <- "25"
platform <- "OS X 10.9"
extraCapabilities <- list(
  name = "Test RSelenium",
  username = user,
  accessKey = pass
)
 
remDr <- remoteDriver$new(
  remoteServerAddr = ip,
  port = port,
  browserName = browser,
  version = version,
  platform = platform,
  extraCapabilities = extraCapabilities
)

BrowserStack

user <- "johnharrison" 
pass <- "*******************"
port <- 80
ip <- paste0(user, ':', pass, "@hub.browserstack.com")
extraCapabilities <- list(
  "browser" = "IE",
  "browser_version" = "7.0",
  "os" = "Windows",
  "os_version" = "XP",
  "browserstack.debug" = "true"
)
 
remDr <- remoteDriver$new(
  remoteServerAddr = ip,
  port = port,
  extraCapabilities = extraCapabilities
)

Related Work

  • seleniumPipes: A lightweight implementation of the w3c webdriver specification. It has been built utilising xml2, httr and magrittr so provides an alternative for users who are familiar with piping.
  • webdriver: A client for the 'WebDriver API'. It allows driving a (probably headless) web browser, and can be used to test web applications, including Shiny apps. In theory it works with any 'WebDriver' implementation, but it was only tested with 'PhantomJS'.
  • rwebdriver: R bindings to the Webdriver API
  • rdom: Render and parse the DOM from R via phantomjs.

License

The RSelenium package is licensed under the AGPLv3. The help files are licensed under the creative commons attribution, non-commercial, share-alike license CC-NC-SA.

As a summary, the AGPLv3 license requires, attribution, include copyright and license in copies of the software, state changes if you modify the code, and disclose all source code. Details are in the COPYING file.

News

RSelenium 1.7.5

  • Fix switchToWindow issue in fiefox (#143)
  • Add a tutorial to allow running RSelenium Tests in Internet Explorer (thanks @zappingseb #193)
  • Updated vignettes and documentation

RSelenium 1.7.4

  • executeScript now passes a dummy argument
  • Defunct phantom() function
  • Updated unit tests and test environment
  • Updated vignettes and documentation

RSelenium 1.7.3

  • Address issue with user/pass credentials being exposed using SauceLabs (thanks @jstockwin #131)
  • Cache packages on TRAVIS to reduce runtime (thanks @jstockwin #132)

RSelenium 1.7.2

  • Fixed issue where rsDriver client when failing to open didnt catch error
  • Correctly pass the check argument in rsDriver to wdman (thanks @bourdieu #123)

RSelenium 1.7.1

  • Fixed issue where rsDriver was not passing additional arguments via ...
  • Fixed issue with rsDriver and Win/Firefox
  • serverURL field in remoteDriver class is now set in initialize method

RSelenium 1.7.0

  • Basic vignette update with appendix on using rsDriver
  • Print method added for environment returned by rsDriver
  • Default PhantomJS version switched to 2.1.1 (2.5.0-beta has old version of ghostdriver)

RSelenium 1.6.6

  • phantom is marked as deprecated. To drive PhantomJS via selenium use the rsDriver function. To drive directly use wdman::phantomjs

RSelenium 1.6.5

  • checkForServer and startServer are now defunct. rsDriver is marked as a dual replacement. Docker is recommended to run a selenium server/browser.

RSelenium 1.6.4

  • Add a rsDriver function to return a Selenium/webdriver server and a browser client.

RSelenium 1.6.3

  • Return a selected value with the selectTag method.

RSelenium 1.6.1

  • Added a selectTag method to the webElement class see #108.
  • RSelenium Basics vignette was updated/revised.

RSelenium 1.6.0

  • Moved http package from RCurl to httr see #106.
  • Removed dependence on rjson. httr incorporates jsonlite.
  • Import base64_decode from openssl.
  • Fixed issue with attributes.Selenium not firing error see #109

RSelenium 1.5.1

  • Added a path argument to the remoteDriver class.

RSelenium 1.4.9

  • Fix .DollarNames to correct issues running under recent RStudio version.

RSelenium 1.4.8

  • Added tests for executeScript
  • Fixed issue in executeScript/executeAsyncScript with returning nested web elements

RSelenium 1.4.7

  • Code tidied up
  • statCodes added as an internal data.frame
  • tidy up imports. importFrom instead of import

RSelenium 1.4.6

  • Replace calls to cat with message when error

RSelenium 1.4.5

  • Use canonical form for referring to r-project

RSelenium 1.4.4

  • Deprecate startServer and checkForServer (look at processx to manage process)
  • Use message rather than print (thanks Dean Attali #88) in checkForServer. Fix typo in startServer (thanks Charles Thompson #85)
  • Copy startServer and checkForServer to examples/serverUtils

RSelenium 1.4.3

  • Moved testing to TRAVIS
  • Switch to rjson from RJSONIO as issue with RJSONIO and TRAVIS/covr
  • Ported api tests to TRAVIS

RSelenium 1.4.2

  • Add vignette on RSelenium and Docker containers.

RSelenium 1.4.1

  • Add option to pass arguments to JVM in startServer.
  • In startServer look for multiple copies of selenium binary in selDIR
  • Make renaming selenium binary optional in checkForServer
  • Add option to download beta releases in checkForServer

RSelenium 1.4.0

  • startServer utility function now returns a list of function; getpid returns the process id of the started server, the stop function stops the started server using the process id. Thanks to
    Dan Tenenbaum #67 and Toby Dylan Hocking #72

RSelenium 1.3.7

  • Add fix for multiple/Beta JARS in checkForServer (Thanks Dean Attali #79)
  • Update reference for Selenium download (Thanks @mnel)

RSelenium 1.3.6

  • Allow passing of system2 arguments in startServer utility function

RSelenium 1.3.4

  • Fix custom path not being passed correctly to phantom utility function.
  • Allowing passing of commandline arguments via utility function startServer.

RSelenium 1.3.3

  • Add utility function makeFirefoxProfile (Thanks Shan Huang #24)
  • Fix phantom utility function for OSX (Thanks Carson Sievert #25)

RSelenium 1.3.2

  • Methods now fail with errors if the server returns an error related status code. Summary and Detail of the error are outputted as well as the associated java class.
  • Add a phantom utility function to enable driving of phantomjs in webdriver mode independent of Selenium Server.
  • Fixed file paths in startServer for windows (Thanks @mnel #22)

RSelenium 1.3.0

  • Add the content from OC-RUG webinar as a vignette.
  • Update the Driving OS/Browsers local and remote vignette.

RSelenium 1.2.5

  • Update reference classes to use @field and inline docstrings for methods
  • Allow partial string matching on the using argument of the findElement and findElements method from the remoteDriver class.
  • Allow partial string matching on the using argument of the findChildElement and findChildElements method from the webElement class.

RSelenium 1.2.4

  • Add getLogtypes() and log(type) methods to remoteDriver class
  • Fix getFirefoxProfile so useBase = TRUE works under windows.
  • Add additional support for encoding (thanks to Nicola Logrillo issue #16)
  • Add file argument to screenshot method in remoteDriver class to allow writing screenshot to file
  • Add a getChromeProfile utility function.

RSelenium 1.2.3

  • Add option to display screenshot in viewer panel if using RStudio

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.
install.packages("RSelenium")

1.7.7 by Ju Yeong Kim, 9 months ago

http://docs.ropensci.org/RSelenium

Report a bug at http://github.com/ropensci/RSelenium/issues

Browse source code at https://github.com/cran/RSelenium

Authors: John Harrison [aut] (original author) , Ju Yeong Kim [cre] (rOpenSci maintainer)

Documentation:   PDF Manual  

Task views: Web Technologies and Services

AGPL-3 license

Imports XML, methods, caTools, tools, utils, openssl, httr, wdman, binman

Suggests testthat, knitr, Rcompression, covr, rmarkdown

Imported by LIHKGr, carbonate, gesisdata, pewdata, ropercenter, snotelr, wdpar.

See at CRAN

R links

R homepage

Download R

Mailing lists

R documentation

R manuals

R FAQs

The R Journal

CRAN links

CRAN homepage

CRAN repository policy

Submit a package

METACRAN stuff

About METACRAN

At github

Report a bug