Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Sandwich.WebDriver.Internal.Types

Contents

Labels
Video stuff

Synopsis

type Session = String
webdriver :: Label "webdriver" WebDriver
webdriverSession :: Label "webdriverSession" WebDriverSession
type WebDriverContext context wd = (HasLabel context "webdriver" WebDriver, WebDriver (ExampleT context wd))
class HasWebDriver a where
- getWebDriver :: a -> WebDriver
type ToolsRoot = FilePath
data WhenToSave
- = Always
- | OnException
- | Never
data RunMode
- = Normal
- | RunHeadless HeadlessConfig
- | RunInXvfb XvfbConfig
data WdOptions = WdOptions {
- toolsRoot :: ToolsRoot
- capabilities :: Capabilities
- saveSeleniumMessageHistory :: WhenToSave
- seleniumToUse :: SeleniumToUse
- chromeBinaryPath :: Maybe FilePath
- chromeDriverToUse :: ChromeDriverToUse
- firefoxBinaryPath :: Maybe FilePath
- geckoDriverToUse :: GeckoDriverToUse
- runMode :: RunMode
- httpManager :: Maybe Manager
- httpRetryCount :: Int
}
data SeleniumToUse
- = DownloadSeleniumFrom String
- | DownloadSeleniumDefault
- | UseSeleniumAt FilePath
data ChromeDriverToUse
- = DownloadChromeDriverFrom String
- | DownloadChromeDriverVersion ChromeDriverVersion
- | DownloadChromeDriverAutodetect (Maybe FilePath)
- | UseChromeDriverAt FilePath
data GeckoDriverToUse
- = DownloadGeckoDriverFrom String
- | DownloadGeckoDriverVersion GeckoDriverVersion
- | DownloadGeckoDriverAutodetect (Maybe FilePath)
- | UseGeckoDriverAt FilePath
newtype ChromeVersion = ChromeVersion (Int, Int, Int, Int)
data ChromeDriverVersion
- = ChromeDriverVersionTuple (Int, Int, Int, Int)
- | ChromeDriverVersionExactUrl (Int, Int, Int, Int) Text
newtype FirefoxVersion = FirefoxVersion (Int, Int, Int)
newtype GeckoDriverVersion = GeckoDriverVersion (Int, Int, Int)
data HeadlessConfig = HeadlessConfig {
- headlessResolution :: Maybe (Int, Int)
}
defaultHeadlessConfig :: HeadlessConfig
data XvfbConfig = XvfbConfig {
- xvfbResolution :: Maybe (Int, Int)
- xvfbStartFluxbox :: Bool
}
defaultXvfbConfig :: XvfbConfig
defaultWdOptions :: FilePath -> WdOptions
data WebDriver = WebDriver {
- wdName :: String
- wdWebDriver :: (Handle, Handle, ProcessHandle, FilePath, FilePath, Maybe XvfbSession)
- wdOptions :: WdOptions
- wdSessionMap :: MVar (Map Session WDSession)
- wdConfig :: WDConfig
- wdDownloadDir :: FilePath
}
data InvalidLogsException = InvalidLogsException [LogEntry]
data XvfbSession = XvfbSession {
- xvfbDisplayNum :: Int
- xvfbXauthority :: FilePath
- xvfbDimensions :: (Int, Int)
- xvfbProcess :: ProcessHandle
- xvfbFluxboxProcess :: Maybe ProcessHandle
}
type WebDriverSession = (Session, IORef WDSession)
getWdOptions :: WebDriver -> WdOptions
getDisplayNumber :: WebDriver -> Maybe Int
getXvfbSession :: WebDriver -> Maybe XvfbSession
getWebDriverName :: WebDriver -> String
fastX11VideoOptions :: [String]
qualityX11VideoOptions :: [String]
defaultAvfoundationOptions :: [String]
defaultGdigrabOptions :: [String]
data VideoSettings = VideoSettings {
- x11grabOptions :: [String]
- avfoundationOptions :: [String]
- gdigrabOptions :: [String]
- hideMouseWhenRecording :: Bool
- logToDisk :: Bool
}
defaultVideoSettings :: VideoSettings

Documentation

type Session = String Source #

Session is just a String name.

Labels

webdriver :: Label "webdriver" WebDriver Source #

webdriverSession :: Label "webdriverSession" WebDriverSession Source #

type WebDriverContext context wd = (HasLabel context "webdriver" WebDriver, WebDriver (ExampleT context wd)) Source #

class HasWebDriver a where Source #

Methods

getWebDriver :: a -> WebDriver Source #

Instances

Instances details

HasWebDriver WebDriver Source #
Instance details Defined in Test.Sandwich.WebDriver.Internal.Types Methods getWebDriver :: WebDriver -> WebDriver Source #

type ToolsRoot = FilePath Source #

data WhenToSave Source #

Constructors

Always
OnException
Never

Instances

Instances details

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

data RunMode Source #

Headless and Xvfb modes are useful because they allow you to run tests in the background, without popping up browser windows. This is useful for development or for running on a CI server, and is also more reproducible since the screen resolution can be fixed. In addition, Xvfb mode allows videos to be recorded of tests.

Constructors

Normal	Normal Selenium behavior; will pop up a web browser.
RunHeadless HeadlessConfig	Run with a headless browser. Supports screenshots but videos will be black.
RunInXvfb XvfbConfig	Run inside Xvfb so that tests run in their own X11 display. xvfb-run script must be installed and on the PATH.

data WdOptions Source #

Constructors

WdOptions

Fields

toolsRoot :: ToolsRoot
Folder where any necessary binaries (chromedriver, Selenium, etc.) will be downloaded if needed. Required.
capabilities :: Capabilities
The WebDriver capabilities to use.
saveSeleniumMessageHistory :: WhenToSave
When to save a record of Selenium requests and responses.
seleniumToUse :: SeleniumToUse
Which Selenium server JAR file to use.
chromeBinaryPath :: Maybe FilePath
Which chrome binary to use.
chromeDriverToUse :: ChromeDriverToUse
Which chromedriver executable to use.
firefoxBinaryPath :: Maybe FilePath
Which firefox binary to use.
geckoDriverToUse :: GeckoDriverToUse
Which geckodriver executable to use.
runMode :: RunMode
How to handle opening the browser (in a popup window, headless, etc.).
httpManager :: Maybe Manager
HTTP manager for making requests to Selenium. If not provided, one will be created for each session.
httpRetryCount :: Int
Number of times to retry an HTTP request if it times out.

data SeleniumToUse Source #

How to obtain the Selenium server JAR file.

Constructors

DownloadSeleniumFrom String	Download selenium from the given URL to the `toolsRoot`
DownloadSeleniumDefault	Download selenium from a default location to the `toolsRoot`
UseSeleniumAt FilePath	Use the JAR file at the given path

Instances

Instances details

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

data ChromeDriverToUse Source #

How to obtain the chromedriver binary.

Constructors

DownloadChromeDriverFrom String	Download chromedriver from the given URL to the `toolsRoot`
DownloadChromeDriverVersion ChromeDriverVersion	Download the given chromedriver version to the `toolsRoot`
DownloadChromeDriverAutodetect (Maybe FilePath)	Autodetect chromedriver to use based on the Chrome version and download it to the `toolsRoot` Pass the path to the Chrome binary, or else it will be found by looking for google-chrome on the PATH.
UseChromeDriverAt FilePath	Use the chromedriver at the given path

Instances

Instances details

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

data GeckoDriverToUse Source #

How to obtain the geckodriver binary.

Constructors

DownloadGeckoDriverFrom String	Download geckodriver from the given URL to the `toolsRoot`
DownloadGeckoDriverVersion GeckoDriverVersion	Download the given geckodriver version to the `toolsRoot`
DownloadGeckoDriverAutodetect (Maybe FilePath)	Autodetect geckodriver to use based on the Gecko version and download it to the `toolsRoot` Pass the path to the Firefox binary, or else it will be found by looking for firefox on the PATH.
UseGeckoDriverAt FilePath	Use the geckodriver at the given path

Instances

Instances details

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

newtype ChromeVersion Source #

Constructors

ChromeVersion (Int, Int, Int, Int)

Instances

Instances details

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

data ChromeDriverVersion Source #

Constructors

ChromeDriverVersionTuple (Int, Int, Int, Int)
ChromeDriverVersionExactUrl (Int, Int, Int, Int) Text

Instances

Instances details

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

newtype FirefoxVersion Source #

Constructors

FirefoxVersion (Int, Int, Int)

Instances

Instances details

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

newtype GeckoDriverVersion Source #

Constructors

GeckoDriverVersion (Int, Int, Int)

Instances

Instances details

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

data HeadlessConfig Source #

Constructors

HeadlessConfig
Fields headlessResolution :: Maybe (Int, Int) Resolution for the headless browser. Defaults to (1920, 1080)

defaultHeadlessConfig :: HeadlessConfig Source #

Default headless config.

data XvfbConfig Source #

Constructors

XvfbConfig
Fields xvfbResolution :: Maybe (Int, Int) Resolution for the virtual screen. Defaults to (1920, 1080) xvfbStartFluxbox :: Bool Whether to start fluxbox window manager to go with the Xvfb session. fluxbox must be on the path

defaultXvfbConfig :: XvfbConfig Source #

Default Xvfb settings.

defaultWdOptions :: FilePath -> WdOptions Source #

The default WdOptions object. You should start with this and modify it using the accessors.

data WebDriver Source #

Constructors

WebDriver
Fields wdName :: String wdWebDriver :: (Handle, Handle, ProcessHandle, FilePath, FilePath, Maybe XvfbSession) wdOptions :: WdOptions wdSessionMap :: MVar (Map Session WDSession) wdConfig :: WDConfig wdDownloadDir :: FilePath

Instances

Instances details

HasWebDriver WebDriver Source #
Instance details Defined in Test.Sandwich.WebDriver.Internal.Types Methods getWebDriver :: WebDriver -> WebDriver Source #

data InvalidLogsException Source #

Constructors

InvalidLogsException [LogEntry]

Instances

Instances details

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

data XvfbSession Source #

Constructors

XvfbSession
Fields xvfbDisplayNum :: Int xvfbXauthority :: FilePath xvfbDimensions :: (Int, Int) xvfbProcess :: ProcessHandle xvfbFluxboxProcess :: Maybe ProcessHandle

Instances

Instances details

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

type WebDriverSession = (Session, IORef WDSession) Source #

getWdOptions :: WebDriver -> WdOptions Source #

Get the WdOptions associated with the WebDriver.

getDisplayNumber :: WebDriver -> Maybe Int Source #

Get the X11 display number associated with the WebDriver. Only present if running in RunInXvfb mode.

getXvfbSession :: WebDriver -> Maybe XvfbSession Source #

Get the Xvfb session associated with the WebDriver, if present.

getWebDriverName :: WebDriver -> String Source #

Get the name of the WebDriver.

Video stuff

fastX11VideoOptions :: [String] Source #

Default options for fast X11 video recording.

qualityX11VideoOptions :: [String] Source #

Default options for quality X11 video recording.

defaultAvfoundationOptions :: [String] Source #

Default options for AVFoundation recording (for Darwin).

defaultGdigrabOptions :: [String] Source #

Default options for gdigrab recording (for Windows).

data VideoSettings Source #

Constructors

VideoSettings
Fields x11grabOptions :: [String] Arguments to x11grab, used with Linux. avfoundationOptions :: [String] Arguments to avfoundation, used with OS X. gdigrabOptions :: [String] Arguments to gdigrab, used with Windows. hideMouseWhenRecording :: Bool Hide the mouse while recording video. Linux and Windows only. logToDisk :: Bool Log ffmpeg stdout and stderr to disk.

defaultVideoSettings :: VideoSettings Source #

Default video settings.