Copyright	(c) Plow Technologies 2016
License	BSD3
Maintainer	mchaver@gmail.com
Stability	Beta
Safe Haskell	None
Language	Haskell2010

Test.Aeson.Internal.Utils

Description

Synopsis

data ComparisonFile
- = FaultyFile
- | OverwriteGoldenFile
data RandomMismatchOption
- = RandomMismatchWarning
- | RandomMismatchError
data Settings = Settings {
}
data GoldenDirectoryOption
- = CustomDirectoryName String
- | GoldenDirectory
defaultSettings :: Settings
addBrackets :: String -> String
shouldBeIdentity :: (Eq a, Show a, Arbitrary a) => Proxy a -> (a -> IO a) -> Property
checkAesonEncodingEquality :: forall a. (ToJSON a, FromJSON a) => JsonShow a -> Bool
aesonDecodeIO :: FromJSON a => ByteString -> IO a
newtype JsonShow a = JsonShow a
newtype TopDir = TopDir {
- unTopDir :: FilePath
}
newtype ModuleName = ModuleName {
- unModuleName :: FilePath
}
newtype TypeName = TypeName {
- unTypeName :: FilePath
}
data TypeNameInfo a = TypeNameInfo {
- typeNameTopDir :: TopDir
- typeNameModuleName :: Maybe ModuleName
- typeNameTypeName :: TypeName
}
mkTypeNameInfo :: forall a. Arbitrary a => Typeable a => Settings -> Proxy a -> IO (TypeNameInfo a)

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) #
Instance details Defined in Test.Aeson.Internal.Utils Methods showsPrec :: Int -> JsonShow a -> ShowS # show :: JsonShow a -> String # showList :: [JsonShow a] -> ShowS #
Arbitrary a => Arbitrary (JsonShow a) #
Instance details Defined in Test.Aeson.Internal.Utils Methods arbitrary :: Gen (JsonShow a) # shrink :: JsonShow a -> [JsonShow a] #
ToJSON a => ToJSON (JsonShow a) #
Instance details Defined in Test.Aeson.Internal.Utils Methods toJSON :: JsonShow a -> Value # toEncoding :: JsonShow a -> Encoding # toJSONList :: [JsonShow a] -> Value # toEncodingList :: [JsonShow a] -> Encoding #
FromJSON a => FromJSON (JsonShow a) #
Instance details Defined in Test.Aeson.Internal.Utils Methods parseJSON :: Value -> Parser (JsonShow a) # parseJSONList :: Value -> Parser [JsonShow a] #

newtype TopDir #

Constructors

TopDir
Fields unTopDir :: FilePath

Instances

Eq TopDir #
Instance details Defined in Test.Aeson.Internal.Utils Methods (==) :: TopDir -> TopDir -> Bool # (/=) :: TopDir -> TopDir -> Bool #
Read TopDir #
Instance details Defined in Test.Aeson.Internal.Utils Methods readsPrec :: Int -> ReadS TopDir # readList :: ReadS [TopDir] # readPrec :: ReadPrec TopDir # readListPrec :: ReadPrec [TopDir] #
Show TopDir #
Instance details Defined in Test.Aeson.Internal.Utils Methods showsPrec :: Int -> TopDir -> ShowS # show :: TopDir -> String # showList :: [TopDir] -> ShowS #

newtype ModuleName #

Constructors

ModuleName
Fields unModuleName :: FilePath

Instances

Eq ModuleName #
Instance details Defined in Test.Aeson.Internal.Utils Methods (==) :: ModuleName -> ModuleName -> Bool # (/=) :: ModuleName -> ModuleName -> Bool #
Read ModuleName #
Instance details Defined in Test.Aeson.Internal.Utils Methods readsPrec :: Int -> ReadS ModuleName # readList :: ReadS [ModuleName] # readPrec :: ReadPrec ModuleName # readListPrec :: ReadPrec [ModuleName] #
Show ModuleName #
Instance details Defined in Test.Aeson.Internal.Utils Methods showsPrec :: Int -> ModuleName -> ShowS # show :: ModuleName -> String # showList :: [ModuleName] -> ShowS #

newtype TypeName #

Constructors

TypeName
Fields unTypeName :: FilePath

Instances

Eq TypeName #
Instance details Defined in Test.Aeson.Internal.Utils Methods (==) :: TypeName -> TypeName -> Bool # (/=) :: TypeName -> TypeName -> Bool #
Read TypeName #
Instance details Defined in Test.Aeson.Internal.Utils Methods readsPrec :: Int -> ReadS TypeName # readList :: ReadS [TypeName] # readPrec :: ReadPrec TypeName # readListPrec :: ReadPrec [TypeName] #
Show TypeName #
Instance details Defined in Test.Aeson.Internal.Utils 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) #
Instance details Defined in Test.Aeson.Internal.Utils Methods (==) :: TypeNameInfo a -> TypeNameInfo a -> Bool # (/=) :: TypeNameInfo a -> TypeNameInfo a -> Bool #
Read (TypeNameInfo a) #
Instance details Defined in Test.Aeson.Internal.Utils Methods readsPrec :: Int -> ReadS (TypeNameInfo a) # readList :: ReadS [TypeNameInfo a] # readPrec :: ReadPrec (TypeNameInfo a) # readListPrec :: ReadPrec [TypeNameInfo a] #
Show (TypeNameInfo a) #
Instance details Defined in Test.Aeson.Internal.Utils 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) #