Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Golden

Functions for golden testing.

Main test function

1 declaration

valuegolden

Runs a Golden test.

5 declarations

valuegoldenText :: String -> Text -> Golden Text

Golden for a Text.

valuegoldenString :: String -> String -> Golden String

Golden for a String.

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

Golden for an Aeson value (ToJSON/FromJSON).

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

Golden for a general Show/Read type.

valuemkGolden

Make your own Golden constructor by providing goldenWriteToFile and goldenReadFromFile.

6 declarations

valuegoldenOutput :: Golden a -> a

Expected output.

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

How to write into the golden file the file.

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

How to read the file.

valuegoldenFile :: Golden a -> FilePath

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

valuegoldenActualFile :: Golden a -> Maybe FilePath

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

valuegoldenFailFirstTime :: Golden a -> Bool

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