Test.Syd.Webdriver

Defining webdriver tests

type WebdriverSpec app = TestDef '[SeleniumServerHandle, Manager] (WebdriverTestEnv app)

Type synonym for webdriver tests

webdriverSpec :: (Manager -> SetupFunc (URI, app)) -> WebdriverSpec app -> Spec

newtype WebdriverTestM app a

A monad for webdriver tests. This instantiates the WebDriver class, as well as the IsTest class.

Constructors

WebdriverTestM

Fields

• unWebdriverTestM :: ReaderT (WebdriverTestEnv app) WD a

Instances

MonadBaseControl IO (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Associated Types

type StM (WebdriverTestM app) a

Methods

liftBaseWith :: (RunInBase (WebdriverTestM app) IO -> IO a) -> WebdriverTestM app a

restoreM :: StM (WebdriverTestM app) a -> WebdriverTestM app a

MonadBase IO (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

liftBase :: IO α -> WebdriverTestM app α

MonadIO (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

liftIO :: IO a -> WebdriverTestM app a

Applicative (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

pure :: a -> WebdriverTestM app a

(<*>) :: WebdriverTestM app (a -> b) -> WebdriverTestM app a -> WebdriverTestM app b

liftA2 :: (a -> b -> c) -> WebdriverTestM app a -> WebdriverTestM app b -> WebdriverTestM app c

(*>) :: WebdriverTestM app a -> WebdriverTestM app b -> WebdriverTestM app b

(<*) :: WebdriverTestM app a -> WebdriverTestM app b -> WebdriverTestM app a

Functor (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

fmap :: (a -> b) -> WebdriverTestM app a -> WebdriverTestM app b

(<$) :: a -> WebdriverTestM app b -> WebdriverTestM app a

Monad (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

(>>=) :: WebdriverTestM app a -> (a -> WebdriverTestM app b) -> WebdriverTestM app b

(>>) :: WebdriverTestM app a -> WebdriverTestM app b -> WebdriverTestM app b

return :: a -> WebdriverTestM app a

WebDriver (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

doCommand :: (HasCallStack, ToJSON a, FromJSON b) => Method -> Text -> a -> WebdriverTestM app b

WDSessionState (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

getSession :: WebdriverTestM app WDSession

putSession :: WDSession -> WebdriverTestM app ()

MonadReader (WebdriverTestEnv app) (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

ask :: WebdriverTestM app (WebdriverTestEnv app)

local :: (WebdriverTestEnv app -> WebdriverTestEnv app) -> WebdriverTestM app a -> WebdriverTestM app a

reader :: (WebdriverTestEnv app -> a) -> WebdriverTestM app a

IsTest (WebdriverTestM app (GoldenTest a))

Defined in Test.Syd.Webdriver

Associated Types

type Arg1 (WebdriverTestM app (GoldenTest a))

type Arg2 (WebdriverTestM app (GoldenTest a))

Methods

runTest :: WebdriverTestM app (GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (WebdriverTestM app (GoldenTest a)) -> Arg2 (WebdriverTestM app (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (WebdriverTestM app ())

Defined in Test.Syd.Webdriver

Associated Types

type Arg1 (WebdriverTestM app ())

type Arg2 (WebdriverTestM app ())

Methods

runTest :: WebdriverTestM app () -> TestRunSettings -> ProgressReporter -> ((Arg1 (WebdriverTestM app ()) -> Arg2 (WebdriverTestM app ()) -> IO ()) -> IO ()) -> IO TestRunResult

type StM (WebdriverTestM app) a

Defined in Test.Syd.Webdriver

type StM (WebdriverTestM app) a = StM (ReaderT (WebdriverTestEnv app) WD) a

type Arg1 (WebdriverTestM app (GoldenTest a))

Defined in Test.Syd.Webdriver

type Arg1 (WebdriverTestM app (GoldenTest a)) = ()

type Arg1 (WebdriverTestM app ())

Defined in Test.Syd.Webdriver

type Arg1 (WebdriverTestM app ()) = ()

type Arg2 (WebdriverTestM app (GoldenTest a))

Defined in Test.Syd.Webdriver

type Arg2 (WebdriverTestM app (GoldenTest a)) = WebdriverTestEnv app

type Arg2 (WebdriverTestM app ())

Defined in Test.Syd.Webdriver

type Arg2 (WebdriverTestM app ()) = WebdriverTestEnv app

runWebdriverTestM :: WebdriverTestEnv app -> WebdriverTestM app a -> IO a

Run a webdriver test.

data WebdriverTestEnv app

Constructors

WebdriverTestEnv

Fields

• webdriverTestEnvURI :: !URI

  The base url of the app we test, so that we can test external sites just like local ones.

• webdriverTestEnvConfig :: !WDConfig

  The webdriver configuration

• webdriverTestEnvApp :: !app

  The app that we'll test.

  You can put any piece of data here. In the case of yesod tests, we'll put an App here.

Instances

MonadReader (WebdriverTestEnv app) (WebdriverTestM app)

Defined in Test.Syd.Webdriver

Methods

ask :: WebdriverTestM app (WebdriverTestEnv app)

local :: (WebdriverTestEnv app -> WebdriverTestEnv app) -> WebdriverTestM app a -> WebdriverTestM app a

reader :: (WebdriverTestEnv app -> a) -> WebdriverTestM app a

webdriverTestEnvSetupFunc :: SeleniumServerHandle -> Manager -> URI -> app -> SetupFunc (WebdriverTestEnv app)

Set up a WebdriverTestEnv for your app by readying a webdriver session

Writing webdriver tests

openPath :: String -> WebdriverTestM app ()

Open a page on the URI in the WebdriverTestEnv.

setWindowSize

Arguments

:: (HasCallStack, WebDriver wd)

=> (Word, Word)

(Width, Height)

-> wd ()

Running a selenium server

data SeleniumServerHandle

Constructors

SeleniumServerHandle

Fields

• seleniumServerHandlePort :: PortNumber

seleniumServerSetupFunc :: SetupFunc SeleniumServerHandle

Run, and clean up, a selenium server