Documentation

Create a conditional parameter based on Q Exp.

In calling a mock function, if the argument does not satisfy this condition, an error is raised.

The conditional expression is displayed in the error message.

Create a mock of a typeclasses that returns a monad.

Given a monad type class, generate the following.

• MockT instance of the given typeclass
• A stub function corresponding to a function of the original class type. The name of stub function is the name of the original function with a "_" appended.

The prefix can be changed. In that case, use makeMockWithOptions.

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

 makeMock [t|FileOperation|]

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

     result shouldBe ()
 

Create a mock of a typeclasses that returns a monad.

Given a monad type class, generate the following.

• MockT instance of the given typeclass
• A stub function corresponding to a function of the original class type. The name of stub function is the name of the original function with a "_" appended.

This function automatically wraps the return value in a monad (Implicit Monadic Return).

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

 makeAutoLiftMock [t|FileOperation|]

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

     result shouldBe ()
 

Create a partial mock of a typeclasses that returns a monad.

Given a monad type class, generate the following.

• MockT instance of the given typeclass
• A stub function corresponding to a function of the original class type. The name of stub function is the name of the original function with a "_" appended.

For functions that are not stubbed in the test, the real function is used as appropriate for the context.

The prefix can be changed. In that case, use makePartialMockWithOptions.

 class Monad m => Finder a b m | a -> b, b -> a where
   findIds :: m [a]
   findById :: a -> m b

 instance Finder Int String IO where
   findIds = pure [1, 2, 3]
   findById id = pure $ "{id: " <> show id <> "}"

 findValue :: Finder a b m => m [b]
 findValue = do
   ids <- findIds
   mapM findById ids

 makePartialMock [t|Finder|]

 spec :: Spec
 spec = do
   it "Use all real functions." do
     values <- runMockT findValue
     values shouldBe ["{id: 1}", "{id: 2}", "{id: 3}"]

   it "Only findIds should be stubbed." do
     values <- runMockT do
       _findIds [1 :: Int, 2]
       findValue
     values shouldBe ["{id: 1}", "{id: 2}"]
 

makePartialMock with `implicitMonadicReturn = True` by default.