Test.Sandwich.WebDriver

Introducing a WebDriver server

introduceWebDriver :: BaseMonadContext m context => WdOptions -> SpecFree (LabelValue "webdriver" WebDriver :> context) m () -> SpecFree context m ()

This is the main introduce method for creating a WebDriver.

introduceWebDriverOptions :: forall a context m. (BaseMonadContext m context, HasCommandLineOptions context a) => WdOptions -> SpecFree (LabelValue "webdriver" WebDriver :> context) m () -> SpecFree context m ()

Same as introduceWebDriver, but merges command line options into the WdOptions.

addCommandLineOptionsToWdOptions :: CommandLineOptions a -> WdOptions -> WdOptions

Merge the options from the CommandLineOptions into some WdOptions.

Running an example in a given session

withSession :: forall m context a. WebDriverMonad m context => Session -> ExampleT (ContextWithSession context) m a -> ExampleT context m a

Run a given example using a given Selenium session.

withSession1 :: WebDriverMonad m context => ExampleT (ContextWithSession context) m a -> ExampleT context m a

Convenience function. withSession1 = withSession "session1"

withSession2 :: WebDriverMonad m context => ExampleT (ContextWithSession context) m a -> ExampleT context m a

Convenience function. withSession2 = withSession "session2"

Managing sessions

getSessions :: (WebDriverMonad m context, MonadReader context m, HasLabel context "webdriver" WebDriver) => m [Session]

Get all existing session names

closeCurrentSession :: (HasCallStack, MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadReader context m, HasLabel context "webdriver" WebDriver, HasLabel context "webdriverSession" WebDriverSession) => m ()

Close the current session

closeSession :: (HasCallStack, MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => Session -> WebDriver -> m ()

Close the given sessions

closeAllSessions :: (HasCallStack, MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => WebDriver -> m ()

Close all sessions

closeAllSessionsExcept :: (HasCallStack, MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => [Session] -> WebDriver -> m ()

Close all sessions except those listed

type Session = String

Session is just a String name.

Lower-level allocation functions

allocateWebDriver :: (HasBaseContext context, BaseMonad m) => WdOptions -> ExampleT context m WebDriver

Allocate a WebDriver using the given options.

allocateWebDriver' :: FilePath -> WdOptions -> IO WebDriver

Allocate a WebDriver using the given options and putting logs under the given path.

cleanupWebDriver :: (HasBaseContext context, BaseMonad m) => WebDriver -> ExampleT context m ()

Clean up the given WebDriver.

cleanupWebDriver' :: WebDriver -> IO ()

Clean up the given WebDriver without logging.

Re-exports

module Test.Sandwich.WebDriver.Class

module Test.Sandwich.WebDriver.Config

module Test.Sandwich.WebDriver.Types