Distribution.TestSuite.QuickCheck

This module allows you to easily make Cabal tests for the detailed-0.9 interface. ([docs](https:/cabal.readthedocs.ioen3.6cabal-package.html#example-package-using-detailed-0-9-interface)) It sets sensible option declarations for the tests.

This module re-uses record names from Distribution.TestSuite and Test.QuickCheck. It is recommended that you enable the DisambiguateRecordFields extension in GHC and/or import the module qualified. For basic tests, you don’t need to import Distribution.TestSuite.

Create tests

getPropertyTest :: Testable prop => PropertyTest prop -> Test

Get a Cabal Test from a PropertyTest

getPropertyTestWith

Arguments

:: Testable prop

=> TestArgs

The arguments for the test

-> PropertyTest prop

-> Test

Get a Cabal Test from a PropertyTest with custom TestArgs

getPropertyTestUsing

Arguments

:: Testable prop

=> PropertyTest (TestArgs -> prop)

A property test whose property takes a TestArgs argument

-> Test

Get a Cabal Test from a PropertyTest that takes the test arguments and returns a Testable value

getPropertyTestWithUsing

Arguments

:: Testable prop

=> TestArgs

The arguments for the test

-> PropertyTest (TestArgs -> prop)

A property test whose property takes a TestArgs argument

-> Test

Get a Cabal Test with custom TestArgs from a PropertyTest that takes the test arguments and returns a testable value

getPropertyTests :: Testable prop => [PropertyTest prop] -> [Test]

Get a list of Tests from a list of PropertyTests

propertyTestGroup :: Testable prop => String -> [PropertyTest prop] -> Test

Get a named test group from a list of PropertyTests. These are assumed to be able to run in parallel. See testGroup and Group.

Argument data types

data PropertyTest prop

Property test declaration with metadata

Constructors

PropertyTest

Fields

• name :: String

  Name of the test, for Cabal. See See Cabal’s name.

• tags :: [String]

  Tags of the test, for Cabal. See Cabal’s tags.

• property :: prop

  Property to check. This should usually be or return an instance of Testable.

data TestArgs

Arguments for altering property test behaviour. These can be altered in the final Cabal Test using setOption.

Constructors

TestArgs

Fields

• verbosity :: Verbosity

  Verbosity for tests. See verbose and chatty.

• verboseShrinking :: Bool

  Whether QuickCheck should print shrinks. See verboseShrinking.

• maxDiscardRatio :: Int

  Maximum discarded tests per successful test. See maxDiscardRatio.

• noShrinking :: Bool

  Disable shrinking. See noShrinking.

• maxShrinks :: Int

  Maximum number of shrink attempts. See maxShrinks.

• maxSuccess :: Int

  Maximum number of successful checks before passing. See maxSuccess.

• maxSize :: Int

  Maximum size of test cases. See maxSize.

• sizeScale :: Int

  Scale size by an integer using mapSize.

data Verbosity

Datatype for setting the verbosity of tests

Constructors

Silent

QuickCheck prints nothing. This sets chatty = False.

Chatty

Print basic statistics. This sets chatty = True.

Verbose

Print every test case. This applies verbose.

Instances

Bounded Verbosity

Defined in Distribution.TestSuite.QuickCheck

Methods

minBound :: Verbosity

maxBound :: Verbosity

Enum Verbosity

Defined in Distribution.TestSuite.QuickCheck

Methods

succ :: Verbosity -> Verbosity

pred :: Verbosity -> Verbosity

toEnum :: Int -> Verbosity

fromEnum :: Verbosity -> Int

enumFrom :: Verbosity -> [Verbosity]

enumFromThen :: Verbosity -> Verbosity -> [Verbosity]

enumFromTo :: Verbosity -> Verbosity -> [Verbosity]

enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity]

Read Verbosity

Defined in Distribution.TestSuite.QuickCheck

Methods

readsPrec :: Int -> ReadS Verbosity

readList :: ReadS [Verbosity]

readPrec :: ReadPrec Verbosity

readListPrec :: ReadPrec [Verbosity]

Show Verbosity

Defined in Distribution.TestSuite.QuickCheck

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

Eq Verbosity

Defined in Distribution.TestSuite.QuickCheck

Methods

(==) :: Verbosity -> Verbosity -> Bool

(/=) :: Verbosity -> Verbosity -> Bool

Ord Verbosity

Silent < Chatty < Verbose

Defined in Distribution.TestSuite.QuickCheck

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

(<=) :: Verbosity -> Verbosity -> Bool

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

Functions for using arguments

argsToTestArgs :: Args -> TestArgs

Transform a QuickCheck Args value to a TestArgs value, defaulting all missing properties

testArgsToArgs :: TestArgs -> Args

Recover arguments passed to quickCheck from a TestArgs

stdTestArgs :: TestArgs

Default arguments for property tests