object Checkers extends Checkers
Companion object that facilitates the importing of Checkers members as
an alternative to mixing it in. One use case is to import Checkers members so you can use
them in the Scala interpreter.
- Annotations
- @deprecated
- Deprecated
Checkers has been moved from org.scalatest.prop to org.scalatestplus.scalacheck. Please update your imports, as this deprecated type alias will be removed in a future version of ScalaTest.
- Source
- Checkers.scala
- Alphabetic
- By Inheritance
- Checkers
- Checkers
- ScalaCheckConfiguration
- Configuration
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class MaxDiscardedFactor(value: PosZDouble) extends PropertyCheckConfigParam with Product with Serializable
- Definition Classes
- Configuration
- case class MinSize(value: PosZInt) extends PropertyCheckConfigParam with Product with Serializable
A
PropertyCheckConfigParamthat 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
PropertyCheckConfigParamthat 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
- Exceptions thrown
IllegalArgumentExceptionif specifiedvalueis less than zero.
- case class MinSuccessful(value: PosInt) extends PropertyCheckConfigParam with Product with Serializable
A
PropertyCheckConfigParamthat specifies the minimum number of successful property evaluations required for the property to pass.A
PropertyCheckConfigParamthat specifies the minimum number of successful property evaluations required for the property to pass.- Definition Classes
- Configuration
- 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
forAllmethods of traitsPropertyChecks(for ScalaTest-style property checks) andCheckers(for ScalaCheck-style property checks).- Definition Classes
- Configuration
- case class PropertyCheckConfiguration(minSuccessful: PosInt = PosInt.from(10).get, maxDiscardedFactor: PosZDouble = PosZDouble.from(5.0).get, minSize: PosZInt = PosZInt.from(0).get, sizeRange: PosZInt = PosZInt.from(100).get, workers: PosInt = PosInt.from(1).get) extends PropertyCheckConfigurable with Product with Serializable
- Definition Classes
- Configuration
- case class SizeRange(value: PosZInt) extends PropertyCheckConfigParam with Product with Serializable
A
PropertyCheckConfigParamthat (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
PropertyCheckConfigParamthat (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
- case class Workers(value: PosInt) extends PropertyCheckConfigParam with Product with Serializable
A
PropertyCheckConfigParamthat specifies the number of worker threads to use when evaluating a property.A
PropertyCheckConfigParamthat specifies the number of worker threads to use when evaluating a property.- Definition Classes
- Configuration
- Exceptions thrown
IllegalArgumentExceptionif specifiedvalueis less than or equal to zero.
Deprecated Type Members
- case class MaxDiscarded(value: Int) extends PropertyCheckConfigParam with Product with Serializable
A
PropertyCheckConfigParamthat specifies the maximum number of discarded property evaluations allowed during property evaluation.A
PropertyCheckConfigParamthat specifies the maximum number of discarded property evaluations allowed during property evaluation.In
GeneratorDrivenPropertyChecks, a property evaluation is discarded if it throwsDiscardedEvaluationException, which is produce bywheneverclause that evaluates to false. For example, consider this ScalaTest property check:// forAll defined in
GeneratorDrivenPropertyChecksforAll { (n: Int) => whenever (n > 0) { doubleIt(n) should equal (n * 2) } }
In the above code, whenever a non-positive
nis passed, the property function will complete abruptly withDiscardedEvaluationException.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
CheckersforAll { (n: Int) => (n > 0) ==> doubleIt(n) == (n * 2) }
For either kind of property check,
MaxDiscardedindicates the maximum number of discarded evaluations that will be allowed. As soon as one past this number of evaluations indicates it needs to be discarded, the property check will fail.- Definition Classes
- Configuration
- Annotations
- @deprecated
- Deprecated
- Exceptions thrown
IllegalArgumentExceptionif specifiedvalueis less than zero.
- case class MaxSize(value: Int) extends PropertyCheckConfigParam with Product with Serializable
A
PropertyCheckConfigParamthat 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
PropertyCheckConfigParamthat 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
PropertyCheckConfigconstructor and theforAllmethods of traitsPropertyChecksandCheckers. In other words, it is enforced at the point both a maximum and minimum size are provided together.- Definition Classes
- Configuration
- Annotations
- @deprecated
- Deprecated
use SizeRange instead
- Exceptions thrown
IllegalArgumentExceptionif specifiedvalueis less than zero.
- case class PropertyCheckConfig(minSuccessful: Int = 10, maxDiscarded: Int = 500, minSize: Int = 0, maxSize: Int = 100, workers: Int = 1) extends PropertyCheckConfigurable with Product with Serializable
Configuration object for property checks.
Configuration object for property checks.
The default values for the parameters are:
minSuccessful 100 maxDiscarded 500 minSize 0 maxSize 100 workers 1 - minSuccessful
the minimum number of successful property evaluations required for the property to pass.
- maxDiscarded
the maximum number of discarded property evaluations allowed during a property check
- 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).
- maxSize
the maximum size parameter to provide to ScalaCheck, which it will use when generating objects for which size matters (such as strings or lists).
- workers
specifies the number of worker threads to use during property evaluation
- Definition Classes
- Configuration
- Annotations
- @deprecated
- Deprecated
Use PropertyCheckConfiguration instead
- Exceptions thrown
IllegalArgumentExceptionif the specifiedminSuccessfulvalue is less than or equal to zero, the specifiedmaxDiscardedvalue is less than zero, the specifiedminSizevalue is less than zero, the specifiedmaxSizevalue is less than zero, the specifiedminSizeis greater than the specified or default value ofmaxSize, or the specifiedworkersvalue is less than or equal to zero.
- trait PropertyCheckConfigurable extends AnyRef
- Definition Classes
- Configuration
- Annotations
- @deprecated
- Deprecated
Use PropertyCheckConfiguration directly instead.
Value Members
- object PropertyCheckConfiguration extends Serializable
- Definition Classes
- Configuration
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- implicit def PropertyCheckConfig2PropertyCheckConfiguration(p: PropertyCheckConfig): PropertyCheckConfiguration
Implicitly converts
PropertyCheckConfigs toPropertyCheckConfiguration, which enables a smoother upgrade path.Implicitly converts
PropertyCheckConfigs toPropertyCheckConfiguration, which enables a smoother upgrade path.- Definition Classes
- ScalaCheckConfiguration → Configuration
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def check[ASSERTION](p: Prop, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Check a property.
Check a property.
- p
the property to check
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[ASSERTION](p: Prop, prms: Parameters)(implicit asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Check a property with the given testing parameters.
Check a property with the given testing parameters.
- p
the property to check
- prms
the test parameters
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[A1, A2, A3, A4, A5, A6, P, ASSERTION](f: (A1, A2, A3, A4, A5, A6) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) => Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) => Pretty, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Convert the passed 6-arg function into a property, and check it.
Convert the passed 6-arg function into a property, and check it.
- f
the function to be converted into a property and checked
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[A1, A2, A3, A4, A5, P, ASSERTION](f: (A1, A2, A3, A4, A5) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) => Pretty, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Convert the passed 5-arg function into a property, and check it.
Convert the passed 5-arg function into a property, and check it.
- f
the function to be converted into a property and checked
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[A1, A2, A3, A4, P, ASSERTION](f: (A1, A2, A3, A4) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) => Pretty, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Convert the passed 4-arg function into a property, and check it.
Convert the passed 4-arg function into a property, and check it.
- f
the function to be converted into a property and checked
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[A1, A2, A3, P, ASSERTION](f: (A1, A2, A3) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) => Pretty, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Convert the passed 3-arg function into a property, and check it.
Convert the passed 3-arg function into a property, and check it.
- f
the function to be converted into a property and checked
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[A1, A2, P, ASSERTION](f: (A1, A2) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) => Pretty, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Convert the passed 2-arg function into a property, and check it.
Convert the passed 2-arg function into a property, and check it.
- f
the function to be converted into a property and checked
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def check[A1, P, ASSERTION](f: (A1) => P, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfigurable, p: (P) => Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) => Pretty, asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): Result
Convert the passed 1-arg function into a property, and check it.
Convert the passed 1-arg function into a property, and check it.
- f
the function to be converted into a property and checked
- Definition Classes
- Checkers
- Exceptions thrown
TestFailedExceptionif a test case is discovered for which the property doesn't hold.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- implicit val generatorDrivenConfig: PropertyCheckConfiguration
Implicit
PropertyCheckConfigvalue providing default configuration values.Implicit
PropertyCheckConfigvalue providing default configuration values.- Definition Classes
- Configuration
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def maxDiscardedFactor(value: PosZDouble): MaxDiscardedFactor
Returns a
MaxDiscardedFactorproperty check configuration parameter containing the passed value, which specifies the factor of discarded property evaluations allowed during property evaluation.Returns a
MaxDiscardedFactorproperty check configuration parameter containing the passed value, which specifies the factor of discarded property evaluations allowed during property evaluation.- Definition Classes
- Configuration
- def minSize(value: PosZInt): MinSize
Returns a
MinSizeproperty 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
MinSizeproperty 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).- Definition Classes
- Configuration
- def minSuccessful(value: PosInt): MinSuccessful
Returns a
MinSuccessfulproperty check configuration parameter containing the passed value, which specifies the minimum number of successful property evaluations required for the property to pass.Returns a
MinSuccessfulproperty check configuration parameter containing the passed value, which specifies the minimum number of successful property evaluations required for the property to pass.- Definition Classes
- Configuration
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def sizeRange(value: PosZInt): SizeRange
Returns a
SizeRangeproperty check configuration parameter containing the passed value, 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).Returns a
SizeRangeproperty check configuration parameter containing the passed value, 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def workers(value: PosInt): Workers
Returns a
Workersproperty check configuration parameter containing the passed value, which specifies the number of worker threads to use when evaluating a property.Returns a
Workersproperty check configuration parameter containing the passed value, which specifies the number of worker threads to use when evaluating a property.- Definition Classes
- Configuration
Deprecated Value Members
- def maxDiscarded(value: Int): MaxDiscarded
Returns a
MaxDiscardedproperty check configuration parameter containing the passed value, which specifies the maximum number of discarded property evaluations allowed during property evaluation.Returns a
MaxDiscardedproperty check configuration parameter containing the passed value, which specifies the maximum number of discarded property evaluations allowed during property evaluation.- Definition Classes
- Configuration
- Annotations
- @deprecated
- Deprecated
use maxDiscardedFactor instead
- Exceptions thrown
IllegalArgumentExceptionif specifiedvalueis less than zero.
- def maxSize(value: Int): MaxSize
Returns a
MaxSizeproperty 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
MaxSizeproperty 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
PropertyCheckConfigconstructor and theforAllmethods of traitsPropertyChecksandCheckers. In other words, it is enforced at the point both a maximum and minimum size are provided together.- Definition Classes
- Configuration
- Annotations
- @deprecated
- Deprecated
use SizeRange instead
- Exceptions thrown
IllegalArgumentExceptionif specifiedvalueis less than zero.