Skeletest

Spec

type Spec = Spec' ()

describe :: String -> Spec -> Spec

it :: String -> IO () -> Spec

prop :: String -> Property -> Spec

Modifiers

xfail :: String -> Spec -> Spec

Mark the given spec as expected to fail. Fails tests if they unexpectedly pass.

Can be selected with the marker @xfail

skip :: String -> Spec -> Spec

Skip all tests in the given spec.

Can be selected with the marker @skip

markManual :: Spec -> Spec

Markers

class (Show a, Typeable a) => IsMarker a where

Methods

getMarkerName :: a -> String

The name of the marker that can be selected with @name syntax.

Marker names must only include alphanumeric characters, hyphens, underscores, and periods.

Instances

IsMarker AnonMarker

Defined in Skeletest.Internal.Markers

Methods

getMarkerName :: AnonMarker -> String

withMarkers :: [String] -> Spec -> Spec

Adds the given names as plain markers to all tests in the given spec.

See getMarkerName.

withMarker :: IsMarker a => a -> Spec -> Spec

Adds the given marker to all the tests in the given spec.

Useful for selecting tests from the command line or identifying tests in hooks

Assertions

shouldBe :: (HasCallStack, Testable m, Eq a) => a -> a -> m () infix 1

shouldNotBe :: (HasCallStack, Testable m, Eq a) => a -> a -> m () infix 1

shouldSatisfy :: (HasCallStack, Testable m) => a -> Predicate m a -> m () infix 1

shouldNotSatisfy :: (HasCallStack, Testable m) => a -> Predicate m a -> m () infix 1

context :: Testable m => String -> m a -> m a

failTest :: (HasCallStack, Testable m) => String -> m a

type HasCallStack = ?callStack :: CallStack

Request a CallStack.

NOTE: The implicit parameter ?callStack :: CallStack is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.

@since base-4.9.0.0

data Predicate (m :: Type -> Type) a

class MonadIO m => Testable (m :: Type -> Type)

Minimal complete definition

runTestable, context, throwFailure

Instances

Testable IO

Defined in Skeletest.Assertions

Methods

runTestable :: IO () -> IO ()

context :: String -> IO a -> IO a

throwFailure :: AssertionFail -> IO a

Testable PropertyM

Defined in Skeletest.Prop.Internal

Methods

runTestable :: PropertyM () -> IO ()

context :: String -> PropertyM a -> PropertyM a

throwFailure :: AssertionFail -> PropertyM a

Properties

type Property = PropertyM ()

A property to run, with optional configuration settings specified up front.

Settings should be specified before any forAll or IO calls; any settings specified afterwards are ignored.

data PropertyM a

Instances

MonadIO PropertyM

Defined in Skeletest.Prop.Internal

Methods

liftIO :: IO a -> PropertyM a

Applicative PropertyM

Defined in Skeletest.Prop.Internal

Methods

pure :: a -> PropertyM a

(<*>) :: PropertyM (a -> b) -> PropertyM a -> PropertyM b

liftA2 :: (a -> b -> c) -> PropertyM a -> PropertyM b -> PropertyM c

(*>) :: PropertyM a -> PropertyM b -> PropertyM b

(<*) :: PropertyM a -> PropertyM b -> PropertyM a

Functor PropertyM

Defined in Skeletest.Prop.Internal

Methods

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

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

Monad PropertyM

Defined in Skeletest.Prop.Internal

Methods

(>>=) :: PropertyM a -> (a -> PropertyM b) -> PropertyM b

(>>) :: PropertyM a -> PropertyM b -> PropertyM b

return :: a -> PropertyM a

Testable PropertyM

Defined in Skeletest.Prop.Internal

Methods

runTestable :: PropertyM () -> IO ()

context :: String -> PropertyM a -> PropertyM a

throwFailure :: AssertionFail -> PropertyM a

type Gen = GenT Identity

Generator for random values of a.

forAll :: (HasCallStack, Show a) => Gen a -> PropertyM a

discard :: PropertyM a

Settings

setDiscardLimit :: Int -> Property

setShrinkLimit :: Int -> Property

setShrinkRetries :: Int -> Property

setConfidence :: Int -> Property

setVerifiedTermination :: Property

setTestLimit :: Int -> Property

Fixtures

class Typeable a => Fixture a where

Minimal complete definition

fixtureAction

Methods

fixtureScope :: FixtureScope

The scope of the fixture, defaults to per-test

fixtureAction :: IO (a, FixtureCleanup)

Instances

Fixture FixtureTmpDir

Defined in Skeletest.Internal.Fixtures

Methods

fixtureScope :: FixtureScope

fixtureAction :: IO (FixtureTmpDir, FixtureCleanup)

data FixtureScope

Constructors

PerTestFixture

PerFileFixture

PerSessionFixture

Instances

Show FixtureScope

Defined in Skeletest.Internal.Fixtures

Methods

showsPrec :: Int -> FixtureScope -> ShowS

show :: FixtureScope -> String

showList :: [FixtureScope] -> ShowS

data FixtureCleanup

Constructors

NoCleanup

CleanupFunc (IO ())

getFixture :: (Fixture a, MonadIO m) => m a

Load a fixture, initializing it if it hasn't been cached already.

noCleanup :: a -> (a, FixtureCleanup)

A helper for specifying no cleanup.

withCleanup :: a -> IO () -> (a, FixtureCleanup)

A helper for defining the cleanup function in-line.

Built-in fixtures

newtype FixtureTmpDir

A fixture that provides a temporary directory that can be used in a test.

Constructors

FixtureTmpDir FilePath

Instances

Fixture FixtureTmpDir

Defined in Skeletest.Internal.Fixtures

Methods

fixtureScope :: FixtureScope

fixtureAction :: IO (FixtureTmpDir, FixtureCleanup)

CLI flags

data Flag

Register a CLI flag.

Usage:

{- MyFixture.hs -}
import Skeletest

newtype MyFlag = MyFlag String
instance IsFlag MyFlag where
  flagName = "my-flag"
  flagHelp = "The value for MyFixture"
  flagSpec =
    OptionalFlag
      { flagDefault = "foo"
      , flagParse = case
          "illegal" -> Left "invalid flag value"
          s -> Right (MyFlag s)
      }

instance Fixture MyFixture where
  fixtureAction = do
    MyFlag val <- getFlag
    ...

{- Main.hs -}
import MyFixture

cliFlags =
  [ flag @MyFlag
  ]

Constructors

IsFlag a => Flag (Proxy a)

class Typeable a => IsFlag a where

Minimal complete definition

flagName, flagHelp, flagSpec

Methods

flagName :: String

flagShort :: Maybe Char

flagMetaVar :: String

The placeholder for the flag to show in the help text, if the flag takes an argument.

flagHelp :: String

flagSpec :: FlagSpec a

Instances

IsFlag SnapshotUpdateFlag

Defined in Skeletest.Internal.Snapshot

Methods

flagName :: String

flagShort :: Maybe Char

flagMetaVar :: String

flagHelp :: String

flagSpec :: FlagSpec SnapshotUpdateFlag

IsFlag PropLimitFlag

Defined in Skeletest.Prop.Internal

Methods

flagName :: String

flagShort :: Maybe Char

flagMetaVar :: String

flagHelp :: String

flagSpec :: FlagSpec PropLimitFlag

IsFlag PropSeedFlag

Defined in Skeletest.Prop.Internal

Methods

flagName :: String

flagShort :: Maybe Char

flagMetaVar :: String

flagHelp :: String

flagSpec :: FlagSpec PropSeedFlag

data FlagSpec a

Constructors

SwitchFlag

Fields

• flagFromBool :: Bool -> a

RequiredFlag

Fields

• flagParse :: String -> Either String a

OptionalFlag

Fields

• flagDefault :: a
• flagParse :: String -> Either String a

getFlag :: forall a m. (MonadIO m, IsFlag a) => m a