Freckle.App.Test

Documentation

data AppExample app a

An Hspec example over some App value

Instances

MonadReader app (AppExample app)

Defined in Freckle.App.Test

Methods

ask :: AppExample app app

local :: (app -> app) -> AppExample app a -> AppExample app a

reader :: (app -> a) -> AppExample app a

MonadBase IO (AppExample app)

Defined in Freckle.App.Test

Methods

liftBase :: IO α -> AppExample app α

MonadBaseControl IO (AppExample app)

Defined in Freckle.App.Test

Associated Types

type StM (AppExample app) a

Methods

liftBaseWith :: (RunInBase (AppExample app) IO -> IO a) -> AppExample app a

restoreM :: StM (AppExample app) a -> AppExample app a

Monad (AppExample app)

Defined in Freckle.App.Test

Methods

(>>=) :: AppExample app a -> (a -> AppExample app b) -> AppExample app b

(>>) :: AppExample app a -> AppExample app b -> AppExample app b

return :: a -> AppExample app a

Functor (AppExample app)

Defined in Freckle.App.Test

Methods

fmap :: (a -> b) -> AppExample app a -> AppExample app b

(<$) :: a -> AppExample app b -> AppExample app a

MonadFail (AppExample app)

Defined in Freckle.App.Test

Methods

fail :: String -> AppExample app a

Applicative (AppExample app)

Defined in Freckle.App.Test

Methods

pure :: a -> AppExample app a

(<*>) :: AppExample app (a -> b) -> AppExample app a -> AppExample app b

liftA2 :: (a -> b -> c) -> AppExample app a -> AppExample app b -> AppExample app c

(*>) :: AppExample app a -> AppExample app b -> AppExample app b

(<*) :: AppExample app a -> AppExample app b -> AppExample app a

MonadIO (AppExample app)

Defined in Freckle.App.Test

Methods

liftIO :: IO a -> AppExample app a

MonadRandom (AppExample app)

Defined in Freckle.App.Test

Methods

getRandomR :: Random a => (a, a) -> AppExample app a

getRandom :: Random a => AppExample app a

getRandomRs :: Random a => (a, a) -> AppExample app [a]

getRandoms :: Random a => AppExample app [a]

MonadUnliftIO (AppExample app)

Defined in Freckle.App.Test

Methods

withRunInIO :: ((forall a. AppExample app a -> IO a) -> IO b) -> AppExample app b

PrimMonad (AppExample app)

Defined in Freckle.App.Test

Associated Types

type PrimState (AppExample app)

Methods

primitive :: (State# (PrimState (AppExample app)) -> (# State# (PrimState (AppExample app)), a #)) -> AppExample app a

MonadThrow (AppExample app)

Defined in Freckle.App.Test

Methods

throwM :: Exception e => e -> AppExample app a

MonadCatch (AppExample app)

Defined in Freckle.App.Test

Methods

catch :: Exception e => AppExample app a -> (e -> AppExample app a) -> AppExample app a

MonadLogger (AppExample app)

Defined in Freckle.App.Test

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> AppExample app ()

Example (AppExample app a)

Defined in Freckle.App.Test

Associated Types

type Arg (AppExample app a)

Methods

evaluateExample :: AppExample app a -> Params -> (ActionWith (Arg (AppExample app a)) -> IO ()) -> ProgressCallback -> IO Result

type PrimState (AppExample app)

Defined in Freckle.App.Test

type PrimState (AppExample app) = PrimState IO

type StM (AppExample app) a

Defined in Freckle.App.Test

type StM (AppExample app) a = StM (NoLoggingT (ReaderT app IO)) a

type Arg (AppExample app a)

Defined in Freckle.App.Test

type Arg (AppExample app a) = app

withApp :: IO app -> SpecWith app -> Spec

Spec before helper

spec :: Spec
spec = withApp loadApp $ do

Reads .env.test, then .env, then loads the application. Examples within this spec can use runAppTest (and runDB, if the app HasSqlPool).

withAppSql :: HasSqlPool app => SqlPersistT IO a -> IO app -> SpecWith app -> Spec

withApp, with custom DB Pool initialization

Runs the given function on the pool before every spec item. For example, to truncate tables.

runAppTest :: ReaderT app (LoggingT IO) a -> AppExample app a

Run an action with the test App

Like runApp, but without exception handling or logging

type HasCallStack = ?callStack :: CallStack

Request a CallStack.

NOTE: The implicit parameter ?callStack :: CallStack is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.

Since: base-4.9.0.0

example :: Expectation -> Expectation

example is a type restricted version of id. It can be used to get better error messages on type mismatches.

Compare e.g.

it "exposes some behavior" $ example $ do
  putStrLn

with

it "exposes some behavior" $ do
  putStrLn

type Spec = SpecWith ()

beforeWith :: (b -> IO a) -> SpecWith a -> SpecWith b

Run a custom action before every spec item.

beforeAll :: HasCallStack => IO a -> SpecWith a -> Spec

Run a custom action before the first spec item.

describe :: HasCallStack => String -> SpecWith a -> SpecWith a

The describe function combines a list of specs into a larger spec.

context :: HasCallStack => String -> SpecWith a -> SpecWith a

context is an alias for describe.

it :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

The it function creates a spec item.

A spec item consists of:

• a textual description of a desired behavior
• an example for that behavior

describe "absolute" $ do
  it "returns a positive number when given a negative number" $
    absolute (-1) == 1

xit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

Changing it to xit marks the corresponding spec item as pending.

This can be used to temporarily disable a spec item.

fit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

fit is an alias for fmap focus . it

shouldNotReturn :: (HasCallStack, MonadIO m, Show a, Eq a) => m a -> a -> m () infix 1

action `shouldNotReturn` notExpected sets the expectation that action does not return notExpected.

shouldNotContain :: (HasCallStack, MonadIO m, Show a, Eq a) => [a] -> [a] -> m () infix 1

list `shouldNotContain` sublist sets the expectation that sublist is not contained anywhere in list.

shouldNotSatisfy :: (HasCallStack, MonadIO m, Show a) => a -> (a -> Bool) -> m () infix 1

v `shouldNotSatisfy` p sets the expectation that p v is False.

shouldNotBe :: (HasCallStack, MonadIO m, Show a, Eq a) => a -> a -> m () infix 1

actual `shouldNotBe` notExpected sets the expectation that actual is not equal to notExpected

shouldReturn :: (HasCallStack, MonadIO m, Show a, Eq a) => m a -> a -> m () infix 1

action `shouldReturn` expected sets the expectation that action returns expected.

shouldMatchList :: (HasCallStack, MonadIO m, Show a, Eq a) => [a] -> [a] -> m () infix 1

xs `shouldMatchList` ys sets the expectation that xs has the same elements that ys has, possibly in another order

shouldContain :: (HasCallStack, MonadIO m, Show a, Eq a) => [a] -> [a] -> m () infix 1

list `shouldContain` sublist sets the expectation that sublist is contained, wholly and intact, anywhere in list.

shouldEndWith :: (HasCallStack, MonadIO m, Show a, Eq a) => [a] -> [a] -> m () infix 1

list `shouldEndWith` suffix sets the expectation that list ends with suffix,

shouldStartWith :: (HasCallStack, MonadIO m, Show a, Eq a) => [a] -> [a] -> m () infix 1

list `shouldStartWith` prefix sets the expectation that list starts with prefix,

shouldSatisfy :: (HasCallStack, MonadIO m, Show a) => a -> (a -> Bool) -> m () infix 1

v `shouldSatisfy` p sets the expectation that p v is True.

shouldBe :: (HasCallStack, MonadIO m, Show a, Eq a) => a -> a -> m () infix 1

actual `shouldBe` expected sets the expectation that actual is equal to expected.

expectationFailure :: (HasCallStack, MonadIO m) => String -> m ()

data Pool a

Instances

HasSqlPool SqlPool

Defined in Freckle.App.Database

Methods

getSqlPool :: SqlPool -> SqlPool

Show (Pool a)

Defined in Data.Pool

Methods

showsPrec :: Int -> Pool a -> ShowS

show :: Pool a -> String

showList :: [Pool a] -> ShowS

destroyAllResources :: Pool a -> IO ()

Destroy all resources in all stripes in the pool. Note that this will ignore any exceptions in the destroy function.

This function is useful when you detect that all resources in the pool are broken. For example after a database has been restarted all connections opened before the restart will be broken. In that case it's better to close those connections so that takeResource won't take a broken connection from the pool but will open a new connection instead.

Another use-case for this function is that when you know you are done with the pool you can destroy all idle resources immediately instead of waiting on the garbage collector to destroy them, thus freeing up those resources sooner.

putResource :: LocalPool a -> a -> IO ()

Return a resource to the given LocalPool.

destroyResource :: Pool a -> LocalPool a -> a -> IO ()

Destroy a resource. Note that this will ignore any exceptions in the destroy function.

tryTakeResource :: Pool a -> IO (Maybe (a, LocalPool a))

A non-blocking version of takeResource. The tryTakeResource function returns immediately, with Nothing if the pool is exhausted, or Just (a, LocalPool a) if a resource could be borrowed from the pool successfully.

tryWithResource :: MonadBaseControl IO m => Pool a -> (a -> m b) -> m (Maybe b)

Similar to withResource, but only performs the action if a resource could be taken from the pool without blocking. Otherwise, tryWithResource returns immediately with Nothing (ie. the action function is not called). Conversely, if a resource can be borrowed from the pool without blocking, the action is performed and it's result is returned, wrapped in a Just.

takeResource :: Pool a -> IO (a, LocalPool a)

Take a resource from the pool, following the same results as withResource. Note that this function should be used with caution, as improper exception handling can lead to leaked resources.

This function returns both a resource and the LocalPool it came from so that it may either be destroyed (via destroyResource) or returned to the pool (via putResource).

withResource :: MonadBaseControl IO m => Pool a -> (a -> m b) -> m b

Temporarily take a resource from a Pool, perform an action with it, and return it to the pool afterwards.

• If the pool has an idle resource available, it is used immediately.
• Otherwise, if the maximum number of resources has not yet been reached, a new resource is created and used.
• If the maximum number of resources has been reached, this function blocks until a resource becomes available.

If the action throws an exception of any type, the resource is destroyed, and not returned to the pool.

It probably goes without saying that you should never manually destroy a pooled resource, as doing so will almost certainly cause a subsequent user (who expects the resource to be valid) to throw an exception.

createPool

Arguments

:: IO a

Action that creates a new resource.

-> (a -> IO ())

Action that destroys an existing resource.

-> Int

The number of stripes (distinct sub-pools) to maintain. The smallest acceptable value is 1.

-> NominalDiffTime

Amount of time for which an unused resource is kept open. The smallest acceptable value is 0.5 seconds.

The elapsed time before destroying a resource may be a little longer than requested, as the reaper thread wakes at 1-second intervals.

-> Int

Maximum number of resources to keep open per stripe. The smallest acceptable value is 1.

Requests for resources will block if this limit is reached on a single stripe, even if other stripes have idle resources available.

-> IO (Pool a)

Create a striped resource pool.

Although the garbage collector will destroy all idle resources when the pool is garbage collected it's recommended to manually destroyAllResources when you're done with the pool so that the resources are freed up as soon as possible.

data LocalPool a

A single striped pool.

data PostgresStatementTimeout

Constructors

PostgresStatementTimeoutSeconds Int

PostgresStatementTimeoutMilliseconds Int

Instances

Eq PostgresStatementTimeout

Defined in Freckle.App.Database

Methods

(==) :: PostgresStatementTimeout -> PostgresStatementTimeout -> Bool

(/=) :: PostgresStatementTimeout -> PostgresStatementTimeout -> Bool

Show PostgresStatementTimeout

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresStatementTimeout -> ShowS

show :: PostgresStatementTimeout -> String

showList :: [PostgresStatementTimeout] -> ShowS

data PostgresPassword

Constructors

PostgresPasswordIamAuth

PostgresPasswordStatic String

Instances

Eq PostgresPassword

Defined in Freckle.App.Database

Methods

(==) :: PostgresPassword -> PostgresPassword -> Bool

(/=) :: PostgresPassword -> PostgresPassword -> Bool

Show PostgresPassword

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresPassword -> ShowS

show :: PostgresPassword -> String

showList :: [PostgresPassword] -> ShowS

data PostgresPasswordSource

Constructors

PostgresPasswordSourceIamAuth

PostgresPasswordSourceEnv

Instances

Eq PostgresPasswordSource

Defined in Freckle.App.Database

Methods

(==) :: PostgresPasswordSource -> PostgresPasswordSource -> Bool

(/=) :: PostgresPasswordSource -> PostgresPasswordSource -> Bool

Show PostgresPasswordSource

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresPasswordSource -> ShowS

show :: PostgresPasswordSource -> String

showList :: [PostgresPasswordSource] -> ShowS

data PostgresConnectionConf

Constructors

PostgresConnectionConf

Fields

• pccHost :: String
• pccPort :: Int
• pccUser :: String
• pccPassword :: PostgresPassword
• pccDatabase :: String
• pccPoolSize :: Int
• pccStatementTimeout :: PostgresStatementTimeout

Instances

Eq PostgresConnectionConf

Defined in Freckle.App.Database

Methods

(==) :: PostgresConnectionConf -> PostgresConnectionConf -> Bool

(/=) :: PostgresConnectionConf -> PostgresConnectionConf -> Bool

Show PostgresConnectionConf

Defined in Freckle.App.Database

Methods

showsPrec :: Int -> PostgresConnectionConf -> ShowS

show :: PostgresConnectionConf -> String

showList :: [PostgresConnectionConf] -> ShowS

class HasSqlPool app where

Methods

getSqlPool :: app -> SqlPool

Instances

HasSqlPool SqlPool

Defined in Freckle.App.Database

Methods

getSqlPool :: SqlPool -> SqlPool

type SqlPool = Pool SqlBackend

makePostgresPool :: IO SqlPool

runDB :: (HasSqlPool app, MonadUnliftIO m, MonadReader app m) => SqlPersistT m a -> m a

postgresStatementTimeoutMilliseconds :: PostgresStatementTimeout -> Int

envPostgresPasswordSource :: Parser PostgresPasswordSource

envParseDatabaseConf :: PostgresPasswordSource -> Parser PostgresConnectionConf

makePostgresPoolWith :: PostgresConnectionConf -> IO SqlPool