Control.Monad.AWS.MockT

Concrete reader monad over Matchers

Its MonadAWS instance can be used in tests where you don't have or want your own test-app transformer:

import Amazonka.S3
import Control.Monad.AWS

spec :: Spec
spec = do
  describe "someAction" $ do
    it "works" $ do
      let matcher =
            SendMatcher (const _ ListBuckets True) -- match all calls
              $ Right
              $ newListBucketsResponse               -- return no buckets
              & listBucketsResponse_buckets ?~ []

      names <- runMockT $ withMatcher matcher $ someAction
      names shouldBe []

someAction :: (MonadIO m, MonadAWS) m => m [BucketName]
someAction = do
  resp <- send newListBuckets
  pure
    $ maybe [] (map (^. bucket_name))
    $ resp ^. listBucketsResponse_buckets

Documentation

data MockT m a

Since: 0.1.0.0

Instances

Monad m => MonadReader Matchers (MockT m)

Defined in Control.Monad.AWS.MockT

Methods

ask :: MockT m Matchers

local :: (Matchers -> Matchers) -> MockT m a -> MockT m a

reader :: (Matchers -> a) -> MockT m a

MonadIO m => MonadAWS (MockT m)

Defined in Control.Monad.AWS.MockT

Methods

sendEither :: (AWSRequest a, Typeable a, Typeable (AWSResponse a)) => a -> MockT m (Either Error (AWSResponse a))

awaitEither :: (AWSRequest a, Typeable a) => Wait a -> a -> MockT m (Either Error Accept)

withAuth :: (AuthEnv -> MockT m a) -> MockT m a

localEnv :: (Env -> Env) -> MockT m a -> MockT m a

MonadIO m => MonadIO (MockT m)

Defined in Control.Monad.AWS.MockT

Methods

liftIO :: IO a -> MockT m a

Applicative m => Applicative (MockT m)

Defined in Control.Monad.AWS.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)

Defined in Control.Monad.AWS.MockT

Methods

fmap :: (a -> b) -> MockT m a -> MockT m b

(<$) :: a -> MockT m b -> MockT m a

Monad m => Monad (MockT m)

Defined in Control.Monad.AWS.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)

Defined in Control.Monad.AWS.MockT

Methods

withRunInIO :: ((forall a. MockT m a -> IO a) -> IO b) -> MockT m b

runMockT :: MockT m a -> m a

Since: 0.1.0.0

Setting up Matchers

data Matcher where

Define a response to provide for any matched requests

Constructors

SendMatcher :: forall a. (AWSRequest a, Typeable a, Typeable (AWSResponse a)) => (a -> Bool) -> Either Error (AWSResponse a) -> Matcher

Matches calls to send where the given predicate holds

Since: 0.1.0.0

AwaitMatcher :: forall a. (AWSRequest a, Typeable a) => (Wait a -> a -> Bool) -> Either Error Accept -> Matcher

Matches calls to await where the given predicate holds

Since: 0.1.0.0

withMatcher :: (MonadReader env m, HasMatchers env) => Matcher -> m a -> m a

Add a Matcher for the duration of the block

Since: 0.1.0.0

withMatchers :: (MonadReader env m, HasMatchers env) => [Matcher] -> m a -> m a

Add multiple Matchers for the duration of the block

Since: 0.1.0.0