Test.Swagger

Re-exports

Documentation

generateRequest :: Seed -> Size -> NormalizedSwagger -> Maybe OperationId -> (Operation, HttpRequest)

Given a swagger.json schema, produce a Request that complies with the schema. The return type is a random Request (in the IO monad because it's random).

data Format

Possible output formats that applies to HttpRequest and HttpResponse values

Constructors

FormatHttp

FormatCurl

FormatNone

FormatJSON

Instances

Bounded Format

Methods

minBound :: Format

maxBound :: Format

Enum Format

Methods

succ :: Format -> Format

pred :: Format -> Format

toEnum :: Int -> Format

fromEnum :: Format -> Int

enumFrom :: Format -> [Format]

enumFromThen :: Format -> Format -> [Format]

enumFromTo :: Format -> Format -> [Format]

enumFromThenTo :: Format -> Format -> Format -> [Format]

Show Format

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

requestFormats :: [Format]

Valid output formats for HttpRequest values

responseFormats :: [Format]

Valid output formats for HttpResponse values

printRequest :: Format -> HttpRequest -> Builder

Print a request according to format

printResponse :: Format -> HttpResponse -> Builder

Print a response according to format

doHttpRequest :: HttpRequest -> IO HttpResponse

Executes the HTTP request and returns the HTTP response

type FullyQualifiedHost = String

The FullyQualifiedHost contains the scheme (i.e. http://), hostname and port.

type Seed = Int

type Size = Int

data NormalizedSwagger

Instances

FromJSON NormalizedSwagger

Methods

parseJSON :: Value -> Parser NormalizedSwagger

parseJSONList :: Value -> Parser [NormalizedSwagger]

getSwagger :: NormalizedSwagger -> Swagger

type OperationId = Text

type HttpHeader = (CI Text, Text)

type Headers = [HttpHeader]

data HttpRequest

Constructors

HttpRequest

Fields

• requestHost :: Maybe FullyQualifiedHost
• requestMethod :: Method
• requestPath :: Text
• requestQuery :: QueryText
• requestHeaders :: Headers
• requestBody :: Maybe ByteString

Instances

Eq HttpRequest

Methods

(==) :: HttpRequest -> HttpRequest -> Bool

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

Show HttpRequest

Methods

showsPrec :: Int -> HttpRequest -> ShowS

show :: HttpRequest -> String

showList :: [HttpRequest] -> ShowS

ToJSON HttpRequest

Methods

toJSON :: HttpRequest -> Value

toEncoding :: HttpRequest -> Encoding

toJSONList :: [HttpRequest] -> Value

toEncodingList :: [HttpRequest] -> Encoding

data HttpResponse

Constructors

HttpResponse

Fields

• responseHttpVersion :: HttpVersion
• responseStatus :: Status
• responseHeaders :: Headers
• responseBody :: Maybe ByteString

Instances

Eq HttpResponse

Methods

(==) :: HttpResponse -> HttpResponse -> Bool

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

Show HttpResponse

Methods

showsPrec :: Int -> HttpResponse -> ShowS

show :: HttpResponse -> String

showList :: [HttpResponse] -> ShowS

ToJSON HttpResponse

Methods

toJSON :: HttpResponse -> Value

toEncoding :: HttpResponse -> Encoding

toJSONList :: [HttpResponse] -> Value

toEncodingList :: [HttpResponse] -> Encoding

refToMaybe :: Referenced a -> Maybe a

Transform a reference into a Just value if is inline, Nothing, otherwise

data TestReport

A description of a particular test run.

Constructors

TestReport

Fields

• reportSeed :: Seed
• reportOperation :: Operation
• reportRequest :: HttpRequest
• reportResponse :: Maybe HttpResponse
• reportResult :: ValidationResult

Instances

Eq TestReport

Methods

(==) :: TestReport -> TestReport -> Bool

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

Ord TestReport

Methods

compare :: TestReport -> TestReport -> Ordering

(<) :: TestReport -> TestReport -> Bool

(<=) :: TestReport -> TestReport -> Bool

(>) :: TestReport -> TestReport -> Bool

(>=) :: TestReport -> TestReport -> Bool

max :: TestReport -> TestReport -> TestReport

min :: TestReport -> TestReport -> TestReport

ToJSON TestReport

Methods

toJSON :: TestReport -> Value

toEncoding :: TestReport -> Encoding

toJSONList :: [TestReport] -> Value

toEncodingList :: [TestReport] -> Encoding

isSuccessful :: TestReport -> Bool

Predicate that tells whether or not a report is of a successful validation

isFailure :: TestReport -> Bool

writeReportFile :: FilePath -> NormalizedSwagger -> [TestReport] -> IO ()

Write a report file containing a header description about the Swagger schema, then a section about each Operation, how many tests were performed, general stats (# failuressuccesses) and requestresponse details for failures.

writeErrorReportFile :: FilePath -> String -> IO ()

Write a report file containing just a single error message. This is to be used if we find an error before being able to run any test (parsing schema, etc.)

runTests :: NormalizedSwagger -> Int -> Size -> IO [TestReport]

Run n tests for a Swagger schema

parseResponse :: ByteString -> Either String HttpResponse

Parse a HttpResponse from ByteString

type ValidationResult = Either String ()

validateResponseBytes :: ByteString -> NormalizedSwagger -> OperationId -> ValidationResult

Validate a response, from a particular operation id, (encoded in a byte-string) against a Swagger schema

validateResponseWithOperation :: HttpResponse -> NormalizedSwagger -> Operation -> ValidationResult

Validate a response, from a particular operation against a Swagger schema

validateResponse :: HttpResponse -> NormalizedSwagger -> OperationId -> ValidationResult

Validate a response, from a particular operation id against a Swagger schema