module Test.Validity.Aeson
( jsonSpecOnValid
, jsonSpec
, jsonSpecOnArbitrary
, jsonSpecOnGen
, neverFailsToEncodeOnGen
, encodeAndDecodeAreInversesOnGen
) where
import Data.GenValidity
import Control.DeepSeq (deepseq)
import Control.Exception (evaluate)
import Data.Aeson (FromJSON, ToJSON)
import qualified Data.Aeson as JSON
import Data.Typeable
import Test.Hspec
import Test.QuickCheck
import Test.Validity.Utils
jsonSpecOnValid
:: forall a.
(Show a, Eq a, Typeable a, GenValid a, FromJSON a, ToJSON a)
=> Spec
jsonSpecOnValid = jsonSpecOnGen (genValid @a) "valid"
jsonSpec
:: forall a.
(Show a, Eq a, Typeable a, GenUnchecked a, FromJSON a, ToJSON a)
=> Spec
jsonSpec = jsonSpecOnGen (genUnchecked @a) "unchecked"
jsonSpecOnArbitrary
:: forall a.
(Show a, Eq a, Typeable a, Arbitrary a, FromJSON a, ToJSON a)
=> Spec
jsonSpecOnArbitrary = jsonSpecOnGen (arbitrary @a) "arbitrary"
jsonSpecOnGen
:: forall a.
(Show a, Eq a, Typeable a, FromJSON a, ToJSON a)
=> Gen a -> String -> Spec
jsonSpecOnGen gen genname = parallel $ do
let name = nameOf @a
describe ("JSON " ++ name ++ " (" ++ genname ++ ")") $ do
describe ("encode :: " ++ name ++ " -> Data.ByteString.Lazy.ByteString") $
it
(unwords
["never fails to encode a", "\"" ++ genname, name ++ "\""]) $
neverFailsToEncodeOnGen gen
describe ("decode :: " ++ name ++ " -> Data.ByteString.Lazy.ByteString") $
it
(unwords
[ "ensures that encode and decode are inverses for"
, "\"" ++ genname
, name ++ "\"" ++ "'s"
]) $
encodeAndDecodeAreInversesOnGen gen
neverFailsToEncodeOnGen
:: (Show a, ToJSON a)
=> Gen a -> Property
neverFailsToEncodeOnGen gen =
forAll gen $ \(a :: a) ->
evaluate (deepseq (JSON.encode a) ()) `shouldReturn` ()
encodeAndDecodeAreInversesOnGen
:: (Show a, Eq a, FromJSON a, ToJSON a)
=> Gen a -> Property
encodeAndDecodeAreInversesOnGen gen =
forAll gen $ \(a :: a) ->
JSON.eitherDecode (JSON.encode a) `shouldBe` Right a