Safe Haskell	None
Language	Haskell2010

Test.WebDriver.Types

Contents

SessionState class
- WebDriver sessions
Exceptions
Stack frames
WebDriver class

Synopsis

data WebDriverContext = WebDriverContext {
- _webDriverSessions :: MVar (Map String Session)
- _webDriverSelenium :: MVar (Maybe Driver)
- _webDriverChromedriver :: MVar (Maybe Driver)
}
mkEmptyWebDriverContext :: MonadIO m => m WebDriverContext
data Driver = Driver {
- _driverHostname :: String
- _driverPort :: Int
- _driverBasePath :: String
- _driverRequestHeaders :: RequestHeaders
- _driverManager :: Manager
- _driverProcess :: Maybe ProcessHandle
- _driverLogAsync :: Maybe (Async ())
- _driverConfig :: DriverConfig
}
data DriverConfig
- = DriverConfigSeleniumJar {
  - driverConfigJava :: FilePath
  - driverConfigJavaFlags :: [String]
  - driverConfigSeleniumJar :: FilePath
  - driverConfigSeleniumVersion :: Maybe SeleniumVersion
  - driverConfigSubDrivers :: [DriverConfig]
  - driverConfigLogDir :: FilePath
  }
- | DriverConfigGeckodriver {
  - driverConfigGeckodriver :: FilePath
  - driverConfigGeckodriverFlags :: [String]
  - driverConfigFirefox :: FilePath
  - driverConfigLogDir :: FilePath
  }
- | DriverConfigChromedriver {
  - driverConfigChromedriver :: FilePath
  - driverConfigChromedriverFlags :: [String]
  - driverConfigChrome :: FilePath
  - driverConfigLogDir :: FilePath
  }
data SeleniumVersion
- = Selenium3
- | Selenium4
class SessionState (m :: Type -> Type) where
- getSession :: m Session
class SessionState m => SessionStatePut (m :: Type -> Type) where
- withModifiedSession :: (Session -> Session) -> m a -> m a
newtype SessionId = SessionId Text
data Session = Session {
- sessionDriver :: Driver
- sessionId :: SessionId
- sessionName :: String
- sessionWebSocketUrl :: Maybe String
}
data SessionException
data StackFrame = StackFrame {
- sfFileName :: String
- sfClassName :: String
- sfMethodName :: String
- sfLineNumber :: Int
}
callStackItemToStackFrame :: (String, SrcLoc) -> StackFrame
type WebDriver (m :: Type -> Type) = (WebDriverBase m, SessionState m)
class MonadUnliftIO m => WebDriverBase (m :: Type -> Type) where
- doCommandBase :: (HasCallStack, ToJSON a) => Driver -> Method -> Text -> a -> m (Response ByteString)
type Method = ByteString
methodDelete :: Method
methodGet :: Method
methodPost :: Method

Documentation

data WebDriverContext Source #

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.

Constructors

WebDriverContext
Fields _webDriverSessions :: MVar (Map String Session) _webDriverSelenium :: MVar (Maybe Driver) _webDriverChromedriver :: MVar (Maybe Driver)

mkEmptyWebDriverContext :: MonadIO m => m WebDriverContext Source #

Create a new WebDriverContext.

data Driver Source #

Constructors

Driver
Fields _driverHostname :: String _driverPort :: Int _driverBasePath :: String _driverRequestHeaders :: RequestHeaders _driverManager :: Manager _driverProcess :: Maybe ProcessHandle _driverLogAsync :: Maybe (Async ()) _driverConfig :: DriverConfig

data DriverConfig Source #

Configuration for how to launch a given driver.

Constructors

DriverConfigSeleniumJar	For launching a WebDriver via "java -jar selenium.jar". Selenium can launch other drivers on your behalf. You should pass these as `driverConfigSubDrivers`.
Fields driverConfigJava :: FilePath Path to `java` binary. driverConfigJavaFlags :: [String] Extra flags to pass to `java`. driverConfigSeleniumJar :: FilePath Path to `selenium.jar` file. driverConfigSeleniumVersion :: Maybe SeleniumVersion Specify 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 :: FilePath Directory in which to place driver logs.
DriverConfigGeckodriver
Fields driverConfigGeckodriver :: FilePath Path to `geckodriver` binary. driverConfigGeckodriverFlags :: [String] Extra flags to pass to `geckodriver`. driverConfigFirefox :: FilePath Path to `firefox` binary. driverConfigLogDir :: FilePath Directory in which to place driver logs.
DriverConfigChromedriver
Fields driverConfigChromedriver :: FilePath Path to `chromedriver` binary. driverConfigChromedriverFlags :: [String] Extra flags to pass to `chromedriver`. driverConfigChrome :: FilePath Path to `chrome` binary. driverConfigLogDir :: FilePath Directory in which to place driver logs.

data SeleniumVersion Source #

Constructors

Selenium3
Selenium4

Instances

Instances details

Show SeleniumVersion Source #
Instance details Defined in Test.WebDriver.Types Methods showsPrec :: Int -> SeleniumVersion -> ShowS # show :: SeleniumVersion -> String # showList :: [SeleniumVersion] -> ShowS #
Eq SeleniumVersion Source #
Instance details Defined in Test.WebDriver.Types Methods (==) :: SeleniumVersion -> SeleniumVersion -> Bool # (/=) :: SeleniumVersion -> SeleniumVersion -> Bool #

SessionState class

class SessionState (m :: Type -> Type) where Source #

Methods

getSession :: m Session Source #

class SessionState m => SessionStatePut (m :: Type -> Type) where Source #

Methods

withModifiedSession :: (Session -> Session) -> m a -> m a Source #

WebDriver sessions

newtype SessionId Source #

An opaque identifier for a WebDriver session. These handles are produced by the server on session creation, and act to identify a session in progress.

Constructors

SessionId Text

Instances

Instances details

FromJSON SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods parseJSON :: Value -> Parser SessionId # parseJSONList :: Value -> Parser [SessionId] # omittedField :: Maybe SessionId #
ToJSON SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods toJSON :: SessionId -> Value # toEncoding :: SessionId -> Encoding # toJSONList :: [SessionId] -> Value # toEncodingList :: [SessionId] -> Encoding # omitField :: SessionId -> Bool #
IsString SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods fromString :: String -> SessionId #
Read SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods readsPrec :: Int -> ReadS SessionId # readList :: ReadS [SessionId] # readPrec :: ReadPrec SessionId # readListPrec :: ReadPrec [SessionId] #
Show SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #
Eq SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods (==) :: SessionId -> SessionId -> Bool # (/=) :: SessionId -> SessionId -> Bool #
Ord SessionId Source #
Instance details Defined in Test.WebDriver.Types Methods compare :: SessionId -> SessionId -> Ordering # (<) :: SessionId -> SessionId -> Bool # (<=) :: SessionId -> SessionId -> Bool # (>) :: SessionId -> SessionId -> Bool # (>=) :: SessionId -> SessionId -> Bool # max :: SessionId -> SessionId -> SessionId # min :: SessionId -> SessionId -> SessionId #

data Session Source #

Constructors

Session
Fields sessionDriver :: Driver sessionId :: SessionId sessionName :: String sessionWebSocketUrl :: Maybe String

Instances

Instances details

Show Session Source #
Instance details Defined in Test.WebDriver.Types Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #

Exceptions

data SessionException Source #

Constructors

SessionNameAlreadyExists
SessionCreationFailed (Response ByteString)
SessionCreationResponseHadNoSessionId (Response ByteString)

Instances

Instances details

Exception SessionException Source #
Instance details Defined in Test.WebDriver.Types Methods toException :: SessionException -> SomeException # fromException :: SomeException -> Maybe SessionException # displayException :: SessionException -> String #
Show SessionException Source #
Instance details Defined in Test.WebDriver.Types Methods showsPrec :: Int -> SessionException -> ShowS # show :: SessionException -> String # showList :: [SessionException] -> ShowS #

Stack frames

data StackFrame Source #

An individual stack frame from the stack trace provided by the server during a FailedCommand.

Constructors

StackFrame
Fields sfFileName :: String sfClassName :: String sfMethodName :: String sfLineNumber :: Int

Instances

Instances details

FromJSON StackFrame Source #
Instance details Defined in Test.WebDriver.Types Methods parseJSON :: Value -> Parser StackFrame # parseJSONList :: Value -> Parser [StackFrame] # omittedField :: Maybe StackFrame #
Show StackFrame Source #
Instance details Defined in Test.WebDriver.Types Methods showsPrec :: Int -> StackFrame -> ShowS # show :: StackFrame -> String # showList :: [StackFrame] -> ShowS #
Eq StackFrame Source #
Instance details Defined in Test.WebDriver.Types Methods (==) :: StackFrame -> StackFrame -> Bool # (/=) :: StackFrame -> StackFrame -> Bool #

callStackItemToStackFrame :: (String, SrcLoc) -> StackFrame Source #

WebDriver class

type WebDriver (m :: Type -> Type) = (WebDriverBase m, SessionState m) Source #

class MonadUnliftIO m => WebDriverBase (m :: Type -> Type) where Source #

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.

Methods

doCommandBase Source #

Arguments

:: (HasCallStack, ToJSON a)
=> Driver
-> Method	HTTP request method
-> Text	URL of request
-> a	JSON parameters passed in the body of the request. Note that, as a special case, anything that converts to Data.Aeson.Null will result in an empty request body.
-> m (Response ByteString)	The response of the HTTP request.

type Method = ByteString #

HTTP method (flat ByteString type).

methodDelete :: Method #

HTTP DELETE Method

methodGet :: Method #

HTTP GET Method

methodPost :: Method #

HTTP POST Method