Test.FitSpec.Report

Generate FitSpec reports.

Documentation

report :: (Mutable a, ShowMutable a) => a -> (a -> [Property]) -> IO ()

Report results generated by FitSpec. Uses standard configuration (see args). Needs a function to be mutated and a property map. Example (specification of boolean negation):

properties not =
  [ property $ \p -> not (not p) == p
  , property $ \p -> not (not (not p)) == not p
  ]

main = report not properties

reportWith :: (Mutable a, ShowMutable a) => Args -> a -> (a -> [Property]) -> IO ()

Same as report but can be configured via Args (args or fixargs), e.g.:

reportWith args { timeout = 10 } fun properties

reportWithExtra :: (Mutable a, ShowMutable a) => [a] -> Args -> a -> (a -> [Property]) -> IO ()

Same as reportWith, but accepts a list of manually defined (extra) mutants to be tested alongside those automatically generated.

data Args

Extra arguments / configuration for reportWith. See args for default values.

Constructors

Args

Fields

• nMutants :: Int

  (starting) number of function mutations

• nTests :: Int

  (starting) number of test values (for each prop.)

• timeout :: Int

  timeout in seconds, 0 for just nTests * nMutants

• names :: [String]

  names of functions: ["foo x y","goo x y"]

• verbose :: Bool

  whether to show detailed results

• showMutantAs :: ShowMutantAs

  how to show mutants

• rows :: Maybe Int

  number of surviving mutants to show

• extra :: [String]

  ignored argument (user defined meaning)

Instances

Data Args

Defined in Test.FitSpec.Main

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Args -> c Args

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Args

toConstr :: Args -> Constr

dataTypeOf :: Args -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Args)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Args)

gmapT :: (forall b. Data b => b -> b) -> Args -> Args

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Args -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Args -> r

gmapQ :: (forall d. Data d => d -> u) -> Args -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Args -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Args -> m Args

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Args -> m Args

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Args -> m Args

args :: Args

Default arguments for reportWith:

• nMutants = 500, start with 500 mutants
• nTests = 1000, start with 1000 test values
• timeout = 5, keep incresing the number of mutants until 5 seconds elapse
• names = [], default function call template:

["f x y z", "g x y z", "h x y z", ...]

fixargs :: Int -> Int -> Args

Non timed-out default arguments. Make conjectures based on a fixed number of mutants and tests, e.g.:

reportWith (fixargs 100 200) f pmap

This is just a shorthand, see:

fixargs nm nt  =  args { nMutants = nm, nTests = nt, timeout = 0 }

(fixargs nm nt) { nMutants = 500, nTests = 1000, timeout = 5 }  =  args

type Property = [([String], Bool)]

An encoded representation of a property suitable for use by FitSpec.

Each list of strings is a printable representation of one possible choice of argument values for the property. Each boolean indicate whether the property holds for this choice.

data ShowMutantAs

How to show mutants. Use this to fill showMutantAs.

Constructors

Tuple

NestedTuple

Definition

Bindings

Instances

Data ShowMutantAs

Defined in Test.FitSpec.Main

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ShowMutantAs -> c ShowMutantAs

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ShowMutantAs

toConstr :: ShowMutantAs -> Constr

dataTypeOf :: ShowMutantAs -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ShowMutantAs)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ShowMutantAs)

gmapT :: (forall b. Data b => b -> b) -> ShowMutantAs -> ShowMutantAs

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ShowMutantAs -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ShowMutantAs -> r

gmapQ :: (forall d. Data d => d -> u) -> ShowMutantAs -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ShowMutantAs -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ShowMutantAs -> m ShowMutantAs

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ShowMutantAs -> m ShowMutantAs

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ShowMutantAs -> m ShowMutantAs