| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Test.WebDriver.Waits
Synopsis
- waitUntil :: (MonadUnliftIO m, HasCallStack) => Double -> m a -> m a
- waitUntil' :: (MonadUnliftIO m, HasCallStack) => Int -> Double -> m a -> m a
- waitWhile :: (MonadUnliftIO m, HasCallStack) => Double -> m a -> m ()
- waitWhile' :: (MonadUnliftIO m, HasCallStack) => Int -> Double -> m a -> m ()
- data ExpectFailed = ExpectFailed String
- expect :: MonadIO m => Bool -> m ()
- unexpected :: MonadIO m => String -> m a
- expectAny :: (Foldable f, MonadIO m) => (a -> m Bool) -> f a -> m ()
- expectAll :: (Foldable f, MonadIO m) => (a -> m Bool) -> f a -> m ()
- expectNotStale :: (HasCallStack, WebDriver wd) => Element -> wd Element
- expectAlertOpen :: (HasCallStack, WebDriver wd) => wd Text
- catchFailedCommand :: MonadUnliftIO m => FailedCommandError -> m a -> m a
- onTimeout :: MonadUnliftIO m => m a -> m a -> m a
Wait on expected conditions
waitUntil :: (MonadUnliftIO m, HasCallStack) => Double -> m a -> m a Source #
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' :: (MonadUnliftIO m, HasCallStack) => Int -> Double -> m a -> m a Source #
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 :: (MonadUnliftIO m, HasCallStack) => Double -> m a -> m () Source #
Like waitUntil, but retries the action until it fails or until the timeout is exceeded.
waitWhile' :: (MonadUnliftIO m, HasCallStack) => Int -> Double -> m a -> m () Source #
Like waitUntil', but retries the action until it either fails or until the timeout is exceeded.
Expected conditions
data ExpectFailed Source #
An exception representing the failure of an expected condition.
Constructors
| ExpectFailed String |
Instances
| Exception ExpectFailed Source # | |
Defined in Test.WebDriver.Waits Methods toException :: ExpectFailed -> SomeException # fromException :: SomeException -> Maybe ExpectFailed # displayException :: ExpectFailed -> String # | |
| Show ExpectFailed Source # | |
Defined in Test.WebDriver.Waits Methods showsPrec :: Int -> ExpectFailed -> ShowS # show :: ExpectFailed -> String # showList :: [ExpectFailed] -> ShowS # | |
| Eq ExpectFailed Source # | |
Defined in Test.WebDriver.Waits | |
expect :: MonadIO m => Bool -> m () Source #
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.
Throws ExpectFailed. This is nice for writing your own abstractions.
expectAny :: (Foldable f, MonadIO m) => (a -> m Bool) -> f a -> m () Source #
Apply a monadic predicate to every element in a list, and expect that at least one succeeds.
expectAll :: (Foldable f, MonadIO m) => (a -> m Bool) -> f a -> m () Source #
Apply a monadic predicate to every element in a list, and expect that all succeed.
expectNotStale :: (HasCallStack, WebDriver wd) => Element -> wd Element Source #
expectAlertOpen :: (HasCallStack, WebDriver wd) => wd Text Source #
expect an alert to be present on the page, and returns its text.
catchFailedCommand :: MonadUnliftIO m => FailedCommandError -> m a -> m a Source #
Catches any FailedCommand exceptions with the given FailedCommandType and rethrows as ExpectFailed.
Convenience functions
onTimeout :: MonadUnliftIO m => m a -> m a -> m a Source #
Convenience function to catch FailedCommand Timeout exceptions and perform some action.
Example:
waitUntil 5 (getText <=< findElem $ ByCSS ".class") `onTimeout` return ""