Safe Haskell	None
Language	GHC2021

Futhark.Test.Property

Synopsis

runPBT :: PBTConfig -> Server -> [PropSpec] -> IORef PBTPhase -> FilePath -> IO [Either PBTFailure PBTOutput]
data PBTConfig = PBTConfig {
- configNumTests :: Int32
- configMaxSize :: Int64
- configSeed :: Word64
- configShrinkTries :: Int
}
data PBTPhase = PBTPhase {
- activeTest :: Maybe EntryName
- phase :: Maybe EntryName
- shrinkWith :: Maybe EntryName
- phaseSize :: Maybe Int64
- phaseSeed :: Maybe Word64
- phaseRandom :: Maybe Word64
}
data PropSpec = PropSpec {
- psProp :: Text
- psGen :: Maybe Text
- psShrink :: Maybe Text
- psSize :: Maybe Int64
}
type PBTOutput = Maybe Text
type PBTFailure = Text
extractPropSpecs :: Server -> [EntryName] -> IO (Either PBTFailure [PropSpec])

Documentation

runPBT :: PBTConfig -> Server -> [PropSpec] -> IORef PBTPhase -> FilePath -> IO [Either PBTFailure PBTOutput] Source #

Run a list of property specifications, returning a list of results. Each result is either a failure with an error message or a success.

data PBTConfig Source #

Configuration for property-based testing. Includes parameters for test case generation, shrinking, and random seed management.

Constructors

PBTConfig

Fields

configNumTests :: Int32
Number of test cases to run for each property.
configMaxSize :: Int64
Maximum size argument to pass to generators and shrinkers (unless overridden by PropSpec).
configSeed :: Word64
Seed to use for the random number generator (can be overridden by PropSpec).
configShrinkTries :: Int
Number of shrinking attempts to make on userdefined shrinker before giving up and reporting the current candidate as the final counterexample.

Instances

Instances details

Show PBTConfig Source #
Instance details Defined in Futhark.Test.Property Methods showsPrec :: Int -> PBTConfig -> ShowS # show :: PBTConfig -> String # showList :: [PBTConfig] -> ShowS #
Eq PBTConfig Source #
Instance details Defined in Futhark.Test.Property Methods (==) :: PBTConfig -> PBTConfig -> Bool # (/=) :: PBTConfig -> PBTConfig -> Bool #

data PBTPhase Source #

Information about the current phase of property-based testing, used for logging and debugging.

Constructors

PBTPhase

Fields

activeTest :: Maybe EntryName
Property being tested (same for generator and shrinker phases).
phase :: Maybe EntryName
Current entrypoint being called (property, generator, or shrinker).
shrinkWith :: Maybe EntryName
Property or generator (only for auto).
phaseSize :: Maybe Int64
Size argument for generator and shrinker phases.
phaseSeed :: Maybe Word64
Seed argument for generator and shrinker phases.
phaseRandom :: Maybe Word64
Random value argument for shrinker phase (used for user-defined shrinker, otherwise Nothing).

Instances

Instances details

Show PBTPhase Source #
Instance details Defined in Futhark.Test.Property Methods showsPrec :: Int -> PBTPhase -> ShowS # show :: PBTPhase -> String # showList :: [PBTPhase] -> ShowS #
Eq PBTPhase Source #
Instance details Defined in Futhark.Test.Property Methods (==) :: PBTPhase -> PBTPhase -> Bool # (/=) :: PBTPhase -> PBTPhase -> Bool #

data PropSpec Source #

Specification for a property to be tested, including the property entry point and optional generator and shrinker entry points, as well as an optional size parameter.

Constructors

PropSpec
Fields psProp :: Text The property entry point to test. psGen :: Maybe Text Optional generator entry point to use instead of the default auto-generator. psShrink :: Maybe Text Optional shrinker entry point to use instead of the default auto-shrinker. psSize :: Maybe Int64 Optional size argument to pass to the generator and shrinker phases (overrides `configMaxSize`).

Instances

Instances details

Show PropSpec Source #
Instance details Defined in Futhark.Test.Property Methods showsPrec :: Int -> PropSpec -> ShowS # show :: PropSpec -> String # showList :: [PropSpec] -> ShowS #
Eq PropSpec Source #
Instance details Defined in Futhark.Test.Property Methods (==) :: PropSpec -> PropSpec -> Bool # (/=) :: PropSpec -> PropSpec -> Bool #

type PBTOutput = Maybe Text Source #

Output of a property-based test run, which is either a failure with an error message or a success.

type PBTFailure = Text Source #

Failure in property-based testing, represented as an error message. For example a division by zero runtime error.

extractPropSpecs :: Server -> [EntryName] -> IO (Either PBTFailure [PropSpec]) Source #

Extract property specifications from the server by looking for entry points with #[prop(...)] attributes, comparing with the declared list of properties.