Modulehedgehog-extras-0.10.1.0Haskell2010

Hedgehog.Extras.Test.TestWatchdog

This module provides a test watchdog - an utility monitoring test cases and killing them if they don't finish in time. Watchdog thread runs in the background, and after specified timeout, it throws WatchdogException to the target thread. A user is able to kickWatchdog, which delays the killing and poisonWatchdog which stops the watchdog.

To wrap a test case in a watchdog just use

runWithWatchdog watchdogConfig $ \watchdog -> do
  -- body of your test case

3 types
8 values

Packagehedgehog-extras-0.10.1.0
Exports11
LanguageHaskell2010
LicenceApache-2.0
SourceTestWatchdog.hs

Wrap in watchdog

4 declarations

valuerunWithWatchdog_

:: (HasCallStack, MonadBaseControl IO m)
=> WatchdogConfig
configuration
-> (HasCallStack => m a)
a test case to be wrapped in watchdog
-> m a

Execute a test case with a watchdog.

valuerunWithWatchdog

:: (HasCallStack, MonadBaseControl IO m)
=> WatchdogConfig
configuration
-> (HasCallStack => Watchdog -> m a)
a test case to be wrapped in watchdog
-> m a

Execute a test case with a watchdog.

valuerunWithDefaultWatchdog_

:: (HasCallStack, MonadBaseControl IO m)
=> (HasCallStack => m a)
a test case to be wrapped in watchdog
-> m a

Execute a test case with watchdog with default config.

valuerunWithDefaultWatchdog

:: (HasCallStack, MonadBaseControl IO m)
=> (HasCallStack => Watchdog -> m a)
a test case to be wrapped in watchdog
-> m a

Execute a test case with watchdog with default config.

Watchdog control

2 declarations

valuekickWatchdog :: MonadIO m => Watchdog -> m ()

Enqueue a kick for the watchdog. It will extend the timeout by another one defined in the watchdog configuration.

valuepoisonWatchdog :: MonadIO m => Watchdog -> m ()

Enqueue a poison pill for the watchdog. It will stop the watchdog after all timeouts.

Types

3 declarations

datadata Watchdog

A watchdog instance. See the module header for more detailed description.

Instances1Show

Show WatchdogDefined in hedgehog-extras-0.10.1.0 · Hedgehog.Extras.Test.TestWatchdog

newtypenewtype WatchdogConfig

Configuration for the watchdog.

Constructors

WatchdogConfig
- watchdogTimeout :: Int
  Timeout in seconds after which watchdog will kill the test case

newtypenewtype WatchdogException

An exception thrown to the test case thread.

Constructors

WatchdogException
- timeElapsed :: NominalDiffTime

Instances2Show, Exception

Show WatchdogExceptionDefined in hedgehog-extras-0.10.1.0 · Hedgehog.Extras.Test.TestWatchdog
Exception WatchdogExceptionDefined in hedgehog-extras-0.10.1.0 · Hedgehog.Extras.Test.TestWatchdog

Low level API

2 declarations

There is also a lower-level API available, giving the ability to provide target thread ID, which watchdog will try to kill.

valuemakeWatchdog

:: MonadBase IO m
=> WatchdogConfig
-> ThreadId
thread id which will get killed after all kicks expire
-> m Watchdog

Create manually a new watchdog, providing the target thread ID. After all watchdog timeouts expire, the target thread will get WatchdogException thrown to it asynchronously (using throwTo).

valuerunWatchdog :: MonadBase IO m => Watchdog -> m ()

Run watchdog in a loop in the current thread. Usually this function should be used with withAsync to run it in the background.