Test.Tasty.Golden.Advanced

tasty-golden-2.3.5: Golden tests support for tasty

Safe Haskell | None
Language | Haskell2010

Test.Tasty.Golden.Advanced

Contents

- The main functions

Synopsis

- goldenTest :: TestName -> IO a -> IO a -> (a -> a -> IO (Maybe String)) -> (a -> IO ()) -> TestTree
- goldenTest2 :: TestName -> IO a -> IO a -> (a -> a -> IO (Maybe String)) -> (a -> IO ()) -> IO () -> TestTree

# The main functions

goldenTest #

Arguments

:: TestName | test name
-> IO a | get the golden correct value Note that this action may be followed by the update function call. Therefore, this action *should avoid* reading the file lazily; otherwise, the file may remain half-open and the update action will fail.
-> IO a | get the tested value
-> (a -> a -> IO (Maybe String)) | comparison function. If two values are the same, it should return `Nothing`. If they are different, it should return an error that will be printed to the user. First argument is the golden value. The function may use `IO`, for example, to launch an external `diff` command.
-> (a -> IO ()) | update the golden file
-> TestTree |

A very general testing function.

goldenTest2 #

Arguments

:: TestName | Test name
-> IO a | Get the golden correct value Note that this action may be followed by the update function call. Therefore, this action *should avoid* reading the file lazily; otherwise, the file may remain half-open and the update action will fail.
-> IO a | Get the tested value (in this case from the output file)
-> (a -> a -> IO (Maybe String)) | Comparison function. If two values are the same, it should return `Nothing`. If they are different, it should return an error that will be printed to the user. First argument is the golden value. The function may use `IO`, for example, to launch an external `diff` command.
-> (a -> IO ()) | Update the golden file
-> IO () | Action to delete the output file
-> TestTree |

A variant of `goldenTest` that also provides for deleting the output file. The `DeleteOuputFile` option controls the circumstances in which the output file is to be deleted.

Since: 2.3.4