a Haskell client for the Selenium WebDriver protocol
|Version on this page:||0.8.5|
|LTS Haskell 20.25:||0.10.0.1|
|Stackage Nightly 2023-06-08:||0.11.0.0|
|Latest on Hackage:||0.11.0.0|
Module documentation for 0.8.5
hs-webdriver is a Selenium WebDriver client for the Haskell programming language. You can use it to automate browser sessions for testing, system administration, etc.
For more information about Selenium itself, see http://seleniumhq.org/
- Getting Started
- Integration with Haskell Testing Frameworks
hs-webdriver uses the Cabal build system to configure, build, install, and generate documentation on multiple platforms.
For more information on using Cabal and its various installation options, see the Cabal User’s Guide at http://www.haskell.org/cabal/users-guide/index.html
Installation from Hackage
hs-webdriver is hosted on Hackage under the name webdriver. Thus, the simplest way to download and install the most recent version of hs-webdriver is to run:
cabal install webdriver
There are also options to do system-wide installation, version selection, and other build options; see cabal-install documentation.
Installation from this repository
To build and install a git revision for a single user on your system, run these commands from within the repository directory
For systems without cabal-install available, you can also run the Setup.hs script, as such:
runhaskell Setup.hs configure --user runhaskell Setup.hs build runhaskell Setup.hs install
For more build options, please refer to the Cabal documentation.
WebDriver is a client-server protocol. Since hs-webdriver only implements a WebDriver client, you must have a WebDriver server to which you can connect in order to make use of this library.
Using the Selenium Server
While you can use any WebDriver server out there, probably the simplest server to use with hs-webdriver is Selenium Server. You’ll need an installation of the Java runtime to use this server. Once you’ve downloaded Selenium Server to your current working directory, you can start the server with this shell command:
java -jar selenium-server-standalone-*.jar
The server should now be listening at localhost on port 4444.
With the Selenium server running locally, you’re ready to write browser automation scripts in Haskell.
A simple example can be found here, written in literate Haskell so that you can compile it with GHC yourself. It is very beginner friendly and assumes no prior knowledge of Haskell. If you already have an intermediate understanding of Haskell, this is the example for you For other examples see the examples and test/etc directory.
Integration with Haskell Testing Frameworks
This package does not provide utilities to integrate with popular Haskell testing frameworks. However, other packages exist for this purpose:
Documentation for hs-webdriver is available on Hackage at http://hackage.haskell.org/package/webdriver. You can also generate local HTML documentation from this source revision with the following shell command:
runhaskell Setup.hs haddock
Haddock will generate documentation and save it in
#Change Log ##0.8.5
- Added support for experimental Chrome options that are not part of the API
- Added a Phantomjs constructor for the Browser type
- Changed the type of StackFrame line numbers from Word to Int to avoid parse errors in newer Aeson versions (sometimes the server returns negative line numbers)
- Fixed support for http-client > 0.5
- Added a new
Test.WebDriver.Common.Keysmodule with named constants for use with
- Updated old URLs in documentation
- Introduced support for http-client 5.0
- Removed most upper bounds on dependencies in our cabal file to avoid stackage version madness.
- Added a
saveScreenshotcommand, for conenience, which writes the results of the
screenshotcommand directly to a given file path.
- Added new
- Previously internal convenience functions
ignoreReturnare now exported in Test.WebDriver.JSON
elemInfois now deprecated due to it being phased out in the Marionette (Firefox) driver. It will likely be removed once Selenium 4 is released.
- Fixed an issue causing PAC settings to not work.
- Quick fix to parse “unsupported command” errors when using Marionette driver (Selenium + Marionette has nonstandard behavior when reporting that error type)
- Fixed build errors for GHC < 7.10. webdriver now builds with GHC stable releases 7.4.2, 7.6.3, and 7.8.4
- Fixed support for bytestring 0.9.*
- Fixed issue introduced in 0.8 that caused build failure when using aeson < 0.10
- findElems and and findElemsFrom were accidentally changed to return a single Element in the last release. This has been fixed.
- All commands that previously accepted a list parameter now accepts any instance of
###Overloadable configuration It is now possible to define custom configuration types that can be used to initialize webdriver sessions.
runSession now has the following type:
runSession :: WebDriverConfig conf => conf -> WD a -> IO a
And the typeclass to create new config types looks like this:
-- |Class of types that can configure a WebDriver session. class WebDriverConfig c where -- |Produces a 'Capabilities' from the given configuration. mkCaps :: MonadBase IO m => c -> m Capabilities -- |Produces a 'WDSession' from the given configuration. mkSession :: MonadBase IO m => c -> m WDSession
Of course you can still use
WDConfig, as it is now an instance of
###Reworked custom HTTP headers interface
- Support for custom request headers was added rather hastily, resulting in several functions having explicit
RequestHeadersparameters. The interface has been reworked now so that custom request headers are stored inside
RequestHeadersparameters have been removed.
- There’s also now a distinction in configuration between
wdAuthHeaderswhich are used only during initial session creation, and
wdRequestHeaders, which are used with all other HTTP requests
- Two new utility functions were added to make working with custom HTTP headers easier:
###Clean-up and dependency changes
- Removed a whole mess of unusued import and deprecation warnings when building with GHC 7.10
- We now enforce an attoparsec lower bound of 0.10 (there was no lower bound before)
- The unnecessary dependency on mtl is now removed.
- Added some monad transformer instances for WebDriver and WDSessionState that were mysteriously missing: strict WriterT, ReaderT, ListT
- data-default dependency was changed to data-default-class
Because this is a fairly major update, changes have been described in detail and organized into categories. Most of the potentially breaking changes are to the “intermediate” API that might affect library code or advanced applications; changes that are not entirely “user-facing” but also not quite “internal”.
Basic web test code only has to contend with a few additional symbol exports, overloading of type signatures on some existing functions, and the reworked session history API.
###Top-level API (exposed by
withSessionis now overloaded over the new constraint alias
WDSessionStateControl(see below). This means that it can be used with monad transformer stacks over
WDwithout any lifting required.
- Added several new
useProxy; these functions are overloaded over the new
HasCapabilitiesconstraint alias (see below)
- Reworked and improved session history API
SessionHistoryrecord type to replace the old
(Request, Response ByteString)type. The new type has the same data as the previous tuple, but additionally records the number of attempted HTTP retries, and instead of
Either SomeException (Response ByteString)so that HTTP request errors can be logged.
WDConfigand replaced it with
wdHistoryConfig, which uses a new
-- |A function used to append new requests/responses to session history. type SessionHistoryConfig = SessionHistory -> [SessionHistory] -> [SessionHistory]
The new field can be configured using several new constants:
unlimitedHistoryis now the default configuration for history. For the old behavior, use
New top-level functions for accessing session history
-- |Gets the command history for the current session. getSessionHistory :: WDSessionState wd => wd [SessionHistory] -- |Prints a history of API requests to stdout after computing the given action -- or after an exception is thrown dumpSessionHistory :: WDSessionStateControl wd => wd a -> wd a
###Implicit waits API (
- Added functions for checking some expected conditions in explicit waits:
WDSessionStateis now a superclass of
MonadBaseControl IO. This makes the class significantly more flexible in how it can be used, as it no longer requires
IOas a base monad.
For convenience the following constraint aliases were added (requires
ConstraintKindsextension to use). Several existing API functions have been updated to use these new constraints where appropriate.
type WDSessionStateIO s = (WDSessionState s, MonadBase IO s) type WDSessionStateControl s = (WDSessionState s, MonadBaseControl IO s)
WDSessionStateControlconstraint is equivalent to the previous
WebDriverclass is unaffected (it is now a superclass of
WDSessionStateControl), so code using the basic
Test.WebDriverAPI will not be affected.
New typeclasses added to
SetCapabilities; for convenience a constraint alias
HasCapabilitieshas been added to work with both of these classes (requires
ConstraintKindsextension to use)
```hs -- |A typeclass for readable 'Capabilities' class GetCapabilities t where getCaps :: t -> Capabilities -- |A typeclass for writable 'Capabilities' class SetCapabilities t where setCaps :: Capabilities -> t -> t -- |Read/write 'Capabilities' type HasCapabilities t = (GetCapabilities t, SetCapabilities t) ```
###Minor API changes (not exposed to
- new function
- new function
(Either SomeException (Response ByteString))and catches any exceptions that occur during the request. When using default configuration, the exceptions are also saved in ‘wdSessHist’.
Test.WebDriver.Internalno longer defines and exports exception types. All exception defined here previously have been moved to an unexposed
Test.WebDriver.Exceptions.Internalmodule. These types are still exported in the usual places.
- Now supports http-types up to 0.9
- Fixed an issue with aeson 0.10 support
- Support aeson 0.10
- Added support for multiple HTTP attempts per command request, using the new WDConfig field wdHTTPRetryCount
- Supports vector 0.11, aeson 0.9, attoparsec 0.13
- Supports GHC 7.10
- Supports reworked Chrome capabilities used by newer versions of WebDriver
- Servers that return empty JSON strings for commands with no return value will no longer cause parse errors
- Added the ability to pass HTTP request headers at session creation
- Fixed an issue involving an obsolete JSON representation of Chrome capabilities
- Relax upper bound on exceptions dependency
- Support for monad-control 1.0
- Relaxed upper bounds on text and http-client versions
- Added support for aeson > 0.8 and network > 2.6
- Added support for the “X-Response-Body-Start” HTTP header used for error responses in newer http-client versions
- Fixed Haddock parse errors. No code changes introduced in this version.
- Rather than WDSession serving dual roles as configuration and state, its functionality has been split into 2 respective types: WDConfig and WDSession.
- runSession now takes a WDConfig instead of WDSession and Capabilities parameters.
- runSession no longer closes its session on successful completion; use finallyClose or closeOnException for this behavior
- The old Test.WebDriver.Classes module has been split into Test.WebDriver.Session and Test.WebDriver.Class
- SessionState typeclass renamed to WDSessionState
- We now use the http-client package instead of HTTP. This is reflected in the addition of Manager fields in both WDConfig and WDSession
- Added optional HTTP history tracking for debugging purposes.
- MonadCatchIO is deprecated in favour of exceptions.
- Relaxed dependencies on mtl, network and scientific.
- Relaxed text dependency up to 1.2
##0.5.3.2 ###bug fixes
- fixed remaining compilation problems with aeson. now supports aeson >= 0.6.2.0 && < 0.8
- now depends on directory-tree instead of filesystem-trees. this fixes several problems with firefox/chrome profile support.
##0.5.3.1 ###bug fixes
- fixed compilation error with aeson 0.7 and greater
- SessionNotCreated constructor added to FailedCommandType
- new command deleteCookieByName added
- asyncJS now properly distinguishes between a null return and a script timeout
- fixed a change in waitWhile causing the opposite of expected behavior
##0.5.2 ###API changes
- added many new Internet Explorer capabilities
- added additionalCaps to Capabilities, which allows support for non-standard capabilities
- Browser type now supports non-standard browsers via the new Browser constructor
- added support for the new unexpectedAlertBehaviour capability
- new command getApplicationCacheStatus supported
- error reporting for unknown commands now slightly improved
- internal request URIs are now properly percent-encoded
- improved handling of browser-specific capabilities
- fixed incompatability with new session creation protocol changes introduced in selenium 2.35
- updated to work with Aeson 0.6.2 and onward
##hs-webdriver 0.5.1 ###API changes
- Test.WebDriver.Internal.FailedCommandInfo now stores screenshots as lazy bytestrings
- Test.WebDriver.Common.Profile now stores PreparedProfile as a lazy bytestring
- Test.WebDriver.Chrome.Extension now stores ChromeExtension as a lazy bytestring
- The LogPref type has been renamed to LogLevel to reflect its use within the new log interface
- a new log interface as specified by the webdriver standard. This includes the functions getLogs and getLogTypes, and the types LogType and LogEntry.
- waitWhile and waitUntil now show more detailed information about why an explicit wait timed out.
##hs-webdriver 0.5.0.1 ###bug fixes
- hs-webdriver now correctly handles a wider variety of server-specific responses when a webdriver command expects no return value.
- An issue with the redirect status codes used during session creation has been fixed.
- As a result of the above fixes, hs-webdriver should now work with chromedriver. Note that, prior to this version, you can still use chromedriver if you use the selenium standalone server jar as a proxy.
##hs-webdriver 0.5 ###API changes
- Test.WebDriver.Commands.Wait.unexpected now accepts a String argument, which is used as an error message
- screenshot and uploadZipEntry from Test.WebDriver.Commands now use lazy bytestrings
- wdBasePath field added to WDSession. This allows you to specify a custom base path for all WebDriver requests. The default, as specified in the WebDriver standard, is “/wd/hub”
- added Test.WebDriver.Commands.screenshotBase64
- finallyClose and closeOnException are now overloaded on the WebDriver class.
- NoSessionId and doSessCommand were moved from Test.WebDriver.Classes to Test.WebDriver.Commands.Internal
- fixed a typo in the export list of Firefox.Profile; deleteFile is now correctly exported instead of removeFile from System.Directory
- fixed an error in the JSON representation of MouseButton
- A new module, Test.WebDriver.Commands.Internal, which exports some low-level functions used to implement the high-level interface. This makes it possible for library users to extend hs-webdriver with nonstandard or unimplemented features.
- The representation of profile files has been changed to use a HashMap instead of an association list. This ensures that destination paths are always unique.
- The default preferences used by Selenium are now merged into the preferences of Firefox profiles loaded from disk.
- addExtension will now correctly add extension directories to a profile.
- Because of the way loadProfile currently adds directories to the profileFiles HashMap, it’s possible for extensions added via addExtension to be overriden by the extensions originally listed in the on-disk extensions directory.
- It’s now possible to add entire directories to a profile in pure code using addFile and addExtension.
- new functions in Common.Profile: unionProfiles, onProfileFiles, onProfilePrefs
- new function in Commands.Wait: onTimeout
- the WD monad now has a MonadCatchIO instance, as an alternative to lifted-base for exception handling
- Removed a bug in waitWhile’ that resulted in an infinite loop
- Fixed the incorrect representation of JSON profiles
- Fixed relative path issues when zipping profile directories from disk
- Changed the constraint on filesystrem-trees to avoid a broken version
- Added the missing exports for addFile and deleteFile in Common.Profile and Firefox.Profile
- new Common.Profile functions: hasExtension, hasFile
- The representation of Profiles has changed, allowing it to store arbitrary files as well as extensions. The functional API for working with preferences and extensions ismostly unchanged, except for the behavior of calling addExtension consecutively with the same filepath argument.
- The old <&&> and <||> operators in Test.WebDriver.Commands.Wait have been removed and replaced with the ones exported from Control.Conditional from the cond package.
- Fixed memory leak resulting from an infinite recursion in the FromJSON instance of PreparedProfile.
- loadProfile now properly loads an entire Firefox profile from disk, rather than just the extensions and preferences.
- An issue involving lazy bytestring IO in the zip-archive package means that unusually large profiles might exceed the OSes open file limit.
- several new functions for working with Firefox/Opera profiles have been added. This includes functions for loading large profiles from disk, functions for working with zipped profiles, and functions for adding arbitrary files to a profile in pure code.
- new helper functions were added to Test.WebDriver.Commands.Wait, exported from the cond package.
- due to a nonconformance in the spec from the Grid server, wire responses were being received that contained no sessionId key, which subsequently resulted in a parse error from our JSON parser. This has been fixed, so that an omitted sessionId defaults to Nothing.
- major bux fixes in the Firefox profile code. Note that loadProfile is unlikely to work as expected, but prepareTempProfile should.
- 2 typeclasses were introduced. All WebDriver commands are now overloaded on WebDriver class, so that monad transformers with a WD base can be used conveniently.
- The MonadState instance of WD has been removed and replaced by SessionState.
- The Firefox profile code has been generalized to work with either Opera or Firefox profiles. A phantom type parameter is used to create a distinction between the two. See documentation on Common.Profile and Firefox.Profile to learn about the specific changes that were made.
- FFLogPref is now removed and replaced by the LogPref type, because both Firefox and Opera config use the same logging preference values.
- Several new modules have been created, including: Capabilities, Monad, Classes, Exceptions. Many of the definitions have been moved around, but the export lists of the pre-existing modules are the same.
- Various issues with the serialization of capabilities meant that Chrome, IE, and Opera weren’t able to startup correctly with default capabilities. This is now fixed.
- General documentation improvements.
- Opera configuration is now implemented.
- FailedCommandInfo changed so that it stores a WDSession rather than just a Maybe SessionId, thus providing server host and port information as well as the session ID.
- As a result, mkFailedCommandInfo is now String -> WD FailedCommandInfo, since it requires access to the WDSession state.
- HTML5StorageType changed to the more accurate WebStorageType
- general documentation improvements
- the uploadFile, uploadRawFile, and uploadZipEntry functions, which support uploading file contents to the remote server
- getWindowSize, setWindowSize, getWindowPos, and setWindowPos have all been deprived of their WindowHandle argument. This is due to the fact that using unfocused windows with those commands causes undefined behavior.
- the mkCookie function for convenient cookie construction
- the focusFrame function for focusing to individual frames
- the setPageLoadTimeout function
- the maximize function for maximizing windows
- support for HTML 5 web storage