Test.ImpSpec · ImpSpec-0.2.0.0

valueansiDocToString :: Doc AnsiStyle -> String

#

valueapplyQCGen :: (QCGen -> (b, QCGen)) -> ImpM t b

#

valueevalImpGenM :: ImpSpec t => ImpInit t -> ImpM t b -> Gen (IO b)

#

valueevalImpM

:: ImpSpec t
=> Maybe QCGen
-> Maybe Int
-> ImpInit t
-> ImpM t b
-> IO b

#

valueexecImpGenM :: ImpSpec t => ImpInit t -> ImpM t b -> Gen (IO (ImpState t))

#

valueexecImpM

:: ImpSpec t
=> Maybe QCGen
-> Maybe Int
-> ImpInit t
-> ImpM t b
-> IO (ImpState t)

#

valuegetLogs :: ImpM t (Doc AnsiStyle)

#

valueimpAnn :: NFData a => String -> ImpM t a -> ImpM t a

#

Annotation for when failure happens. All the logging done within annotation will be discarded if there no failures within the annotation.

valueimpAnnDoc :: NFData a => Doc AnsiStyle -> ImpM t a -> ImpM t a

#

valueimpSetSeed :: Int -> ImpM t ()

#

Override the QuickCheck generator using a fixed seed.

valuelogDoc :: HasCallStack => Doc AnsiStyle -> ImpM t ()

#

Adds a Doc to the log, which is only shown if the test fails

valuelogString :: HasCallStack => String -> ImpM t ()

#

Adds a String to the log, which is only shown if the test fails

valuelogText :: HasCallStack => Text -> ImpM t ()

#

Adds a Text to the log, which is only shown if the test fails

valuelogWithCallStack :: CallStack -> Doc AnsiStyle -> ImpM t ()

#

Adds a source location and Doc to the log, which are only shown if the test fails

valuemodifyImpInit

:: ImpInit t -> ImpInit t
-> SpecWith (ImpInit t)
-> SpecWith (ImpInit t)

#

valuemodifyLogs :: (Doc AnsiStyle -> Doc AnsiStyle) -> ImpM t ()

#

valueprettyImpException :: ImpException -> Doc AnsiStyle

#

valuerunImpGenM :: ImpSpec t => ImpInit t -> ImpM t b -> Gen (IO (b, ImpState t))

#

valuerunImpGenM_ :: ImpSpec t => ImpInit t -> ImpM t b -> Gen (IO ())

#

valuerunImpM

:: ImpSpec t
=> Maybe QCGen
-> Maybe Int
-> ImpInit t
-> ImpM t b
-> IO (b, ImpState t)

#

valuerunImpM_

:: ImpSpec t
=> Maybe QCGen
-> Maybe Int
-> ImpInit t
-> ImpM t b
-> IO ()

#

valuewithImpInit :: ImpSpec t => SpecWith (ImpInit t) -> Spec

#

valuefprop :: (HasCallStack, Testable prop) => String -> prop -> Spec

#

fprop ".." $
  ..

is a shortcut for

fit ".." $ property $
  ..

valueprop :: (HasCallStack, Testable prop) => String -> prop -> Spec

#

prop ".." $
  ..

is a shortcut for

it ".." $ property $
  ..

valuexprop :: (HasCallStack, Testable prop) => String -> prop -> Spec

#

xprop ".." $
  ..

is a shortcut for

xit ".." $ property $
  ..

valuedescribe :: HasCallStack => String -> SpecWith a -> SpecWith a

#

The describe function combines a list of specs into a larger spec.

valuefdescribe :: HasCallStack => String -> SpecWith a -> SpecWith a

#

fdescribe is an alias for fmap focus . describe

valuefit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

#

fit is an alias for fmap focus . it

valueit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

#

The it function creates a spec item.

A spec item consists of:

a textual description of a desired behavior
an example for that behavior

describe "absolute" $ do
  it "returns a positive number when given a negative number" $
    absolute (-1) == 1

Example a optionally accepts an argument Arg a, which is then given to the test body. This is useful for provisioning resources for a test which are created and cleaned up outside the test itself. See Arg for details.

Note that this function is often on the scene of nasty type errors due to GHC failing to infer the type of do notation in the test body. It can be helpful to use TypeApplications to explicitly specify the intended Example type.

valuexdescribe :: HasCallStack => String -> SpecWith a -> SpecWith a

#

Changing describe to xdescribe marks all spec items of the corresponding subtree as pending.

This can be used to temporarily disable spec items.

valuexit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)

#

Changing it to xit marks the corresponding spec item as pending.

This can be used to temporarily disable a spec item.

datadata ImpEnv t

#

Constructors

ImpEnv
- impEnvSpecEnv :: !ImpSpecEnv t
- impEnvStateRef :: !IORef (ImpState t)
- impEnvQCGenRef :: !IOGenM QCGen
- impEnvQCSize :: !Int

datadata ImpException

#

Stores extra information about the failure of the unit test

Constructors

ImpException
- ieAnnotation :: [Doc AnsiStyle]
  Description of the IO action that caused the failure
- ieThrownException :: SomeException
  Exception that caused the test to fail

Instances2Show, Exception

Show ImpExceptionDefined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
Exception ImpExceptionDefined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal

datadata ImpInit t

#

Constructors

ImpInit
- impInitEnv :: ImpSpecEnv t
- impInitState :: ImpSpecState t

Instances3Eq, Ord, Show

(Eq (ImpSpecEnv t), Eq (ImpSpecState t)) => Eq (ImpInit t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
(Ord (ImpSpecEnv t), Ord (ImpSpecState t)) => Ord (ImpInit t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
(Show (ImpSpecEnv t), Show (ImpSpecState t)) => Show (ImpInit t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal

newtypenewtype ImpM t a

#

Constructors

ImpM
- unImpM :: ReaderT (ImpEnv t) IO a

Instances15MonadReader, MonadState, Monad, Functor, MonadFail, Applicative, …

env ~ ImpSpecEnv t => MonadReader env (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
s ~ ImpSpecState t => MonadState s (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
Monad (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
Functor (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
MonadFail (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
Applicative (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
MonadIO (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
MonadGen (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
MonadUnliftIO (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
HasStatefulGen (IOGenM QCGen) (ImpM t)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
(ImpSpec t, Testable a) => Testable (ImpM t a)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
(ImpSpec t, Testable p) => Example (ImpM t p)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
(Arbitrary a, Show a, ImpSpec t, Testable p) => Example (a -> ImpM t p)Defined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
type Arg (ImpM t p) = ImpInit tDefined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal
type Arg (a -> ImpM t p) = ImpInit tDefined in ImpSpec-0.2.0.0 · Test.ImpSpec.Internal

classclass ImpSpec t where

#

Associated types

type family ImpSpecEnv t
type family ImpSpecState t

Methods

impInitIO :: QCGen -> IO (ImpInit t)
impPrepAction :: ImpM t ()
This will be the very first action that will run in all ImpM specs.

familytype family ImpSpecEnv t

#

familytype family ImpSpecState t

#

datadata ImpState t

#

Constructors

ImpState
- impStateSpecState :: !ImpSpecState t
- impStateLog :: !Doc AnsiStyle

typetype Spec = SpecWith ()

#

A SpecWith that can be evaluated directly by the hspec function as it does not require any parameters.

typetype SpecWith a = SpecM a ()

#

A SpecWith a represents a test or group of tests that require an a value to run.

In the common case, a Spec is a SpecWith () which requires () and can thus be executed with hspec.

To supply an argument to SpecWith tests to turn them into Spec, use functions from Test.Hspec.Core.Hooks such as around, before, mapSubject and similar.

Values of this type are created by it, describe and similar.