Type Members

1.  case class MaxDiscardedFactor(value: PosZDouble) extends PropertyCheckConfigParam with Product with Serializable

   A PropertyCheckConfigParam that specifies how many generated values may be discarded, as a multiple of the successful attempts, before the property check is considered to be org.scalatest.prop.PropertyCheckResult.Exhausted.

   A PropertyCheckConfigParam that specifies how many generated values may be discarded, as a multiple of the successful attempts, before the property check is considered to be org.scalatest.prop.PropertyCheckResult.Exhausted.

   In GeneratorDrivenPropertyChecks, a property evaluation is discarded if it throws DiscardedEvaluationException, which is produced by a whenever clause that evaluates to false. For example, consider this ScalaTest property check:

   // forAll defined in GeneratorDrivenPropertyChecks
   forAll { (n: Int) =>
     whenever (n > 0) {
       doubleIt(n) should equal (n * 2)
     }
   }
   
   
   

   In the above code, whenever a non-positive n is passed, the property function will complete abruptly with DiscardedEvaluationException.

   Similarly, in Checkers, a property evaluation is discarded if the expression to the left of ScalaCheck's ==> operator is false. Here's an example:

   // forAll defined in Checkers
   forAll { (n: Int) =>
     (n > 0) ==> doubleIt(n) == (n * 2)
   }
   
   
   

   For either kind of property check, MaxDiscardedFactor indicates the maximum fraction of total tests that may be discarded, relative to the number of successful tests. For example, if this is set to 4.0, and you are running 100 tests, it may discard up to 400 tries before considering the test to be org.scalatest.prop.PropertyCheckResult.Exhausted.

   value

   the permitted number of discarded tests, as a multiple of successful ones.

   Definition Classes

   Configuration

2.  case class MinSize(value: PosZInt) extends PropertyCheckConfigParam with Product with Serializable

   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 size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).

   Definition Classes

   Configuration

3.  case class MinSuccessful(value: PosInt) extends PropertyCheckConfigParam with Product with Serializable

   A PropertyCheckConfigParam that specifies the minimum number of successful property evaluations required for the property to pass.

   A PropertyCheckConfigParam that specifies the minimum number of successful property evaluations required for the property to pass.

   Once this many evaluations have passed, the property will return PropertyCheckResult.Success.

   Definition Classes

   Configuration

4.  case class Parameter(minSuccessful: PosInt = PosInt.ensuringValid(10), maxDiscardedFactor: PosZDouble = PosZDouble.ensuringValid(5.0), minSize: PosZInt = PosZInt.ensuringValid(0), sizeRange: PosZInt = PosZInt.ensuringValid(100), workers: PosInt = PosInt.ensuringValid(1)) extends Product with Serializable

   The parameters that define how a property evaluation should be executed.

   The parameters that define how a property evaluation should be executed.

   You typically will not build this directly. Instead, you should define a PropertyCheckConfiguration and/or some PropertyCheckConfigParams, pass those in, and the system will resolve those to a coherent Parameter.

   minSuccessful

   the minimum number of successful property evaluations required for the property to pass; see MinSuccessful

   maxDiscardedFactor

   how many generated values may be discarded, as a multiple of the successful attempts, before the property check is considered to be org.scalatest.prop.PropertyCheckResult.Exhausted; see MaxDiscardedFactor

   minSize

   the minimum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists); see MinSize

   sizeRange

   the maximum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists); see SizeRange

   workers

   number of worker threads to use when evaluating a property; see Workers

5.  sealed abstract class PropertyCheckConfigParam extends Product with Serializable

   Abstract class defining a family of configuration parameters for property checks.

   Abstract class defining a family of configuration parameters for property checks.

   The subclasses of this abstract class are used to pass configuration information to the forAll methods of traits PropertyChecks (for ScalaTest-style property checks) and Checkers(for ScalaCheck-style property checks).

   Definition Classes

   Configuration

6.  case class PropertyCheckConfiguration(minSuccessful: PosInt = PosInt.ensuringValid(10), maxDiscardedFactor: PosZDouble = PosZDouble.ensuringValid(5.0), minSize: PosZInt = Configuration.minSize.get(), sizeRange: PosZInt = Configuration.sizeRange.get(), workers: PosInt = PosInt.ensuringValid(1)) extends Product with Serializable

   Describes the configuration to use when evaluating a property.

   Describes the configuration to use when evaluating a property.

   minSuccessful

   the minimum number of successful property evaluations required for the property to pass; see MinSuccessful

   maxDiscardedFactor

   how many generated values may be discarded, as a multiple of the successful attempts, before the property check is considered to be org.scalatest.prop.PropertyCheckResult.Exhausted; see MaxDiscardedFactor

   minSize

   the minimum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists); see MinSize

   sizeRange

   the maximum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists); see SizeRange

   workers

   number of worker threads to use when evaluating a property; see Workers

   Definition Classes

   Configuration

7.  case class SizeRange(value: PosZInt) extends PropertyCheckConfigParam with Product with Serializable

   A PropertyCheckConfigParam that (with minSize) 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 (with minSize) 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 size range is added to minSize in order to calculate the maximum size passed to ScalaCheck. Using a range allows compile-time checking of a non-negative number being specified.

   Definition Classes

   Configuration

8.  case class Workers(value: PosInt) extends PropertyCheckConfigParam with Product with Serializable

   A PropertyCheckConfigParam that specifies the number of worker threads to use when evaluating a property.

   A PropertyCheckConfigParam that specifies the number of worker threads to use when evaluating a property.

   Property evaluation runs on a single thread by default, but may run multiple threads if desired. If so, the evaluation will generally run faster. However, be careful not to use this if there is any risk of deadlocks, race conditions, or other hazards of multi-threaded code in evaluating this property or the code under test.

   Definition Classes

   Configuration