TableDrivenPropertyChecks

Object containing one apply factory method for each TableFor<n> class.

For example, you could create a table of 5 rows and 2 colums like this:

import org.scalatest.prop.Tables._

val examples =
 Table(
   ("a", "b"),
   (  1,   2),
   (  2,   4),
   (  4,   8),
   (  8,  16),
   ( 16,  32)
 )

Because you supplied 2 members in each tuple, the type you'll get back will be a TableFor2. If you wanted a table with just one column you could write this:

val moreExamples =
 Table(
   "powerOfTwo",
        1,
        2,
        4,
        8,
        16
 )

Or if you wanted a table with 10 columns and 10 rows, you could do this:

val multiplicationTable =
 Table(
   ("a", "b", "c", "d", "e", "f", "g", "h", "i", "j"),
   (  1,   2,   3,   4,   5,   6,   7,   8,   9,  10),
   (  2,   4,   6,   8,  10,  12,  14,  16,  18,  20),
   (  3,   6,   9,  12,  15,  18,  21,  24,  27,  30),
   (  4,   8,  12,  16,  20,  24,  28,  32,  36,  40),
   (  5,  10,  15,  20,  25,  30,  35,  40,  45,  50),
   (  6,  12,  18,  24,  30,  36,  42,  48,  54,  60),
   (  7,  14,  21,  28,  35,  42,  49,  56,  63,  70),
   (  8,  16,  24,  32,  40,  48,  56,  64,  72,  80),
   (  9,  18,  27,  36,  45,  54,  63,  72,  81,  90),
   ( 10,  20,  30,  40,  50,  60,  70,  80,  90, 100)
 )

The type of multiplicationTable would be TableFor10. You can pass the resulting tables to a forAll method (defined in trait PropertyChecks), to perform a property check with the data in the table. Or, because tables are sequences of tuples, you can treat them as a Seq.

Performs a property check by applying the specified property check function to each row of the specified TableFor22 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor21 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor20 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor19 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor18 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor17 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor16 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor15 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor14 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor13 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor12 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor11 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor10 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor9 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor8 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor7 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor6 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor5 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor4 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor3 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor2 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor1 and succeeding if at least one element satisfies the property check.

Performs a property check by applying the specified property check function to each row of the specified TableFor22.

Performs a property check by applying the specified property check function to each row of the specified TableFor21.

Performs a property check by applying the specified property check function to each row of the specified TableFor20.

Performs a property check by applying the specified property check function to each row of the specified TableFor19.

Performs a property check by applying the specified property check function to each row of the specified TableFor18.

Performs a property check by applying the specified property check function to each row of the specified TableFor17.

Performs a property check by applying the specified property check function to each row of the specified TableFor16.

Performs a property check by applying the specified property check function to each row of the specified TableFor15.

Performs a property check by applying the specified property check function to each row of the specified TableFor14.

Performs a property check by applying the specified property check function to each row of the specified TableFor13.

Performs a property check by applying the specified property check function to each row of the specified TableFor12.

Performs a property check by applying the specified property check function to each row of the specified TableFor11.

Performs a property check by applying the specified property check function to each row of the specified TableFor10.

Performs a property check by applying the specified property check function to each row of the specified TableFor9.

Performs a property check by applying the specified property check function to each row of the specified TableFor8.

Performs a property check by applying the specified property check function to each row of the specified TableFor7.

Performs a property check by applying the specified property check function to each row of the specified TableFor6.

Performs a property check by applying the specified property check function to each row of the specified TableFor5.

Performs a property check by applying the specified property check function to each row of the specified TableFor4.

Performs a property check by applying the specified property check function to each row of the specified TableFor3.

Performs a property check by applying the specified property check function to each row of the specified TableFor2.

Performs a property check by applying the specified property check function to each row of the specified TableFor1.

Performs a property check by applying the specified property check function to each row of the specified TableFor22 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor21 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor20 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor19 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor18 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor17 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor16 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor15 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor14 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor13 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor12 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor11 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor10 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor9 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor8 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor7 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor6 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor5 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor4 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor3 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor2 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

Performs a property check by applying the specified property check function to each row of the specified TableFor1 and reporting every error.

The difference between forEvery and forAll is that forEvery will continue to inspect all elements after first failure, and report all failures, whereas forAll will stop on (and only report) the first failure.

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.Matchers._

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.