Safe Haskell	None
Language	Haskell2010

Test.Tasty.Silver.Internal

Contents

Generic utilites

Synopsis

data Golden = Golden (IO (Maybe a)) (IO a) (a -> a -> IO GDiff) (a -> IO GShow) (Maybe (a -> IO ()))
newtype AcceptTests = AcceptTests Bool
readFileMaybe :: FilePath -> IO (Maybe ByteString)
data GDiff
- = Equal
- | DiffText {
  - gReason :: Maybe String
  - gActual :: Text
  - gExpected :: Text
  }
- | ShowDiffed {
  - gReason :: Maybe String
  - gDiff :: Text
  }
data GShow = ShowText Text
type GoldenResult = GoldenResult' IO
type GoldenResultI = GoldenResult' Identity
data GoldenResult' (m :: Type -> Type)
- = GREqual
- | GRDifferent a a GDiff (Maybe (a -> IO ()))
- | GRNoGolden (m a) (a -> IO GShow) (Maybe (a -> IO ()))
runGolden :: Golden -> IO (Result, GoldenResult)
forceGoldenResult :: GoldenResult -> IO GoldenResultI
ifM :: Monad m => m Bool -> m a -> m a -> m a
ifNotM :: Monad m => m Bool -> m a -> m a -> m a
and2M :: Monad m => m Bool -> m Bool -> m Bool
andM :: Monad m => [m Bool] -> m Bool
or2M :: Monad m => m Bool -> m Bool -> m Bool
orM :: Monad m => [m Bool] -> m Bool

Documentation

data Golden Source #

See goldenTest1 for explanation of the fields.

Constructors

Golden (IO (Maybe a)) (IO a) (a -> a -> IO GDiff) (a -> IO GShow) (Maybe (a -> IO ()))

Instances

Instances details

IsTest Golden Source #
Instance details Defined in Test.Tasty.Silver.Internal Methods run :: OptionSet -> Golden -> (Progress -> IO ()) -> IO Result testOptions :: Tagged Golden [OptionDescription]

newtype AcceptTests Source #

This option, when set to True, specifies that we should run in the «accept tests» mode.

Constructors

AcceptTests Bool

Instances

Instances details

Eq AcceptTests Source #
Instance details Defined in Test.Tasty.Silver.Internal Methods (==) :: AcceptTests -> AcceptTests -> Bool # (/=) :: AcceptTests -> AcceptTests -> Bool #
Ord AcceptTests Source #
Instance details Defined in Test.Tasty.Silver.Internal Methods compare :: AcceptTests -> AcceptTests -> Ordering # (<) :: AcceptTests -> AcceptTests -> Bool # (<=) :: AcceptTests -> AcceptTests -> Bool # (>) :: AcceptTests -> AcceptTests -> Bool # (>=) :: AcceptTests -> AcceptTests -> Bool # max :: AcceptTests -> AcceptTests -> AcceptTests # min :: AcceptTests -> AcceptTests -> AcceptTests #
IsOption AcceptTests Source #
Instance details Defined in Test.Tasty.Silver.Internal Methods defaultValue :: AcceptTests parseValue :: String -> Maybe AcceptTests optionName :: Tagged AcceptTests String optionHelp :: Tagged AcceptTests String showDefaultValue :: AcceptTests -> Maybe String optionCLParser :: Parser AcceptTests

readFileMaybe :: FilePath -> IO (Maybe ByteString) Source #

Read the file if it exists, else return Nothing. Useful for reading golden files.

data GDiff Source #

The comparison/diff result.

Constructors

Equal	Values are equal.
DiffText	The two values are different, show a diff between the two given texts.
Fields gReason :: Maybe String gActual :: Text gExpected :: Text
ShowDiffed	The two values are different, just show the given text to the user.
Fields gReason :: Maybe String gDiff :: Text

data GShow Source #

How to show a value to the user.

Constructors

ShowText Text

Show the given text.

type GoldenResult = GoldenResult' IO Source #

type GoldenResultI = GoldenResult' Identity Source #

data GoldenResult' (m :: Type -> Type) Source #

Constructors

GREqual
GRDifferent a a GDiff (Maybe (a -> IO ()))
GRNoGolden (m a) (a -> IO GShow) (Maybe (a -> IO ()))

Instances

Instances details

Show (GoldenResult' m) Source #
Instance details Defined in Test.Tasty.Silver.Internal Methods showsPrec :: Int -> GoldenResult' m -> ShowS # show :: GoldenResult' m -> String # showList :: [GoldenResult' m] -> ShowS #

runGolden :: Golden -> IO (Result, GoldenResult) Source #

forceGoldenResult :: GoldenResult -> IO GoldenResultI Source #

Generic utilites

ifM :: Monad m => m Bool -> m a -> m a -> m a Source #

Monadic if.

ifNotM :: Monad m => m Bool -> m a -> m a -> m a Source #

Monadic if (not ...) ....

and2M :: Monad m => m Bool -> m Bool -> m Bool Source #

Short-cutting version of liftM2 (&&).

andM :: Monad m => [m Bool] -> m Bool Source #

Short-cutting version of and . sequence.

or2M :: Monad m => m Bool -> m Bool -> m Bool Source #

Short-cutting version of liftM2 (||).

orM :: Monad m => [m Bool] -> m Bool Source #

Short-cutting version of or . sequence.