Modulehspec-api-2.11.18Haskell2010

Test.Hspec.Api.Format.V1

12 types
5 values

Packagehspec-api-2.11.18
Exports17
LanguageHaskell2010
LicenceMIT
SourceExample.hs

typetype Format = Event -> IO ()

datadata FormatConfig

Constructors

FormatConfig
- formatConfigUseColor :: Bool
- formatConfigReportProgress :: Bool
- formatConfigOutputUnicode :: Bool
- formatConfigUseDiff :: Bool
- formatConfigDiffContext :: Maybe Int
- formatConfigExternalDiff :: Maybe (String -> String -> IO ())
- formatConfigPrettyPrint :: Bool
  Deprecated: use formatConfigPrettyPrintFunction instead
- formatConfigPrettyPrintFunction :: Maybe (String -> String -> (String, String))
- formatConfigPrintTimes :: Bool
- formatConfigHtmlOutput :: Bool
- formatConfigPrintCpuTime :: Bool
- formatConfigUsedSeed :: Integer
- formatConfigExpectedTotalCount :: Int

datadata Event

Constructors

Started
GroupStarted Path
GroupDone Path
Progress Path Progress
ItemStarted Path
ItemDone Path Item
Done [(Path, Item)]

Instances1Show

Show EventDefined in hspec-api-2.11.18 · Test.Hspec.Api.Format.V1

typetype Progress = (Int, Int)

(CurrentItem, TotalItems) tuple.

typetype Path = ([String], String)

A Path describes the location of a spec item within a spec tree.

It consists of a list of group descriptions and a requirement description.

datadata Location

Location is used to represent source locations.

Constructors

Location
- locationFile :: FilePath
- locationLine :: Int
- locationColumn :: Int

Instances3Eq, Read, Show

Eq LocationDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example.Location
Read LocationDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example.Location
Show LocationDefined in hspec-core-2.11.18 · Test.Hspec.Core.Example.Location

newtypenewtype Seconds

Constructors

Seconds Double

Instances6Eq, Fractional, Num, Ord, Show, PrintfArg

Eq SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Fractional SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Num SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Ord SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
Show SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock
PrintfArg SecondsDefined in hspec-core-2.11.18 · Test.Hspec.Core.Clock

datadata Item

Constructors

Item
- itemLocation :: Maybe Location
- itemDuration :: Seconds
- itemInfo :: String
- itemResult :: Result

Instances1Show

Show ItemDefined in hspec-api-2.11.18 · Test.Hspec.Api.Format.V1.Internal

datadata Result

Constructors

Success
Pending (Maybe Location) (Maybe String)
Failure (Maybe Location) FailureReason

Instances1Show

Show ResultDefined in hspec-api-2.11.18 · Test.Hspec.Api.Format.V1.Internal

datadata FailureReason

Constructors

NoReason
Reason String
ExpectedButGot (Maybe String) String String
Error (Maybe String) SomeException

Instances1Show

Show FailureReasonDefined in hspec-core-2.11.18 · Test.Hspec.Core.Formatters.V1.Monad

valuemonadic :: MonadIO m => (m () -> IO ()) -> (Event -> m ()) -> IO Format

Register a formatter

3 declarations

valueregisterFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config

Make a formatter available for use with --format.

valueuseFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config

Make a formatter available for use with --format and use it by default.

valueliftFormatter

:: (String, FormatConfig -> IO Format)
-> (String, FormatConfig -> IO Format)

Make a formatter compatible with types from Test.Hspec.Core.Format.

Re-exports

3 declarations

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.

datadata Config

valuemodifyConfig :: (Config -> Config) -> SpecWith a