System.TmpProc.Docker.Redis

Provides an instance of Proc that launches redis as a tmp proc.

The instance this module provides can be used in integration tests as is.

It's also possible to write other instances that launch redis in different ways; for those, this instance can be used as a reference example.

Proc instance

newtype TmpRedis

Provides the capability to launch a redis instance as tmp proc.

The constructor receives the names of keys to be dropped on reset.

Constructors

TmpRedis [KeyName]

Instances

Connectable TmpRedis

Specifies how to connect to a tmp redis service.

Defined in System.TmpProc.Docker.Redis

Associated Types

type Conn TmpRedis = (conn :: Type)

Methods

openConn :: ProcHandle TmpRedis -> IO (Conn TmpRedis)

closeConn :: Conn TmpRedis -> IO ()

Proc TmpRedis

Specifies how to run redis as a tmp proc.

Defined in System.TmpProc.Docker.Redis

Associated Types

type Image TmpRedis :: Symbol

type Name TmpRedis = (labelName :: Symbol)

Methods

runArgs :: [Text]

uriOf :: HostIpAddress -> SvcURI

reset :: ProcHandle TmpRedis -> IO ()

ping :: ProcHandle TmpRedis -> IO Pinged

pingCount :: Natural

pingGap :: Natural

type Conn TmpRedis

Defined in System.TmpProc.Docker.Redis

type Conn TmpRedis = Connection

type Image TmpRedis

Defined in System.TmpProc.Docker.Redis

type Image TmpRedis = "redis:5.0"

type Name TmpRedis

Defined in System.TmpProc.Docker.Redis

type Name TmpRedis = "a-redis-db"

Useful definitions

aProc :: HList '[TmpRedis]

A singleton HList containing an example TmpRedis.

aHandle :: IO (HandlesOf '[TmpRedis])

An HList that just contains the handle created from aProc.

type KeyName = ByteString

The name of a key in redis.

Re-exports

withTmpConn :: Connectable a => ProcHandle a -> (Conn a -> IO b) -> IO b

Run an action on a Connectable handle as a callback on its Conn

startupAll :: forall (procs :: [Type]). AreProcs procs => HList procs -> IO (HandlesOf procs)

Start up processes for each Proc type.

data ProcHandle a

Provides access to a Proc that has been started.

Constructors

ProcHandle

Fields

• hProc :: !a
• hPid :: !String
• hUri :: !SvcURI
• hAddr :: !HostIpAddress

type family Conn a = (conn :: Type) | conn -> a

The connection type.

Instances

type Conn TmpRedis

Defined in System.TmpProc.Docker.Redis

type Conn TmpRedis = Connection

class Proc a => Connectable a where

Specifies how to a get a connection to a Proc.

Minimal complete definition

openConn

Associated Types

type Conn a = (conn :: Type) | conn -> a

The connection type.

Methods

openConn :: ProcHandle a -> IO (Conn a)

Get a connection to the Proc via its ProcHandle.

closeConn :: Conn a -> IO ()

Close a connection to a Proc.

Instances

Connectable TmpRedis

Specifies how to connect to a tmp redis service.

Defined in System.TmpProc.Docker.Redis

Associated Types

type Conn TmpRedis = (conn :: Type)

Methods

openConn :: ProcHandle TmpRedis -> IO (Conn TmpRedis)

closeConn :: Conn TmpRedis -> IO ()

type family Name a = (labelName :: Symbol) | labelName -> a

A label used to refer to running process created from this image, e.g, a-postgres-db

Instances

type Name TmpRedis

Defined in System.TmpProc.Docker.Redis

type Name TmpRedis = "a-redis-db"

type family Image a :: Symbol

The image name of the docker image, e.g, postgres:10.6

Instances

type Image TmpRedis

Defined in System.TmpProc.Docker.Redis

type Image TmpRedis = "redis:5.0"

class (KnownSymbol (Image a), KnownSymbol (Name a)) => Proc a where

Specifies how to launch a temporary process using Docker.

Minimal complete definition

uriOf, reset, ping

Associated Types

type Image a :: Symbol

The image name of the docker image, e.g, postgres:10.6

type Name a = (labelName :: Symbol) | labelName -> a

A label used to refer to running process created from this image, e.g, a-postgres-db

Methods

runArgs :: [Text]

Additional arguments to the docker command that launches the tmp proc.

uriOf :: HostIpAddress -> SvcURI

Determines the service URI of the process, when applicable.

reset :: ProcHandle a -> IO ()

Resets some state in a tmp proc service.

ping :: ProcHandle a -> IO Pinged

Checks if the tmp proc started ok.

pingCount :: Natural

Maximum number of pings to perform during startup.

pingGap :: Natural

Number of milliseconds between pings.

Instances

Proc TmpRedis

Specifies how to run redis as a tmp proc.

Defined in System.TmpProc.Docker.Redis

Associated Types

type Image TmpRedis :: Symbol

type Name TmpRedis = (labelName :: Symbol)

Methods

runArgs :: [Text]

uriOf :: HostIpAddress -> SvcURI

reset :: ProcHandle TmpRedis -> IO ()

ping :: ProcHandle TmpRedis -> IO Pinged

pingCount :: Natural

pingGap :: Natural

data Pinged

Indicates the result of pinging a Proc.

If the ping succeeds, ping should return OK.

ping should catch any exceptions that are expected when the Procs service is not available and return NotOK.

startupAll uses PingFailed to report any unexpected exceptions that escape ping.

Constructors

OK

The service is running OK.

NotOK

The service is not running.

PingFailed Text

Contact to the service failed unexpectedly.

Instances

Show Pinged

Defined in System.TmpProc.Docker

Methods

showsPrec :: Int -> Pinged -> ShowS

show :: Pinged -> String

showList :: [Pinged] -> ShowS

Eq Pinged

Defined in System.TmpProc.Docker

Methods

(==) :: Pinged -> Pinged -> Bool

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

type HostIpAddress = Text

The IP address of the docker host.

type SvcURI = ByteString

A connection string used to access the service once its running.

type HandlesOf (procs :: [Type]) = HList (Proc2Handle procs)

A list of ProcHandle values.

only :: x -> HList '[x]

Construct a singleton HList

data HList (a :: [Type]) where

Defines a Heterogenous list.

Constructors

HNil :: HList ('[] :: [Type])

HCons :: forall anyTy (manyTys :: [Type]). anyTy -> HList manyTys -> HList (anyTy ': manyTys) infixr 5

Instances

(Show x, Show (HList xs)) => Show (HList (x ': xs))

Defined in System.TmpProc.TypeLevel

Methods

showsPrec :: Int -> HList (x ': xs) -> ShowS

show :: HList (x ': xs) -> String

showList :: [HList (x ': xs)] -> ShowS

Show (HList ('[] :: [Type]))

Defined in System.TmpProc.TypeLevel

Methods

showsPrec :: Int -> HList '[] -> ShowS

show :: HList '[] -> String

showList :: [HList '[]] -> ShowS

(Eq x, Eq (HList xs)) => Eq (HList (x ': xs))

Defined in System.TmpProc.TypeLevel

Methods

(==) :: HList (x ': xs) -> HList (x ': xs) -> Bool

(/=) :: HList (x ': xs) -> HList (x ': xs) -> Bool

Eq (HList ('[] :: [Type]))

Defined in System.TmpProc.TypeLevel

Methods

(==) :: HList '[] -> HList '[] -> Bool

(/=) :: HList '[] -> HList '[] -> Bool