org.scalatest.prop.Checkers.scala Maven / Gradle / Ivy
Show all versions of scalatest_2.11.0-M3 Show documentation
/*
* Copyright 2001-2008 Artima, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.scalatest.prop
import org.scalatest._
import org.scalatest.Suite
import org.scalacheck.Arbitrary
import org.scalacheck.Shrink
import org.scalacheck.Pretty
import org.scalacheck.Arg
import org.scalacheck.Prop
import org.scalacheck.Test
import org.scalatest.exceptions.StackDepthExceptionHelper.getStackDepthFun
import org.scalatest.exceptions.StackDepth
/* Uncomment this when remove the deprecated type aliases in the org.scalatest.prop package object.
import org.scalatest.exceptions.GeneratorDrivenPropertyCheckFailedException
*/
/**
* Trait that contains several “check” methods that perform ScalaCheck property checks.
* If ScalaCheck finds a test case for which a property doesn't hold, the problem will be reported as a ScalaTest test failure.
*
*
* To use ScalaCheck, you specify properties and, in some cases, generators that generate test data. You need not always
* create generators, because ScalaCheck provides many default generators for you that can be used in many situations.
* ScalaCheck will use the generators to generate test data and with that data run tests that check that the property holds.
* Property-based tests can, therefore, give you a lot more testing for a lot less code than assertion-based tests.
* Here's an example of using ScalaCheck from a JUnitSuite:
*
*
* import org.scalatest.junit.JUnitSuite
* import org.scalatest.prop.Checkers
* import org.scalacheck.Arbitrary._
* import org.scalacheck.Prop._
*
* class MySuite extends JUnitSuite with Checkers {
* @Test
* def testConcat() {
* check((a: List[Int], b: List[Int]) => a.size + b.size == (a ::: b).size)
* }
* }
*
*
* The check method, defined in Checkers, makes it easy to write property-based tests inside
* ScalaTest, JUnit, and TestNG test suites. This example specifies a property that List's ::: method
* should obey. ScalaCheck properties are expressed as function values that take the required
* test data as parameters. ScalaCheck will generate test data using generators and
repeatedly pass generated data to the function. In this case, the test data is composed of integer lists named a and b.
* Inside the body of the function, you see:
*
*
* a.size + b.size == (a ::: b).size
*
*
* The property in this case is a Boolean expression that will yield true if the size of the concatenated list is equal
* to the size of each individual list added together. With this small amount
* of code, ScalaCheck will generate possibly hundreds of value pairs for a and b and test each pair, looking for
* a pair of integers for which the property doesn't hold. If the property holds true for every value ScalaCheck tries,
* check returns normally. Otherwise, check will complete abruptly with a TestFailedException that
* contains information about the failure, including the values that cause the property to be false.
*
*
*
* For more information on using ScalaCheck properties, see the documentation for ScalaCheck, which is available
* from http://code.google.com/p/scalacheck/.
*
*
*
* To execute a suite that mixes in Checkers with ScalaTest's Runner, you must include ScalaCheck's jar file on the class path or runpath.
*
*
* Property check configuration
*
*
* The property checks performed by the check methods of this trait can be flexibly configured via the services
* provided by supertrait Configuration. The five configuration parameters for property checks along with their
* default values and meanings are described in the following table:
*
*
*
*
*
* Configuration Parameter
*
*
* Default Value
*
*
* Meaning
*
*
*
*
* minSuccessful
*
*
* 100
*
*
* the minimum number of successful property evaluations required for the property to pass
*
*
*
*
* maxDiscarded
*
*
* 500
*
*
* the maximum number of discarded property evaluations allowed during a property check
*
*
*
*
* minSize
*
*
* 0
*
*
* 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
*
*
* 100
*
*
* 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
*
*
* 1
*
*
* specifies the number of worker threads to use during property evaluation
*
*
*
*
*
* The check methods of trait Checkers each take a PropertyCheckConfig
* object as an implicit parameter. This object provides values for each of the five configuration parameters. Trait Configuration
* provides an implicit val named generatorDrivenConfig with each configuration parameter set to its default value.
* If you want to set one or more configuration parameters to a different value for all property checks in a suite you can override this
* val (or hide it, for example, if you are importing the members of the Checkers companion object rather
* than mixing in the trait.) For example, if
* you want all parameters at their defaults except for minSize and maxSize, you can override
* generatorDrivenConfig, like this:
*
*
* implicit override val generatorDrivenConfig =
* PropertyCheckConfig(minSize = 10, maxSize = 20)
*
*
*
* Or, if hide it by declaring a variable of the same name in whatever scope you want the changed values to be in effect:
*
*
*
* implicit val generatorDrivenConfig =
* PropertyCheckConfig(minSize = 10, maxSize = 20)
*
*
*
* In addition to taking a PropertyCheckConfig object as an implicit parameter, the check methods of trait
* Checkers also take a variable length argument list of PropertyCheckConfigParam
* objects that you can use to override the values provided by the implicit PropertyCheckConfig for a single check
* invocation. You place these configuration settings after the property or property function, For example, if you want to
* set minSuccessful to 500 for just one particular check invocation,
* you can do so like this:
*
*
*
* check((n: Int) => n + 0 == n, minSuccessful(500))
*
*
*
* This invocation of check will use 500 for minSuccessful and whatever values are specified by the
* implicitly passed PropertyCheckConfig object for the other configuration parameters.
* If you want to set multiple configuration parameters in this way, just list them separated by commas:
*
*
*
* check((n: Int) => n + 0 == n, minSuccessful(500), maxDiscarded(300))
*
*
*
* The previous configuration approach works the same in Checkers as it does in GeneratorDrivenPropertyChecks.
* Trait Checkers also provides one check method that takes an org.scalacheck.Test.Params object,
* in case you want to configure ScalaCheck that way.
*
*
*
* import org.scalacheck.Prop
* import org.scalacheck.Test.Params
* import org.scalatest.prop.Checkers._
*
* check(Prop.forAll((n: Int) => n + 0 == n), Params(minSuccessfulTests = 5))
*
*
*
* For more information, see the documentation
* for supertrait Configuration.
*
*
* @author Bill Venners
*/
trait Checkers extends Configuration {
/**
* Convert the passed 1-arg function into a property, and check it.
*
* @param f the function to be converted into a property and checked
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check[A1,P](f: A1 => P, configParams: PropertyCheckConfigParam*)
(implicit
config: PropertyCheckConfig,
p: P => Prop,
a1: Arbitrary[A1], s1: Shrink[A1], pp1: A1 => Pretty
) {
check(Prop.forAll(f)(p, a1, s1, pp1), configParams: _*)(config)
}
/**
* Convert the passed 2-arg function into a property, and check it.
*
* @param f the function to be converted into a property and checked
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check[A1,A2,P](f: (A1,A2) => P, configParams: PropertyCheckConfigParam*)
(implicit
config: PropertyCheckConfig,
p: P => Prop,
a1: Arbitrary[A1], s1: Shrink[A1], pp1: A1 => Pretty,
a2: Arbitrary[A2], s2: Shrink[A2], pp2: A2 => Pretty
) {
val params = getParams(configParams, config)
check(Prop.forAll(f)(p, a1, s1, pp1, a2, s2, pp2), configParams: _*)(config)
}
/**
* Convert the passed 3-arg function into a property, and check it.
*
* @param f the function to be converted into a property and checked
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check[A1,A2,A3,P](f: (A1,A2,A3) => P, configParams: PropertyCheckConfigParam*)
(implicit
config: PropertyCheckConfig,
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
) {
check(Prop.forAll(f)(p, a1, s1, pp1, a2, s2, pp2, a3, s3, pp3), configParams: _*)(config)
}
/**
* Convert the passed 4-arg function into a property, and check it.
*
* @param f the function to be converted into a property and checked
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check[A1,A2,A3,A4,P](f: (A1,A2,A3,A4) => P, configParams: PropertyCheckConfigParam*)
(implicit
config: PropertyCheckConfig,
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
) {
check(Prop.forAll(f)(p, a1, s1, pp1, a2, s2, pp2, a3, s3, pp3, a4, s4, pp4), configParams: _*)(config)
}
/**
* Convert the passed 5-arg function into a property, and check it.
*
* @param f the function to be converted into a property and checked
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check[A1,A2,A3,A4,A5,P](f: (A1,A2,A3,A4,A5) => P, configParams: PropertyCheckConfigParam*)
(implicit
config: PropertyCheckConfig,
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
) {
check(Prop.forAll(f)(p, a1, s1, pp1, a2, s2, pp2, a3, s3, pp3, a4, s4, pp4, a5, s5, pp5), configParams: _*)(config)
}
/**
* Convert the passed 6-arg function into a property, and check it.
*
* @param f the function to be converted into a property and checked
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check[A1,A2,A3,A4,A5,A6,P](f: (A1,A2,A3,A4,A5,A6) => P, configParams: PropertyCheckConfigParam*)
(implicit
config: PropertyCheckConfig,
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
) {
check(Prop.forAll(f)(p, a1, s1, pp1, a2, s2, pp2, a3, s3, pp3, a4, s4, pp4, a5, s5, pp5, a6, s6, pp6), configParams: _*)(config)
}
/**
* Check a property with the given testing parameters.
*
* @param p the property to check
* @param prms the test parameters
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check(p: Prop, prms: Test.Params) {
Checkers.doCheck(p, prms, "Checkers.scala", "check")
}
/**
* Check a property.
*
* @param p the property to check
* @throws TestFailedException if a test case is discovered for which the property doesn't hold.
*/
def check(p: Prop, configParams: PropertyCheckConfigParam*)(implicit config: PropertyCheckConfig) {
val params = getParams(configParams, config)
check(p, params)
}
}
/**
* 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.
*
* @author Bill Venners
*/
object Checkers extends Checkers {
private[prop] def doCheck(p: Prop, prms: Test.Params, stackDepthFileName: String, stackDepthMethodName: String, argNames: Option[List[String]] = None) {
val result = Test.check(prms, p)
if (!result.passed) {
val (args, labels) = argsAndLabels(result)
(result.status: @unchecked) match {
case Test.Exhausted =>
val failureMsg =
if (result.succeeded == 1)
FailureMessages("propCheckExhaustedAfterOne", result.discarded)
else
FailureMessages("propCheckExhausted", result.succeeded, result.discarded)
throw new GeneratorDrivenPropertyCheckFailedException(
sde => failureMsg,
None,
getStackDepthFun(stackDepthFileName, stackDepthMethodName),
// getStackDepth("ScalaCheck.scala", "check"),
// { val x = getStackDepth("GeneratorDrivenPropertyChecks$class.scala", "forAll"); println("stackDepth:" + x); x},
None,
failureMsg,
args,
None,
labels
)
case Test.Failed(scalaCheckArgs, scalaCheckLabels) =>
throw new GeneratorDrivenPropertyCheckFailedException(
sde => FailureMessages("propertyException", UnquotedString(sde.getClass.getSimpleName)) + "\n" +
( sde.failedCodeFileNameAndLineNumberString match { case Some(s) => " (" + s + ")"; case None => "" }) + "\n" +
" " + FailureMessages("propertyFailed", result.succeeded) + "\n" +
(
sde match {
case sd: StackDepth if sd.failedCodeFileNameAndLineNumberString.isDefined =>
" " + FailureMessages("thrownExceptionsLocation", UnquotedString(sd.failedCodeFileNameAndLineNumberString.get)) + "\n"
case _ => ""
}
) +
" " + FailureMessages("occurredOnValues") + "\n" +
prettyArgs(getArgsWithSpecifiedNames(argNames, scalaCheckArgs)) + "\n" +
" )",
None,
getStackDepthFun(stackDepthFileName, stackDepthMethodName),
None,
FailureMessages("propertyFailed", result.succeeded),
args,
None,
labels
)
case Test.PropException(scalaCheckArgs, e, scalaCheckLabels) =>
throw new GeneratorDrivenPropertyCheckFailedException(
sde => FailureMessages("propertyException", UnquotedString(e.getClass.getSimpleName)) + "\n" +
" " + FailureMessages("thrownExceptionsMessage", if (e.getMessage == null) "None" else UnquotedString(e.getMessage)) + "\n" +
(
e match {
case sd: StackDepth if sd.failedCodeFileNameAndLineNumberString.isDefined =>
" " + FailureMessages("thrownExceptionsLocation", UnquotedString(sd.failedCodeFileNameAndLineNumberString.get)) + "\n"
case _ => ""
}
) +
" " + FailureMessages("occurredOnValues") + "\n" +
prettyArgs(getArgsWithSpecifiedNames(argNames, scalaCheckArgs)) + "\n" +
" )",
Some(e),
getStackDepthFun(stackDepthFileName, stackDepthMethodName),
None,
FailureMessages("propertyException", UnquotedString(e.getClass.getName)),
args,
None,
labels
)
case Test.GenException(e) =>
throw new GeneratorDrivenPropertyCheckFailedException(
sde => prettyTestStats(result),
Some(e),
getStackDepthFun(stackDepthFileName, stackDepthMethodName),
None,
FailureMessages("generatorException", UnquotedString(e.getClass.getName)),
args,
None,
labels
)
}
}
}
private def getArgsWithSpecifiedNames(argNames: Option[List[String]], scalaCheckArgs: Prop.Args) = {
if (argNames.isDefined) {
// length of scalaCheckArgs should equal length of argNames
val zipped = argNames.get zip scalaCheckArgs
zipped map { case (argName, arg) => arg.copy(label = argName) }
}
else
scalaCheckArgs
}
private def argsAndLabels(result: Test.Result): (List[Any], List[String]) = {
val (scalaCheckArgs, scalaCheckLabels) =
result.status match {
case Test.Proved(args) => (args.toList, List())
case Test.Failed(args, labels) => (args.toList, labels.toList)
case Test.PropException(args, _, labels) => (args.toList, labels.toList)
case _ => (List(), List())
}
val args: List[Any] = for (scalaCheckArg <- scalaCheckArgs.toList) yield scalaCheckArg.arg
// scalaCheckLabels is a Set[String], I think
val labels: List[String] = for (scalaCheckLabel <- scalaCheckLabels.iterator.toList) yield scalaCheckLabel
(args, labels)
}
// TODO: Internationalize these, and make them consistent with FailureMessages stuff (only strings get quotes around them, etc.)
private def prettyTestStats(result: Test.Result) = result.status match {
case Test.Proved(args) =>
"OK, proved property: \n" + prettyArgs(args)
case Test.Passed =>
"OK, passed " + result.succeeded + " tests."
case Test.Failed(args, labels) =>
"Falsified after " + result.succeeded + " passed tests:\n" + prettyLabels(labels) + prettyArgs(args)
case Test.Exhausted =>
"Gave up after only " + result.succeeded + " passed tests. " +
result.discarded + " tests were discarded."
case Test.PropException(args, e, labels) =>
FailureMessages("propertyException", UnquotedString(e.getClass.getSimpleName)) + "\n" + prettyLabels(labels) + prettyArgs(args)
case Test.GenException(e) =>
"Exception \"" + e + "\" (included as the TestFailedException's cause) was thrown during argument generation."
}
private def prettyLabels(labels: Set[String]) = {
if (labels.isEmpty) ""
else if (labels.size == 1) "Label of failing property: " + labels.iterator.next + "\n"
else "Labels of failing property: " + labels.mkString("\n") + "\n"
}
import FailureMessages.decorateToStringValue
private def prettyArgs(args: List[Arg[_]]) = {
val strs = for((a, i) <- args.zipWithIndex) yield (
" " +
(if (a.label == "") "arg" + i else a.label) +
" = " + decorateToStringValue(a.arg) + (if (i < args.length - 1) "," else "") +
(if (a.shrinks > 0) " // " + a.shrinks + (if (a.shrinks == 1) " shrink" else " shrinks") else "")
)
strs.mkString("\n")
}
}
/*
* Returns a ScalaCheck Prop that succeeds if the passed by-name
* parameter, fun, returns normally; fails if it throws
* an exception.
*
*
* This method enables ScalaTest assertions and matcher expressions to be used
* in property checks. Here's an example:
*
*
*
* check((s: String, t: String) => successOf(s + t should endWith (s)))
*
*
*
* The detail message of the TestFailedException that will likely
* be thrown by the matcher expression will be added as a label to the ScalaCheck
* Prop returned by successOf. This, this property
* check might fail with an exception like:
*
*
*
* org.scalatest.prop.GeneratorDrivenPropertyCheckFailedException: TestFailedException (included as this exception's cause) was thrown during property evaluation.
* Label of failing property: "ab" did not end with substring "a" (script.scala:24)
* > arg0 = "?" (1 shrinks)
* > arg1 = "?" (1 shrinks)
* at org.scalatest.prop.Checkers$class.check(Checkers.scala:252)
* at org.scalatest.prop.Checkers$.check(Checkers.scala:354)
* ...
*
*
*
* One use case for using matcher expressions in your properties is to
* get helpful error messages without using ScalaCheck labels. For example,
* instead of:
*
*
*
* val complexProp = forAll { (m: Int, n: Int) =>
* val res = n * m
* (res >= m) :| "result > #1" &&
* (res >= n) :| "result > #2" &&
* (res < m + n) :| "result not sum"
* }
*
*
*
* You could write:
*
*
*
* val complexProp = forAll { (m: Int, n: Int) =>
* successOf {
* val res = n * m
* res should be >= m
* res should be >= n
* res should be < (m + n)
* }
*
*
* @param fun the expression to evaluate to determine what Prop
* to return
* @return a ScalaCheck property that passes if the passed by-name parameter,
* fun, returns normally, fails if it throws an exception
private def successOf(fun: => Unit): Prop =
try {
fun
Prop.passed
}
catch {
case e: StackDepth =>
val msgPart = if (e.message.isDefined) e.message.get + " " else ""
val fileLinePart =
if (e.failedCodeFileNameAndLineNumberString.isDefined)
"(" + e.failedCodeFileNameAndLineNumberString.get + ")"
else
""
val lbl = msgPart + fileLinePart
Prop.exception(e).label(lbl)
case e => Prop.exception(e) // Not sure what to do here
}
*/