Test.Syd.Run

This module defines the IsTest class and the different instances for it.

Documentation

class IsTest e where

Associated Types

type Arg1 e

The argument from aroundAll

type Arg2 e

The argument from around

Methods

runTest :: e -> TestRunSettings -> ProgressReporter -> ((Arg1 e -> Arg2 e -> IO ()) -> IO ()) -> IO TestRunResult

Running the test, safely

Instances

IsTest Property

Defined in Test.Syd.Run

Associated Types

type Arg1 Property

type Arg2 Property

Methods

runTest :: Property -> TestRunSettings -> ProgressReporter -> ((Arg1 Property -> Arg2 Property -> IO ()) -> IO ()) -> IO TestRunResult

IsTest Bool

Defined in Test.Syd.Run

Associated Types

type Arg1 Bool

type Arg2 Bool

Methods

runTest :: Bool -> TestRunSettings -> ProgressReporter -> ((Arg1 Bool -> Arg2 Bool -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (IO (GoldenTest a))

Defined in Test.Syd.Run

Associated Types

type Arg1 (IO (GoldenTest a))

type Arg2 (IO (GoldenTest a))

Methods

runTest :: IO (GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (IO (GoldenTest a)) -> Arg2 (IO (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (IO ())

Defined in Test.Syd.Run

Associated Types

type Arg1 (IO ())

type Arg2 (IO ())

Methods

runTest :: IO () -> TestRunSettings -> ProgressReporter -> ((Arg1 (IO ()) -> Arg2 (IO ()) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (GoldenTest a)

Defined in Test.Syd.Run

Associated Types

type Arg1 (GoldenTest a)

type Arg2 (GoldenTest a)

Methods

runTest :: GoldenTest a -> TestRunSettings -> ProgressReporter -> ((Arg1 (GoldenTest a) -> Arg2 (GoldenTest a) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> Property)

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> Property)

type Arg2 (arg -> Property)

Methods

runTest :: (arg -> Property) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> Property) -> Arg2 (arg -> Property) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> IO (GoldenTest a))

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> IO (GoldenTest a))

type Arg2 (arg -> IO (GoldenTest a))

Methods

runTest :: (arg -> IO (GoldenTest a)) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> IO (GoldenTest a)) -> Arg2 (arg -> IO (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> IO ())

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> IO ())

type Arg2 (arg -> IO ())

Methods

runTest :: (arg -> IO ()) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> IO ()) -> Arg2 (arg -> IO ()) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> GoldenTest a)

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> GoldenTest a)

type Arg2 (arg -> GoldenTest a)

Methods

runTest :: (arg -> GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> GoldenTest a) -> Arg2 (arg -> GoldenTest a) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> Bool)

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> Bool)

type Arg2 (arg -> Bool)

Methods

runTest :: (arg -> Bool) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> Bool) -> Arg2 (arg -> Bool) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> ReaderT env IO ())

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> ReaderT env IO ())

type Arg2 (outerArgs -> ReaderT env IO ())

Methods

runTest :: (outerArgs -> ReaderT env IO ()) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> ReaderT env IO ()) -> Arg2 (outerArgs -> ReaderT env IO ()) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> Property)

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> Property)

type Arg2 (outerArgs -> innerArg -> Property)

Methods

runTest :: (outerArgs -> innerArg -> Property) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> Property) -> Arg2 (outerArgs -> innerArg -> Property) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> IO (GoldenTest a))

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> IO (GoldenTest a))

type Arg2 (outerArgs -> innerArg -> IO (GoldenTest a))

Methods

runTest :: (outerArgs -> innerArg -> IO (GoldenTest a)) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> IO (GoldenTest a)) -> Arg2 (outerArgs -> innerArg -> IO (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> IO ())

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> IO ())

type Arg2 (outerArgs -> innerArg -> IO ())

Methods

runTest :: (outerArgs -> innerArg -> IO ()) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> IO ()) -> Arg2 (outerArgs -> innerArg -> IO ()) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> GoldenTest a)

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> GoldenTest a)

type Arg2 (outerArgs -> innerArg -> GoldenTest a)

Methods

runTest :: (outerArgs -> innerArg -> GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> GoldenTest a) -> Arg2 (outerArgs -> innerArg -> GoldenTest a) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> Bool)

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> Bool)

type Arg2 (outerArgs -> innerArg -> Bool)

Methods

runTest :: (outerArgs -> innerArg -> Bool) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> Bool) -> Arg2 (outerArgs -> innerArg -> Bool) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (ReaderT env IO ())

Defined in Test.Syd.Run

Associated Types

type Arg1 (ReaderT env IO ())

type Arg2 (ReaderT env IO ())

Methods

runTest :: ReaderT env IO () -> TestRunSettings -> ProgressReporter -> ((Arg1 (ReaderT env IO ()) -> Arg2 (ReaderT env IO ()) -> IO ()) -> IO ()) -> IO TestRunResult

runPureTestWithArg :: (outerArgs -> innerArg -> Bool) -> TestRunSettings -> ProgressReporter -> ((outerArgs -> innerArg -> IO ()) -> IO ()) -> IO TestRunResult

applyWrapper2 :: forall r outerArgs innerArg. ((outerArgs -> innerArg -> IO ()) -> IO ()) -> (outerArgs -> innerArg -> IO r) -> IO (Either SomeException r)

runIOTestWithArg :: (outerArgs -> innerArg -> IO ()) -> TestRunSettings -> ProgressReporter -> ((outerArgs -> innerArg -> IO ()) -> IO ()) -> IO TestRunResult

makeQuickCheckArgs :: TestRunSettings -> Args

runPropertyTestWithArg :: forall outerArgs innerArg. (outerArgs -> innerArg -> Property) -> TestRunSettings -> ProgressReporter -> ((outerArgs -> innerArg -> IO ()) -> IO ()) -> IO TestRunResult

aroundProperty :: ((a -> b -> IO ()) -> IO ()) -> (a -> b -> Property) -> Property

aroundProp :: ((a -> b -> IO ()) -> IO ()) -> (a -> b -> Prop) -> Prop

aroundRose :: ((a -> b -> IO ()) -> IO ()) -> (a -> b -> Rose Result) -> Rose Result

data GoldenTest a

A golden test for output of type a.

The purpose of a golden test is to ensure that the output of a certain process does not change even over time.

Golden tests can also be used to show how the output of a certain process changes over time and force code reviewers to review the diff that they see in the PR.

This works by saving a golden output in the repository somewhere, committing it, and then compare that golden output to the output that is currently being produced. You can use `--golden-reset` to have sydtest update the golden output by writing the current output.

Constructors

GoldenTest

Fields

• goldenTestRead :: IO (Maybe a)

  Read the golden test output, Nothing if there is no golden output yet.

• goldenTestProduce :: IO a

  Produce the current output

• goldenTestWrite :: a -> IO ()

  Write golden output

• goldenTestCompare :: a -> a -> IO (Maybe Assertion)

  Compare golden output with current output

  The first argument is the current output, the second is the golden output

Instances

IsTest (IO (GoldenTest a))

Defined in Test.Syd.Run

Associated Types

type Arg1 (IO (GoldenTest a))

type Arg2 (IO (GoldenTest a))

Methods

runTest :: IO (GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (IO (GoldenTest a)) -> Arg2 (IO (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (GoldenTest a)

Defined in Test.Syd.Run

Associated Types

type Arg1 (GoldenTest a)

type Arg2 (GoldenTest a)

Methods

runTest :: GoldenTest a -> TestRunSettings -> ProgressReporter -> ((Arg1 (GoldenTest a) -> Arg2 (GoldenTest a) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> IO (GoldenTest a))

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> IO (GoldenTest a))

type Arg2 (arg -> IO (GoldenTest a))

Methods

runTest :: (arg -> IO (GoldenTest a)) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> IO (GoldenTest a)) -> Arg2 (arg -> IO (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (arg -> GoldenTest a)

Defined in Test.Syd.Run

Associated Types

type Arg1 (arg -> GoldenTest a)

type Arg2 (arg -> GoldenTest a)

Methods

runTest :: (arg -> GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (arg -> GoldenTest a) -> Arg2 (arg -> GoldenTest a) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> IO (GoldenTest a))

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> IO (GoldenTest a))

type Arg2 (outerArgs -> innerArg -> IO (GoldenTest a))

Methods

runTest :: (outerArgs -> innerArg -> IO (GoldenTest a)) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> IO (GoldenTest a)) -> Arg2 (outerArgs -> innerArg -> IO (GoldenTest a)) -> IO ()) -> IO ()) -> IO TestRunResult

IsTest (outerArgs -> innerArg -> GoldenTest a)

Defined in Test.Syd.Run

Associated Types

type Arg1 (outerArgs -> innerArg -> GoldenTest a)

type Arg2 (outerArgs -> innerArg -> GoldenTest a)

Methods

runTest :: (outerArgs -> innerArg -> GoldenTest a) -> TestRunSettings -> ProgressReporter -> ((Arg1 (outerArgs -> innerArg -> GoldenTest a) -> Arg2 (outerArgs -> innerArg -> GoldenTest a) -> IO ()) -> IO ()) -> IO TestRunResult

type Arg1 (IO (GoldenTest a))

Defined in Test.Syd.Run

type Arg1 (IO (GoldenTest a)) = ()

type Arg1 (GoldenTest a)

Defined in Test.Syd.Run

type Arg1 (GoldenTest a) = ()

type Arg2 (IO (GoldenTest a))

Defined in Test.Syd.Run

type Arg2 (IO (GoldenTest a)) = ()

type Arg2 (GoldenTest a)

Defined in Test.Syd.Run

type Arg2 (GoldenTest a) = ()

type Arg1 (arg -> IO (GoldenTest a))

Defined in Test.Syd.Run

type Arg1 (arg -> IO (GoldenTest a)) = ()

type Arg1 (arg -> GoldenTest a)

Defined in Test.Syd.Run

type Arg1 (arg -> GoldenTest a) = ()

type Arg1 (outerArgs -> innerArg -> IO (GoldenTest a))

Defined in Test.Syd.Run

type Arg1 (outerArgs -> innerArg -> IO (GoldenTest a)) = outerArgs

type Arg1 (outerArgs -> innerArg -> GoldenTest a)

Defined in Test.Syd.Run

type Arg1 (outerArgs -> innerArg -> GoldenTest a) = outerArgs

type Arg2 (arg -> IO (GoldenTest a))

Defined in Test.Syd.Run

type Arg2 (arg -> IO (GoldenTest a)) = arg

type Arg2 (arg -> GoldenTest a)

Defined in Test.Syd.Run

type Arg2 (arg -> GoldenTest a) = arg

type Arg2 (outerArgs -> innerArg -> IO (GoldenTest a))

Defined in Test.Syd.Run

type Arg2 (outerArgs -> innerArg -> IO (GoldenTest a)) = innerArg

type Arg2 (outerArgs -> innerArg -> GoldenTest a)

Defined in Test.Syd.Run

type Arg2 (outerArgs -> innerArg -> GoldenTest a) = innerArg

runGoldenTestWithArg :: (outerArgs -> innerArg -> IO (GoldenTest a)) -> TestRunSettings -> ProgressReporter -> ((outerArgs -> innerArg -> IO ()) -> IO ()) -> IO TestRunResult

exceptionHandlers :: [Handler (Either SomeException a)]

type Test = IO ()

data TestRunSettings

Constructors

TestRunSettings

Fields

• testRunSettingSeed :: !SeedSetting
• testRunSettingMaxSuccess :: !Int
• testRunSettingMaxSize :: !Int
• testRunSettingMaxDiscardRatio :: !Int
• testRunSettingMaxShrinks :: !Int
• testRunSettingGoldenStart :: !Bool
• testRunSettingGoldenReset :: !Bool

Instances

Generic TestRunSettings

Defined in Test.Syd.Run

Associated Types

type Rep TestRunSettings :: Type -> Type

Methods

from :: TestRunSettings -> Rep TestRunSettings x

to :: Rep TestRunSettings x -> TestRunSettings

Show TestRunSettings

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> TestRunSettings -> ShowS

show :: TestRunSettings -> String

showList :: [TestRunSettings] -> ShowS

Eq TestRunSettings

Defined in Test.Syd.Run

Methods

(==) :: TestRunSettings -> TestRunSettings -> Bool

(/=) :: TestRunSettings -> TestRunSettings -> Bool

type Rep TestRunSettings

Defined in Test.Syd.Run

type Rep TestRunSettings = D1 ('MetaData "TestRunSettings" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) (C1 ('MetaCons "TestRunSettings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "testRunSettingSeed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SeedSetting) :*: (S1 ('MetaSel ('Just "testRunSettingMaxSuccess") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "testRunSettingMaxSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "testRunSettingMaxDiscardRatio") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "testRunSettingMaxShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "testRunSettingGoldenStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "testRunSettingGoldenReset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))

defaultTestRunSettings :: TestRunSettings

data SeedSetting

Constructors

RandomSeed

FixedSeed !Int

Instances

HasCodec SeedSetting

Defined in Test.Syd.Run

Methods

codec :: JSONCodec SeedSetting

listCodecForStringCompatibility :: JSONCodec [SeedSetting]

Generic SeedSetting

Defined in Test.Syd.Run

Associated Types

type Rep SeedSetting :: Type -> Type

Methods

from :: SeedSetting -> Rep SeedSetting x

to :: Rep SeedSetting x -> SeedSetting

Show SeedSetting

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> SeedSetting -> ShowS

show :: SeedSetting -> String

showList :: [SeedSetting] -> ShowS

Eq SeedSetting

Defined in Test.Syd.Run

Methods

(==) :: SeedSetting -> SeedSetting -> Bool

(/=) :: SeedSetting -> SeedSetting -> Bool

HasParser SeedSetting

Defined in Test.Syd.Run

Methods

settingsParser :: Parser SeedSetting

type Rep SeedSetting

Defined in Test.Syd.Run

type Rep SeedSetting = D1 ('MetaData "SeedSetting" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) (C1 ('MetaCons "RandomSeed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FixedSeed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)))

data TestRunResult

Constructors

TestRunResult

Fields

• testRunResultStatus :: !TestStatus
• testRunResultException :: !(Maybe SomeException)
• testRunResultNumTests :: !(Maybe Word)
• testRunResultNumShrinks :: !(Maybe Word)
• testRunResultFailingInputs :: [String]
• testRunResultLabels :: !(Maybe (Map [String] Int))
• testRunResultClasses :: !(Maybe (Map String Int))
• testRunResultTables :: !(Maybe (Map String (Map String Int)))
• testRunResultGoldenCase :: !(Maybe GoldenCase)
• testRunResultExtraInfo :: !(Maybe String)

Instances

Generic TestRunResult

Defined in Test.Syd.Run

Associated Types

type Rep TestRunResult :: Type -> Type

Methods

from :: TestRunResult -> Rep TestRunResult x

to :: Rep TestRunResult x -> TestRunResult

Show TestRunResult

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> TestRunResult -> ShowS

show :: TestRunResult -> String

showList :: [TestRunResult] -> ShowS

type Rep TestRunResult

Defined in Test.Syd.Run

type Rep TestRunResult = D1 ('MetaData "TestRunResult" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) (C1 ('MetaCons "TestRunResult" 'PrefixI 'True) (((S1 ('MetaSel ('Just "testRunResultStatus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TestStatus) :*: S1 ('MetaSel ('Just "testRunResultException") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe SomeException))) :*: (S1 ('MetaSel ('Just "testRunResultNumTests") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Word)) :*: (S1 ('MetaSel ('Just "testRunResultNumShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Word)) :*: S1 ('MetaSel ('Just "testRunResultFailingInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))) :*: ((S1 ('MetaSel ('Just "testRunResultLabels") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Map [String] Int))) :*: S1 ('MetaSel ('Just "testRunResultClasses") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Map String Int)))) :*: (S1 ('MetaSel ('Just "testRunResultTables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Map String (Map String Int)))) :*: (S1 ('MetaSel ('Just "testRunResultGoldenCase") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe GoldenCase)) :*: S1 ('MetaSel ('Just "testRunResultExtraInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe String)))))))

data TestStatus

Constructors

TestPassed

TestFailed

Instances

Generic TestStatus

Defined in Test.Syd.Run

Associated Types

type Rep TestStatus :: Type -> Type

Methods

from :: TestStatus -> Rep TestStatus x

to :: Rep TestStatus x -> TestStatus

Show TestStatus

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> TestStatus -> ShowS

show :: TestStatus -> String

showList :: [TestStatus] -> ShowS

Eq TestStatus

Defined in Test.Syd.Run

Methods

(==) :: TestStatus -> TestStatus -> Bool

(/=) :: TestStatus -> TestStatus -> Bool

type Rep TestStatus

Defined in Test.Syd.Run

type Rep TestStatus = D1 ('MetaData "TestStatus" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) (C1 ('MetaCons "TestPassed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TestFailed" 'PrefixI 'False) (U1 :: Type -> Type))

data Assertion

A special exception that sydtest knows about and can display nicely in the error output

This is exported outwards so that you can define golden tests for custom types.

You will probably not want to use this directly in everyday tests, use shouldBe or a similar function instead.

Constructors

NotEqualButShouldHaveBeenEqualWithDiff !String !String !(Maybe [Diff Text])

Both strings are not equal. The latest argument is a diff between both arguments. If Nothing, the raw values will be displayed instead of the diff.

EqualButShouldNotHaveBeenEqual !String !String

PredicateSucceededButShouldHaveFailed !String !(Maybe String)

PredicateFailedButShouldHaveSucceeded !String !(Maybe String)

ExpectationFailed !String

Context !Assertion !String

Instances

Exception Assertion

Defined in Test.Syd.Run

Methods

toException :: Assertion -> SomeException

fromException :: SomeException -> Maybe Assertion

displayException :: Assertion -> String

Generic Assertion

Defined in Test.Syd.Run

Associated Types

type Rep Assertion :: Type -> Type

Methods

from :: Assertion -> Rep Assertion x

to :: Rep Assertion x -> Assertion

Show Assertion

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> Assertion -> ShowS

show :: Assertion -> String

showList :: [Assertion] -> ShowS

Eq Assertion

Defined in Test.Syd.Run

Methods

(==) :: Assertion -> Assertion -> Bool

(/=) :: Assertion -> Assertion -> Bool

type Rep Assertion

Defined in Test.Syd.Run

type Rep Assertion = D1 ('MetaData "Assertion" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) ((C1 ('MetaCons "NotEqualButShouldHaveBeenEqualWithDiff" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [Diff Text])))) :+: (C1 ('MetaCons "EqualButShouldNotHaveBeenEqual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "PredicateSucceededButShouldHaveFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe String))))) :+: (C1 ('MetaCons "PredicateFailedButShouldHaveSucceeded" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe String))) :+: (C1 ('MetaCons "ExpectationFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)) :+: C1 ('MetaCons "Context" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Assertion) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)))))

computeDiff :: String -> String -> [Diff Text]

Returns the diff between two strings

Be careful, this function runtime is not bounded and it can take a lot of time (hours) if the input strings are complex. This is exposed for reference, but you may want to use mkNotEqualButShouldHaveBeenEqual which ensures that diff computation timeouts.

mkNotEqualButShouldHaveBeenEqual :: String -> String -> IO Assertion

Assertion when both arguments are not equal. While display a diff between both at the end of tests. The diff computation is cancelled after 2s.

data Contextual

An exception with context.

We wrap an existentially qualified exception here, instead of SomeException, so that we can unwrap it. (For some unknown reason, that doesn't work otherwise.)

Constructors

forall e.Exception e => Contextual !e !String

Instances

Exception Contextual

Defined in Test.Syd.Run

Methods

toException :: Contextual -> SomeException

fromException :: SomeException -> Maybe Contextual

displayException :: Contextual -> String

Show Contextual

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> Contextual -> ShowS

show :: Contextual -> String

showList :: [Contextual] -> ShowS

addContextToException :: Exception e => e -> String -> Contextual

data GoldenCase

Constructors

GoldenNotFound

GoldenStarted

GoldenReset

Instances

Generic GoldenCase

Defined in Test.Syd.Run

Associated Types

type Rep GoldenCase :: Type -> Type

Methods

from :: GoldenCase -> Rep GoldenCase x

to :: Rep GoldenCase x -> GoldenCase

Show GoldenCase

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> GoldenCase -> ShowS

show :: GoldenCase -> String

showList :: [GoldenCase] -> ShowS

Eq GoldenCase

Defined in Test.Syd.Run

Methods

(==) :: GoldenCase -> GoldenCase -> Bool

(/=) :: GoldenCase -> GoldenCase -> Bool

type Rep GoldenCase

Defined in Test.Syd.Run

type Rep GoldenCase = D1 ('MetaData "GoldenCase" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) (C1 ('MetaCons "GoldenNotFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "GoldenStarted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GoldenReset" 'PrefixI 'False) (U1 :: Type -> Type)))

type ProgressReporter = Progress -> IO ()

noProgressReporter :: ProgressReporter

reportProgress :: ProgressReporter -> Progress -> IO ()

data Progress

Constructors

ProgressTestStarting

ProgressExampleStarting !Word !Word

ProgressExampleDone !Word !Word !Word64

ProgressTestDone

Instances

Generic Progress

Defined in Test.Syd.Run

Associated Types

type Rep Progress :: Type -> Type

Methods

from :: Progress -> Rep Progress x

to :: Rep Progress x -> Progress

Show Progress

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> Progress -> ShowS

show :: Progress -> String

showList :: [Progress] -> ShowS

Eq Progress

Defined in Test.Syd.Run

Methods

(==) :: Progress -> Progress -> Bool

(/=) :: Progress -> Progress -> Bool

type Rep Progress

Defined in Test.Syd.Run

type Rep Progress = D1 ('MetaData "Progress" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) ((C1 ('MetaCons "ProgressTestStarting" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ProgressExampleStarting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word))) :+: (C1 ('MetaCons "ProgressExampleDone" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))) :+: C1 ('MetaCons "ProgressTestDone" 'PrefixI 'False) (U1 :: Type -> Type)))

timeItT :: MonadIO m => Int -> m a -> m (Timed a)

Time an action and return the result as well as how long it took in seconds.

This function does not use the timeit package because that package uses CPU time instead of system time. That means that any waiting, like with threadDelay would not be counted.

Note that this does not evaluate the result, on purpose.

timeItDuration :: MonadIO m => m a -> m (a, Word64)

timeItBeginEnd :: MonadIO m => m a -> m (a, (Word64, Word64))

data Timed a

Constructors

Timed

Fields

• timedValue :: !a
• timedWorker :: !Int
• timedBegin :: !Word64

  In nanoseconds

• timedEnd :: !Word64

  In nanoseconds

Instances

Functor Timed

Defined in Test.Syd.Run

Methods

fmap :: (a -> b) -> Timed a -> Timed b

(<$) :: a -> Timed b -> Timed a

Generic (Timed a)

Defined in Test.Syd.Run

Associated Types

type Rep (Timed a) :: Type -> Type

Methods

from :: Timed a -> Rep (Timed a) x

to :: Rep (Timed a) x -> Timed a

Show a => Show (Timed a)

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> Timed a -> ShowS

show :: Timed a -> String

showList :: [Timed a] -> ShowS

Eq a => Eq (Timed a)

Defined in Test.Syd.Run

Methods

(==) :: Timed a -> Timed a -> Bool

(/=) :: Timed a -> Timed a -> Bool

type Rep (Timed a)

Defined in Test.Syd.Run

type Rep (Timed a) = D1 ('MetaData "Timed" "Test.Syd.Run" "sydtest-0.18.0.1-Ew5jfYMgc6A6Aos3R0TaKJ" 'False) (C1 ('MetaCons "Timed" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timedValue") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "timedWorker") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "timedBegin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "timedEnd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))))

timedTime :: Timed a -> Word64