Elm Webdriver

Remote control a browser with selenium, in Elm!

This can be used as a testing suite or you can utilize the exposed API for adapting it to your own use case.

Quick Start

Since this package contains a Native module (some javascript), this cannot be published in packages.elm-lang.org. Instead, you need to install it using npm. Do this at the root of your Elm project, where the elm-package.json file is:

npm install elm-webdriver

You are now ready to copy some skeleton tests into your project folder:

node_modules/.bin/elm-webdriver init

This will create a new folder webdriver-tests. Change to that folder, where you will see a Main.elm and a Tests.elm file. You can add your tests to Tests.elm without having to touch anything else!

If you need to use modules from your project, make sure you also add all the dependencies from the main elm-package.json into webdriver-tests/elm-package.json. Remember to keep those in sync.

Install selenium webdriver

To run tests locally you need the Selenium standalone server.
Download the .jar file from the official Selenium page and run it like this:

java -jar selenium-server-standalone.jar

You are now ready to run your tests. In another terminal, while the standalone server is still running:

cd webdriver-tests
../node_modules/.bin/elm-webdriver

You can also filter tests by name:

../node_modules/.bin/elm-webdriver --filter "Some Test Name"

If the Selenium server complains:

WARN - Exception: The path to the driver executable must be set by the webdriver.gecko.driver system property; 
for more information, see https://github.com/mozilla/geckodriver. 
The latest version can be downloaded from https: //github.com/mozilla/geckodriver/releases                  

Make sure you have the geckodriver installed, and tell Selenium where it is by setting the system property:

java -Dwebdriver.gecko.driver="<path-to-geckodriver>" -jar selenium-server-standalone.jar

API

Check the API Docs