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

defaultWebDriverMain :: TestTree -> IO ()
testCase :: TestName -> WebDriverT IO () -> TestTree
testCaseM :: (Monad eff, Typeable eff) => TestName -> (forall a. P WDAct a -> eff a) -> (forall a. eff a -> IO a) -> WebDriverT eff () -> TestTree
testCaseT :: (Monad (t IO), MonadTrans t, Typeable t) => TestName -> (forall a. t IO a -> IO a) -> WebDriverTT t IO () -> TestTree
testCaseTM :: (Monad eff, Monad (t eff), MonadTrans t, Typeable eff, Typeable t) => TestName -> (forall a. P WDAct a -> eff a) -> (forall a. t eff a -> IO a) -> WebDriverTT t eff () -> TestTree
testCaseWithSetup :: TestName -> WebDriverT IO u -> (v -> WebDriverT IO ()) -> (u -> WebDriverT IO v) -> TestTree
testCaseWithSetupM :: (Monad eff, Typeable eff) => TestName -> (forall a. P WDAct a -> eff a) -> (forall a. eff a -> IO a) -> WebDriverT eff u -> (v -> WebDriverT eff ()) -> (u -> WebDriverT eff v) -> TestTree
testCaseWithSetupT :: (Monad (t IO), MonadTrans t, Typeable t) => TestName -> (forall a. t IO a -> IO a) -> WebDriverTT t IO u -> (v -> WebDriverTT t IO ()) -> (u -> WebDriverTT t IO v) -> TestTree
testCaseWithSetupTM :: (Monad eff, Monad (t eff), MonadTrans t, Typeable eff, Typeable t) => TestName -> (forall a. P WDAct a -> eff a) -> (forall a. t eff a -> IO a) -> WebDriverTT t eff u -> (v -> WebDriverTT t eff ()) -> (u -> WebDriverTT t eff v) -> TestTree
ifDriverIs :: DriverName -> (TestTree -> TestTree) -> TestTree -> TestTree
ifTierIs :: DeploymentTier -> (TestTree -> TestTree) -> TestTree -> TestTree
ifHeadless :: (TestTree -> TestTree) -> TestTree -> TestTree
unlessDriverIs :: DriverName -> (TestTree -> TestTree) -> TestTree -> TestTree
unlessTierIs :: DeploymentTier -> (TestTree -> TestTree) -> TestTree -> TestTree
unlessHeadless :: (TestTree -> TestTree) -> TestTree -> TestTree
newtype Driver = Driver {
- theDriver :: DriverName
}
data DriverName
- = Geckodriver
- | Chromedriver
newtype DataPath = DataPath {
- theDataPath :: Maybe FilePath
}
newtype Deployment = Deployment {
- theDeployment :: DeploymentTier
}
data DeploymentTier
- = DEV
- | TEST
- | PROD
newtype BrowserPath = BrowserPath {
- theBrowserPath :: Maybe FilePath
}
newtype ApiResponseFormat = ApiResponseFormat {
- theApiResponseFormat :: ResponseFormat
}
newtype WebDriverApiVersion = WebDriverApiVersion {
- theWebDriverApiVersion :: ApiVersion
}
newtype LogHandle = LogHandle {
- theLogHandle :: Handle
}
newtype TestDelay = TestDelay {
- theTestDelay :: Int
}
newtype NumRetries = NumRetries {
- theNumRetries :: Int
}
data LogNoiseLevel
- = NoisyLog
- | SilentLog
newtype ConsoleInHandle = ConsoleInHandle {
- theConsoleInHandle :: Handle
}
newtype ConsoleOutHandle = ConsoleOutHandle {
- theConsoleOutHandle :: Handle
}
newtype RemoteEndRef = RemoteEndRef {
- theRemoteEndRef :: Maybe (TVar RemoteEndPool)
}
newtype Headless = Headless {
- theHeadless :: Bool
}
newtype LogColors = LogColors {
- theLogColors :: Bool
}
newtype GeckodriverLog = GeckodriverLog {
- theGeckodriverLog :: LogLevel
}
newtype PrivateMode = PrivateMode {
- thePrivateMode :: Bool
}
module Test.Tasty.WebDriver.Config

Documentation

defaultWebDriverMain :: TestTree -> IO () Source #

Run a tree of WebDriverT 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
-> WebDriverT 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`
-> WebDriverT eff ()
-> TestTree

WebDriver test case with a custom effect evaluator.

testCaseT Source #

Arguments

:: (Monad (t IO), MonadTrans t, Typeable t)
=> TestName
-> (forall a. t IO a -> IO a)	Conversion to `IO`
-> WebDriverTT t IO ()	The test
-> TestTree

WebDriverT test case with the default IO effect evaluator.

testCaseTM Source #

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t, Typeable eff, Typeable t)
=> TestName
-> (forall a. P WDAct a -> eff a)	Evaluator
-> (forall a. t eff a -> IO a)	Conversion to `IO`.
-> WebDriverTT t eff ()	The test
-> TestTree

WebDriverT test case with a custom effect evaluator.

testCaseWithSetup Source #

Arguments

:: TestName
-> WebDriverT IO u	Setup
-> (v -> WebDriverT IO ())	Teardown
-> (u -> WebDriverT 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 a. P WDAct a -> eff a)	Evaluator
-> (forall a. eff a -> IO a)	Conversion to `IO`
-> WebDriverT eff u	Setup
-> (v -> WebDriverT eff ())	Teardown
-> (u -> WebDriverT 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 (t IO), MonadTrans t, Typeable t)
=> TestName
-> (forall a. t IO a -> IO a)	Conversion to `IO`
-> WebDriverTT t IO u	Setup
-> (v -> WebDriverTT t IO ())	Teardown
-> (u -> WebDriverTT t 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 (t eff), MonadTrans t, Typeable eff, Typeable t)
=> TestName
-> (forall a. P WDAct a -> eff a)	Evaluator
-> (forall a. t eff a -> IO a)	Conversion to `IO`.
-> WebDriverTT t eff u	Setup
-> (v -> WebDriverTT t eff ())	Teardown
-> (u -> WebDriverTT t 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

Instances details

IsOption Driver Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: Driver # parseValue :: String -> Maybe Driver # optionName :: Tagged Driver String # optionHelp :: Tagged Driver String # showDefaultValue :: Driver -> Maybe String # optionCLParser :: Parser Driver #

data DriverName Source #

Remote end name.

Constructors

Geckodriver
Chromedriver

Instances

Instances details

Eq DriverName Source #
Instance details Defined in Test.Tasty.WebDriver.Config Methods (==) :: DriverName -> DriverName -> Bool # (/=) :: DriverName -> DriverName -> Bool #
Ord DriverName Source #
Instance details Defined in Test.Tasty.WebDriver.Config 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 #
Instance details Defined in Test.Tasty.WebDriver.Config 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

Instances details

IsOption DataPath Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: DataPath # parseValue :: String -> Maybe DataPath # optionName :: Tagged DataPath String # optionHelp :: Tagged DataPath String # showDefaultValue :: DataPath -> Maybe String # optionCLParser :: Parser DataPath #

newtype Deployment Source #

Named deployment environment.

Constructors

Deployment
Fields theDeployment :: DeploymentTier

Instances

Instances details

Eq Deployment Source #
Instance details Defined in Test.Tasty.WebDriver Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
IsOption Deployment Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: Deployment # parseValue :: String -> Maybe Deployment # optionName :: Tagged Deployment String # optionHelp :: Tagged Deployment String # showDefaultValue :: Deployment -> Maybe 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

Instances details

Eq DeploymentTier Source #
Instance details Defined in Test.Tasty.WebDriver Methods (==) :: DeploymentTier -> DeploymentTier -> Bool # (/=) :: DeploymentTier -> DeploymentTier -> Bool #
Show DeploymentTier Source #
Instance details Defined in Test.Tasty.WebDriver 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

Instances details

IsOption BrowserPath Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: BrowserPath # parseValue :: String -> Maybe BrowserPath # optionName :: Tagged BrowserPath String # optionHelp :: Tagged BrowserPath String # showDefaultValue :: BrowserPath -> Maybe String # optionCLParser :: Parser BrowserPath #

newtype ApiResponseFormat Source #

Expected API response format.

Constructors

ApiResponseFormat
Fields theApiResponseFormat :: ResponseFormat

Instances

Instances details

IsOption ApiResponseFormat Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: ApiResponseFormat # parseValue :: String -> Maybe ApiResponseFormat # optionName :: Tagged ApiResponseFormat String # optionHelp :: Tagged ApiResponseFormat String # showDefaultValue :: ApiResponseFormat -> Maybe String # optionCLParser :: Parser ApiResponseFormat #

newtype WebDriverApiVersion Source #

WebDriver API version.

Constructors

WebDriverApiVersion
Fields theWebDriverApiVersion :: ApiVersion

Instances

Instances details

IsOption WebDriverApiVersion Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: WebDriverApiVersion # parseValue :: String -> Maybe WebDriverApiVersion # optionName :: Tagged WebDriverApiVersion String # optionHelp :: Tagged WebDriverApiVersion String # showDefaultValue :: WebDriverApiVersion -> Maybe String # optionCLParser :: Parser WebDriverApiVersion #

newtype LogHandle Source #

Log location.

Constructors

LogHandle
Fields theLogHandle :: Handle

Instances

Instances details

IsOption LogHandle Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: LogHandle # parseValue :: String -> Maybe LogHandle # optionName :: Tagged LogHandle String # optionHelp :: Tagged LogHandle String # showDefaultValue :: LogHandle -> Maybe String # optionCLParser :: Parser LogHandle #

newtype TestDelay Source #

Delay between test attempts.

Constructors

TestDelay
Fields theTestDelay :: Int

Instances

Instances details

Eq TestDelay Source #
Instance details Defined in Test.Tasty.WebDriver Methods (==) :: TestDelay -> TestDelay -> Bool # (/=) :: TestDelay -> TestDelay -> Bool #
Show TestDelay Source #
Instance details Defined in Test.Tasty.WebDriver Methods showsPrec :: Int -> TestDelay -> ShowS # show :: TestDelay -> String # showList :: [TestDelay] -> ShowS #
IsOption TestDelay Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: TestDelay # parseValue :: String -> Maybe TestDelay # optionName :: Tagged TestDelay String # optionHelp :: Tagged TestDelay String # showDefaultValue :: TestDelay -> Maybe String # optionCLParser :: Parser TestDelay #

newtype NumRetries Source #

Max number of retries.

Constructors

NumRetries
Fields theNumRetries :: Int

Instances

Instances details

IsOption NumRetries Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: NumRetries # parseValue :: String -> Maybe NumRetries # optionName :: Tagged NumRetries String # optionHelp :: Tagged NumRetries String # showDefaultValue :: NumRetries -> Maybe String # optionCLParser :: Parser NumRetries #

data LogNoiseLevel Source #

Log Noise Level.

Constructors

NoisyLog
SilentLog

Instances

Instances details

IsOption LogNoiseLevel Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: LogNoiseLevel # parseValue :: String -> Maybe LogNoiseLevel # optionName :: Tagged LogNoiseLevel String # optionHelp :: Tagged LogNoiseLevel String # showDefaultValue :: LogNoiseLevel -> Maybe String # optionCLParser :: Parser LogNoiseLevel #

newtype ConsoleInHandle Source #

Console in location. Used to mock stdin for testing.

Constructors

ConsoleInHandle
Fields theConsoleInHandle :: Handle

Instances

Instances details

IsOption ConsoleInHandle Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: ConsoleInHandle # parseValue :: String -> Maybe ConsoleInHandle # optionName :: Tagged ConsoleInHandle String # optionHelp :: Tagged ConsoleInHandle String # showDefaultValue :: ConsoleInHandle -> Maybe String # optionCLParser :: Parser ConsoleInHandle #

newtype ConsoleOutHandle Source #

Console out location. Used to mock stdout for testing.

Constructors

ConsoleOutHandle
Fields theConsoleOutHandle :: Handle

Instances

Instances details

IsOption ConsoleOutHandle Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: ConsoleOutHandle # parseValue :: String -> Maybe ConsoleOutHandle # optionName :: Tagged ConsoleOutHandle String # optionHelp :: Tagged ConsoleOutHandle String # showDefaultValue :: ConsoleOutHandle -> Maybe String # optionCLParser :: Parser ConsoleOutHandle #

newtype RemoteEndRef Source #

Mutable remote end pool

Constructors

RemoteEndRef
Fields theRemoteEndRef :: Maybe (TVar RemoteEndPool)

Instances

Instances details

IsOption RemoteEndRef Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: RemoteEndRef # parseValue :: String -> Maybe RemoteEndRef # optionName :: Tagged RemoteEndRef String # optionHelp :: Tagged RemoteEndRef String # showDefaultValue :: RemoteEndRef -> Maybe String # optionCLParser :: Parser RemoteEndRef #

newtype Headless Source #

Run in headless mode.

Constructors

Headless
Fields theHeadless :: Bool

Instances

Instances details

IsOption Headless Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: Headless # parseValue :: String -> Maybe Headless # optionName :: Tagged Headless String # optionHelp :: Tagged Headless String # showDefaultValue :: Headless -> Maybe String # optionCLParser :: Parser Headless #

newtype LogColors Source #

Governs whether logs are printed in color

Constructors

LogColors
Fields theLogColors :: Bool

Instances

Instances details

IsOption LogColors Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: LogColors # parseValue :: String -> Maybe LogColors # optionName :: Tagged LogColors String # optionHelp :: Tagged LogColors String # showDefaultValue :: LogColors -> Maybe String # optionCLParser :: Parser LogColors #

newtype GeckodriverLog Source #

Verbosity level passed to geckodriver

Constructors

GeckodriverLog
Fields theGeckodriverLog :: LogLevel

Instances

Instances details

IsOption GeckodriverLog Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: GeckodriverLog # parseValue :: String -> Maybe GeckodriverLog # optionName :: Tagged GeckodriverLog String # optionHelp :: Tagged GeckodriverLog String # showDefaultValue :: GeckodriverLog -> Maybe String # optionCLParser :: Parser GeckodriverLog #

newtype PrivateMode Source #

Run in private mode.

Constructors

PrivateMode
Fields thePrivateMode :: Bool

Instances

Instances details

IsOption PrivateMode Source #
Instance details Defined in Test.Tasty.WebDriver Methods defaultValue :: PrivateMode # parseValue :: String -> Maybe PrivateMode # optionName :: Tagged PrivateMode String # optionHelp :: Tagged PrivateMode String # showDefaultValue :: PrivateMode -> Maybe String # optionCLParser :: Parser PrivateMode #

module Test.Tasty.WebDriver.Config