Test.Aeson.Internal.Utils

Documentation

data ComparisonFile

Option to indicate whether to create a separate comparison file or overwrite the golden file. A separate file allows you to use diff to compare. Overwriting allows you to use source control tools for comparison.

Constructors

FaultyFile

Create a new faulty file when tests fail

OverwriteGoldenFile

Overwrite the golden file when tests fail

data RandomMismatchOption

Option indicating whether to fail tests when the random seed does not produce the same values as in the golden file. Default is to output a warning.

Constructors

RandomMismatchWarning

Only output a warning when the random seed does not produce the same values

RandomMismatchError

Fail the test when the random seed does not produce the same value

data Settings

Constructors

Settings

Fields

• goldenDirectoryOption :: GoldenDirectoryOption

  use a custom directory name or use the generic "golden" directory.

• useModuleNameAsSubDirectory :: Bool

  If true, use the module name in the file path, otherwise ignore it.

• sampleSize :: Int

  How many instances of each type you want. If you use ADT versions than it will use the sample size for each constructor.

• comparisonFile :: ComparisonFile

  Whether to create a separate comparison file or ovewrite the golden file.

• randomMismatchOption :: RandomMismatchOption

  Whether to output a warning or fail the test when the random seed produces different values than the values in the golden file.

data GoldenDirectoryOption

A custom directory name or a preselected directory name.

Constructors

CustomDirectoryName String

GoldenDirectory

defaultSettings :: Settings

The default settings for general use cases.

addBrackets :: String -> String

put brackets around a String.

shouldBeIdentity :: (Eq a, Show a, Arbitrary a) => Proxy a -> (a -> IO a) -> Property

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

checkAesonEncodingEquality :: forall a. (ToJSON a, FromJSON a) => JsonShow a -> Bool

This function will compare one JSON encoding to a subsequent JSON encoding, thus eliminating the need for an Eq instance

aesonDecodeIO :: FromJSON a => ByteString -> IO a

run decode in IO, if it returns Left then throw an error.

newtype JsonShow a

Used to eliminate the need for an Eq instance

Constructors

JsonShow a

Instances

ToJSON a => Show (JsonShow a)

Methods

showsPrec :: Int -> JsonShow a -> ShowS

show :: JsonShow a -> String

showList :: [JsonShow a] -> ShowS

Arbitrary a => Arbitrary (JsonShow a)

Methods

arbitrary :: Gen (JsonShow a)

shrink :: JsonShow a -> [JsonShow a]

ToJSON a => ToJSON (JsonShow a)

Methods

toJSON :: JsonShow a -> Value

toEncoding :: JsonShow a -> Encoding

FromJSON a => FromJSON (JsonShow a)

Methods

parseJSON :: Value -> Parser (JsonShow a)

newtype TopDir

Constructors

TopDir

Fields

• unTopDir :: FilePath

Instances

Eq TopDir

Methods

(==) :: TopDir -> TopDir -> Bool

(/=) :: TopDir -> TopDir -> Bool

Read TopDir

Methods

readsPrec :: Int -> ReadS TopDir

readList :: ReadS [TopDir]

readPrec :: ReadPrec TopDir

readListPrec :: ReadPrec [TopDir]

Show TopDir

Methods

showsPrec :: Int -> TopDir -> ShowS

show :: TopDir -> String

showList :: [TopDir] -> ShowS

newtype ModuleName

Constructors

ModuleName

Fields

• unModuleName :: FilePath

Instances

Eq ModuleName

Methods

(==) :: ModuleName -> ModuleName -> Bool

(/=) :: ModuleName -> ModuleName -> Bool

Read ModuleName

Methods

readsPrec :: Int -> ReadS ModuleName

readList :: ReadS [ModuleName]

readPrec :: ReadPrec ModuleName

readListPrec :: ReadPrec [ModuleName]

Show ModuleName

Methods

showsPrec :: Int -> ModuleName -> ShowS

show :: ModuleName -> String

showList :: [ModuleName] -> ShowS

newtype TypeName

Constructors

TypeName

Fields

• unTypeName :: FilePath

Instances

Eq TypeName

Methods

(==) :: TypeName -> TypeName -> Bool

(/=) :: TypeName -> TypeName -> Bool

Read TypeName

Methods

readsPrec :: Int -> ReadS TypeName

readList :: ReadS [TypeName]

readPrec :: ReadPrec TypeName

readListPrec :: ReadPrec [TypeName]

Show TypeName

Methods

showsPrec :: Int -> TypeName -> ShowS

show :: TypeName -> String

showList :: [TypeName] -> ShowS

data TypeNameInfo a

Constructors

TypeNameInfo

Fields

• typeNameTopDir :: TopDir
• typeNameModuleName :: Maybe ModuleName
• typeNameTypeName :: TypeName

Instances

Eq (TypeNameInfo a)

Methods

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

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

Read (TypeNameInfo a)

Methods

readsPrec :: Int -> ReadS (TypeNameInfo a)

readList :: ReadS [TypeNameInfo a]

readPrec :: ReadPrec (TypeNameInfo a)

readListPrec :: ReadPrec [TypeNameInfo a]

Show (TypeNameInfo a)

Methods

showsPrec :: Int -> TypeNameInfo a -> ShowS

show :: TypeNameInfo a -> String

showList :: [TypeNameInfo a] -> ShowS

mkTypeNameInfo :: forall a. Arbitrary a => Typeable a => Settings -> Proxy a -> IO (TypeNameInfo a)