Test.Sandwich.QuickCheck

Functions for introducing QuickCheck tests into a Sandwich test tree. Modelled after Hspec's version.

Documentation can be found here.

Introducing QuickCheck args

introduceQuickCheck :: (MonadIO m, MonadBaseControl IO m) => SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Same as introduceQuickCheck' but with default args.

introduceQuickCheck' :: (MonadIO m, MonadBaseControl IO m) => Args -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Same as introduceQuickCheck'' but with a default message.

introduceQuickCheck'' :: (MonadIO m, MonadBaseControl IO m) => String -> Args -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Introduce QuickCheck args with configurable message.

Versions that can be configured with built-in command line arguments.

introduceQuickCheckCommandLineOptions :: forall a m context. (MonadIO m, MonadBaseControl IO m, HasLabel context "commandLineOptions" (CommandLineOptions a), MonadReader context m) => SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Same as introduceQuickCheckCommandLineOptions' but with default args.

introduceQuickCheckCommandLineOptions' :: forall a m context. (MonadIO m, MonadBaseControl IO m, HasLabel context "commandLineOptions" (CommandLineOptions a), MonadReader context m) => Args -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Same as introduceQuickCheckCommandLineOptions'' but with a default message.

introduceQuickCheckCommandLineOptions'' :: forall a m context. (MonadIO m, MonadBaseControl IO m, HasLabel context "commandLineOptions" (CommandLineOptions a), MonadReader context m) => String -> Args -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Introduce QuickCheck args with configurable message, overriding those args with any command line options passed.

Prop

prop :: (HasCallStack, HasQuickCheckContext context, MonadIO m, MonadThrow m, Testable prop) => String -> prop -> Free (SpecCommand context m) ()

Similar to it. Runs the given prop with QuickCheck using the currently introduced Args. Throws an appropriate exception on failure.

Modifying QuickCheck args

modifyArgs :: (HasQuickCheckContext context, Monad m) => (Args -> Args) -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Modify the Args for the given spec.

modifyMaxSuccess :: (HasQuickCheckContext context, Monad m) => (Int -> Int) -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Modify the maxSuccess for the given spec.

modifyMaxDiscardRatio :: (HasQuickCheckContext context, Monad m) => (Int -> Int) -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Modify the maxDiscardRatio for the given spec.

modifyMaxSize :: (HasQuickCheckContext context, Monad m) => (Int -> Int) -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Modify the maxSize for the given spec.

modifyMaxShrinks :: (HasQuickCheckContext context, Monad m) => (Int -> Int) -> SpecFree (LabelValue "quickCheckContext" QuickCheckContext :> context) m () -> SpecFree context m ()

Modify the maxShrinks for the given spec.