ilyakooo0/servant-quickcheck
1
0
Fork 0
mirror of https://github.com/ilyakooo0/servant-quickcheck.git synced 2024-11-25 21:42:59 +03:00
Code Issues Packages Projects Releases Wiki Activity
not really known
77 Commits 2 Branches 0 Tags 280 KiB
Haskell 100%
6c163dc981
Go to file
Erik Aker 6c163dc981 Utilize new FailedWith constructor to fix json equality tests
2017-10-15 20:31:52 -07:00
doc docs 2016-07-18 16:12:21 -03:00
src/Servant Create jsonEqaulity function and add some tests for similar JSON values but slightly different whitespace, ordering 2017-10-15 20:24:21 -07:00
test Utilize new FailedWith constructor to fix json equality tests 2017-10-15 20:31:52 -07:00
.gitignore Add predicate getsHaveLastModifiedHeader. 2016-10-03 15:39:46 +02:00
.travis.yml Switch CI to stack 2017-03-10 15:53:26 -06:00
CHANGELOG.yaml Bump version 2017-03-11 09:36:16 -06:00
LICENSE initial commit 2016-04-22 13:00:23 +02:00
README.md Add readme 2016-04-26 13:43:52 +02:00
servant-quickcheck.cabal Create jsonEqaulity function and add some tests for similar JSON values but slightly different whitespace, ordering 2017-10-15 20:24:21 -07:00
Setup.hs initial commit 2016-04-22 13:00:23 +02:00
stack-lts-6.yaml Switch CI to stack 2017-03-10 15:53:26 -06:00
stack-lts-7.yaml Switch CI to stack 2017-03-10 15:53:26 -06:00
stack.yaml Bump HSpec to 2.4.4 and make tests use safeEvaluateExample to capture failure msg 2017-07-15 15:03:06 -07:00

README.md

servant-quickcheck

servant-quickcheck provides tools to test properties across entire APIs. Rather than writing the same tests for each endpoint, with servant-quickcheck you can simply specify properties every endpoint must meet once and for all. For example:

followsBestPractices :: Spec
followsBestPractices = describe "my API" $ do

  it "follows best practices" $ do
    withServantServer myAPI myServer $ \burl ->
      serverSatisfies api burl stdArgs
           ( not500
         <%> onlyJsonObjects
         <%> getsHaveCacheControlHeader
         <%> headsHaveCacheControlHeader
         <%> mempty)

Additionally, servant-quickcheck provides a serversEqual function that generates arbitrary requests (that conform to the description of an API) and tests that two servers respond identically to them. This can be useful when refactoring or rewriting an API that should not change.