Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Golden

Functions for golden testing.

Contents

Main test function
Built-in Goldens
Parameters for a Golden

Synopsis

value golden
value goldenText
value goldenString
value goldenJSON
value goldenShowable
value mkGolden
value goldenOutput
value goldenWriteToFile
value goldenReadFromFile
value goldenFile
value goldenActualFile
value goldenFailFirstTime

Packagesandwich-0.3.1.0
Exports12
LanguageHaskell2010
LicenceBSD-3-Clause
SourceGolden.hs

Main test function

valuegolden

:: (MonadIO m, Eq str, Show str)
=> Golden str
-> Free (SpecCommand context m) ()

Source#

Runs a Golden test.

Built-in Goldens

valuegoldenText :: String -> Text -> Golden Text

Source#

Golden for a Text.

valuegoldenString :: String -> String -> Golden String

Source#

Golden for a String.

valuegoldenJSON :: (ToJSON a, FromJSON a) => String -> a -> Golden a

Source#

Golden for an Aeson value (ToJSON/FromJSON).

valuegoldenShowable :: (Show a, Read a) => String -> a -> Golden a

Source#

Golden for a general Show/Read type.

valuemkGolden

:: FilePath -> a -> IO ()
-> FilePath -> IO a
-> String
-> a
-> Golden a

Source#

Make your own Golden constructor by providing goldenWriteToFile and goldenReadFromFile.

Parameters for a `Golden`

valuegoldenOutput :: Golden a -> a

Source#

Expected output.

valuegoldenWriteToFile :: Golden a -> FilePath -> a -> IO ()

Source#

How to write into the golden file the file.

valuegoldenReadFromFile :: Golden a -> FilePath -> IO a

Source#

How to read the file.

valuegoldenFile :: Golden a -> FilePath

Source#

Where to read/write the golden file for this test.

valuegoldenActualFile :: Golden a -> Maybe FilePath

Source#

Where to save the actual file for this test. If it is Nothing then no file is written.

valuegoldenFailFirstTime :: Golden a -> Bool

Source#

Whether to record a failure the first time this test is run.

Main test function

Built-in Goldens

Parameters for a Golden

Parameters for a `Golden`