Test.Swagger.Report

Documentation

data TestReport

A description of a particular test run.

Constructors

TestReport

Fields

• reportSeed :: Seed
• reportOperation :: Operation
• reportRequest :: HttpRequest
• reportResponse :: 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

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