A PropertyCheckConfigParam
that specifies the maximum number of discarded
property evaluations allowed during property evaluation.
A PropertyCheckConfigParam
that specifies the maximum size parameter to
provide to ScalaCheck, which it will use when generating objects for which size matters (such as
strings or lists).
A PropertyCheckConfigParam
that specifies the minimum size parameter to
provide to ScalaCheck, which it will use when generating objects for which size matters (such as
strings or lists).
A PropertyCheckConfigParam
that specifies the minimum number of successful
property evaluations required for the property to pass.
Configuration object for property checks.
Abstract class defining a family of configuration parameters for property checks.
A PropertyCheckConfigParam
that specifies the number of worker threads
to use when evaluating a property.
Implicit PropertyCheckConfig
value providing default configuration values.
Implicit PropertyCheckConfig
value providing default configuration values.
Returns a MaxDiscarded
property check configuration parameter containing the passed value, which specifies the maximum number of discarded
property evaluations allowed during property evaluation.
Returns a MaxDiscarded
property check configuration parameter containing the passed value, which specifies the maximum number of discarded
property evaluations allowed during property evaluation.
if specified value
is less than zero.
Returns a MaxSize
property check configuration parameter containing the passed value, which specifies the maximum size parameter to
provide to ScalaCheck, which it will use when generating objects for which size matters (such as
strings or lists).
Returns a MaxSize
property check configuration parameter containing the passed value, which specifies the maximum size parameter to
provide to ScalaCheck, which it will use when generating objects for which size matters (such as
strings or lists).
Note that the maximum size should be greater than or equal to the minimum size. This requirement is
enforced by the PropertyCheckConfig
constructor and the forAll
methods of
traits PropertyChecks
and Checkers
. In other words, it is enforced at the point
both a maximum and minimum size are provided together.
if specified value
is less than zero.
Returns a MinSize
property check configuration parameter containing the passed value, which specifies the minimum size parameter to
provide to ScalaCheck, which it will use when generating objects for which size matters (such as
strings or lists).
Returns a MinSize
property check configuration parameter containing the passed value, which specifies the minimum size parameter to
provide to ScalaCheck, which it will use when generating objects for which size matters (such as
strings or lists).
if specified value
is less than zero.
Returns a MinSuccessful
property check configuration parameter containing the passed value, which specifies the minimum number of successful
property evaluations required for the property to pass.
Returns a MinSuccessful
property check configuration parameter containing the passed value, which specifies the minimum number of successful
property evaluations required for the property to pass.
if specified value
is less than or equal to zero.
Evaluates the passed code block if the passed boolean condition is true, else throws DiscardedEvaluationException
.
Evaluates the passed code block if the passed boolean condition is true, else throws DiscardedEvaluationException
.
The whenever
method can be used inside property check functions to discard invocations of the function with
data for which it is known the property would fail. For example, given the following Fraction
class:
class Fraction(n: Int, d: Int) { require(d != 0) require(d != Integer.MIN_VALUE) require(n != Integer.MIN_VALUE) val numer = if (d < 0) -1 * n else n val denom = d.abs override def toString = numer + " / " + denom }
import org.scalatest.prop.TableDrivenPropertyChecks._ val fractions = Table( ("n", "d"), ( 1, 2), ( -1, 2), ( 1, -2), ( -1, -2), ( 3, 1), ( -3, 1), ( -3, 0), ( 3, -1), ( 3, Integer.MIN_VALUE), (Integer.MIN_VALUE, 3), ( -3, -1) )
Imagine you wanted to check a property against this class with data that includes some
value that are rejected by the constructor, such as a denominator of zero, which should
result in an IllegalArgumentException
. You could use whenever
to discard any rows in the fraction
that represent illegal arguments, like this:
import org.scalatest.matchers.ShouldMatchers._ forAll (fractions) { (n: Int, d: Int) => whenever (d != 0 && d != Integer.MIN_VALUE && n != Integer.MIN_VALUE) { val f = new Fraction(n, d) if (n < 0 && d < 0 || n > 0 && d > 0) f.numer should be > 0 else if (n != 0) f.numer should be < 0 else f.numer should === (0) f.denom should be > 0 } }
In this example, rows 6, 8, and 9 have values that would cause a false to be passed
to whenever
. (For example, in row 6, d
is 0, which means d
!=
0
will be false.) For those rows, whenever
will throw DiscardedEvaluationException
,
which will cause the forAll
method to discard that row.
the boolean condition that determines whether whenever
will evaluate the
fun
function (condition
is true) or throws DiscardedEvaluationException
(condition
is false)
the function to evaluate if the specified condition
is true
Returns a Workers
property check configuration parameter containing the passed value, which specifies the number of worker threads
to use when evaluating a property.
Returns a Workers
property check configuration parameter containing the passed value, which specifies the number of worker threads
to use when evaluating a property.
if specified value
is less than or equal to zero.