docs
API
Generated with
docs/scalus/scalus.testing/scalus.testing.kit/EvalTestKit

EvalTestKit

scalus.testing.kit.EvalTestKit
trait EvalTestKit extends Assertions, ScalaCheckPropertyChecks, ArbitraryInstances

ScalaTest integration trait for evaluation testing.

Provides:

  • Inline compilation via assertEval* methods using PlutusV3.compile
  • Given-based configuration injection
  • Property-based testing support via checkEval
  • Configurable PlutusVM via using parameters

This trait provides the core functionality for testing Scalus code evaluation.

Attributes

Graph
Supertypes
trait ScalaCheckPropertyChecks
trait ScalaCheckDrivenPropertyChecks
trait Configuration
trait TableDrivenPropertyChecks
trait Tables
trait Whenever
trait Assertions
trait TripleEquals
trait TripleEqualsSupport
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

class CheckingEqualizer[L](val leftSide: L)

Class used via an implicit conversion to enable two objects to be compared with === and !== with a Boolean result and an enforced type constraint between two object types. For example:

Class used via an implicit conversion to enable two objects to be compared with === and !== with a Boolean result and an enforced type constraint between two object types. For example:

assert(a === b)
assert(c !== d)

You can also check numeric values against another with a tolerance. Here are some examples:

assert(a === (2.0 +- 0.1))
assert(c !== (2.0 +- 0.1))

Value parameters

leftSide

An object to convert to Equalizer, which represents the value on the left side of a === or !== invocation.

Attributes

Inherited from:
TripleEqualsSupport
Supertypes
class Object
trait Matchable
class Any
class ConfiguredPropertyCheck(configParams: Seq[PropertyCheckConfigParam])

Performs a configured property checks by applying property check functions passed to its apply methods to arguments supplied by implicitly passed generators, modifying the values in the PropertyGenConfig object passed implicitly to its apply methods with parameter values passed to its constructor.

Performs a configured property checks by applying property check functions passed to its apply methods to arguments supplied by implicitly passed generators, modifying the values in the PropertyGenConfig object passed implicitly to its apply methods with parameter values passed to its constructor.

Instances of this class are returned by trait ScalaCheckDrivenPropertyChecks forAll method that accepts a variable length argument list of PropertyCheckConfigParam objects. Thus it is used with functions of all six arities. Here are some examples:

forAll (minSize(1), sizeRange(9)) { (a: String) =>
 a.length should equal ((a).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String) =>
 a.length + b.length should equal ((a + b).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String) =>
 a.length + b.length + c.length should equal ((a + b + c).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String, d: String) =>
 a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String, d: String, e: String) =>
 a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String, d: String, e: String, f: String) =>
 a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
}

In the first example above, the ConfiguredPropertyCheck object is returned by:

forAll (minSize(1), sizeRange(9))

The code that follows is an invocation of one of the ConfiguredPropertyCheck apply methods:

{ (a: String) =>
 a.length should equal ((a).length)
}

Value parameters

configParams

a variable length list of PropertyCheckConfigParam objects that should override corresponding values in the PropertyCheckConfiguration implicitly passed to the apply methods of instances of this class.

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
Supertypes
class Object
trait Matchable
class Any
class Equalizer[L](val leftSide: L)

Class used via an implicit conversion to enable any two objects to be compared with === and !== with a Boolean result and no enforced type constraint between two object types. For example:

Class used via an implicit conversion to enable any two objects to be compared with === and !== with a Boolean result and no enforced type constraint between two object types. For example:

assert(a === b)
assert(c !== d)

You can also check numeric values against another with a tolerance. Here are some examples:

assert(a === (2.0 +- 0.1))
assert(c !== (2.0 +- 0.1))

Value parameters

leftSide

An object to convert to Equalizer, which represents the value on the left side of a === or !== invocation.

Attributes

Inherited from:
TripleEqualsSupport
Supertypes
class Object
trait Matchable
class Any
case class MaxDiscardedFactor(value: PosZDouble) extends PropertyCheckConfigParam

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 parameters

value

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

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MinSize(value: PosZInt) extends PropertyCheckConfigParam

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).

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MinSuccessful(value: PosInt) extends PropertyCheckConfigParam

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.

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PropertyCheckConfiguration(minSuccessful: PosInt = ..., maxDiscardedFactor: PosZDouble = ..., minSize: PosZInt = ..., sizeRange: PosZInt = ..., workers: PosInt = ...)

Describes the configuration to use when evaluating a property.

Describes the configuration to use when evaluating a property.

Value parameters

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

minSuccessful

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

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

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PropertyCheckConfiguration

Internal utility functions for configuration management.

Internal utility functions for configuration management.

Attributes

Inherited from:
Configuration
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
case class SizeRange(value: PosZInt) extends PropertyCheckConfigParam

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.

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Table

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

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.

Attributes

Inherited from:
Tables
Supertypes
class Object
trait Matchable
class Any
object UseDefaultAssertions

Attributes

Inherited from:
Assertions
Supertypes
class Object
trait Matchable
class Any
case class Workers(value: PosInt) extends PropertyCheckConfigParam

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.

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited and Abstract classlikes

sealed abstract class PropertyCheckConfigParam extends Product, 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).

Attributes

Inherited from:
Configuration
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class MinSize
class SizeRange
class Workers

Value members

Concrete methods

final inline protected def assertEval(inline code: Boolean)(using vm: PlutusVM): Unit

Assert that code evaluates to true on both JVM and PlutusVM.

Assert that code evaluates to true on both JVM and PlutusVM.

Attributes

final inline protected def assertEvalEq[T : Eq](inline code: T, inline expected: T)(implicit evidence$1: Eq[T], vm: PlutusVM): Unit

Assert that code evaluates to expected value on both JVM and PlutusVM.

Assert that code evaluates to expected value on both JVM and PlutusVM.

Attributes

final inline protected def assertEvalFails[E <: Throwable : ClassTag](inline code: Any)(implicit evidence$1: ClassTag[E], vm: PlutusVM): Unit

Assert that code evaluation fails with expected exception type.

Assert that code evaluation fails with expected exception type.

Attributes

final inline protected def assertEvalFailsWithMessage[E <: Throwable : ClassTag](expectedMessage: String)(inline code: Any)(implicit evidence$1: ClassTag[E], vm: PlutusVM): Unit

Assert that code evaluation fails with specific error message.

Assert that code evaluation fails with specific error message.

Attributes

final inline protected def assertEvalNotEq[T : Eq](inline code: T, inline expected: T)(implicit evidence$1: Eq[T], vm: PlutusVM): Unit

Assert that code evaluates to different value than expected.

Assert that code evaluates to different value than expected.

Attributes

final inline protected def assertEvalSuccess(inline code: Any)(using vm: PlutusVM): Unit

Assert code evaluates successfully (no exception).

Assert code evaluates successfully (no exception).

Attributes

final inline protected def assertEvalWithinBudget[T : Eq](inline code: T, inline expected: T, budget: ExUnits)(implicit evidence$1: Eq[T], vm: PlutusVM): Unit

Assert that code evaluates to expected value with budget limit check.

Assert that code evaluates to expected value with budget limit check.

Attributes

protected def assertTermEvalEq(a: Term, b: Term)(using vm: PlutusVM): Unit

Assert two terms evaluate to the same result

Assert two terms evaluate to the same result

Attributes

protected def assertTermEvalThrows[E <: Throwable : ClassTag](term: Term)(implicit evidence$1: ClassTag[E], vm: PlutusVM): Unit

Assert term evaluation throws expected exception

Assert term evaluation throws expected exception

Attributes

final inline protected def checkEval[A1](inline f: A1 => Boolean, configParams: PropertyCheckConfigParam*)(using vm: PlutusVM)(implicit inline a1FromData: FromData[A1], inline a1ToData: ToData[A1], config: PropertyCheckConfiguration, a1: Arbitrary[A1], s1: Shrink[A1], pp1: A1 => Pretty, prettifier: Prettifier, pos: Position): Assertion
final inline protected def checkEval[A1, A2](inline f: (A1, A2) => Boolean, configParams: PropertyCheckConfigParam*)(using vm: PlutusVM)(implicit inline a1FromData: FromData[A1], inline a1ToData: ToData[A1], inline a2FromData: FromData[A2], inline a2ToData: ToData[A2], config: PropertyCheckConfiguration, a1: Arbitrary[A1], s1: Shrink[A1], pp1: A1 => Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: A2 => Pretty, prettifier: Prettifier, pos: Position): Assertion
final inline protected def checkEval[A1, A2, A3](inline f: (A1, A2, A3) => Boolean, configParams: PropertyCheckConfigParam*)(using vm: PlutusVM)(implicit inline a1FromData: FromData[A1], inline a1ToData: ToData[A1], inline a2FromData: FromData[A2], inline a2ToData: ToData[A2], inline a3FromData: FromData[A3], inline a3ToData: ToData[A3], config: PropertyCheckConfiguration, 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, prettifier: Prettifier, pos: Position): Assertion
final inline protected def liftThrowableToOption[A](inline code: A): Option[A]
protected def plutusVM: PlutusVM

Default PlutusVM - can be overridden by subclasses

Default PlutusVM - can be overridden by subclasses

Attributes

Inherited methods

def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should !== (<pivot> +- <tolerance>)” syntax of Matchers.

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should !== (<pivot> +- <tolerance>)” syntax of Matchers.

Value parameters

right

the Spread[T] against which to compare the left-hand value

Attributes

Returns

a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to false.

Inherited from:
TripleEqualsSupport
def !==(right: Null): TripleEqualsInvocation[Null]

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

Value parameters

right

a null reference

Attributes

Returns

a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to false.

Inherited from:
TripleEqualsSupport
def !==[T](right: T): TripleEqualsInvocation[T]

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

Value parameters

right

the right-hand side value for an equality assertion

Attributes

Returns

a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to false.

Inherited from:
TripleEqualsSupport
def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should === (<pivot> +- <tolerance>)” syntax of Matchers.

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should === (<pivot> +- <tolerance>)” syntax of Matchers.

Value parameters

right

the Spread[T] against which to compare the left-hand value

Attributes

Returns

a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to true.

Inherited from:
TripleEqualsSupport
def ===(right: Null): TripleEqualsInvocation[Null]

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

Value parameters

right

a null reference

Attributes

Returns

a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to true.

Inherited from:
TripleEqualsSupport
def ===[T](right: T): TripleEqualsInvocation[T]

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

Value parameters

right

the right-hand side value for an equality assertion

Attributes

Returns

a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to true.

Inherited from:
TripleEqualsSupport
def arbConstantByType(t: DefaultUni): Gen[Constant]

Attributes

Inherited from:
ArbitraryInstances
inline def assert(inline condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with a helpful error message appended with the String obtained by invoking toString on the specified clue as the exception's detail message.

Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with a helpful error message appended with the String obtained by invoking toString on the specified clue as the exception's detail message.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assert(a == b, "a good clue")

  • assert(a != b, "a good clue")

  • assert(a === b, "a good clue")

  • assert(a !== b, "a good clue")

  • assert(a > b, "a good clue")

  • assert(a >= b, "a good clue")

  • assert(a < b, "a good clue")

  • assert(a <= b, "a good clue")

  • assert(a startsWith "prefix", "a good clue")

  • assert(a endsWith "postfix", "a good clue")

  • assert(a contains "something", "a good clue")

  • assert(a eq b, "a good clue")

  • assert(a ne b, "a good clue")

  • assert(a > 0 && b > 5, "a good clue")

  • assert(a > 0 || b > 5, "a good clue")

  • assert(a.isEmpty, "a good clue")

  • assert(!a.isEmpty, "a good clue")

  • assert(a.isInstanceOf[String], "a good clue")

  • assert(a.length == 8, "a good clue")

  • assert(a.size == 8, "a good clue")

  • assert(a.exists(_ == 8), "a good clue")

At this time, any other form of expression will just get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

clue

An objects whose toString method returns a message to include in a failure report.

condition

the boolean condition to assert

Attributes

Throws
NullArgumentException

if message is null.

TestFailedException

if the condition is false.

Inherited from:
Assertions
inline def assert(inline condition: Boolean)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.

Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assert(a == b)

  • assert(a != b)

  • assert(a === b)

  • assert(a !== b)

  • assert(a > b)

  • assert(a >= b)

  • assert(a < b)

  • assert(a <= b)

  • assert(a startsWith "prefix")

  • assert(a endsWith "postfix")

  • assert(a contains "something")

  • assert(a eq b)

  • assert(a ne b)

  • assert(a > 0 && b > 5)

  • assert(a > 0 || b > 5)

  • assert(a.isEmpty)

  • assert(!a.isEmpty)

  • assert(a.isInstanceOf[String])

  • assert(a.length == 8)

  • assert(a.size == 8)

  • assert(a.exists(_ == 8))

At this time, any other form of expression will get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

condition

the boolean condition to assert

Attributes

Throws
TestFailedException

if the condition is false.

Inherited from:
Assertions
transparent inline def assertCompiles(inline code: String): Assertion

Asserts that a given string snippet of code passes both the Scala parser and type checker.

Asserts that a given string snippet of code passes both the Scala parser and type checker.

You can use this to make sure a snippet of code compiles:

assertCompiles("val a: Int = 1")

Although assertCompiles is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string compiles, errors (i.e., snippets of code that do not compile) are reported as test failures at runtime.

Value parameters

code

the snippet of code that should compile

Attributes

Inherited from:
Assertions
transparent inline def assertDoesNotCompile(inline code: String): Assertion

Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

assertDoesNotCompile("val a: String = \"a string")

Although assertDoesNotCompile is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string doesn't compile, errors (i.e., snippets of code that do compile) are reported as test failures at runtime.

Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

Value parameters

code

the snippet of code that should not type check

Attributes

Inherited from:
Assertions
inline def assertResult[L, R](expected: L)(actual: R)(implicit prettifier: Prettifier, caneq: CanEqual[L, R]): Assertion

Assert that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), assertResult returns normally. Else, assertResult throws a TestFailedException whose detail message includes the expected and actual values.

Assert that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), assertResult returns normally. Else, assertResult throws a TestFailedException whose detail message includes the expected and actual values.

Value parameters

actual

the actual value, which should equal the passed expected value

expected

the expected value

Attributes

Throws
TestFailedException

if the passed actual value does not equal the passed expected value.

Inherited from:
Assertions
inline def assertResult[L, R](expected: L, clue: Any)(actual: R)(implicit prettifier: Prettifier, caneq: CanEqual[L, R]): Assertion

Assert that the value passed as expected equals the value passed as actual. If the actual equals the expected (as determined by ==), assertResult returns normally. Else, if actual is not equal to expected, assertResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.

Assert that the value passed as expected equals the value passed as actual. If the actual equals the expected (as determined by ==), assertResult returns normally. Else, if actual is not equal to expected, assertResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.

Value parameters

actual

the actual value, which should equal the passed expected value

clue

An object whose toString method returns a message to include in a failure report.

expected

the expected value

Attributes

Throws
TestFailedException

if the passed actual value does not equal the passed expected value.

Inherited from:
Assertions
inline def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T]): Assertion

Ensure that an expected exception is thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns Succeeded. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Ensure that an expected exception is thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns Succeeded. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

Also note that the difference between this method and intercept is that this method does not return the expected exception, so it does not let you perform further assertions on that exception. Instead, this method returns Succeeded, which means it can serve as the last statement in an async- or safe-style suite. It also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to use assertThrows by default, intercept only when you need to inspect the caught exception further.

Value parameters

classTag

an implicit ClassTag representing the type of the specified type parameter.

f

the function value that should throw the expected exception

Attributes

Returns

the Succeeded singleton, if an exception of the expected type is thrown

Throws
TestFailedException

if the passed function does not complete abruptly with an exception that's an instance of the specified type.

Inherited from:
Assertions
transparent inline def assertTypeError(inline code: String): Assertion

Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

assertTypeError("val a: String = 1")

Although assertTypeError is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string type checks, errors (i.e., snippets of code that do type check) are reported as test failures at runtime.

Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

Value parameters

code

the snippet of code that should not type check

Attributes

Inherited from:
Assertions
inline def assume(inline condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with a helpful error message appended with String obtained by invoking toString on the specified clue as the exception's detail message.

Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with a helpful error message appended with String obtained by invoking toString on the specified clue as the exception's detail message.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assume(a == b, "a good clue")

  • assume(a != b, "a good clue")

  • assume(a === b, "a good clue")

  • assume(a !== b, "a good clue")

  • assume(a > b, "a good clue")

  • assume(a >= b, "a good clue")

  • assume(a < b, "a good clue")

  • assume(a <= b, "a good clue")

  • assume(a startsWith "prefix", "a good clue")

  • assume(a endsWith "postfix", "a good clue")

  • assume(a contains "something", "a good clue")

  • assume(a eq b, "a good clue")

  • assume(a ne b, "a good clue")

  • assume(a > 0 && b > 5, "a good clue")

  • assume(a > 0 || b > 5, "a good clue")

  • assume(a.isEmpty, "a good clue")

  • assume(!a.isEmpty, "a good clue")

  • assume(a.isInstanceOf[String], "a good clue")

  • assume(a.length == 8, "a good clue")

  • assume(a.size == 8, "a good clue")

  • assume(a.exists(_ == 8), "a good clue")

At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

clue

An objects whose toString method returns a message to include in a failure report.

condition

the boolean condition to assume

Attributes

Throws
NullArgumentException

if message is null.

TestCanceledException

if the condition is false.

Inherited from:
Assertions
inline def assume(inline condition: Boolean)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assume that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException.

Assume that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assume(a == b)

  • assume(a != b)

  • assume(a === b)

  • assume(a !== b)

  • assume(a > b)

  • assume(a >= b)

  • assume(a < b)

  • assume(a <= b)

  • assume(a startsWith "prefix")

  • assume(a endsWith "postfix")

  • assume(a contains "something")

  • assume(a eq b)

  • assume(a ne b)

  • assume(a > 0 && b > 5)

  • assume(a > 0 || b > 5)

  • assume(a.isEmpty)

  • assume(!a.isEmpty)

  • assume(a.isInstanceOf[String])

  • assume(a.length == 8)

  • assume(a.size == 8)

  • assume(a.exists(_ == 8))

At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

condition

the boolean condition to assume

Attributes

Throws
TestCanceledException

if the condition is false.

Inherited from:
Assertions
inline def cancel(cause: Throwable): Nothing

Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestCanceledException will return cause.toString.

Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestCanceledException will return cause.toString.

Value parameters

cause

a Throwable that indicates the cause of the cancellation.

Attributes

Throws
NullArgumentException

if cause is null

Inherited from:
Assertions
inline def cancel(message: String, cause: Throwable): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Value parameters

cause

A Throwable that indicates the cause of the failure.

message

A message describing the failure.

Attributes

Throws
NullArgumentException

if message or cause is null

Inherited from:
Assertions
inline def cancel(message: String): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.

Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.

Value parameters

message

A message describing the cancellation.

Attributes

Throws
NullArgumentException

if message is null

Inherited from:
Assertions
inline def cancel(): Nothing

Throws TestCanceledException to indicate a test was canceled.

Throws TestCanceledException to indicate a test was canceled.

Attributes

Inherited from:
Assertions
override def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: A <:< B): CanEqual[A, B]

Provides a A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

Provides a A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B.

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

equivalenceOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that A is a subype of B

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: B <:< A): CanEqual[A, B]

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B. For example, under TypeCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

def closeEnoughTo1(num: Double): Boolean =
 (num === 1.0)(decided by forgivingEquality)

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits TypeCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

equalityOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that B is a subype of A

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

Converts to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

Converts to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

This method is overridden and made implicit by subtrait TypeCheckedTripleEquals, and overriden as non-implicit by the other subtraits in this package.

Value parameters

left

the object whose type to convert to CheckingEqualizer.

Attributes

Throws
NullPointerException

if left is null.

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def defaultEquality[A]: Equality[A]

Returns an Equality[A] for any type A that determines equality by first calling .deep on any Array (on either the left or right side), then comparing the resulting objects with ==.

Returns an Equality[A] for any type A that determines equality by first calling .deep on any Array (on either the left or right side), then comparing the resulting objects with ==.

Attributes

Returns

a default Equality for type A

Inherited from:
TripleEqualsSupport
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, ASSERTION](table: TableFor22[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor22 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, ASSERTION](table: TableFor21[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor21 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, ASSERTION](table: TableFor20[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor20 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, ASSERTION](table: TableFor19[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor19 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, ASSERTION](table: TableFor18[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor18 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, ASSERTION](table: TableFor17[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor17 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, ASSERTION](table: TableFor16[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor16 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, ASSERTION](table: TableFor15[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor15 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, N, ASSERTION](table: TableFor14[A, B, C, D, E, F, G, H, I, J, K, L, M, N])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor14 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, M, ASSERTION](table: TableFor13[A, B, C, D, E, F, G, H, I, J, K, L, M])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor13 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, L, ASSERTION](table: TableFor12[A, B, C, D, E, F, G, H, I, J, K, L])(fun: (A, B, C, D, E, F, G, H, I, J, K, L) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor12 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, K, ASSERTION](table: TableFor11[A, B, C, D, E, F, G, H, I, J, K])(fun: (A, B, C, D, E, F, G, H, I, J, K) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor11 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, J, ASSERTION](table: TableFor10[A, B, C, D, E, F, G, H, I, J])(fun: (A, B, C, D, E, F, G, H, I, J) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor10 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, I, ASSERTION](table: TableFor9[A, B, C, D, E, F, G, H, I])(fun: (A, B, C, D, E, F, G, H, I) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor9 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, H, ASSERTION](table: TableFor8[A, B, C, D, E, F, G, H])(fun: (A, B, C, D, E, F, G, H) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor8 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, G, ASSERTION](table: TableFor7[A, B, C, D, E, F, G])(fun: (A, B, C, D, E, F, G) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor7 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, F, ASSERTION](table: TableFor6[A, B, C, D, E, F])(fun: (A, B, C, D, E, F) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor6 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, E, ASSERTION](table: TableFor5[A, B, C, D, E])(fun: (A, B, C, D, E) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor5 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, D, ASSERTION](table: TableFor4[A, B, C, D])(fun: (A, B, C, D) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor4 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, C, ASSERTION](table: TableFor3[A, B, C])(fun: (A, B, C) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor3 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, B, ASSERTION](table: TableFor2[A, B])(fun: (A, B) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor2 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def exists[A, ASSERTION](table: TableFor1[A])(fun: A => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor1 and succeeding if at least one element satisfies the property check.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
inline def fail(cause: Throwable): Nothing

Throws TestFailedException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestFailedException will return cause.toString.

Throws TestFailedException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestFailedException will return cause.toString.

Value parameters

cause

a Throwable that indicates the cause of the failure.

Attributes

Throws
NullArgumentException

if cause is null

Inherited from:
Assertions
inline def fail(message: String, cause: Throwable): Nothing

Throws TestFailedException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Throws TestFailedException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Value parameters

cause

A Throwable that indicates the cause of the failure.

message

A message describing the failure.

Attributes

Throws
NullArgumentException

if message or cause is null

Inherited from:
Assertions
inline def fail(message: String): Nothing

Throws TestFailedException, with the passed String message as the exception's detail message, to indicate a test failed.

Throws TestFailedException, with the passed String message as the exception's detail message, to indicate a test failed.

Value parameters

message

A message describing the failure.

Attributes

Throws
NullArgumentException

if message is null

Inherited from:
Assertions
inline def fail(): Nothing

Throws TestFailedException to indicate a test failed.

Throws TestFailedException to indicate a test failed.

Attributes

Inherited from:
Assertions
def forAll[A, B, C, D, E, F, ASSERTION](genAndNameA: (Gen[A], String), genAndNameB: (Gen[B], String), genAndNameC: (Gen[C], String), genAndNameD: (Gen[D], String), genAndNameE: (Gen[E], String), genAndNameF: (Gen[F], String), configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D, E, F) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], shrD: Shrink[D], shrE: Shrink[E], shrF: Shrink[F], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c"), (famousLastWords, "d"), (famousLastWords, "e"), (famousLastWords, "f")) { (a: String, b: String, c: String, d: String, e: String, f: String) =>
 a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, F, ASSERTION](genA: Gen[A], genB: Gen[B], genC: Gen[C], genD: Gen[D], genE: Gen[E], genF: Gen[F], configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D, E, F) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], shrD: Shrink[D], shrE: Shrink[E], shrF: Shrink[F], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll (famousLastWords, famousLastWords, famousLastWords, famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String, d: String, e: String, f: String) =>
 a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, F, ASSERTION](nameA: String, nameB: String, nameC: String, nameD: String, nameE: String, nameF: String, configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D, E, F) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], arbD: Arbitrary[D], shrD: Shrink[D], arbE: Arbitrary[E], shrE: Shrink[E], arbF: Arbitrary[F], shrF: Shrink[F], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Here's an example:

forAll ("a", "b", "c", "d", "e", "f") { (a: String, b: String, c: String, d: String, e: String, f: String) =>
 a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, F, ASSERTION](fun: (A, B, C, D, E, F) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], arbD: Arbitrary[D], shrD: Shrink[D], arbE: Arbitrary[E], shrE: Shrink[E], arbF: Arbitrary[F], shrF: Shrink[F], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Here's an example:

forAll { (a: String, b: String, c: String, d: String, e: String, f: String) =>
 a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, ASSERTION](genAndNameA: (Gen[A], String), genAndNameB: (Gen[B], String), genAndNameC: (Gen[C], String), genAndNameD: (Gen[D], String), genAndNameE: (Gen[E], String), configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D, E) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], shrD: Shrink[D], shrE: Shrink[E], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c"), (famousLastWords, "d"), (famousLastWords, "e")) { (a: String, b: String, c: String, d: String, e: String) =>
 a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, ASSERTION](genA: Gen[A], genB: Gen[B], genC: Gen[C], genD: Gen[D], genE: Gen[E], configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D, E) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], shrD: Shrink[D], shrE: Shrink[E], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll (famousLastWords, famousLastWords, famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String, d: String, e: String) =>
 a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, ASSERTION](nameA: String, nameB: String, nameC: String, nameD: String, nameE: String, configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D, E) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], arbD: Arbitrary[D], shrD: Shrink[D], arbE: Arbitrary[E], shrE: Shrink[E], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Here's an example:

forAll ("a", "b", "c", "d", "e") { (a: String, b: String, c: String, d: String, e: String) =>
 a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, ASSERTION](fun: (A, B, C, D, E) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], arbD: Arbitrary[D], shrD: Shrink[D], arbE: Arbitrary[E], shrE: Shrink[E], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Here's an example:

forAll { (a: String, b: String, c: String, d: String, e: String) =>
 a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, ASSERTION](genAndNameA: (Gen[A], String), genAndNameB: (Gen[B], String), genAndNameC: (Gen[C], String), genAndNameD: (Gen[D], String), configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], shrD: Shrink[D], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c"), (famousLastWords, "d")) { (a: String, b: String, c: String, d: String) =>
 a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, ASSERTION](genA: Gen[A], genB: Gen[B], genC: Gen[C], genD: Gen[D], configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], shrD: Shrink[D], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll (famousLastWords, famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String, d: String) =>
 a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, ASSERTION](nameA: String, nameB: String, nameC: String, nameD: String, configParams: PropertyCheckConfigParam*)(fun: (A, B, C, D) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], arbD: Arbitrary[D], shrD: Shrink[D], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Here's an example:

forAll ("a", "b", "c", "d") { (a: String, b: String, c: String, d: String) =>
 a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, ASSERTION](fun: (A, B, C, D) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], arbD: Arbitrary[D], shrD: Shrink[D], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Here's an example:

forAll { (a: String, b: String, c: String, d: String) =>
 a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, ASSERTION](genAndNameA: (Gen[A], String), genAndNameB: (Gen[B], String), genAndNameC: (Gen[C], String), configParams: PropertyCheckConfigParam*)(fun: (A, B, C) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll ((famousLastWords, "a"), (famousLastWords, "b"), (famousLastWords, "c")) { (a: String, b: String, c: String) =>
 a.length + b.length + c.length should equal ((a + b + c).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, ASSERTION](genA: Gen[A], genB: Gen[B], genC: Gen[C], configParams: PropertyCheckConfigParam*)(fun: (A, B, C) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], shrC: Shrink[C], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll (famousLastWords, famousLastWords, famousLastWords) { (a: String, b: String, c: String) =>
 a.length + b.length + c.length should equal ((a + b + c).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, ASSERTION](nameA: String, nameB: String, nameC: String, configParams: PropertyCheckConfigParam*)(fun: (A, B, C) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Here's an example:

forAll ("a", "b", "c") { (a: String, b: String, c: String) =>
 a.length + b.length + c.length should equal ((a + b + c).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, ASSERTION](fun: (A, B, C) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], arbC: Arbitrary[C], shrC: Shrink[C], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Here's an example:

forAll { (a: String, b: String, c: String) =>
 a.length + b.length + c.length should equal ((a + b + c).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, ASSERTION](genAndNameA: (Gen[A], String), genAndNameB: (Gen[B], String), configParams: PropertyCheckConfigParam*)(fun: (A, B) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll ((famousLastWords, "a"), (famousLastWords, "b")) { (a: String, b: String) =>
 a.length + b.length should equal ((a + b).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, ASSERTION](genA: Gen[A], genB: Gen[B], configParams: PropertyCheckConfigParam*)(fun: (A, B) => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], shrB: Shrink[B], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll (famousLastWords, famousLastWords) { (a: String, b: String) =>
 a.length + b.length should equal ((a + b).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, ASSERTION](nameA: String, nameB: String, configParams: PropertyCheckConfigParam*)(fun: (A, B) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Here's an example:

forAll ("a", "b") { (a: String, b: String) =>
 a.length + b.length should equal ((a + b).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, ASSERTION](fun: (A, B) => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], arbB: Arbitrary[B], shrB: Shrink[B], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Here's an example:

forAll { (a: String, b: String) =>
 a.length + b.length should equal ((a + b).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, ASSERTION](genAndNameA: (Gen[A], String), configParams: PropertyCheckConfigParam*)(fun: A => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to named arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll ((famousLastWords, "a")) { (a: String) =>
 a.length should equal ((a).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, ASSERTION](genA: Gen[A], configParams: PropertyCheckConfigParam*)(fun: A => ASSERTION)(implicit config: PropertyCheckConfiguration, shrA: Shrink[A], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Performs a property check by applying the specified property check function to arguments supplied by the specified generators.

Here's an example:

import org.scalacheck.Gen

// Define your own string generator:
val famousLastWords = for {
 s <- Gen.oneOf("the", "program", "compiles", "therefore", "it", "should", "work")
} yield s

forAll (famousLastWords) { (a: String) =>
 a.length should equal ((a).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, ASSERTION](nameA: String, configParams: PropertyCheckConfigParam*)(fun: A => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function with the specified argument names to arguments supplied by implicitly passed generators.

Here's an example:

forAll ("a") { (a: String) =>
 a.length should equal ((a).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, ASSERTION](fun: A => ASSERTION)(implicit config: PropertyCheckConfiguration, arbA: Arbitrary[A], shrA: Shrink[A], asserting: CheckerAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators.

Here's an example:

forAll { (a: String) =>
 a.length should equal ((a).length)
}

Value parameters

fun

the property check function to apply to the generated arguments

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll(configParams: PropertyCheckConfigParam*): ConfiguredPropertyCheck

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators, modifying the values in the implicitly passed PropertyGenConfig object with explicitly passed parameter values.

Performs a property check by applying the specified property check function to arguments supplied by implicitly passed generators, modifying the values in the implicitly passed PropertyGenConfig object with explicitly passed parameter values.

This method creates a ConfiguredPropertyCheck object that has six overloaded apply methods that take a function. Thus it is used with functions of all six arities. Here are some examples:

forAll (minSize(1), sizeRange(9)) { (a: String) =>
 a.length should equal ((a).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String) =>
 a.length + b.length should equal ((a + b).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String) =>
 a.length + b.length + c.length should equal ((a + b + c).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String, d: String) =>
 a.length + b.length + c.length + d.length should equal ((a + b + c + d).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String, d: String, e: String) =>
 a.length + b.length + c.length + d.length + e.length should equal ((a + b + c + d + e).length)
}

forAll (minSize(1), sizeRange(9)) { (a: String, b: String, c: String, d: String, e: String, f: String) =>
 a.length + b.length + c.length + d.length + e.length + f.length should equal ((a + b + c + d + e + f).length)
}

Value parameters

configParams

a variable length list of PropertyCheckConfigParam objects that should override corresponding values in the PropertyCheckConfiguration implicitly passed to the apply methods of the ConfiguredPropertyCheck object returned by this method.

Attributes

Inherited from:
ScalaCheckDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, ASSERTION](table: TableFor22[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor22.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, ASSERTION](table: TableFor21[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor21.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, ASSERTION](table: TableFor20[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor20.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, ASSERTION](table: TableFor19[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor19.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, ASSERTION](table: TableFor18[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor18.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, ASSERTION](table: TableFor17[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor17.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, ASSERTION](table: TableFor16[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor16.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, ASSERTION](table: TableFor15[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor15.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, N, ASSERTION](table: TableFor14[A, B, C, D, E, F, G, H, I, J, K, L, M, N])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor14.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, M, ASSERTION](table: TableFor13[A, B, C, D, E, F, G, H, I, J, K, L, M])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor13.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, L, ASSERTION](table: TableFor12[A, B, C, D, E, F, G, H, I, J, K, L])(fun: (A, B, C, D, E, F, G, H, I, J, K, L) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor12.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, K, ASSERTION](table: TableFor11[A, B, C, D, E, F, G, H, I, J, K])(fun: (A, B, C, D, E, F, G, H, I, J, K) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor11.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, J, ASSERTION](table: TableFor10[A, B, C, D, E, F, G, H, I, J])(fun: (A, B, C, D, E, F, G, H, I, J) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor10.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, I, ASSERTION](table: TableFor9[A, B, C, D, E, F, G, H, I])(fun: (A, B, C, D, E, F, G, H, I) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor9.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, H, ASSERTION](table: TableFor8[A, B, C, D, E, F, G, H])(fun: (A, B, C, D, E, F, G, H) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor8.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, G, ASSERTION](table: TableFor7[A, B, C, D, E, F, G])(fun: (A, B, C, D, E, F, G) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor7.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, F, ASSERTION](table: TableFor6[A, B, C, D, E, F])(fun: (A, B, C, D, E, F) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor6.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, E, ASSERTION](table: TableFor5[A, B, C, D, E])(fun: (A, B, C, D, E) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor5.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, D, ASSERTION](table: TableFor4[A, B, C, D])(fun: (A, B, C, D) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor4.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, C, ASSERTION](table: TableFor3[A, B, C])(fun: (A, B, C) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor3.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, B, ASSERTION](table: TableFor2[A, B])(fun: (A, B) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor2.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forAll[A, ASSERTION](table: TableFor1[A])(fun: A => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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 TableFor1.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, ASSERTION](table: TableFor22[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, ASSERTION](table: TableFor21[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, ASSERTION](table: TableFor20[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, ASSERTION](table: TableFor19[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, ASSERTION](table: TableFor18[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, ASSERTION](table: TableFor17[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, ASSERTION](table: TableFor16[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, ASSERTION](table: TableFor15[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, N, ASSERTION](table: TableFor14[A, B, C, D, E, F, G, H, I, J, K, L, M, N])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M, N) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, M, ASSERTION](table: TableFor13[A, B, C, D, E, F, G, H, I, J, K, L, M])(fun: (A, B, C, D, E, F, G, H, I, J, K, L, M) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, L, ASSERTION](table: TableFor12[A, B, C, D, E, F, G, H, I, J, K, L])(fun: (A, B, C, D, E, F, G, H, I, J, K, L) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, K, ASSERTION](table: TableFor11[A, B, C, D, E, F, G, H, I, J, K])(fun: (A, B, C, D, E, F, G, H, I, J, K) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, J, ASSERTION](table: TableFor10[A, B, C, D, E, F, G, H, I, J])(fun: (A, B, C, D, E, F, G, H, I, J) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, I, ASSERTION](table: TableFor9[A, B, C, D, E, F, G, H, I])(fun: (A, B, C, D, E, F, G, H, I) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, H, ASSERTION](table: TableFor8[A, B, C, D, E, F, G, H])(fun: (A, B, C, D, E, F, G, H) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, G, ASSERTION](table: TableFor7[A, B, C, D, E, F, G])(fun: (A, B, C, D, E, F, G) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, F, ASSERTION](table: TableFor6[A, B, C, D, E, F])(fun: (A, B, C, D, E, F) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, E, ASSERTION](table: TableFor5[A, B, C, D, E])(fun: (A, B, C, D, E) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, D, ASSERTION](table: TableFor4[A, B, C, D])(fun: (A, B, C, D) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, C, ASSERTION](table: TableFor3[A, B, C])(fun: (A, B, C) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, B, ASSERTION](table: TableFor2[A, B])(fun: (A, B) => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def forEvery[A, ASSERTION](table: TableFor1[A])(fun: A => ASSERTION)(implicit asserting: TableAsserting[ASSERTION], prettifier: Prettifier, pos: Position): asserting.Result

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

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.

Value parameters

fun

the property check function to apply to each row of data in the table

table

the table of data with which to perform the property check

Attributes

Inherited from:
TableDrivenPropertyChecks
def genByteStringOfN(n: Int): Gen[ByteString]

Attributes

Inherited from:
ArbitraryInstances
def getParameter(configParams: Seq[Configuration#PropertyCheckConfigParam], config: PropertyCheckConfiguration): Parameter

Given some optional PropertyCheckConfigParams and a PropertyCheckConfiguration, compute the resulting Configuration.Parameter.

Given some optional PropertyCheckConfigParams and a PropertyCheckConfiguration, compute the resulting Configuration.Parameter.

This function deals with resolving the various forms of these configuration values, into a consistent form suitable for using in properties.

Duplicate PropertyCheckConfigParam entries are not permitted in the configParams list.

TODO: should this function be public? It feels like an internal implementation detail -- I think it should be private.

Value parameters

c

a configuration object, describing how to run property evaluations

configParams

optionally, some parameters that differ from the provided c

Attributes

Returns

a fully-set-up Configuration.Parameter object, ready to evaluate properties with.

Inherited from:
Configuration
inline def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T]): T

Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

Also note that the difference between this method and assertThrows is that this method returns the expected exception, so it lets you perform further assertions on that exception. By contrast, the assertThrows method returns Succeeded, which means it can serve as the last statement in an async- or safe-style suite. assertThrows also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to use assertThrows by default, intercept only when you need to inspect the caught exception further.

Value parameters

classTag

an implicit ClassTag representing the type of the specified type parameter.

f

the function value that should throw the expected exception

Attributes

Returns

the intercepted exception, if it is of the expected type

Throws
TestFailedException

if the passed function does not complete abruptly with an exception that's an instance of the specified type.

Inherited from:
Assertions
override def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: A <:< B): CanEqual[A, B]

Provides an A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equivalence[B].

Provides an A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equivalence[B].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

equivalenceOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that A is a subype of B

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def maxDiscardedFactor(value: PosZDouble): MaxDiscardedFactor

Returns a MaxDiscardedFactor property check configuration parameter containing the passed value, which specifies the factor of discarded property evaluations allowed during property evaluation.

Returns a MaxDiscardedFactor property check configuration parameter containing the passed value, which specifies the factor of discarded property evaluations allowed during property evaluation.

Attributes

Inherited from:
Configuration
def minSize(value: PosZInt): MinSize

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).

Attributes

Inherited from:
Configuration
def minSuccessful(value: PosInt): MinSuccessful

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.

Attributes

Inherited from:
Configuration
def pending: Assertion & PendingStatement

Throws TestPendingException to indicate a test is pending.

Throws TestPendingException to indicate a test is pending.

A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.

To support this style of testing, a test can be given a name that specifies one bit of behavior required by the system being tested. The test can also include some code that sends more information about the behavior to the reporter when the tests run. At the end of the test, it can call method pending, which will cause it to complete abruptly with TestPendingException. Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information sent to the reporter when running the test can appear in the report of a test run. (In other words, the code of a pending test is executed just like any other test.) However, because the test completes abruptly with TestPendingException, the test will be reported as pending, to indicate the actual test, and possibly the functionality it is intended to test, has not yet been implemented.

Note: This method always completes abruptly with a TestPendingException. Thus it always has a side effect. Methods with side effects are usually invoked with parentheses, as in pending(). This method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or FunSpec to be denoted by placing "(pending)" after the test name, as in:

test("that style rules are not laws") (pending)

Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.

Attributes

Inherited from:
Assertions
inline def pendingUntilFixed(f: => Unit): Assertion & PendingStatement

Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else throw TestFailedException.

Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else throw TestFailedException.

This method can be used to temporarily change a failing test into a pending test in such a way that it will automatically turn back into a failing test once the problem originally causing the test to fail has been fixed. At that point, you need only remove the pendingUntilFixed call. In other words, a pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure. The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when there are no longer needed.

This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more tests and functionality that eventually will get your production code to a point where the original test won't fail anymore. At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally causing your test code to fail has been fixed.

Value parameters

f

a block of code, which if it completes abruptly, should trigger a TestPendingException

Attributes

Throws
TestPendingException

if the passed block of code completes abruptly with an Exception or AssertionError

Inherited from:
Assertions
def sizeRange(value: PosZInt): SizeRange

Returns a SizeRange property 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 SizeRange property 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.

Attributes

Inherited from:
Configuration
override def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: B <:< A): CanEqual[A, B]

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an implicit Equivalence[A].

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an implicit Equivalence[A].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits TypeCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

equalityOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that B is a subype of A

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def whenever[T](condition: Boolean)(fun: => T)(implicit wa: WheneverAsserting[T]): wa.Result

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

Value parameters

condition

the boolean condition that determines whether whenever will evaluate the fun function (condition is true) or throws DiscardedEvaluationException (condition is false)

fun

the function to evaluate if the specified condition is true

Attributes

Inherited from:
Whenever
def withClue[T](clue: Any)(fun: => T): T

Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:

withClue("(Employee's name was: " + employee.name + ")") {
 intercept[IllegalArgumentException] {
   employee.getTask(-1)
 }
}

If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:

(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown

Attributes

Throws
NullArgumentException

if the passed clue is null

Inherited from:
Assertions
def workers(value: PosInt): Workers

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.

Attributes

Inherited from:
Configuration

Deprecated and Inherited methods

override def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: B => A): CanEqual[A, B]

The conversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The conversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an implicit Equivalence[A].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from B to A

equivalenceOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Deprecated
[Since version 3.1.0] The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: A => B): CanEqual[A, B]

The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an explicit Equivalence[B].

This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that converts from A to B.

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint (extended by ConversionCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from A to B

equalityOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Deprecated
[Since version 3.1.0] The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: B => A): CanEqual[A, B]

The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an explicit Equivalence[A].

This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[A], but taking an implicit function that converts from B to A. For example, under ConversionCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

def closeEnoughTo1(num: Double): Boolean =
 (num === 1.0)(decided by forgivingEquality)

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from B to A

equivalenceOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Deprecated
[Since version 3.1.0] The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: A => B): CanEqual[A, B]

The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an implicit Equivalence[B].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint (extended by ConversionCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from A to B

equalityOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Deprecated
[Since version 3.1.0] The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def trap[T](f: => T): Throwable

Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected exception, use intercept, not trap. Here's an example interpreter session without trap:

scala> import org.scalatest._
import org.scalatest._

scala> import Matchers._
import Matchers._

scala> val x = 12
a: Int = 12

scala> x shouldEqual 13
org.scalatest.exceptions.TestFailedException: 12 did not equal 13
  at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449)
  at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203)
  at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417)
  at .<init>(<console>:15)
  at .<clinit>(<console>)
  at .<init>(<console>:7)
  at .<clinit>(<console>)
  at $print(<console>)
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
  at java.lang.reflect.Method.invoke(Method.java:597)
  at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731)
  at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980)
  at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570)
  at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601)
  at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565)
  at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745)
  at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790)
  at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702)
  at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566)
  at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573)
  at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822)
  at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135)
  at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822)
  at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83)
  at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96)
  at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105)
  at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)

That's a pretty tall stack trace. Here's what it looks like when you use trap:

scala> trap { x shouldEqual 13 }
res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13

Much less clutter. Bear in mind, however, that if no exception is thrown by the passed block of code, the trap method will create a new NormalResult (a subclass of Throwable made for this purpose only) and return that. If the result was the Unit value, it will simply say that no exception was thrown:

scala> trap { x shouldEqual 12 }
res2: Throwable = No exception was thrown.

If the passed block of code results in a value other than Unit, the NormalResult's toString will print the value:

scala> trap { "Dude!" }
res3: Throwable = No exception was thrown. Instead, result was: "Dude!"

Although you can access the result value from the NormalResult, its type is Any and therefore not very convenient to use. It is not intended that trap be used in test code. The sole intended use case for trap is decluttering Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.

Attributes

Deprecated
The trap method is no longer needed for demos in the REPL, which now abreviates stack traces, and will be removed in a future version of ScalaTest
Inherited from:
Assertions

Inherited fields

final val pipeChar: '|'

Attributes

Inherited from:
Assertions
final val succeed: Assertion

The Succeeded singleton.

The Succeeded singleton.

You can use succeed to solve a type error when an async test does not end in either Future[Assertion] or Assertion. Because Assertion is a type alias for Succeeded.type, putting succeed at the end of a test body (or at the end of a function being used to map the final future of a test body) will solve the type error.

Attributes

Inherited from:
Assertions

Givens

Givens

protected given given_PlutusVM: PlutusVM

Given PlutusVM using plutusVM - methods can override via using parameter

Given PlutusVM using plutusVM - methods can override via using parameter

Attributes

Inherited givens

given TermShrink: Shrink[Term]

Attributes

Inherited from:
ArbitraryInstances
given arbAssocMap[A : Eq, B : Arbitrary]: Arbitrary[AssocMap[A, B]]

Attributes

Inherited from:
ArbitraryInstances
given arbData: Arbitrary[Data]

Attributes

Inherited from:
ArbitraryInstances
given arbList[A : Arbitrary]: Arbitrary[List[A]]

Attributes

Inherited from:
ArbitraryInstances
given arbOption[A : Arbitrary]: Arbitrary[Option[A]]

Attributes

Inherited from:
ArbitraryInstances
given arbSortedMap[A : Ord, B : Arbitrary]: Arbitrary[SortedMap[A, B]]

Attributes

Inherited from:
ArbitraryInstances
given arbitraryConstant: Arbitrary[Constant]

Attributes

Inherited from:
ArbitraryInstances
given arbitraryDefaultUni: Arbitrary[DefaultUni]

Attributes

Inherited from:
ArbitraryInstances
given arbitraryTerm: Arbitrary[Term]

Attributes

Inherited from:
ArbitraryInstances
given bArb: Arbitrary[B]

Attributes

Inherited from:
ArbitraryInstances
given byteStringArb: Arbitrary[ByteString]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_Program: Arbitrary[Program]

Attributes

Inherited from:
ArbitraryInstances
given given_Shrink_Constant: Shrink[Constant]

Attributes

Inherited from:
ArbitraryInstances
given given_Shrink_Data: Shrink[Data]

Attributes

Inherited from:
ArbitraryInstances
given given_Shrink_Program: Shrink[Program]

Attributes

Inherited from:
ArbitraryInstances
given iArb: Arbitrary[I]

Attributes

Inherited from:
ArbitraryInstances

Extensions

Inherited extensions

extension (x: String)
inline def stripMargin: String

Attributes

Inherited from:
Assertions
extension (x: String)
inline def stripMargin(c: Char): String

Attributes

Inherited from:
Assertions

Implicits

Inherited implicits

implicit override def convertToEqualizer[T](left: T): Equalizer[T]

Converts to an Equalizer that provides === and !== operators that result in Boolean and enforce no type constraint.

Converts to an Equalizer that provides === and !== operators that result in Boolean and enforce no type constraint.

This method is overridden and made implicit by subtrait TripleEquals and overriden as non-implicit by the other subtraits in this package.

Value parameters

left

the object whose type to convert to Equalizer.

Attributes

Throws
NullPointerException

if left is null.

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
implicit val generatorDrivenConfig: PropertyCheckConfiguration

Implicit PropertyCheckConfig value providing default configuration values.

Implicit PropertyCheckConfig value providing default configuration values.

Attributes

Inherited from:
Configuration
implicit override def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

Provides an A CanEqual B instance for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

Provides an A CanEqual B instance for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

The returned Constraint's areEqual method uses the implicitly passed Equality[A]'s areEqual method to determine equality.

This method is overridden and made implicit by subtraits TripleEquals and overriden as non-implicit by the other subtraits in this package.

Value parameters

equalityOfA

an Equality[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEqual method of the passed Equality[A].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals

Exports

Defined exports

final val Arbitrary: Arbitrary
Exported from scalacheck
final type Arbitrary = Arbitrary
Exported from scalacheck
final val Gen: Gen
Exported from scalacheck
final type Gen = Gen
Exported from scalacheck
final val Shrink: Shrink
Exported from scalacheck
final type Shrink = Shrink
Exported from scalacheck
Generated with