Toxiproxy

Documentation

getVersion :: ClientM Version

postReset :: ClientM NoContent

getProxies :: ClientM (Map ProxyName Proxy)

createProxy :: Proxy -> ClientM Proxy

getProxy :: ProxyName -> ClientM Proxy

postPopulate :: [Proxy] -> ClientM Populate

updateProxy :: ProxyName -> Proxy -> ClientM Proxy

deleteProxy :: ProxyName -> ClientM NoContent

getToxics :: ProxyName -> ClientM [Toxic]

createToxic :: ProxyName -> Toxic -> ClientM Toxic

getToxic :: ProxyName -> ToxicName -> ClientM Toxic

updateToxic :: ProxyName -> ToxicName -> Toxic -> ClientM Toxic

deleteToxic :: ProxyName -> ToxicName -> ClientM NoContent

data Proxy

A Toxiproxy proxy. It forwards TCP connections between a listen and upstream host. Toxics can be injected into the proxy to simulate network failure.

Constructors

Proxy

Fields

• proxyName :: ProxyName

  A unique human readable name to identify a proxy.

• proxyListen :: Host

  The proxy listens on this host:port.

• proxyUpstream :: Host

  The proxy forwards to this upstream host:port.

• proxyEnabled :: Bool

  Whether a proxy is currently listening / accepting connections.

• proxyToxics :: [Toxic]

  The toxics currently applied to the proxy. These should not be specified when initially creating a proxy. They must be created seperately with createToxic or withToxic.

Instances

Eq Proxy

Methods

(==) :: Proxy -> Proxy -> Bool

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

Show Proxy

Methods

showsPrec :: Int -> Proxy -> ShowS

show :: Proxy -> String

showList :: [Proxy] -> ShowS

Generic Proxy

Associated Types

type Rep Proxy :: * -> *

Methods

from :: Proxy -> Rep Proxy x

to :: Rep Proxy x -> Proxy

ToJSON Proxy

Methods

toJSON :: Proxy -> Value

toEncoding :: Proxy -> Encoding

toJSONList :: [Proxy] -> Value

toEncodingList :: [Proxy] -> Encoding

FromJSON Proxy

Methods

parseJSON :: Value -> Parser Proxy

parseJSONList :: Value -> Parser [Proxy]

type Rep Proxy

type Rep Proxy

data Toxic

A toxic is applied to a proxy. It allows the user to simulate a specified kind of network failure on the proxy.

Constructors

Toxic

Fields

• toxicName :: ToxicName

  A unique human readable name to identify a toxic.

• toxicType :: ToxicType

  The type of toxic. For example "latency". Please refer to ToxicType or the Toxiproxy documentation for more information.

• toxicStream :: Stream

  The direction on which the toxic is applied. Please refer to Stream.

• toxicToxicity :: Float

  The strength that the toxic is applied to the proxy. Please refer to the Toxiproxy documation.

• toxicAttributes :: Map Text Int

  Attributes configure a toxic. They differ based on the ToxicType. Please refer to the Toxiproxy documentation.

Instances

Eq Toxic

Methods

(==) :: Toxic -> Toxic -> Bool

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

Show Toxic

Methods

showsPrec :: Int -> Toxic -> ShowS

show :: Toxic -> String

showList :: [Toxic] -> ShowS

Generic Toxic

Associated Types

type Rep Toxic :: * -> *

Methods

from :: Toxic -> Rep Toxic x

to :: Rep Toxic x -> Toxic

ToJSON Toxic

Methods

toJSON :: Toxic -> Value

toEncoding :: Toxic -> Encoding

toJSONList :: [Toxic] -> Value

toEncodingList :: [Toxic] -> Encoding

FromJSON Toxic

Methods

parseJSON :: Value -> Parser Toxic

parseJSONList :: Value -> Parser [Toxic]

type Rep Toxic

type Rep Toxic

newtype Populate

The return value of the populate endpoint.

Constructors

Populate

Fields

• populateProxies :: [Proxy]

Instances

Eq Populate

Methods

(==) :: Populate -> Populate -> Bool

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

Show Populate

Methods

showsPrec :: Int -> Populate -> ShowS

show :: Populate -> String

showList :: [Populate] -> ShowS

Generic Populate

Associated Types

type Rep Populate :: * -> *

Methods

from :: Populate -> Rep Populate x

to :: Rep Populate x -> Populate

FromJSON Populate

Methods

parseJSON :: Value -> Parser Populate

parseJSONList :: Value -> Parser [Populate]

type Rep Populate

type Rep Populate = D1 * (MetaData "Populate" "Toxiproxy" "toxiproxy-haskell-0.2.0.0-KB02vNhAQYNEaa7PaChM47" True) (C1 * (MetaCons "Populate" PrefixI True) (S1 * (MetaSel (Just Symbol "populateProxies") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Proxy])))

newtype Version

The version of the Toxiproxy server. This library is fully supported by any version greater or equal to 2.1.3.

Constructors

Version Text

Instances

Eq Version

Methods

(==) :: Version -> Version -> Bool

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

Show Version

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

MimeUnrender * PlainText Version

Methods

mimeUnrender :: Proxy PlainText Version -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy PlainText Version -> MediaType -> ByteString -> Either String a

data Stream

A toxic can be applied to the upstream or the downstream of a connection. Upstream is the stream traveling from the connecting client to the upstream server. Downstream is the stream traveling from the upstream server to the connecting client.

Constructors

Upstream

Downstream

Instances

Eq Stream

Methods

(==) :: Stream -> Stream -> Bool

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

Show Stream

Methods

showsPrec :: Int -> Stream -> ShowS

show :: Stream -> String

showList :: [Stream] -> ShowS

ToJSON Stream

Methods

toJSON :: Stream -> Value

toEncoding :: Stream -> Encoding

toJSONList :: [Stream] -> Value

toEncodingList :: [Stream] -> Encoding

FromJSON Stream

Methods

parseJSON :: Value -> Parser Stream

parseJSONList :: Value -> Parser [Stream]

data ToxicType

Different toxic types simulate different kinds of failure. Different toxics require different attribute configuration. Please refer to the Toxiproxy documentation.

Constructors

Latency

Bandwidth

SlowClose

Timeout

Slicer

LimitData

Other Text

Instances

Eq ToxicType

Methods

(==) :: ToxicType -> ToxicType -> Bool

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

Show ToxicType

Methods

showsPrec :: Int -> ToxicType -> ShowS

show :: ToxicType -> String

showList :: [ToxicType] -> ShowS

ToJSON ToxicType

Methods

toJSON :: ToxicType -> Value

toEncoding :: ToxicType -> Encoding

toJSONList :: [ToxicType] -> Value

toEncodingList :: [ToxicType] -> Encoding

FromJSON ToxicType

Methods

parseJSON :: Value -> Parser ToxicType

parseJSONList :: Value -> Parser [ToxicType]

toxiproxyUrl :: BaseUrl

The default Toxiproxy service URL. (127.0.0.1:8474)

withDisabled :: Proxy -> IO a -> IO a

Given an enabled proxy, disable the proxy, run the given action and then re-enable the proxy.

This is useful for simulating a crashed server or closed connection.

connectToMyProxy       -- This will connect.
withDisabled myProxy $
  connectToMyProxy     -- This will get rejected.
connectToMyProxy       -- This will connect again.

withToxic :: Proxy -> Toxic -> IO a -> IO a

Given a proxy and a toxic, create the toxic on the proxy, run the given action and then delete the toxic.

This is useful for running some action with a toxic enabled.

withToxic myProxy latencyToxic $
  sendRequestThroughProxy -- This request will have latency applied to it.

withProxy :: Proxy -> (Proxy -> IO a) -> IO a

Given a proxy record, create the proxy on the server, run the given action and then delete the proxy off the server.

This is useful for wrapping withDisabled and withToxic calls. It enures that your test cleans up the Toxiproxy server so that proxies don't leak into your other tests.

run :: ClientM a -> IO (Either ServantError a)

A helper for easily querying the Toxiproxy API. Assumes Toxiproxy is running on toxiproxyUrl.

proxies <- run getProxies