{-# LANGUAGE CPP #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE ConstraintKinds #-}
module Test.Hspec.Core.Hooks (
before
, before_
, beforeWith
, beforeAll
, beforeAll_
, beforeAllWith
, after
, after_
, afterAll
, afterAll_
, around
, around_
, aroundWith
, aroundAll
, aroundAll_
, aroundAllWith
, mapSubject
, ignoreSubject
#ifdef TEST
, decompose
#endif
) where
import Prelude ()
import Test.Hspec.Core.Compat
import Data.CallStack (HasCallStack)
import Control.Exception (SomeException, finally, throwIO, try)
import Control.Concurrent
import Test.Hspec.Core.Example
import Test.Hspec.Core.Tree
import Test.Hspec.Core.Spec.Monad
before :: IO a -> SpecWith a -> Spec
before :: IO a -> SpecWith a -> Spec
before IO a
action = (ActionWith a -> IO ()) -> SpecWith a -> Spec
forall a. (ActionWith a -> IO ()) -> SpecWith a -> Spec
around (IO a
action IO a -> ActionWith a -> IO ()
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>=)
before_ :: IO () -> SpecWith a -> SpecWith a
before_ :: IO () -> SpecWith a -> SpecWith a
before_ IO ()
action = (IO () -> IO ()) -> SpecWith a -> SpecWith a
forall a. (IO () -> IO ()) -> SpecWith a -> SpecWith a
around_ (IO ()
action IO () -> IO () -> IO ()
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>>)
beforeWith :: (b -> IO a) -> SpecWith a -> SpecWith b
beforeWith :: (b -> IO a) -> SpecWith a -> SpecWith b
beforeWith b -> IO a
action = (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
forall a b.
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith ((ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b)
-> (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
forall a b. (a -> b) -> a -> b
$ \ActionWith a
e b
x -> b -> IO a
action b
x IO a -> ActionWith a -> IO ()
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= ActionWith a
e
beforeAll :: HasCallStack => IO a -> SpecWith a -> Spec
beforeAll :: IO a -> SpecWith a -> Spec
beforeAll IO a
action SpecWith a
spec = do
MVar (Memoized a)
mvar <- IO (MVar (Memoized a)) -> SpecM () (MVar (Memoized a))
forall r a. IO r -> SpecM a r
runIO (Memoized a -> IO (MVar (Memoized a))
forall a. a -> IO (MVar a)
newMVar Memoized a
forall a. Memoized a
Empty)
IO a -> SpecWith a -> Spec
forall a. IO a -> SpecWith a -> Spec
before (MVar (Memoized a) -> IO a -> IO a
forall a. HasCallStack => MVar (Memoized a) -> IO a -> IO a
memoize MVar (Memoized a)
mvar IO a
action) SpecWith a
spec
beforeAll_ :: HasCallStack => IO () -> SpecWith a -> SpecWith a
beforeAll_ :: IO () -> SpecWith a -> SpecWith a
beforeAll_ IO ()
action SpecWith a
spec = do
MVar (Memoized ())
mvar <- IO (MVar (Memoized ())) -> SpecM a (MVar (Memoized ()))
forall r a. IO r -> SpecM a r
runIO (Memoized () -> IO (MVar (Memoized ()))
forall a. a -> IO (MVar a)
newMVar Memoized ()
forall a. Memoized a
Empty)
IO () -> SpecWith a -> SpecWith a
forall a. IO () -> SpecWith a -> SpecWith a
before_ (MVar (Memoized ()) -> IO () -> IO ()
forall a. HasCallStack => MVar (Memoized a) -> IO a -> IO a
memoize MVar (Memoized ())
mvar IO ()
action) SpecWith a
spec
beforeAllWith :: HasCallStack => (b -> IO a) -> SpecWith a -> SpecWith b
beforeAllWith :: (b -> IO a) -> SpecWith a -> SpecWith b
beforeAllWith b -> IO a
action SpecWith a
spec = do
MVar (Memoized a)
mvar <- IO (MVar (Memoized a)) -> SpecM b (MVar (Memoized a))
forall r a. IO r -> SpecM a r
runIO (Memoized a -> IO (MVar (Memoized a))
forall a. a -> IO (MVar a)
newMVar Memoized a
forall a. Memoized a
Empty)
(b -> IO a) -> SpecWith a -> SpecWith b
forall b a. (b -> IO a) -> SpecWith a -> SpecWith b
beforeWith (MVar (Memoized a) -> IO a -> IO a
forall a. HasCallStack => MVar (Memoized a) -> IO a -> IO a
memoize MVar (Memoized a)
mvar (IO a -> IO a) -> (b -> IO a) -> b -> IO a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. b -> IO a
action) SpecWith a
spec
data Memoized a =
Empty
| Memoized a
| Failed SomeException
memoize :: HasCallStack => MVar (Memoized a) -> IO a -> IO a
memoize :: MVar (Memoized a) -> IO a -> IO a
memoize MVar (Memoized a)
mvar IO a
action = do
Either SomeException a
result <- MVar (Memoized a)
-> (Memoized a -> IO (Memoized a, Either SomeException a))
-> IO (Either SomeException a)
forall a b. MVar a -> (a -> IO (a, b)) -> IO b
modifyMVar MVar (Memoized a)
mvar ((Memoized a -> IO (Memoized a, Either SomeException a))
-> IO (Either SomeException a))
-> (Memoized a -> IO (Memoized a, Either SomeException a))
-> IO (Either SomeException a)
forall a b. (a -> b) -> a -> b
$ \Memoized a
ma -> case Memoized a
ma of
Memoized a
Empty -> do
Either SomeException a
a <- IO a -> IO (Either SomeException a)
forall e a. Exception e => IO a -> IO (Either e a)
try IO a
action
(Memoized a, Either SomeException a)
-> IO (Memoized a, Either SomeException a)
forall (m :: * -> *) a. Monad m => a -> m a
return ((SomeException -> Memoized a)
-> (a -> Memoized a) -> Either SomeException a -> Memoized a
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either SomeException -> Memoized a
forall a. SomeException -> Memoized a
Failed a -> Memoized a
forall a. a -> Memoized a
Memoized Either SomeException a
a, Either SomeException a
a)
Memoized a
a -> (Memoized a, Either SomeException a)
-> IO (Memoized a, Either SomeException a)
forall (m :: * -> *) a. Monad m => a -> m a
return (Memoized a
ma, a -> Either SomeException a
forall a b. b -> Either a b
Right a
a)
Failed SomeException
_ -> ResultStatus -> IO (Memoized a, Either SomeException a)
forall e a. Exception e => e -> IO a
throwIO (Maybe Location -> Maybe String -> ResultStatus
Pending Maybe Location
forall a. Maybe a
Nothing (String -> Maybe String
forall a. a -> Maybe a
Just (String -> Maybe String) -> String -> Maybe String
forall a b. (a -> b) -> a -> b
$ String
"exception in " String -> String -> String
forall a. Semigroup a => a -> a -> a
<> String
-> ((String, Location) -> String)
-> Maybe (String, Location)
-> String
forall b a. b -> (a -> b) -> Maybe a -> b
maybe String
"beforeAll" (String, Location) -> String
forall a b. (a, b) -> a
fst Maybe (String, Location)
HasCallStack => Maybe (String, Location)
callSite String -> String -> String
forall a. Semigroup a => a -> a -> a
<> String
"-hook (see previous failure)"))
(SomeException -> IO a)
-> (a -> IO a) -> Either SomeException a -> IO a
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
either SomeException -> IO a
forall e a. Exception e => e -> IO a
throwIO a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Either SomeException a
result
after :: ActionWith a -> SpecWith a -> SpecWith a
after :: ActionWith a -> SpecWith a -> SpecWith a
after ActionWith a
action = (ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a
forall a b.
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith ((ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a)
-> (ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a
forall a b. (a -> b) -> a -> b
$ \ActionWith a
e a
x -> ActionWith a
e a
x IO () -> IO () -> IO ()
forall a b. IO a -> IO b -> IO a
`finally` ActionWith a
action a
x
after_ :: IO () -> SpecWith a -> SpecWith a
after_ :: IO () -> SpecWith a -> SpecWith a
after_ IO ()
action = ActionWith a -> SpecWith a -> SpecWith a
forall a. ActionWith a -> SpecWith a -> SpecWith a
after (ActionWith a -> SpecWith a -> SpecWith a)
-> ActionWith a -> SpecWith a -> SpecWith a
forall a b. (a -> b) -> a -> b
$ \a
_ -> IO ()
action
around :: (ActionWith a -> IO ()) -> SpecWith a -> Spec
around :: (ActionWith a -> IO ()) -> SpecWith a -> Spec
around ActionWith a -> IO ()
action = (ActionWith a -> ActionWith ()) -> SpecWith a -> Spec
forall a b.
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith ((ActionWith a -> ActionWith ()) -> SpecWith a -> Spec)
-> (ActionWith a -> ActionWith ()) -> SpecWith a -> Spec
forall a b. (a -> b) -> a -> b
$ \ActionWith a
e () -> ActionWith a -> IO ()
action ActionWith a
e
afterAll :: HasCallStack => ActionWith a -> SpecWith a -> SpecWith a
afterAll :: ActionWith a -> SpecWith a -> SpecWith a
afterAll ActionWith a
action = (ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a
forall a b.
HasCallStack =>
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundAllWith (\ ActionWith a
hook a
a -> ActionWith a
hook a
a IO () -> IO () -> IO ()
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> ActionWith a
action a
a)
afterAll_ :: HasCallStack => IO () -> SpecWith a -> SpecWith a
afterAll_ :: IO () -> SpecWith a -> SpecWith a
afterAll_ IO ()
action = ([SpecTree a] -> [SpecTree a]) -> SpecWith a -> SpecWith a
forall a b r.
([SpecTree a] -> [SpecTree b]) -> SpecM a r -> SpecM b r
mapSpecForest (SpecTree a -> [SpecTree a]
forall (m :: * -> *) a. Monad m => a -> m a
return (SpecTree a -> [SpecTree a])
-> ([SpecTree a] -> SpecTree a) -> [SpecTree a] -> [SpecTree a]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe (String, Location) -> IO () -> [SpecTree a] -> SpecTree a
forall c a. Maybe (String, Location) -> c -> [Tree c a] -> Tree c a
NodeWithCleanup Maybe (String, Location)
HasCallStack => Maybe (String, Location)
callSite IO ()
action)
around_ :: (IO () -> IO ()) -> SpecWith a -> SpecWith a
around_ :: (IO () -> IO ()) -> SpecWith a -> SpecWith a
around_ IO () -> IO ()
action = (ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a
forall a b.
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith ((ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a)
-> (ActionWith a -> ActionWith a) -> SpecWith a -> SpecWith a
forall a b. (a -> b) -> a -> b
$ \ActionWith a
e a
a -> IO () -> IO ()
action (ActionWith a
e a
a)
aroundWith :: (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith :: (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith = (Item a -> Item b) -> SpecWith a -> SpecWith b
forall a b. (Item a -> Item b) -> SpecWith a -> SpecWith b
mapSpecItem_ ((Item a -> Item b) -> SpecWith a -> SpecWith b)
-> ((ActionWith a -> ActionWith b) -> Item a -> Item b)
-> (ActionWith a -> ActionWith b)
-> SpecWith a
-> SpecWith b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (ActionWith a -> ActionWith b) -> Item a -> Item b
forall a b. (ActionWith a -> ActionWith b) -> Item a -> Item b
modifyAroundAction
modifyAroundAction :: (ActionWith a -> ActionWith b) -> Item a -> Item b
modifyAroundAction :: (ActionWith a -> ActionWith b) -> Item a -> Item b
modifyAroundAction ActionWith a -> ActionWith b
action item :: Item a
item@Item{itemExample :: forall a.
Item a
-> Params
-> (ActionWith a -> IO ())
-> ProgressCallback
-> IO Result
itemExample = Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
e} =
Item a
item{ itemExample :: Params -> (ActionWith b -> IO ()) -> ProgressCallback -> IO Result
itemExample = \Params
params ActionWith b -> IO ()
aroundAction -> Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
e Params
params (ActionWith b -> IO ()
aroundAction (ActionWith b -> IO ())
-> (ActionWith a -> ActionWith b) -> ActionWith a -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ActionWith a -> ActionWith b
action) }
aroundAll :: HasCallStack => (ActionWith a -> IO ()) -> SpecWith a -> Spec
aroundAll :: (ActionWith a -> IO ()) -> SpecWith a -> Spec
aroundAll ActionWith a -> IO ()
action = (ActionWith a -> ActionWith ()) -> SpecWith a -> Spec
forall a b.
HasCallStack =>
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundAllWith ((ActionWith a -> ActionWith ()) -> SpecWith a -> Spec)
-> (ActionWith a -> ActionWith ()) -> SpecWith a -> Spec
forall a b. (a -> b) -> a -> b
$ \ ActionWith a
e () -> ActionWith a -> IO ()
action ActionWith a
e
aroundAll_ :: HasCallStack => (IO () -> IO ()) -> SpecWith a -> SpecWith a
aroundAll_ :: (IO () -> IO ()) -> SpecWith a -> SpecWith a
aroundAll_ IO () -> IO ()
action SpecWith a
spec = do
(ActionWith ()
acquire, IO ()
release) <- IO (ActionWith (), IO ()) -> SpecM a (ActionWith (), IO ())
forall r a. IO r -> SpecM a r
runIO (IO (ActionWith (), IO ()) -> SpecM a (ActionWith (), IO ()))
-> IO (ActionWith (), IO ()) -> SpecM a (ActionWith (), IO ())
forall a b. (a -> b) -> a -> b
$ (ActionWith () -> ActionWith ()) -> IO (ActionWith (), IO ())
forall a b. ((a -> IO ()) -> b -> IO ()) -> IO (b -> IO a, IO ())
decompose (IO () -> IO ()
action (IO () -> IO ()) -> ActionWith () -> ActionWith ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
.)
IO () -> SpecWith a -> SpecWith a
forall a. HasCallStack => IO () -> SpecWith a -> SpecWith a
beforeAll_ (ActionWith ()
acquire ()) (SpecWith a -> SpecWith a) -> SpecWith a -> SpecWith a
forall a b. (a -> b) -> a -> b
$ IO () -> SpecWith a -> SpecWith a
forall a. HasCallStack => IO () -> SpecWith a -> SpecWith a
afterAll_ IO ()
release SpecWith a
spec
aroundAllWith :: forall a b. HasCallStack => (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundAllWith :: (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundAllWith ActionWith a -> ActionWith b
action SpecWith a
spec = do
(b -> IO a
acquire, IO ()
release) <- IO (b -> IO a, IO ()) -> SpecM b (b -> IO a, IO ())
forall r a. IO r -> SpecM a r
runIO (IO (b -> IO a, IO ()) -> SpecM b (b -> IO a, IO ()))
-> IO (b -> IO a, IO ()) -> SpecM b (b -> IO a, IO ())
forall a b. (a -> b) -> a -> b
$ (ActionWith a -> ActionWith b) -> IO (b -> IO a, IO ())
forall a b. ((a -> IO ()) -> b -> IO ()) -> IO (b -> IO a, IO ())
decompose ActionWith a -> ActionWith b
action
(b -> IO a) -> SpecWith a -> SpecWith b
forall b a. HasCallStack => (b -> IO a) -> SpecWith a -> SpecWith b
beforeAllWith b -> IO a
acquire (SpecWith a -> SpecWith b) -> SpecWith a -> SpecWith b
forall a b. (a -> b) -> a -> b
$ IO () -> SpecWith a -> SpecWith a
forall a. HasCallStack => IO () -> SpecWith a -> SpecWith a
afterAll_ IO ()
release SpecWith a
spec
data Acquired a = Acquired a | ExceptionDuringAcquire SomeException
data Released = Released | ExceptionDuringRelease SomeException
decompose :: forall a b. ((a -> IO ()) -> b -> IO ()) -> IO (b -> IO a, IO ())
decompose :: ((a -> IO ()) -> b -> IO ()) -> IO (b -> IO a, IO ())
decompose (a -> IO ()) -> b -> IO ()
action = do
MVar ()
doCleanupNow <- IO (MVar ())
forall a. IO (MVar a)
newEmptyMVar
MVar (Acquired a)
acquired <- IO (MVar (Acquired a))
forall a. IO (MVar a)
newEmptyMVar
MVar Released
released <- IO (MVar Released)
forall a. IO (MVar a)
newEmptyMVar
let
notify :: Either SomeException () -> IO ()
notify :: Either SomeException () -> IO ()
notify Either SomeException ()
r = case Either SomeException ()
r of
Left SomeException
err -> do
Bool
exceptionDuringAcquire <- MVar (Acquired a) -> Acquired a -> IO Bool
forall a. MVar a -> a -> IO Bool
tryPutMVar MVar (Acquired a)
acquired (SomeException -> Acquired a
forall a. SomeException -> Acquired a
ExceptionDuringAcquire SomeException
err)
MVar Released -> Released -> IO ()
forall a. MVar a -> a -> IO ()
putMVar MVar Released
released (Released -> IO ()) -> Released -> IO ()
forall a b. (a -> b) -> a -> b
$ if Bool
exceptionDuringAcquire then Released
Released else SomeException -> Released
ExceptionDuringRelease SomeException
err
Right () -> do
MVar Released -> Released -> IO ()
forall a. MVar a -> a -> IO ()
putMVar MVar Released
released Released
Released
forkWorker :: b -> IO ()
forkWorker :: b -> IO ()
forkWorker b
b = IO ThreadId -> IO ()
forall (f :: * -> *) a. Functor f => f a -> f ()
void (IO ThreadId -> IO ()) -> (IO () -> IO ThreadId) -> IO () -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (IO () -> (Either SomeException () -> IO ()) -> IO ThreadId)
-> (Either SomeException () -> IO ()) -> IO () -> IO ThreadId
forall a b c. (a -> b -> c) -> b -> a -> c
flip IO () -> (Either SomeException () -> IO ()) -> IO ThreadId
forall a. IO a -> (Either SomeException a -> IO ()) -> IO ThreadId
forkFinally Either SomeException () -> IO ()
notify (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$ do
((a -> IO ()) -> b -> IO ()) -> b -> (a -> IO ()) -> IO ()
forall a b c. (a -> b -> c) -> b -> a -> c
flip (a -> IO ()) -> b -> IO ()
action b
b ((a -> IO ()) -> IO ()) -> (a -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \ a
a -> do
MVar (Acquired a) -> Acquired a -> IO ()
forall a. MVar a -> a -> IO ()
putMVar MVar (Acquired a)
acquired (a -> Acquired a
forall a. a -> Acquired a
Acquired a
a)
MVar () -> IO ()
waitFor MVar ()
doCleanupNow
acquire :: b -> IO a
acquire :: b -> IO a
acquire b
b = do
b -> IO ()
forkWorker b
b
Acquired a
r <- MVar (Acquired a) -> IO (Acquired a)
forall a. MVar a -> IO a
readMVar MVar (Acquired a)
acquired
case Acquired a
r of
Acquired a
a -> a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return a
a
ExceptionDuringAcquire SomeException
err -> SomeException -> IO a
forall e a. Exception e => e -> IO a
throwIO SomeException
err
release :: IO ()
release :: IO ()
release = do
MVar () -> IO ()
signal MVar ()
doCleanupNow
Released
r <- MVar Released -> IO Released
forall a. MVar a -> IO a
takeMVar MVar Released
released
case Released
r of
Released
Released -> ActionWith ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()
ExceptionDuringRelease SomeException
err -> SomeException -> IO ()
forall e a. Exception e => e -> IO a
throwIO SomeException
err
(b -> IO a, IO ()) -> IO (b -> IO a, IO ())
forall (m :: * -> *) a. Monad m => a -> m a
return (b -> IO a
acquire, IO ()
release)
type BinarySemaphore = MVar ()
signal :: BinarySemaphore -> IO ()
signal :: MVar () -> IO ()
signal = (MVar () -> ActionWith ()) -> () -> MVar () -> IO ()
forall a b c. (a -> b -> c) -> b -> a -> c
flip MVar () -> ActionWith ()
forall a. MVar a -> a -> IO ()
putMVar ()
waitFor :: BinarySemaphore -> IO ()
waitFor :: MVar () -> IO ()
waitFor = MVar () -> IO ()
forall a. MVar a -> IO a
takeMVar
mapSubject :: (b -> a) -> SpecWith a -> SpecWith b
mapSubject :: (b -> a) -> SpecWith a -> SpecWith b
mapSubject b -> a
f = (ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
forall a b.
(ActionWith a -> ActionWith b) -> SpecWith a -> SpecWith b
aroundWith (ActionWith a -> (b -> a) -> ActionWith b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. b -> a
f)
ignoreSubject :: SpecWith () -> SpecWith a
ignoreSubject :: Spec -> SpecWith a
ignoreSubject = (a -> ()) -> Spec -> SpecWith a
forall b a. (b -> a) -> SpecWith a -> SpecWith b
mapSubject (() -> a -> ()
forall a b. a -> b -> a
const ())