{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE AllowAmbiguousTypes #-}
module Test.Validity.Cereal
( serializeSpecOnValid
, serializeSpec
, serializeSpecOnArbitrary
, serializeSpecOnGen
, neverFailsToEncodeOnGen
, encodeAndDecodeAreInversesOnGen
) where
import Data.GenValidity
import Control.DeepSeq (deepseq)
import Control.Exception (evaluate)
import qualified Data.Serialize as Serialize
import Data.Serialize (Serialize)
import Data.Typeable
import Test.Hspec
import Test.QuickCheck
import Test.Validity.Utils
serializeSpecOnValid ::
forall a. (Show a, Eq a, Typeable a, GenValid a, Serialize a)
=> Spec
serializeSpecOnValid = serializeSpecOnGen (genValid @a) "valid" shrinkValid
serializeSpec ::
forall a. (Show a, Eq a, Typeable a, GenUnchecked a, Serialize a)
=> Spec
serializeSpec = serializeSpecOnGen (genUnchecked @a) "unchecked" shrinkUnchecked
serializeSpecOnArbitrary ::
forall a. (Show a, Eq a, Typeable a, Arbitrary a, Serialize a)
=> Spec
serializeSpecOnArbitrary = serializeSpecOnGen (arbitrary @a) "arbitrary" shrink
serializeSpecOnGen ::
forall a. (Show a, Eq a, Typeable a, Serialize a)
=> Gen a
-> String
-> (a -> [a])
-> Spec
serializeSpecOnGen gen genname s =
parallel $ do
let name = nameOf @a
describe ("Serialize " ++ name ++ " (" ++ genname ++ ")") $ do
describe ("encode :: " ++ name ++ " -> Data.ByteString.ByteString") $
it
(unwords
[ "never fails to encode a"
, "\"" ++ genname
, name ++ "\""
]) $
neverFailsToEncodeOnGen gen s
describe ("decode :: " ++ name ++ " -> Data.ByteString.ByteString") $
it
(unwords
[ "ensures that encode and decode are inverses for"
, "\"" ++ genname
, name ++ "\"" ++ "'s"
]) $
encodeAndDecodeAreInversesOnGen gen s
neverFailsToEncodeOnGen ::
(Show a, Serialize a) => Gen a -> (a -> [a]) -> Property
neverFailsToEncodeOnGen gen s =
forAllShrink gen s $ \(a :: a) ->
evaluate (deepseq (Serialize.encode a) ()) `shouldReturn` ()
encodeAndDecodeAreInversesOnGen ::
(Show a, Eq a, Serialize a) => Gen a -> (a -> [a]) -> Property
encodeAndDecodeAreInversesOnGen gen s =
forAllShrink gen s $ \(a :: a) ->
Serialize.decode (Serialize.encode a) `shouldBe` Right a