Safe Haskell	None
Language	Haskell2010

Test.Sandwich.Contexts.FakeSmtpServer

Contents

Introduce a fake SMTP server
Bracket-style version
Nix derivation
Types

Description

This module provides functions for introducing a mock SMTP server, represented by FakeSmtpServer.

If you send emails to this server, you can read them out to confirm they were received correctly.

Synopsis

introduceFakeSmtpServerNix :: forall context (m :: Type -> Type). (BaseMonad context m, HasNixContext context) => FakeSmtpServerOptions -> SpecFree (FakeSmtpServerContext context) m () -> SpecFree context m ()
introduceFakeSmtpServerNix' :: forall context (m :: Type -> Type). (BaseMonad context m, HasNixContext context) => Text -> FakeSmtpServerOptions -> SpecFree (FakeSmtpServerContext context) m () -> SpecFree context m ()
introduceFakeSmtpServer :: forall context (m :: Type -> Type). (BaseMonad context m, HasFile context "fake-smtp-server") => FakeSmtpServerOptions -> SpecFree (LabelValue "fakeSmtpServer" FakeSmtpServer :> context) m () -> SpecFree context m ()
withFakeSMTPServer :: (BaseMonad context m, MonadReader context m, MonadLoggerIO m, HasFile context "fake-smtp-server") => FakeSmtpServerOptions -> (FakeSmtpServer -> m [Result]) -> m ()
fakeSmtpServerDerivation :: Text
fakeSmtpServer :: Label "fakeSmtpServer" FakeSmtpServer
data FakeSmtpServerOptions = FakeSmtpServerOptions {
- fakeSmtpServerAuth :: Maybe (String, String)
- fakeSmtpServerAllowInsecureLogin :: Bool
}
defaultFakeSmtpServerOptions :: FakeSmtpServerOptions
data FakeSmtpServer = FakeSmtpServer {
- fakeSmtpServerHostname :: HostName
- fakeSmtpServerSmtpPort :: PortNumber
- fakeSmtpServerGetEmails :: forall (m :: Type -> Type). (MonadLoggerIO m, MonadUnliftIO m, MonadThrow m) => m [EmailInfo]
}
data EmailInfo = EmailInfo {
- emailInfoAttachments :: Value
- emailInfoText :: Text
- emailInfoTextAsHtml :: Text
- emailInfoSubject :: Text
- emailInfoDate :: Maybe Text
- emailInfoTo :: Value
- emailInfoFrom :: Value
- emailInfoMessageId :: Maybe Text
- emailInfoHtml :: Text
}

Introduce a fake SMTP server

introduceFakeSmtpServerNix Source #

Arguments

:: forall context (m :: Type -> Type). (BaseMonad context m, HasNixContext context)
=> FakeSmtpServerOptions	Options
-> SpecFree (FakeSmtpServerContext context) m ()	Child spec
-> SpecFree context m ()	Parent spec

Introduce a fake SMTP server using a Nix derivation hardcoded into this package as fakeSmtpServerDerivation.

introduceFakeSmtpServerNix' Source #

Arguments

:: forall context (m :: Type -> Type). (BaseMonad context m, HasNixContext context)
=> Text	Nix derivation
-> FakeSmtpServerOptions	Options
-> SpecFree (FakeSmtpServerContext context) m ()	Child spec
-> SpecFree context m ()	Parent spec

Same as introduceFakeSmtpServerNix, but allows you to specify the derivation.

introduceFakeSmtpServer Source #

Arguments

:: forall context (m :: Type -> Type). (BaseMonad context m, HasFile context "fake-smtp-server")
=> FakeSmtpServerOptions	Options
-> SpecFree (LabelValue "fakeSmtpServer" FakeSmtpServer :> context) m ()
-> SpecFree context m ()

Introduce a fake SMTP server given a binary already available via HasFile.

Bracket-style version

withFakeSMTPServer Source #

Arguments

:: (BaseMonad context m, MonadReader context m, MonadLoggerIO m, HasFile context "fake-smtp-server")
=> FakeSmtpServerOptions	Options
-> (FakeSmtpServer -> m [Result])
-> m ()

Bracket-style version of introduceFakeSmtpServer.

Nix derivation

fakeSmtpServerDerivation :: Text Source #

A Nix derivation to build a fake Node.js SMTP server, based on https://github.com/ReachFive/fake-smtp-server.

Types

fakeSmtpServer :: Label "fakeSmtpServer" FakeSmtpServer Source #

data FakeSmtpServerOptions Source #

Constructors

FakeSmtpServerOptions
Fields fakeSmtpServerAuth :: Maybe (String, String) Username and password. If not provided, the server will not be configured with authentication. fakeSmtpServerAllowInsecureLogin :: Bool Whether to allow insecure login.

Instances

Instances details

Show FakeSmtpServerOptions Source #
Instance details Defined in Test.Sandwich.Contexts.FakeSmtpServer Methods showsPrec :: Int -> FakeSmtpServerOptions -> ShowS # show :: FakeSmtpServerOptions -> String # showList :: [FakeSmtpServerOptions] -> ShowS #
Eq FakeSmtpServerOptions Source #
Instance details Defined in Test.Sandwich.Contexts.FakeSmtpServer Methods (==) :: FakeSmtpServerOptions -> FakeSmtpServerOptions -> Bool # (/=) :: FakeSmtpServerOptions -> FakeSmtpServerOptions -> Bool #

defaultFakeSmtpServerOptions :: FakeSmtpServerOptions Source #

data FakeSmtpServer Source #

Constructors

FakeSmtpServer
Fields fakeSmtpServerHostname :: HostName The hostname of the fake SMTP server. fakeSmtpServerSmtpPort :: PortNumber The port on which the fake SMTP server is running. fakeSmtpServerGetEmails :: forall (m :: Type -> Type). (MonadLoggerIO m, MonadUnliftIO m, MonadThrow m) => m [EmailInfo] Callback to retrieve the emails the server has received.

data EmailInfo Source #

An email, as received by the server.

Constructors

EmailInfo
Fields emailInfoAttachments :: Value emailInfoText :: Text emailInfoTextAsHtml :: Text emailInfoSubject :: Text emailInfoDate :: Maybe Text emailInfoTo :: Value emailInfoFrom :: Value emailInfoMessageId :: Maybe Text emailInfoHtml :: Text

Instances

Instances details

FromJSON EmailInfo Source #
Instance details Defined in Test.Sandwich.Contexts.FakeSmtpServer Methods parseJSON :: Value -> Parser EmailInfo # parseJSONList :: Value -> Parser [EmailInfo] # omittedField :: Maybe EmailInfo #
ToJSON EmailInfo Source #
Instance details Defined in Test.Sandwich.Contexts.FakeSmtpServer Methods toJSON :: EmailInfo -> Value # toEncoding :: EmailInfo -> Encoding # toJSONList :: [EmailInfo] -> Value # toEncodingList :: [EmailInfo] -> Encoding # omitField :: EmailInfo -> Bool #
Show EmailInfo Source #
Instance details Defined in Test.Sandwich.Contexts.FakeSmtpServer Methods showsPrec :: Int -> EmailInfo -> ShowS # show :: EmailInfo -> String # showList :: [EmailInfo] -> ShowS #
Eq EmailInfo Source #
Instance details Defined in Test.Sandwich.Contexts.FakeSmtpServer Methods (==) :: EmailInfo -> EmailInfo -> Bool # (/=) :: EmailInfo -> EmailInfo -> Bool #