Test.Sandwich.Golden

Main test function

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

Runs a Golden test.

Built-in Goldens.

goldenText :: String -> Text -> Golden Text

Golden for a Text.

goldenString :: String -> String -> Golden String

Golden for a Value.

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

Golden for an Aeson value (ToJSON/FromJSON).

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

Golden for a general Show/Read type.

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

Make your own Golden constructor by providing goldenWriteToFile and goldenReadFromFile.

Parameters for a Golden.

goldenOutput :: Golden a -> a

Expected output.

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

How to write into the golden file the file.

goldenReadFromFile :: Golden a -> FilePath -> IO a

How to read the file.

goldenFile :: Golden a -> FilePath

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

goldenActualFile :: Golden a -> Maybe FilePath

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

goldenFailFirstTime :: Golden a -> Bool

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