Copyright	2018 Automattic Inc.
License	GPL-3
Maintainer	Nathan Bloomfield (nbloomf@gmail.com)
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Test.Tasty.WebDriver

Contents

Test Case Constructors
Branching
Options

Description

Tasty integration for WebDriverT tests.

Synopsis

Documentation

defaultWebDriverMain :: TestTree -> IO () Source #

Run a tree of webdriver tests. Thin wrapper around tasty's defaultMain that attempts to determine the deployment tier and interprets remote end config command line options.

Test Case Constructors

testCase Source #

Arguments

:: TestName
-> WebDriver IO ()	The test
-> TestTree

WebDriver test case with the default IO effect evaluator.

testCaseM Source #

Arguments

:: (Monad eff, Typeable eff)
=> TestName
-> (forall a. P WDAct a -> eff a)	Evaluator
-> (forall a. eff a -> IO a)	Conversion to `IO`
-> WebDriver eff ()
-> TestTree

WebDriver test case with a custom effect evaluator.

testCaseT Source #

Arguments

:: (Monad (m IO), Typeable m)
=> TestName
-> (forall a. IO a -> m IO a)	Lift effects to the inner monad
-> (forall a. m IO a -> IO a)	Conversion to `IO`
-> WebDriverT (m IO) ()	The test
-> TestTree

WebDriverT test case with the default IO effect evaluator.

testCaseTM Source #

Arguments

:: (Monad eff, Monad (m eff), Typeable eff, Typeable m)
=> TestName
-> (forall a. P WDAct a -> eff a)	Evaluator
-> (forall a. eff a -> m eff a)	Lift effects to the inner monad
-> (forall a. m eff a -> IO a)	Conversion to `IO`.
-> WebDriverT (m eff) ()	The test
-> TestTree

WebDriverT test case with a custom effect evaluator.

testCaseWithSetup Source #

Arguments

:: TestName
-> WebDriver IO u	Setup
-> (v -> WebDriver IO ())	Teardown
-> (u -> WebDriver IO v)	The test
-> TestTree

WebDriver test case with additional setup and teardown phases using the default IO effect evaluator. Setup runs before the test (for e.g. logging in) and teardown runs after the test (for e.g. deleting temp files).

testCaseWithSetupM Source #

Arguments

:: (Monad eff, Typeable eff)
=> TestName
-> (forall u. P WDAct u -> eff u)	Evaluator
-> (forall u. eff u -> IO u)	Conversion to `IO`
-> WebDriver eff u	Setup
-> (v -> WebDriver eff ())	Teardown
-> (u -> WebDriver eff v)	The test
-> TestTree

WebDriver test case with additional setup and teardown phases and a custom effect evaluator. Setup runs before the test (for e.g. logging in) and teardown runs after the test (for e.g. deleting temp files).

testCaseWithSetupT Source #

Arguments

:: (Monad (m IO), Typeable m)
=> TestName
-> (forall a. IO a -> m IO a)	Lift effects to the inner monad
-> (forall a. m IO a -> IO a)	Conversion to `IO`
-> WebDriverT (m IO) u	Setup
-> (v -> WebDriverT (m IO) ())	Teardown
-> (u -> WebDriverT (m IO) v)	Test
-> TestTree

WebDriverT test case with additional setup and teardown phases using the default IO effect evaluator. Setup runs before the test (for e.g. logging in) and teardown runs after the test (for e.g. deleting temp files).

testCaseWithSetupTM Source #

Arguments

:: (Monad eff, Monad (m eff), Typeable eff, Typeable m)
=> TestName
-> (forall a. P WDAct a -> eff a)	Evaluator
-> (forall a. eff a -> m eff a)	Lift effects to the inner monad
-> (forall a. m eff a -> IO a)	Conversion to `IO`.
-> WebDriverT (m eff) u	Setup
-> (v -> WebDriverT (m eff) ())	Teardown
-> (u -> WebDriverT (m eff) v)	Test
-> TestTree

WebDriverT test case with additional setup and teardown phases and a custom effect evaluator. Setup runs before the test (for logging in, say) and teardown runs after the test (for deleting temp files, say).

Branching

ifDriverIs :: DriverName -> (TestTree -> TestTree) -> TestTree -> TestTree Source #

Set local options if the Driver option is a given value.

ifTierIs :: DeploymentTier -> (TestTree -> TestTree) -> TestTree -> TestTree Source #

Set local options if the Deployment option is a given value.

ifHeadless :: (TestTree -> TestTree) -> TestTree -> TestTree Source #

Set local options if Headless is true.

unlessDriverIs :: DriverName -> (TestTree -> TestTree) -> TestTree -> TestTree Source #

Set local options if the Driver option is not a given value.

unlessTierIs :: DeploymentTier -> (TestTree -> TestTree) -> TestTree -> TestTree Source #

Set local options if the Deployment option is not a given value.

unlessHeadless :: (TestTree -> TestTree) -> TestTree -> TestTree Source #

Set local options if Headless is false.

Options

newtype Driver Source #

Remote end name.

Constructors

Driver
Fields theDriver :: DriverName

Instances

IsOption Driver Source #
Methods defaultValue :: Driver # parseValue :: String -> Maybe Driver # optionName :: Tagged * Driver String # optionHelp :: Tagged * Driver String # optionCLParser :: Parser Driver #

data DriverName Source #

Remote end name.

Constructors

Geckodriver
Chromedriver

Instances

Eq DriverName Source #
Methods (==) :: DriverName -> DriverName -> Bool # (/=) :: DriverName -> DriverName -> Bool #
Ord DriverName Source #
Methods compare :: DriverName -> DriverName -> Ordering # (<) :: DriverName -> DriverName -> Bool # (<=) :: DriverName -> DriverName -> Bool # (>) :: DriverName -> DriverName -> Bool # (>=) :: DriverName -> DriverName -> Bool # max :: DriverName -> DriverName -> DriverName # min :: DriverName -> DriverName -> DriverName #
Show DriverName Source #
Methods showsPrec :: Int -> DriverName -> ShowS # show :: DriverName -> String # showList :: [DriverName] -> ShowS #

newtype DataPath Source #

Path where secrets are stored.

Constructors

DataPath
Fields theDataPath :: Maybe FilePath

Instances

IsOption DataPath Source #
Methods defaultValue :: DataPath # parseValue :: String -> Maybe DataPath # optionName :: Tagged * DataPath String # optionHelp :: Tagged * DataPath String # optionCLParser :: Parser DataPath #

newtype Deployment Source #

Named deployment environment.

Constructors

Deployment
Fields theDeployment :: DeploymentTier

Instances

Eq Deployment Source #
Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
IsOption Deployment Source #
Methods defaultValue :: Deployment # parseValue :: String -> Maybe Deployment # optionName :: Tagged * Deployment String # optionHelp :: Tagged * Deployment String # optionCLParser :: Parser Deployment #

data DeploymentTier Source #

Representation of the deployment environment.

Constructors

DEV	Local environment
TEST	CI server (for testing the library)
PROD	Production -- e.g. testing a real site

Instances

Eq DeploymentTier Source #
Methods (==) :: DeploymentTier -> DeploymentTier -> Bool # (/=) :: DeploymentTier -> DeploymentTier -> Bool #
Show DeploymentTier Source #
Methods showsPrec :: Int -> DeploymentTier -> ShowS # show :: DeploymentTier -> String # showList :: [DeploymentTier] -> ShowS #

newtype BrowserPath Source #

Path to browser binary.

Constructors

BrowserPath
Fields theBrowserPath :: Maybe FilePath

Instances

IsOption BrowserPath Source #
Methods defaultValue :: BrowserPath # parseValue :: String -> Maybe BrowserPath # optionName :: Tagged * BrowserPath String # optionHelp :: Tagged * BrowserPath String # optionCLParser :: Parser BrowserPath #

newtype ApiResponseFormat Source #

Expected API response format.

Constructors

ApiResponseFormat
Fields theApiResponseFormat :: ResponseFormat

Instances

newtype WebDriverApiVersion Source #

WebDriver API version.

Constructors

WebDriverApiVersion
Fields theWebDriverApiVersion :: ApiVersion

Instances

newtype LogHandle Source #

Log location.

Constructors

LogHandle
Fields theLogHandle :: Handle

Instances

IsOption LogHandle Source #
Methods defaultValue :: LogHandle # parseValue :: String -> Maybe LogHandle # optionName :: Tagged * LogHandle String # optionHelp :: Tagged * LogHandle String # optionCLParser :: Parser LogHandle #

newtype TestDelay Source #

Delay between test attempts.

Constructors

TestDelay
Fields theTestDelay :: Int

Instances

Eq TestDelay Source #
Methods (==) :: TestDelay -> TestDelay -> Bool # (/=) :: TestDelay -> TestDelay -> Bool #
Show TestDelay Source #
Methods showsPrec :: Int -> TestDelay -> ShowS # show :: TestDelay -> String # showList :: [TestDelay] -> ShowS #
IsOption TestDelay Source #
Methods defaultValue :: TestDelay # parseValue :: String -> Maybe TestDelay # optionName :: Tagged * TestDelay String # optionHelp :: Tagged * TestDelay String # optionCLParser :: Parser TestDelay #

newtype NumRetries Source #

Max number of retries.

Constructors

NumRetries
Fields theNumRetries :: Int

Instances

IsOption NumRetries Source #
Methods defaultValue :: NumRetries # parseValue :: String -> Maybe NumRetries # optionName :: Tagged * NumRetries String # optionHelp :: Tagged * NumRetries String # optionCLParser :: Parser NumRetries #

data LogNoiseLevel Source #

Log Noise Level.

Constructors

NoisyLog
SilentLog

Instances

IsOption LogNoiseLevel Source #
Methods defaultValue :: LogNoiseLevel # parseValue :: String -> Maybe LogNoiseLevel # optionName :: Tagged * LogNoiseLevel String # optionHelp :: Tagged * LogNoiseLevel String # optionCLParser :: Parser LogNoiseLevel #

newtype ConsoleInHandle Source #

Console in location. Used to mock stdin for testing.

Constructors

ConsoleInHandle
Fields theConsoleInHandle :: Handle

Instances

IsOption ConsoleInHandle Source #
Methods defaultValue :: ConsoleInHandle # parseValue :: String -> Maybe ConsoleInHandle # optionName :: Tagged * ConsoleInHandle String # optionHelp :: Tagged * ConsoleInHandle String # optionCLParser :: Parser ConsoleInHandle #

newtype ConsoleOutHandle Source #

Console out location. Used to mock stdout for testing.

Constructors

ConsoleOutHandle
Fields theConsoleOutHandle :: Handle

Instances

newtype RemoteEndRef Source #

Mutable remote end pool

Constructors

RemoteEndRef
Fields theRemoteEndRef :: Maybe (TVar RemoteEndPool)

Instances

IsOption RemoteEndRef Source #
Methods defaultValue :: RemoteEndRef # parseValue :: String -> Maybe RemoteEndRef # optionName :: Tagged * RemoteEndRef String # optionHelp :: Tagged * RemoteEndRef String # optionCLParser :: Parser RemoteEndRef #

newtype Headless Source #

Run in headless mode.

Constructors

Headless
Fields theHeadless :: Bool

Instances

IsOption Headless Source #
Methods defaultValue :: Headless # parseValue :: String -> Maybe Headless # optionName :: Tagged * Headless String # optionHelp :: Tagged * Headless String # optionCLParser :: Parser Headless #

newtype LogColors Source #

Governs whether logs are printed in color

Constructors

LogColors
Fields theLogColors :: Bool

Instances

IsOption LogColors Source #
Methods defaultValue :: LogColors # parseValue :: String -> Maybe LogColors # optionName :: Tagged * LogColors String # optionHelp :: Tagged * LogColors String # optionCLParser :: Parser LogColors #

newtype GeckodriverLog Source #

Verbosity level passed to geckodriver

Constructors

GeckodriverLog
Fields theGeckodriverLog :: LogLevel

Instances

IsOption GeckodriverLog Source #
Methods defaultValue :: GeckodriverLog # parseValue :: String -> Maybe GeckodriverLog # optionName :: Tagged * GeckodriverLog String # optionHelp :: Tagged * GeckodriverLog String # optionCLParser :: Parser GeckodriverLog #

module Test.Tasty.WebDriver.Config

IsOption ApiResponseFormat Source #
Methods defaultValue :: ApiResponseFormat # parseValue :: String -> Maybe ApiResponseFormat # optionName :: Tagged * ApiResponseFormat String # optionHelp :: Tagged * ApiResponseFormat String # optionCLParser :: Parser ApiResponseFormat #

IsOption WebDriverApiVersion Source #
Methods defaultValue :: WebDriverApiVersion # parseValue :: String -> Maybe WebDriverApiVersion # optionName :: Tagged * WebDriverApiVersion String # optionHelp :: Tagged * WebDriverApiVersion String # optionCLParser :: Parser WebDriverApiVersion #

IsOption ConsoleOutHandle Source #
Methods defaultValue :: ConsoleOutHandle # parseValue :: String -> Maybe ConsoleOutHandle # optionName :: Tagged * ConsoleOutHandle String # optionHelp :: Tagged * ConsoleOutHandle String # optionCLParser :: Parser ConsoleOutHandle #