Modulehspec-core-2.11.14Haskell2010

Test.Hspec.Core.Extension.Item

This API is experimental.

9 types
5 values

Packagehspec-core-2.11.14
Exports14
LanguageHaskell2010
LicenceMIT
SourceTree.hs

Types

9 declarations

datadata Item a

Item is used to represent spec items internally. A spec item consists of:

a textual description of a desired behavior
an example for that behavior
additional meta information

Everything that is an instance of the Example type class can be used as an example, including QuickCheck properties, Hspec expectations and HUnit assertions.

Constructors

Item
- itemRequirement :: String
  Textual description of behavior
- itemLocation :: Maybe Location
  Source location of the spec item
- itemIsParallelizable :: Maybe Bool
  A flag that indicates whether it is safe to evaluate this spec item in parallel with other spec items
- itemIsFocused :: Bool
  A flag that indicates whether this spec item is focused
- itemAnnotations :: Annotations
  Arbitrary additional data that can be used by third-party extensions.
- itemExample :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
  Example for behavior

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.14 · Test.Hspec.Core.Example.Location
Read LocationDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example.Location
Show LocationDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example.Location

datadata Params

QuickCheck and SmallCheck related parameters.

Constructors

Params
- paramsQuickCheckArgs :: Args
- paramsSmallCheckDepth :: Maybe Int

Instances1Show

Show ParamsDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example

typetype ActionWith a = a -> IO ()

An IO action that expects an argument of type a.

This type is what Examples are ultimately unlifted into for execution.

typetype Progress = (Int, Int)

(CurrentItem, TotalItems) tuple.

typetype ProgressCallback = Progress -> IO ()

Callback used by composite test items that contain many tests to report their progress towards finishing them all.

This is used, for example, to report how many QuickCheck examples are finished.

datadata Result

The result of running an example

Constructors

Result
- resultInfo :: String
- resultStatus :: ResultStatus

Instances5Show, Example, Arg

Show ResultDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example
Example ResultDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example
Example (a -> Result)Defined in hspec-core-2.11.14 · Test.Hspec.Core.Example
type Arg Result = ()Defined in hspec-core-2.11.14 · Test.Hspec.Core.Example
type Arg (a -> Result) = aDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example

datadata ResultStatus

Constructors

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

Instances2Show, Exception

Show ResultStatusDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example
Exception ResultStatusDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example

datadata FailureReason

Constructors

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

Instances2Show, NFData

Show FailureReasonDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example
NFData FailureReasonDefined in hspec-core-2.11.14 · Test.Hspec.Core.Example

Operations

5 declarations

valueisFocused :: Item a -> Bool

valuepending :: Item a -> Item a

valuependingWith :: String -> Item a -> Item a

valuesetAnnotation :: Typeable value => value -> Item a -> Item a

valuegetAnnotation :: Typeable value => Item a -> Maybe value