:: a typeCtrl KGHC 9.14.1 · lts/ghc-9.14.x · 45dd537 · 2026-10-11
Modulewebdriver-0.15.0.0Haskell2010
Once upon a time, the main browser automation tool was Selenium. Users of
this package had to start a Selenium session themselves, making sure to
configure it with a browser-specific driver program like chromedriver or
geckodriver, and provide a hostname/port. Then, this package would connect to
Selenium and use its wire protocol to control browsers.
Nowadays, there is an official W3C spec (https://www.w3.org/TR/webdriver1) specifying the protocol, and a number of implementations. Selenium still exists, but Chromedriver and Geckodriver can both serve as standalone WebDriver servers. This library now helps you start up a driver in one of these supported configurations:
Selenium.jar with one or more supported sub-drivers (chromedriver,
geckodriver). This is similar to the traditional picture.
Chromedriver standalone.
Geckodriver standalone.
You can pick the configuration you want by passing a DriverConfig to the
startSession function. The WebDriver implementations have a few differences
between them, which this library tries to smooth over. For example, a single
Geckodriver instance can't start multiple Firefox sessions (see
https://github.com/mozilla/geckodriver/issues/1946). So, this library will spin
up a separate geckodriver process for every session.
For an example of using this package by itself, see Test.WebDriver.WD. For a full test framework integrated with this package, see sandwich-webdriver.
The WebDriverContext is an opaque type used by this library for bookkeeping purposes. It tracks all the processes we spin up and all the sessions we create.
Currently, we will create at most 1 Selenium or Chromedriver process per WebDriverContext, and N Geckodriver processes, where N is the number of Firefox sessions you request.
Create a new WebDriverContext.
Tear down all sessions and processes associated with a WebDriverContext.
Start a WebDriver session, with a given WebDriverContext and DriverConfig.
You need to provide the WebDriver Capabilities for the session. You should make sure the browser-specific fields of your Capabilities are filled in correctly to match the given DriverConfig. For example, if you're using DriverConfigChromedriver, you should make sure to fill in _capabilitiesGoogChromeOptions and in particular the _chromeOptionsBinary field.
Close the given WebDriver session. This sends the DELETE
/session/:sessionId command to the WebDriver API, and then shuts down the
process if necessary.
Configuration for how to launch a given driver.
DriverConfigSeleniumJarFor launching a WebDriver via "java -jar selenium.jar". Selenium can launch other drivers on your behalf. You should pass these as driverConfigSubDrivers.
driverConfigJava :: FilePathPath to java binary.
driverConfigJavaFlags :: [String]Extra flags to pass to java.
driverConfigJavaExtraEnv :: Maybe [(String, String)]Extra flags to pass to java.
driverConfigSeleniumJar :: FilePathPath to selenium.jar file.
driverConfigSeleniumVersion :: Maybe SeleniumVersionSpecify if this is Selenium 3 or 4. If this is not provided, we'll try to autodetect.
driverConfigSubDrivers :: [DriverConfig]Drivers to configure Selenium to use.
driverConfigLogDir :: Maybe FilePathDirectory in which to place driver logs.
DriverConfigGeckodriverdriverConfigGeckodriver :: FilePathPath to geckodriver binary.
driverConfigGeckodriverFlags :: [String]Extra flags to pass to geckodriver.
driverConfigGeckodriverExtraEnv :: Maybe [(String, String)]Extra environment variables to pass to geckodriver.
driverConfigFirefox :: FilePathPath to firefox binary.
driverConfigLogDir :: Maybe FilePathDirectory in which to place driver logs.
DriverConfigChromedriverdriverConfigChromedriver :: FilePathPath to chromedriver binary.
driverConfigChromedriverFlags :: [String]Extra flags to pass to chromedriver.
driverConfigChromedriverExtraEnv :: Maybe [(String, String)]Extra environment variables to pass to chromedriver.
driverConfigChrome :: FilePathPath to chrome binary.
driverConfigLogDir :: Maybe FilePathDirectory in which to place driver logs.
Lower-level version of startSession. This one allows you to construct a driver instance manually and pass it in. Does not manage process lifecycles.
Close the given WebDriver session. This is a lower-level version of
closeSession, which manages the driver lifecycle for you. This version will
only issue the DELETE /session/:sessionId command to the driver, but will
not shut down driver processes.
mkManualDriver Create a manual Driver to use with startSession'/closeSession'.
Default capabilities.
Empty ChromeOptions.
Empty FirefoxOptions.
A structure describing the capabilities of a session. This record serves dual roles.
It's used to specify the desired capabilities for a session before it's created. In this usage, fields that are set to Nothing indicate that we have no preference for that capability.
When received from the server , it's used to describe the actual capabilities given to us by the WebDriver server. Here a value of Nothing indicates that the server doesn't support the capability. Thus, for Maybe Bool fields, both Nothing and Just False indicate a lack of support for the desired capability.
Capabilities_capabilitiesBrowserName :: Maybe StringIdentifies the user agent.
_capabilitiesBrowserVersion :: Maybe StringIdentifies the version of the user agent.
_capabilitiesPlatformName :: Maybe PlatformIdentifies the operating system of the endpoint node.
_capabilitiesAcceptInsecureCerts :: Maybe BoolIndicates whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
_capabilitiesPageLoadStrategy :: Maybe StringDefines the current session’s page load strategy.
_capabilitiesProxy :: Maybe ProxyDefines the current session’s proxy configuration.
_capabilitiesSetWindowRect :: Maybe BoolIndicates whether the remote end supports all of the commands in Resizing and Positioning Windows.
_capabilitiesTimeouts :: Maybe TimeoutsDescribes the timeouts imposed on certain session operations.
_capabilitiesUnhandledPromptBehavior :: Maybe UserPromptHandlerDescribes the current session’s user prompt handler.
_capabilitiesGoogChromeOptions :: Maybe ChromeOptionsChrome options
_capabilitiesMozFirefoxOptions :: Maybe FirefoxOptionsFirefox options
_capabilitiesWebSocketUrl :: Maybe BoolEq CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.CapabilitiesShow CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.CapabilitiesFromJSON CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.CapabilitiesToJSON CapabilitiesDefined in webdriver-0.15.0.0 · Test.WebDriver.CapabilitiesRepresents the platformName option of the primary capabilities
Eq PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.PlatformOrd PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.PlatformShow PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.PlatformFromJSON PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.PlatformToJSON PlatformDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.PlatformEq ProxyTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ProxyShow ProxyTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ProxyFromJSON ProxyTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.ProxyToJSON ProxyTypeDefined in webdriver-0.15.0.0 · Test.WebDriver.Capabilities.Proxymodule Test.WebDriver.Commands
A class for monads that can handle wire protocol requests. This is the operation underlying all of the high-level commands exported in Test.WebDriver.Commands.
WebDriverBase WDDefined in webdriver-0.15.0.0 · Test.WebDriver.WDWebDriverBase (LoggingT IO)Defined in webdriver-0.15.0.0 · Test.WebDriver.WD · orphanShow SessionDefined in webdriver-0.15.0.0 · Test.WebDriver.TypesMonadReader Session WDDefined in webdriver-0.15.0.0 · Test.WebDriver.WDInternal type representing the JSON response object.
Eq FailedCommandDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsShow FailedCommandDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsException FailedCommandDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsFromJSON FailedCommandDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsElementClickInterceptedThe Element Click command could not be completed because the element receiving the events is obscuring the element that was requested clicked.
ElementNotInteractableA command could not be completed because the element is not pointer- or keyboard interactable.
InsecureCertificateNavigation caused the user agent to hit a certificate warning, which is usually the result of an expired or invalid TLS certificate.
InvalidArgumentThe arguments passed to a command are either invalid or malformed.
InvalidCookieDomainAn illegal attempt was made to set a cookie under a different domain than the current page.
InvalidElementStateA command could not be completed because the element is in an invalid state, e.g. attempting to clear an element that isn't both editable and resettable.
InvalidSelectorArgument was an invalid selector.
InvalidSessionIdOccurs if the given session id is not in the list of active sessions, meaning the session either does not exist or that it’s not active.
JavascriptErrorAn error occurred while executing JavaScript supplied by the user.
MoveTargetOutOfBoundsThe target for mouse interaction is not in the browser’s viewport and cannot be brought into that viewport.
NoSuchAlertAn attempt was made to operate on a modal dialog when one was not open.
NoSuchCookieNo cookie matching the given path name was found amongst the associated cookies of the current browsing context’s active document.
NoSuchElementAn element could not be located on the page using the given search parameters.
NoSuchFrameA command to switch to a frame could not be satisfied because the frame could not be found.
NoSuchWindowA command to switch to a window could not be satisfied because the window could not be found.
ScriptTimeoutA script did not complete before its timeout expired.
SessionNotCreatedA new session could not be created.
StaleElementReferenceA command failed because the referenced element is no longer attached to the DOM.
TimeoutAn operation did not complete before its timeout expired.
UnableToSetCookieA command to set a cookie’s value could not be satisfied.
UnableToCaptureScreenA screen capture was made impossible.
UnexpectedAlertOpenA modal dialog was open, blocking this operation.
UnknownCommandA command could not be executed because the remote end is not aware of it.
UnknownErrorAn unknown error occurred in the remote end while processing the command.
UnknownMethodThe requested command matched a known URL but did not match an method for that URL.
UnsupportedOperationIndicates that a command that should have executed properly cannot be supported for some reason.
UnparsedError TextSome error string we weren't able to parse.
Eq FailedCommandErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsShow FailedCommandErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsFromJSON FailedCommandErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsToJSON FailedCommandErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsAn unexpected HTTP status was sent by the server.
Eq HTTPStatusUnknownDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsShow HTTPStatusUnknownDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsException HTTPStatusUnknownDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsAn invalid URL was given
Eq InvalidURLDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsShow InvalidURLDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsException InvalidURLDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsA command requiring a session ID was attempted when no session ID was available.
Show NoSessionIdDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsException NoSessionIdDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsAn unidentified server-side exception occured
Eq ServerErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsShow ServerErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsException ServerErrorDefined in webdriver-0.15.0.0 · Test.WebDriver.ExceptionsAn individual stack frame from the stack trace provided by the server during a FailedCommand.
Eq StackFrameDefined in webdriver-0.15.0.0 · Test.WebDriver.TypesShow StackFrameDefined in webdriver-0.15.0.0 · Test.WebDriver.TypesFromJSON StackFrameDefined in webdriver-0.15.0.0 · Test.WebDriver.Types