Safe Haskell	None
Language	Haskell2010

Testing.CurlRunnings.Types

Description

Data types for curl-runnings tests

Synopsis

Documentation

newtype CurlSuite #

A wrapper type around a set of test cases. This is the top level spec type that we parse a test spec file into

Constructors

CurlSuite [CurlCase]

Instances

Show CurlSuite #
Methods showsPrec :: Int -> CurlSuite -> ShowS # show :: CurlSuite -> String # showList :: [CurlSuite] -> ShowS #
Generic CurlSuite #
Associated Types type Rep CurlSuite :: * -> * # Methods from :: CurlSuite -> Rep CurlSuite x # to :: Rep CurlSuite x -> CurlSuite #
ToJSON CurlSuite #
Methods toJSON :: CurlSuite -> Value # toEncoding :: CurlSuite -> Encoding # toJSONList :: [CurlSuite] -> Value # toEncodingList :: [CurlSuite] -> Encoding #
FromJSON CurlSuite #
Methods parseJSON :: Value -> Parser CurlSuite # parseJSONList :: Value -> Parser [CurlSuite] #
type Rep CurlSuite #
type Rep CurlSuite = D1 * (MetaData "CurlSuite" "Testing.CurlRunnings.Types" "curl-runnings-0.2.0-8DdrqovPAGfBd9OZfKlrqI" True) (C1 * (MetaCons "CurlSuite" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [CurlCase])))

data CurlCase #

A single curl test case, the basic foundation of a curl-runnings test.

Constructors

CurlCase
Fields name :: String The name of the test case url :: String The target url to test requestMethod :: HttpMethod Berb to use for the request requestData :: Maybe Value Payload to send with the request, if any expectData :: Maybe JsonMatcher The assertions to make on the response payload, if any expectStatus :: StatusCodeMatcher Assertion about the status code returned by the target

Instances

Show CurlCase #
Methods showsPrec :: Int -> CurlCase -> ShowS # show :: CurlCase -> String # showList :: [CurlCase] -> ShowS #
Generic CurlCase #
Associated Types type Rep CurlCase :: * -> * # Methods from :: CurlCase -> Rep CurlCase x # to :: Rep CurlCase x -> CurlCase #
ToJSON CurlCase #
Methods toJSON :: CurlCase -> Value # toEncoding :: CurlCase -> Encoding # toJSONList :: [CurlCase] -> Value # toEncodingList :: [CurlCase] -> Encoding #
FromJSON CurlCase #
Methods parseJSON :: Value -> Parser CurlCase # parseJSONList :: Value -> Parser [CurlCase] #
type Rep CurlCase #
type Rep CurlCase = D1 * (MetaData "CurlCase" "Testing.CurlRunnings.Types" "curl-runnings-0.2.0-8DdrqovPAGfBd9OZfKlrqI" False) (C1 * (MetaCons "CurlCase" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) ((::) (S1 * (MetaSel (Just Symbol "url") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) (S1 * (MetaSel (Just Symbol "requestMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * HttpMethod)))) ((::) (S1 * (MetaSel (Just Symbol "requestData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Value))) ((::) (S1 * (MetaSel (Just Symbol "expectData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe JsonMatcher))) (S1 * (MetaSel (Just Symbol "expectStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * StatusCodeMatcher))))))

data HttpMethod #

A basic enum for supported HTTP verbs

Constructors

GET
POST
PUT
PATCH
DELETE

Instances

Show HttpMethod #
Methods showsPrec :: Int -> HttpMethod -> ShowS # show :: HttpMethod -> String # showList :: [HttpMethod] -> ShowS #
Generic HttpMethod #
Associated Types type Rep HttpMethod :: * -> * # Methods from :: HttpMethod -> Rep HttpMethod x # to :: Rep HttpMethod x -> HttpMethod #
ToJSON HttpMethod #
Methods toJSON :: HttpMethod -> Value # toEncoding :: HttpMethod -> Encoding # toJSONList :: [HttpMethod] -> Value # toEncodingList :: [HttpMethod] -> Encoding #
FromJSON HttpMethod #
Methods parseJSON :: Value -> Parser HttpMethod # parseJSONList :: Value -> Parser [HttpMethod] #
type Rep HttpMethod #
type Rep HttpMethod = D1 * (MetaData "HttpMethod" "Testing.CurlRunnings.Types" "curl-runnings-0.2.0-8DdrqovPAGfBd9OZfKlrqI" False) ((:+:) * ((:+:) * (C1 * (MetaCons "GET" PrefixI False) (U1 )) (C1 (MetaCons "POST" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "PUT" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "PATCH" PrefixI False) (U1 )) (C1 (MetaCons "DELETE" PrefixI False) (U1 *)))))

data JsonMatcher #

A predicate to apply to the json body from the response

Constructors

Exactly Value	Performs `==`
Contains [JsonSubExpr]	A list of matchers to make assertions about some subset of the response.

Instances

Show JsonMatcher #
Methods showsPrec :: Int -> JsonMatcher -> ShowS # show :: JsonMatcher -> String # showList :: [JsonMatcher] -> ShowS #
Generic JsonMatcher #
Associated Types type Rep JsonMatcher :: * -> * # Methods from :: JsonMatcher -> Rep JsonMatcher x # to :: Rep JsonMatcher x -> JsonMatcher #
ToJSON JsonMatcher #
Methods toJSON :: JsonMatcher -> Value # toEncoding :: JsonMatcher -> Encoding # toJSONList :: [JsonMatcher] -> Value # toEncodingList :: [JsonMatcher] -> Encoding #
FromJSON JsonMatcher #
Methods parseJSON :: Value -> Parser JsonMatcher # parseJSONList :: Value -> Parser [JsonMatcher] #
type Rep JsonMatcher #
type Rep JsonMatcher = D1 * (MetaData "JsonMatcher" "Testing.CurlRunnings.Types" "curl-runnings-0.2.0-8DdrqovPAGfBd9OZfKlrqI" False) ((:+:) * (C1 * (MetaCons "Exactly" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Value))) (C1 * (MetaCons "Contains" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [JsonSubExpr]))))

data JsonSubExpr #

A matcher for a subvalue of a json payload

Constructors

ValueMatch Value	Assert some value anywhere in the json has a value equal to a given value. The motivation for this field is largely for checking contents of a top level array. It's also useful if you don't know the key ahead of time.
KeyValueMatch	Assert the key value pair can be found somewhere the json.
Fields matchKey :: Text matchValue :: Value

Instances

Show JsonSubExpr #
Methods showsPrec :: Int -> JsonSubExpr -> ShowS # show :: JsonSubExpr -> String # showList :: [JsonSubExpr] -> ShowS #
Generic JsonSubExpr #
Associated Types type Rep JsonSubExpr :: * -> * # Methods from :: JsonSubExpr -> Rep JsonSubExpr x # to :: Rep JsonSubExpr x -> JsonSubExpr #
ToJSON JsonSubExpr #
Methods toJSON :: JsonSubExpr -> Value # toEncoding :: JsonSubExpr -> Encoding # toJSONList :: [JsonSubExpr] -> Value # toEncodingList :: [JsonSubExpr] -> Encoding #
FromJSON JsonSubExpr #
Methods parseJSON :: Value -> Parser JsonSubExpr # parseJSONList :: Value -> Parser [JsonSubExpr] #
type Rep JsonSubExpr #
type Rep JsonSubExpr = D1 * (MetaData "JsonSubExpr" "Testing.CurlRunnings.Types" "curl-runnings-0.2.0-8DdrqovPAGfBd9OZfKlrqI" False) ((:+:) * (C1 * (MetaCons "ValueMatch" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Value))) (C1 * (MetaCons "KeyValueMatch" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "matchKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "matchValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Value)))))

data StatusCodeMatcher #

Check the status code of a response. You can specify one or many valid codes.

Constructors

ExactCode Int
AnyCodeIn [Int]

Instances

Show StatusCodeMatcher #
Methods showsPrec :: Int -> StatusCodeMatcher -> ShowS # show :: StatusCodeMatcher -> String # showList :: [StatusCodeMatcher] -> ShowS #
Generic StatusCodeMatcher #
Associated Types type Rep StatusCodeMatcher :: * -> * # Methods from :: StatusCodeMatcher -> Rep StatusCodeMatcher x # to :: Rep StatusCodeMatcher x -> StatusCodeMatcher #
ToJSON StatusCodeMatcher #
Methods toJSON :: StatusCodeMatcher -> Value # toEncoding :: StatusCodeMatcher -> Encoding # toJSONList :: [StatusCodeMatcher] -> Value # toEncodingList :: [StatusCodeMatcher] -> Encoding #
FromJSON StatusCodeMatcher #
Methods parseJSON :: Value -> Parser StatusCodeMatcher # parseJSONList :: Value -> Parser [StatusCodeMatcher] #
type Rep StatusCodeMatcher #
type Rep StatusCodeMatcher = D1 * (MetaData "StatusCodeMatcher" "Testing.CurlRunnings.Types" "curl-runnings-0.2.0-8DdrqovPAGfBd9OZfKlrqI" False) ((:+:) * (C1 * (MetaCons "ExactCode" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))) (C1 * (MetaCons "AnyCodeIn" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Int]))))

data AssertionFailure #

Represents the different type of test failures we can have. A single test case | might return many assertion failures.

Constructors

DataFailure CurlCase JsonMatcher (Maybe Value)	The json we got back was wrong. We include this redundant field (it's included in the CurlCase field above) in order to enforce at the type level that we have to be expecting some data in order to have this type of failure.
StatusFailure CurlCase Int	The status code we got back was wrong
UnexpectedFailure	Something else

Instances

Show AssertionFailure #
Methods showsPrec :: Int -> AssertionFailure -> ShowS # show :: AssertionFailure -> String # showList :: [AssertionFailure] -> ShowS #

data CaseResult #

A type representing the result of a single curl, and all associated assertions

Constructors

CasePass CurlCase
CaseFail CurlCase [AssertionFailure]

Instances

Show CaseResult #
Methods showsPrec :: Int -> CaseResult -> ShowS # show :: CaseResult -> String # showList :: [CaseResult] -> ShowS #

isPassing :: CaseResult -> Bool #

Simple predicate that checks if the result is passing

isFailing :: CaseResult -> Bool #

Simple predicate that checks if the result is failing