Safe Haskell	None
Language	Haskell2010

Test.Sandwich.WebDriver.Binaries

Contents

Selenium
Chrome
Chrome driver
Firefox
Geckodriver
Ffmpeg
Xvfb

Description

Obtain various binaries you might need for WebDriver testing.

Synopsis

obtainSelenium :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => SeleniumToUse -> m FilePath
data SeleniumToUse
obtainChrome :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => ChromeToUse -> m (Either Text FilePath)
data ChromeToUse
newtype ChromeVersion = ChromeVersion (Int, Int, Int, Int)
obtainChromeDriver :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => ChromeDriverToUse -> m (Either Text FilePath)
data ChromeDriverToUse
data ChromeDriverVersion
- = ChromeDriverVersionTuple (Int, Int, Int, Int)
- | ChromeDriverVersionExactUrl (Int, Int, Int, Int) Text
obtainFirefox :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => FirefoxToUse -> m (Either Text FilePath)
data FirefoxToUse
obtainGeckoDriver :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => GeckoDriverToUse -> m (Either Text FilePath)
data GeckoDriverToUse
newtype GeckoDriverVersion = GeckoDriverVersion (Int, Int, Int)
obtainFfmpeg :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLoggerIO m, MonadMask m) => FfmpegToUse -> m (Either Text FilePath)
data FfmpegToUse
obtainXvfb :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLoggerIO m) => XvfbToUse -> m (Either Text FilePath)
data XvfbDependenciesSpec = XvfbDependenciesSpec {
- xvfbDependenciesSpecXvfb :: XvfbToUse
- xvfbDependenciesSpecFluxbox :: Maybe FluxboxToUse
}
data XvfbToUse
data FluxboxToUse

Selenium

obtainSelenium Source #

Arguments

:: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m)
=> SeleniumToUse	How to obtain Selenium
-> m FilePath

Manually obtain a Selenium server JAR file, according to the SeleniumToUse policy, storing it under the provided FilePath if necessary and returning the exact path.

data SeleniumToUse Source #

How to obtain the Selenium server JAR file.

Constructors

DownloadSeleniumFrom FilePath String	Download selenium from the given URL to the `toolsRoot`
DownloadSeleniumDefault FilePath	Download selenium from a default location to the `toolsRoot`
UseSeleniumAt FilePath	Use the JAR file at the given path
UseSeleniumFromNixpkgs NixContext	Use the Selenium in the given Nixpkgs derivation

Instances

Instances details

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

Chrome

obtainChrome :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => ChromeToUse -> m (Either Text FilePath) Source #

Manually obtain a chrome binary, according to the ChromeToUse policy,

data ChromeToUse Source #

How to obtain the chrome binary.

Constructors

UseChromeFromPath	Search the PATH for the `google-chrome` or `google-chrome-stable` binary.
UseChromeAt FilePath	Use the Chrome at the given path.
UseChromeFromNixpkgs NixContext	Get Chrome from Nixpkgs.

Instances

Instances details

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

newtype ChromeVersion Source #

Constructors

ChromeVersion (Int, Int, Int, Int)

Instances

Instances details

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

Chrome driver

obtainChromeDriver Source #

Arguments

:: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m)
=> ChromeDriverToUse	How to obtain `chromedriver`
-> m (Either Text FilePath)

Manually obtain a chromedriver binary, according to the ChromeDriverToUse policy.

data ChromeDriverToUse Source #

How to obtain the chromedriver binary.

Constructors

DownloadChromeDriverFrom FilePath String	Download chromedriver from the given URL to the `toolsRoot`.
DownloadChromeDriverVersion FilePath ChromeDriverVersion	Download the given chromedriver version to the `toolsRoot`.
DownloadChromeDriverAutodetect FilePath 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.
UseChromeDriverFromNixpkgs NixContext	Use the chromedriver in the given Nixpkgs derivation.

Instances

Instances details

Show ChromeDriverToUse Source #
Instance details Defined in Test.Sandwich.WebDriver.Internal.Binaries.Chrome.Types Methods showsPrec :: Int -> ChromeDriverToUse -> ShowS # show :: ChromeDriverToUse -> String # showList :: [ChromeDriverToUse] -> 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.Binaries.Chrome.Types Methods showsPrec :: Int -> ChromeDriverVersion -> ShowS # show :: ChromeDriverVersion -> String # showList :: [ChromeDriverVersion] -> ShowS #

Firefox

obtainFirefox :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m) => FirefoxToUse -> m (Either Text FilePath) Source #

Manually obtain a firefox binary, according to the FirefoxToUse policy,

data FirefoxToUse Source #

How to obtain the firefox binary.

Constructors

UseFirefoxFromPath	Search the PATH for the `firefox` binary.
UseFirefoxAt FilePath	Use the Firefox at the given path.
UseFirefoxFromNixpkgs NixContext	Get Firefox from Nixpkgs.

Instances

Instances details

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

Geckodriver

obtainGeckoDriver Source #

Arguments

:: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLogger m)
=> GeckoDriverToUse	How to obtain `geckodriver`
-> m (Either Text FilePath)

Manually obtain a geckodriver binary, according to the GeckoDriverToUse policy, storing it under the provided FilePath if necessary and returning the exact path.

data GeckoDriverToUse Source #

How to obtain the geckodriver binary.

Constructors

DownloadGeckoDriverFrom FilePath String	Download `geckodriver` from the given URL to the `toolsRoot`.
DownloadGeckoDriverVersion FilePath GeckoDriverVersion	Download the given `geckodriver` version to the `toolsRoot`.
DownloadGeckoDriverAutodetect FilePath	Autodetect `geckodriver` to use based on the Firefox version and download it to the `toolsRoot`.
UseGeckoDriverAt FilePath	Use the `geckodriver` at the given path.
UseGeckoDriverFromNixpkgs NixContext	Use the `geckodriver` in the given Nixpkgs derivation.

Instances

Instances details

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

newtype GeckoDriverVersion Source #

Constructors

GeckoDriverVersion (Int, Int, Int)

Instances

Instances details

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

Ffmpeg

obtainFfmpeg :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLoggerIO m, MonadMask m) => FfmpegToUse -> m (Either Text FilePath) Source #

Manually obtain an ffmpeg binary, according to the FfmpegToUse policy.

data FfmpegToUse Source #

How to obtain the ffmpeg binary.

Constructors

UseFfmpegFromPath	Search the PATH for the `ffmpeg` binary.
UseFfmpegAt FilePath	Use the `ffmpeg` at the given path.
UseFfmpegFromNixpkgs NixContext	Get `ffmpeg` from Nixpkgs.

Instances

Instances details

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

Xvfb

obtainXvfb :: (MonadReader context m, HasBaseContext context, MonadUnliftIO m, MonadLoggerIO m) => XvfbToUse -> m (Either Text FilePath) Source #

Manually obtain an Xvfb binary, according to the XvfbToUse policy.

data XvfbDependenciesSpec Source #

Constructors

XvfbDependenciesSpec
Fields xvfbDependenciesSpecXvfb :: XvfbToUse xvfbDependenciesSpecFluxbox :: Maybe FluxboxToUse

data XvfbToUse Source #

How to obtain the Xvfb binary.

Constructors

UseXvfbFromPath	Search the PATH for the `Xvfb` binary.
UseXvfbAt FilePath	Use the `Xvfb` at the given path.
UseXvfbFromNixpkgs NixContext	Get `Xvfb` from Nixpkgs.

Instances

Instances details

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

data FluxboxToUse Source #

How to obtain the fluxbox binary.

Constructors

UseFluxboxFromPath	Search the PATH for the `fluxbox` binary.
UseFluxboxAt FilePath	Use the `fluxbox` at the given path.
UseFluxboxFromNixpkgs NixContext	Get `fluxbox` from Nixpkgs.

Instances

Instances details

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