Safe Haskell	None
Language	Haskell2010

Test.MockCat.MockT

Synopsis

newtype MockT (m :: Type -> Type) a = MockT {
- st :: StateT [Definition] m a
}
data Definition = KnownSymbol sym => Definition {
- symbol :: Proxy sym
- mock :: Mock f p
- verify :: Mock f p -> IO ()
}
runMockT :: MonadIO m => MockT m a -> m a
applyTimesIs :: forall (m :: Type -> Type). Monad m => MockT m () -> Int -> MockT m ()
neverApply :: forall (m :: Type -> Type). Monad m => MockT m () -> MockT m ()

Documentation

newtype MockT (m :: Type -> Type) a Source #

Constructors

MockT
Fields st :: StateT [Definition] m a

Instances

Instances details

MonadTrans MockT Source #
Instance details Defined in Test.MockCat.MockT Methods lift :: Monad m => m a -> MockT m a #
MonadIO m => MonadIO (MockT m) Source #
Instance details Defined in Test.MockCat.MockT Methods liftIO :: IO a -> MockT m a #
Monad m => Applicative (MockT m) Source #
Instance details Defined in Test.MockCat.MockT Methods pure :: a -> MockT m a # (<>) :: MockT m (a -> b) -> MockT m a -> MockT m b # liftA2 :: (a -> b -> c) -> MockT m a -> MockT m b -> MockT m c # (>) :: MockT m a -> MockT m b -> MockT m b # (<*) :: MockT m a -> MockT m b -> MockT m a #
Functor m => Functor (MockT m) Source #
Instance details Defined in Test.MockCat.MockT Methods fmap :: (a -> b) -> MockT m a -> MockT m b # (<$) :: a -> MockT m b -> MockT m a #
Monad m => Monad (MockT m) Source #
Instance details Defined in Test.MockCat.MockT Methods (>>=) :: MockT m a -> (a -> MockT m b) -> MockT m b # (>>) :: MockT m a -> MockT m b -> MockT m b # return :: a -> MockT m a #
MonadUnliftIO m => MonadUnliftIO (MockT m) Source #
Instance details Defined in Test.MockCat.MockT Methods withRunInIO :: ((forall a. MockT m a -> IO a) -> IO b) -> MockT m b #

data Definition Source #

Constructors

KnownSymbol sym => Definition
Fields symbol :: Proxy sym mock :: Mock f p verify :: Mock f p -> IO ()

runMockT :: MonadIO m => MockT m a -> m a Source #

Run MockT monad. After run, verification is performed to see if the stub function has been applied.

 import Test.Hspec
 import Test.MockCat
 ...

 class (Monad m) => FileOperation m where
   writeFile :: FilePath -> Text -> m ()
   readFile :: FilePath -> m Text

 operationProgram ::
   FileOperation m =>
   FilePath ->
   FilePath ->
   m ()
 operationProgram inputPath outputPath = do
   content <- readFile inputPath
   writeFile outputPath content

 makeMock [t|FileOperation|]

 spec :: Spec
 spec = do
   it "test runMockT" do
     result <- runMockT do
       _readFile $ "input.txt" |> pack "content"
       _writeFile $ "output.text" |> pack "content" |> ()
       operationProgram "input.txt" "output.text"

     result shouldBe ()

applyTimesIs :: forall (m :: Type -> Type). Monad m => MockT m () -> Int -> MockT m () Source #

Specify how many times a stub function should be applied.

 import Test.Hspec
 import Test.MockCat
 ...

 class (Monad m) => FileOperation m where
   writeFile :: FilePath -> Text -> m ()
   readFile :: FilePath -> m Text

 operationProgram ::
   FileOperation m =>
   FilePath ->
   FilePath ->
   m ()
 operationProgram inputPath outputPath = do
   content <- readFile inputPath
   when (content == pack "ng") $ writeFile outputPath content

 makeMock [t|FileOperation|]

 spec :: Spec
 spec = do
   it "test runMockT" do
     result <- runMockT do
       _readFile ("input.txt" |> pack "content")
       _writeFile ("output.text" |> pack "content" |> ()) applyTimesIs 0
       operationProgram "input.txt" "output.text"

     result shouldBe ()

neverApply :: forall (m :: Type -> Type). Monad m => MockT m () -> MockT m () Source #