Test.Aeson.GenericSpecs

Tests to ensure that JSON encoding has not unintentionally changed. This could be caused by the following:

• A type's instances of ToJSON or FromJSON have changed.

• Selectors have been edited, added or deleted.

• You have changed version of Aeson the way Aeson serialization has changed works.

If you run this function and the golden files do not exist, it will create them for each constructor. It they do exist, it will compare with golden file if it exists. Golden file encodes json format of a type. It is recommended that you put the golden files under revision control to help monitor changes.

A roundtrip test to check whether values of the given type can be successfully converted to JSON and back to a Haskell value.

roundtripSpecs will

• create random values (using Arbitrary),

• convert them into JSON (using ToJSON),

• read them back into Haskell (using FromJSON) and

• make sure that the result is the same as the value it started with (using Eq).

run roundtrip and golden test for a type. sampleSize is used only when creating the golden file. When it is compared, the sampleSize is derived from the file.

Tests to ensure that JSON encoding has not unintentionally changed. This could be caused by the following:

• A type's instances of ToJSON or FromJSON have changed.

• Selectors have been edited, added or deleted.

• You have changed version of Aeson the way Aeson serialization has changed works.

If you run this function and the golden files do not exist, it will create them for each constructor. It they do exist, it will compare with golden file if it exists. Golden file encodes json format of a type. It is recommended that you put the golden files under revision control to help monitor changes.

A roundtrip test to check whether values of all of constructors of the given type can be successfully converted to JSON and back to a Haskell value.

roundtripADTSpecs will

• create random values for each constructor using ToADTArbitrary,

• convert them into JSON using ToJSON,

• read them back into Haskell using FromJSON and

• make sure that the result is the same as the value it started with using Eq.

roundtripAndGoldenSpecs with custom settings.

run roundtrip and golden tests for all constructors of a type. sampleSize is used only when creating the golden files. When they are compared, the sampleSize is derived from the file.

roundtripAndGoldenADTSpecs with custom settings.

Make a Golden File for the Proxy of a type if the file does not exist.

hspec style combinator to easily write tests that check the a given operation returns the same value it was given, e.g. roundtrip tests.

A custom directory name or a preselected directory name.

The default settings for general use cases.

Proxy is a type that holds no data, but has a phantom parameter of arbitrary type (or even kind). Its use is to provide type information, even though there is no value available of that type (or it may be too costly to create one).

Historically, Proxy :: Proxy a is a safer alternative to the undefined :: a idiom.

>>> Proxy :: Proxy (Void, Int -> Int)Proxy

Proxy can even hold types of higher kinds,

>>> Proxy :: Proxy EitherProxy

>>> Proxy :: Proxy FunctorProxy

>>> Proxy :: Proxy complicatedStructureProxy