Test.WebDriver.Commands.Wait

Wait on expected conditions

waitUntil :: (WDSessionStateControl m, HasCallStack) => Double -> m a -> m a

Wait until either the given action succeeds or the timeout is reached. The action will be retried every .5 seconds until no ExpectFailed or FailedCommand NoSuchElement exceptions occur. If the timeout is reached, then a Timeout exception will be raised. The timeout value is expressed in seconds.

waitUntil' :: (WDSessionStateControl m, HasCallStack) => Int -> Double -> m a -> m a

Similar to waitUntil but allows you to also specify the poll frequency of the WD action. The frequency is expressed as an integer in microseconds.

waitWhile :: (WDSessionStateControl m, HasCallStack) => Double -> m a -> m ()

Like waitUntil, but retries the action until it fails or until the timeout is exceeded.

waitWhile' :: (WDSessionStateControl m, HasCallStack) => Int -> Double -> m a -> m ()

Like waitUntil', but retries the action until it either fails or until the timeout is exceeded.

Expected conditions

data ExpectFailed

An exception representing the failure of an expected condition.

Constructors

ExpectFailed String

Instances

Exception ExpectFailed

Defined in Test.WebDriver.Commands.Wait

Methods

toException :: ExpectFailed -> SomeException

fromException :: SomeException -> Maybe ExpectFailed

displayException :: ExpectFailed -> String

Show ExpectFailed

Defined in Test.WebDriver.Commands.Wait

Methods

showsPrec :: Int -> ExpectFailed -> ShowS

show :: ExpectFailed -> String

showList :: [ExpectFailed] -> ShowS

Eq ExpectFailed

Defined in Test.WebDriver.Commands.Wait

Methods

(==) :: ExpectFailed -> ExpectFailed -> Bool

(/=) :: ExpectFailed -> ExpectFailed -> Bool

expect :: (MonadBaseControl IO m, HasCallStack) => Bool -> m ()

An expected condition. This function allows you to express assertions in your explicit wait. This function raises ExpectFailed if the given boolean is False, and otherwise does nothing.

unexpected

Arguments

:: (MonadBaseControl IO m, HasCallStack)

=> String

Reason why the expected condition failed.

-> m a

throws ExpectFailed. This is nice for writing your own abstractions.

expectAny :: (Foldable f, MonadBaseControl IO m, HasCallStack) => (a -> m Bool) -> f a -> m ()

Apply a monadic predicate to every element in a list, and expect that at least one succeeds.

expectAll :: (Foldable f, MonadBaseControl IO m, HasCallStack) => (a -> m Bool) -> f a -> m ()

Apply a monadic predicate to every element in a list, and expect that all succeed.

expectNotStale :: (WebDriver wd, HasCallStack) => Element -> wd Element

expect the given Element to not be stale and returns it

expectAlertOpen :: (WebDriver wd, HasCallStack) => wd Text

expect an alert to be present on the page, and returns its text.

catchFailedCommand :: (MonadBaseControl IO m, HasCallStack) => FailedCommandType -> m a -> m a

Catches any FailedCommand exceptions with the given FailedCommandType and rethrows as ExpectFailed

Convenience functions

onTimeout :: (MonadBaseControl IO m, HasCallStack) => m a -> m a -> m a

Convenience function to catch FailedCommand Timeout exceptions and perform some action.

Example:

waitUntil 5 (getText <=< findElem $ ByCSS ".class")
   `onTimeout` return ""