Test.Aeson.Internal.GoldenSpecs

Documentation

goldenSpecs :: (Eq a, Show a, Typeable a, Arbitrary a, ToJSON a, FromJSON a) => Proxy a -> Spec

Allows to obtain tests that will try to ensure that the JSON encoding didn't change unintentionally. To this end goldenSpecs will

• write a file golden.json/TYPENAME.json in the current directory containing a number of JSON-encoded sample values,
• during subsequent tests it will encode the same sample values again and compare them with the saved golden encodings,
• on failure it will create a file golden.json/TYPENAME.faulty.json for easy manual inspection.

You can consider putting the golden files under revision control. That way it'll be obvious when JSON encodings change.

goldenSpecsWithNote :: (Eq a, Show a, Typeable a, Arbitrary a, ToJSON a, FromJSON a) => Proxy a -> Maybe String -> Spec

mkGoldenFile :: Typeable a => Proxy a -> FilePath

mkFaultyFile :: Typeable a => Proxy a -> FilePath

createGoldenfile :: forall a. (Show a, Arbitrary a, ToJSON a) => Proxy a -> FilePath -> IO ()

setSeed :: Int -> Gen a -> Gen a

compareWithGolden :: forall a. (Eq a, Show a, Typeable a, Arbitrary a, ToJSON a, FromJSON a) => Proxy a -> FilePath -> IO ()

readSeed :: ByteString -> IO Int

RandomSamples

data RandomSamples a

Constructors

RandomSamples

Fields

• seed :: Int
• samples :: [a]

Instances

Eq a => Eq (RandomSamples a)

Methods

(==) :: RandomSamples a -> RandomSamples a -> Bool

(/=) :: RandomSamples a -> RandomSamples a -> Bool

Ord a => Ord (RandomSamples a)

Methods

compare :: RandomSamples a -> RandomSamples a -> Ordering

(<) :: RandomSamples a -> RandomSamples a -> Bool

(<=) :: RandomSamples a -> RandomSamples a -> Bool

(>) :: RandomSamples a -> RandomSamples a -> Bool

(>=) :: RandomSamples a -> RandomSamples a -> Bool

max :: RandomSamples a -> RandomSamples a -> RandomSamples a

min :: RandomSamples a -> RandomSamples a -> RandomSamples a

Show a => Show (RandomSamples a)

Methods

showsPrec :: Int -> RandomSamples a -> ShowS

show :: RandomSamples a -> String

showList :: [RandomSamples a] -> ShowS

Generic (RandomSamples a)

Associated Types

type Rep (RandomSamples a) :: * -> *

Methods

from :: RandomSamples a -> Rep (RandomSamples a) x

to :: Rep (RandomSamples a) x -> RandomSamples a

ToJSON a => ToJSON (RandomSamples a)

Methods

toJSON :: RandomSamples a -> Value

toEncoding :: RandomSamples a -> Encoding

FromJSON a => FromJSON (RandomSamples a)

Methods

parseJSON :: Value -> Parser (RandomSamples a)

type Rep (RandomSamples a)

type Rep (RandomSamples a) = D1 (MetaData "RandomSamples" "Test.Aeson.Internal.GoldenSpecs" "servant-aeson-specs-0.4.1-AsX1wyFthgUFU5mIoZzIg4" False) (C1 (MetaCons "RandomSamples" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "seed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Just Symbol "samples") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a]))))

mkRandomSamples :: forall a. Arbitrary a => Proxy a -> Int -> IO (RandomSamples a)