StdlibTestKit
Attributes
- Graph
-
- Supertypes
-
trait ArbitraryInstancestrait ScalaCheckPropertyCheckstrait ScalaCheckDrivenPropertyCheckstrait Configurationtrait TableDrivenPropertyCheckstrait Tablestrait Wheneverclass AnyFunSuitetrait AnyFunSuiteLiketrait Documentingtrait Alertingtrait Notifyingtrait Informingtrait TestRegistrationtrait TestSuitetrait Suitetrait Serializabletrait Assertionstrait TripleEqualstrait TripleEqualsSupportclass Objecttrait Matchableclass AnyShow all
Members list
Type members
Inherited classlikes
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 Objecttrait Matchableclass Any
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
PropertyCheckConfigParamobjects that should override corresponding values in thePropertyCheckConfigurationimplicitly passed to theapplymethods of instances of this class.
Attributes
- Inherited from:
- ScalaCheckDrivenPropertyChecks
- Supertypes
-
class Objecttrait Matchableclass Any
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 Objecttrait Matchableclass Any
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
-
class PropertyCheckConfigParamtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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
-
class PropertyCheckConfigParamtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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
-
class PropertyCheckConfigParamtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
A test function taking no arguments and returning an Outcome.
A test function taking no arguments and returning an Outcome.
For more detail and examples, see the relevant section in the documentation for trait fixture.FlatSpec.
Attributes
- Inherited from:
- TestSuite
- Supertypes
-
trait TestDatatrait () => Outcomeclass Objecttrait Matchableclass Any
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Internal utility functions for configuration management.
Internal utility functions for configuration management.
Attributes
- Inherited from:
- Configuration
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
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
-
class PropertyCheckConfigParamtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
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 Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Assertions
- Supertypes
-
class Objecttrait Matchableclass Any
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
-
class PropertyCheckConfigParamtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Inherited and Abstract classlikes
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 Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Value members
Concrete methods
Inherited methods
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
TripleEqualsInvocationOnSpreadwrapping the passedSpread[T]value, withexpectingEqualset tofalse. - Inherited from:
- TripleEqualsSupport
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
TripleEqualsInvocationwrapping the passednullvalue, withexpectingEqualset tofalse. - Inherited from:
- TripleEqualsSupport
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
TripleEqualsInvocationwrapping the passed right value, withexpectingEqualset tofalse. - Inherited from:
- TripleEqualsSupport
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
TripleEqualsInvocationOnSpreadwrapping the passedSpread[T]value, withexpectingEqualset totrue. - Inherited from:
- TripleEqualsSupport
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
TripleEqualsInvocationwrapping the passednullvalue, withexpectingEqualset totrue. - Inherited from:
- TripleEqualsSupport
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
TripleEqualsInvocationwrapping the passed right value, withexpectingEqualset totrue. - Inherited from:
- TripleEqualsSupport
Returns an Alerter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AnyFunSuite is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Returns an Alerter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AnyFunSuite is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Attributes
- Inherited from:
- AnyFunSuiteLike
Attributes
- Inherited from:
- ArbitraryInstances
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
toStringmethod returns a message to include in a failure report. - condition
-
the boolean condition to assert
Attributes
- Throws
-
NullArgumentException
if
messageisnull.TestFailedExceptionif the condition is
false. - Inherited from:
- Assertions
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
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
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
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
expectedvalue - expected
-
the expected value
Attributes
- Throws
-
TestFailedException
if the passed
actualvalue does not equal the passedexpectedvalue. - Inherited from:
- Assertions
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
expectedvalue - clue
-
An object whose
toStringmethod returns a message to include in a failure report. - expected
-
the expected value
Attributes
- Throws
-
TestFailedException
if the passed
actualvalue does not equal the passedexpectedvalue. - Inherited from:
- Assertions
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
ClassTagrepresenting the type of the specified type parameter. - f
-
the function value that should throw the expected exception
Attributes
- Returns
-
the
Succeededsingleton, 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
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
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
toStringmethod returns a message to include in a failure report. - condition
-
the boolean condition to assume
Attributes
- Throws
-
NullArgumentException
if
messageisnull.TestCanceledExceptionif the condition is
false. - Inherited from:
- Assertions
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
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
Throwablethat indicates the cause of the cancellation.
Attributes
- Throws
-
NullArgumentException
if
causeisnull - Inherited from:
- Assertions
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
Throwablethat indicates the cause of the failure. - message
-
A message describing the failure.
Attributes
- Throws
-
NullArgumentException
if
messageorcauseisnull - Inherited from:
- Assertions
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
messageisnull - Inherited from:
- Assertions
Throws TestCanceledException to indicate a test was canceled.
Throws TestCanceledException to indicate a test was canceled.
Attributes
- Inherited from:
- Assertions
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 theConstraint.areEqualmethod will delegate to determine equality. - ev
-
evidence that
Ais a subype of B
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[B]. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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 theConstraint.areEqualmethod will delegate to determine equality. - ev
-
evidence that
Bis a subype of A
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[A]. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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
leftisnull. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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
Equalityfor typeA - Inherited from:
- TripleEqualsSupport
Executes one or more tests in this Suite, printing results to the standard output.
Executes one or more tests in this Suite, printing results to the standard output.
This method invokes run on itself, passing in values that can be configured via the parameters to this method, all of which have default values. This behavior is convenient when working with ScalaTest in the Scala interpreter. Here's a summary of this method's parameters and how you can use them:
The testName parameter
If you leave testName at its default value (of null), this method will pass None to the testName parameter of run, and as a result all the tests in this suite will be executed. If you specify a testName, this method will pass Some(testName) to run, and only that test will be run. Thus to run all tests in a suite from the Scala interpreter, you can write:
scala> (new ExampleSuite).execute()
(The above syntax actually invokes the overloaded parameterless form of execute, which calls this form with its default parameter values.) To run just the test named "my favorite test" in a suite from the Scala interpreter, you would write:
scala> (new ExampleSuite).execute("my favorite test")
Or:
scala> (new ExampleSuite).execute(testName = "my favorite test")
The configMap parameter
If you provide a value for the configMap parameter, this method will pass it to run. If not, the default value of an empty Map will be passed. For more information on how to use a config map to configure your test suites, see the config map section in the main documentation for this trait. Here's an example in which you configure a run with the name of an input file:
scala> (new ExampleSuite).execute(configMap = Map("inputFileName" -> "in.txt")
The color parameter
If you leave the color parameter unspecified, this method will configure the reporter it passes to run to print to the standard output in color (via ansi escape characters). If you don't want color output, specify false for color, like this:
scala> (new ExampleSuite).execute(color = false)
The durations parameter
If you leave the durations parameter unspecified, this method will configure the reporter it passes to run to not print durations for tests and suites to the standard output. If you want durations printed, specify true for durations, like this:
scala> (new ExampleSuite).execute(durations = true)
The shortstacks and fullstacks parameters
If you leave both the shortstacks and fullstacks parameters unspecified, this method will configure the reporter it passes to run to not print stack traces for failed tests if it has a stack depth that identifies the offending line of test code. If you prefer a short stack trace (10 to 15 stack frames) to be printed with any test failure, specify true for shortstacks:
scala> (new ExampleSuite).execute(shortstacks = true)
For full stack traces, set fullstacks to true:
scala> (new ExampleSuite).execute(fullstacks = true)
If you specify true for both shortstacks and fullstacks, you'll get full stack traces.
The stats parameter
If you leave the stats parameter unspecified, this method will not fire RunStarting and either RunCompleted or RunAborted events to the reporter it passes to run. If you specify true for stats, this method will fire the run events to the reporter, and the reporter will print the expected test count before the run, and various statistics after, including the number of suites completed and number of tests that succeeded, failed, were ignored or marked pending. Here's how you get the stats:
scala> (new ExampleSuite).execute(stats = true)
To summarize, this method will pass to run:
-
testName-Noneif this method'stestNameparameter is left at its default value ofnull, elseSome(testName). -
reporter- a reporter that prints to the standard output -
stopper- aStopperwhoseapplymethod always returnsfalse -
filter- aFilterconstructed withNonefortagsToIncludeandSet()fortagsToExclude -
configMap- theconfigMappassed to this method -
distributor-None -
tracker- a newTracker
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and can be used interchangably. The reason this method isn't named run is that it takes advantage of default arguments, and you can't mix overloaded methods and default arguments in Scala. (If named run, this method would have the same name but different arguments than the main run method that takes seven arguments. Thus it would overload and couldn't be used with default argument values.)
Design note: This method has two "features" that may seem unidiomatic. First, the default value of testName is null. Normally in Scala the type of testName would be Option[String] and the default value would be None, as it is in this trait's run method. The null value is used here for two reasons. First, in ScalaTest 1.5, execute was changed from four overloaded methods to one method with default values, taking advantage of the default and named parameters feature introduced in Scala 2.8. To not break existing source code, testName needed to have type String, as it did in two of the overloaded execute methods prior to 1.5. The other reason is that execute has always been designed to be called primarily from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king. A String type with a null default value lets users type suite.execute("my test name") rather than suite.execute(Some("my test name")), saving several keystrokes.
The second non-idiomatic feature is that shortstacks and fullstacks are all lower case rather than camel case. This is done to be consistent with the Shell, which also uses those forms. The reason lower case is used in the Shell is to save keystrokes in an interpreter environment. Most Unix commands, for example, are all lower case, making them easier and quicker to type. In the ScalaTest Shell, methods like shortstacks, fullstacks, and nostats, etc., are designed to be all lower case so they feel more like shell commands than methods.
Value parameters
- color
-
a boolean that configures whether output is printed in color
- configMap
-
a
Mapof key-value pairs that can be used by the executingSuiteof tests. - durations
-
a boolean that configures whether test and suite durations are printed to the standard output
- fullstacks
-
a boolean that configures whether full stack traces should be printed for test failures
- shortstacks
-
a boolean that configures whether short stack traces should be printed for test failures
- stats
-
a boolean that configures whether test and suite statistics are printed to the standard output
- testName
-
the name of one test to run.
Attributes
- Throws
-
IllegalArgumentException
if
testNameis defined, but no test with the specified test name exists in thisSuiteNullArgumentExceptionif the passed
configMapparameter isnull. - Inherited from:
- Suite
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
The total number of tests that are expected to run when this Suite's run method is invoked.
The total number of tests that are expected to run when this Suite's run method is invoked.
This trait's implementation of this method returns the sum of:
-
the size of the
testNamesList, minus the number of tests marked as ignored and any tests that are exluded by the passedFilter -
the sum of the values obtained by invoking
expectedTestCounton every nestedSuitecontained innestedSuites
Value parameters
- filter
-
a
Filterwith which to filter tests to count based on their tags
Attributes
- Inherited from:
- Suite
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
Throwablethat indicates the cause of the failure.
Attributes
- Throws
-
NullArgumentException
if
causeisnull - Inherited from:
- Assertions
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
Throwablethat indicates the cause of the failure. - message
-
A message describing the failure.
Attributes
- Throws
-
NullArgumentException
if
messageorcauseisnull - Inherited from:
- Assertions
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
messageisnull - Inherited from:
- Assertions
Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.
Attributes
- Inherited from:
- Assertions
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
PropertyCheckConfigParamobjects that should override corresponding values in thePropertyCheckConfigurationimplicitly passed to theapplymethods of theConfiguredPropertyCheckobject returned by this method.
Attributes
- Inherited from:
- ScalaCheckDrivenPropertyChecks
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Attributes
- Inherited from:
- ArbitraryInstances
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
Register a test to ignore, which has the specified name, optional tags, and function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the run methods. This method exists to make it easy to ignore an existing test by changing the call to test to ignore without deleting or commenting out the actual test code. The test will not be run, but a report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on this AnyFunSuite instance.
Register a test to ignore, which has the specified name, optional tags, and function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the run methods. This method exists to make it easy to ignore an existing test by changing the call to test to ignore without deleting or commenting out the actual test code. The test will not be run, but a report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on this AnyFunSuite instance.
Value parameters
- testFun
-
the test function
- testName
-
the name of the test
- testTags
-
the optional list of tags for this test
Attributes
- Throws
-
DuplicateTestNameException
if a test with the same name has been registered previously
NotAllowedExceptionif
testNamehad been registered previouslyTestRegistrationClosedExceptionif invoked after
runhas been invoked on this suite - Inherited from:
- AnyFunSuiteLike
Returns an Informer that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, as recordedEvents of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Returns an Informer that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, as recordedEvents of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Attributes
- Inherited from:
- AnyFunSuiteLike
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
ClassTagrepresenting 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
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 theConstraint.areEqualmethod will delegate to determine equality. - ev
-
evidence that
Ais a subype of B
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[B]. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, as recordedEvents of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Returns a Documenter that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked from inside a scope, it will forward the information to the current reporter immediately. If invoked from inside a test function, it will record the information and forward it to the current reporter only after the test completed, as recordedEvents of the test completed event, such as TestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Attributes
- Inherited from:
- AnyFunSuiteLike
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
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
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
An immutable IndexedSeq of this Suite object's nested Suites. If this Suite contains no nested Suites, this method returns an empty IndexedSeq. This trait's implementation of this method returns an empty List.
An immutable IndexedSeq of this Suite object's nested Suites. If this Suite contains no nested Suites, this method returns an empty IndexedSeq. This trait's implementation of this method returns an empty List.
Attributes
- Inherited from:
- Suite
Returns a Notifier that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AnyFunSuite is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Returns a Notifier that during test execution will forward strings passed to its apply method to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while this AnyFunSuite is being executed, such as from inside a test function, it will forward the information to the current reporter immediately. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.
Attributes
- Inherited from:
- AnyFunSuiteLike
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
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
ExceptionorAssertionError - Inherited from:
- Assertions
Registers an ignored test.
Registers an ignored test.
Value parameters
- testFun
-
the test function
- testTags
-
the test tags
- testText
-
the test text
Attributes
- Inherited from:
- AnyFunSuiteLike
Registers a test.
Registers a test.
Value parameters
- testFun
-
the test function
- testTags
-
the test tags
- testText
-
the test text
Attributes
- Inherited from:
- AnyFunSuiteLike
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
The fully qualified class name of the rerunner to rerun this suite. This implementation will look at this.getClass and see if it is either an accessible Suite, or it has a WrapWith annotation. If so, it returns the fully qualified class name wrapped in a Some, or else it returns None.
Attributes
- Inherited from:
- Suite
Runs this suite of tests.
Runs this suite of tests.
If testName is None, this trait's implementation of this method calls these two methods on this object in this order:
-
runNestedSuites -
runTests
If testName is defined, then this trait's implementation of this method calls runTests, but does not call runNestedSuites. This behavior is part of the contract of this method. Subclasses that override run must take care not to call runNestedSuites if testName is defined. (The OneInstancePerTest trait depends on this behavior, for example.)
Subclasses and subtraits that override this run method can implement them without invoking either the runTests or runNestedSuites methods, which are invoked by this trait's implementation of this method. It is recommended, but not required, that subclasses and subtraits that override run in a way that does not invoke runNestedSuites also override runNestedSuites and make it final. Similarly it is recommended, but not required, that subclasses and subtraits that override run in a way that does not invoke runTests also override runTests (and runTest, which this trait's implementation of runTests calls) and make it final. The implementation of these final methods can either invoke the superclass implementation of the method, or throw an UnsupportedOperationException if appropriate. The reason for this recommendation is that ScalaTest includes several traits that override these methods to allow behavior to be mixed into a Suite. For example, trait BeforeAndAfterEach overrides runTestss. In a Suite subclass that no longer invokes runTests from run, the BeforeAndAfterEach trait is not applicable. Mixing it in would have no effect. By making runTests final in such a Suite subtrait, you make the attempt to mix BeforeAndAfterEach into a subclass of your subtrait a compiler error. (It would fail to compile with a complaint that BeforeAndAfterEach is trying to override runTests, which is a final method in your trait.)
Value parameters
- args
-
the
Argsfor this run - testName
-
an optional name of one test to run. If
None, all relevant tests should be run. I.e.,Noneacts like a wildcard that means run all relevant tests in thisSuite.
Attributes
- Returns
-
a
Statusobject that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred. - Throws
-
IllegalArgumentException
if
testNameis defined, but no test with the specified test name exists in thisSuiteNullArgumentExceptionif any passed parameter is
null. - Definition Classes
-
AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
Run a test. This trait's implementation runs the test registered with the name specified by testName.
Run a test. This trait's implementation runs the test registered with the name specified by testName.
Value parameters
- args
-
the
Argsfor this run - testName
-
the name of one test to run.
Attributes
- Returns
-
a
Statusobject that indicates when the test started by this method has completed, and whether or not it failed . - Throws
-
IllegalArgumentException
if
testNameis defined but a test with that name does not exist on thisAnyFunSuiteNullArgumentExceptionif any of
testName,reporter,stopper, orconfigMapisnull. - Definition Classes
-
AnyFunSuiteLike -> TestSuite -> Suite
- Inherited from:
- AnyFunSuiteLike
Run zero to many of this AnyFunSuite's tests.
Run zero to many of this AnyFunSuite's tests.
Value parameters
- args
-
the
Argsfor this run - testName
-
an optional name of one test to run. If
None, all relevant tests should be run. I.e.,Noneacts like a wildcard that means run all relevant tests in thisSuite.
Attributes
- Returns
-
a
Statusobject that indicates when all tests started by this method have completed, and whether or not a failure occurred. - Throws
-
IllegalArgumentException
if
testNameis defined, but no test with the specified test name exists in thisSuiteNullArgumentExceptionif any of the passed parameters is
null. - Definition Classes
-
AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
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
A string ID for this Suite that is intended to be unique among all suites reported during a run.
A string ID for this Suite that is intended to be unique among all suites reported during a run.
This trait's implementation of this method returns the fully qualified name of this object's class. Each suite reported during a run will commonly be an instance of a different Suite class, and in such cases, this default implementation of this method will suffice. However, in special cases you may need to override this method to ensure it is unique for each reported suite. For example, if you write a Suite subclass that reads in a file whose name is passed to its constructor and dynamically creates a suite of tests based on the information in that file, you will likely need to override this method in your Suite subclass, perhaps by appending the pathname of the file to the fully qualified class name. That way if you run a suite of tests based on a directory full of these files, you'll have unique suite IDs for each reported suite.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
Attributes
- Returns
-
this
Suiteobject's ID. - Inherited from:
- Suite
A user-friendly suite name for this Suite.
A user-friendly suite name for this Suite.
This trait's implementation of this method returns the simple name of this object's class. This trait's implementation of runNestedSuites calls this method to obtain a name for Reports to pass to the suiteStarting, suiteCompleted, and suiteAborted methods of the Reporter.
Attributes
- Returns
-
this
Suiteobject's suite name. - Inherited from:
- Suite
A Map whose keys are String names of tagged tests and whose associated values are the Set of tags for the test. If this AnyFunSuite contains no tags, this method returns an empty Map.
A Map whose keys are String names of tagged tests and whose associated values are the Set of tags for the test. If this AnyFunSuite contains no tags, this method returns an empty Map.
This trait's implementation returns tags that were passed as strings contained in Tag objects passed to methods test and ignore.
In addition, this trait's implementation will also auto-tag tests with class level annotations. For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with org.scalatest.Ignore.
Attributes
- Definition Classes
-
AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
Register a test with the specified name, optional tags, and function value that takes no arguments. This method will register the test for later execution via an invocation of one of the run methods. The passed test name must not have been registered previously on this AnyFunSuite instance.
Register a test with the specified name, optional tags, and function value that takes no arguments. This method will register the test for later execution via an invocation of one of the run methods. The passed test name must not have been registered previously on this AnyFunSuite instance.
Value parameters
- testFun
-
the test function
- testName
-
the name of the test
- testTags
-
the optional list of tags for this test
Attributes
- Throws
-
DuplicateTestNameException
if a test with the same name has been registered previously
NotAllowedExceptionif
testNamehad been registered previouslyNullArgumentExceptionif
testNameor any passed test tag isnullTestRegistrationClosedExceptionif invoked after
runhas been invoked on this suite - Inherited from:
- AnyFunSuiteLike
Provides a TestData instance for the passed test name, given the passed config map.
Provides a TestData instance for the passed test name, given the passed config map.
This method is used to obtain a TestData instance to pass to withFixture(NoArgTest) and withFixture(OneArgTest) and the beforeEach and afterEach methods of trait BeforeAndAfterEach.
Value parameters
- testName
-
the name of the test for which to return a
TestDatainstance - theConfigMap
-
the config map to include in the returned
TestData
Attributes
- Returns
-
a
TestDatainstance for the specified test, which includes the specified config map - Definition Classes
-
AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
An immutable Set of test names. If this AnyFunSuite contains no tests, this method returns an empty Set.
An immutable Set of test names. If this AnyFunSuite contains no tests, this method returns an empty Set.
This trait's implementation of this method will return a set that contains the names of all registered tests. The set's iterator will return those names in the order in which the tests were registered.
Attributes
- Definition Classes
-
AnyFunSuiteLike -> Suite
- Inherited from:
- AnyFunSuiteLike
Registers shared tests.
Registers shared tests.
This method enables the following syntax for shared tests in a AnyFunSuite:
testsFor(nonEmptyStack(lastValuePushed))
This method just provides syntax sugar intended to make the intent of the code clearer. Because the parameter passed to it is type Unit, the expression will be evaluated before being passed, which is sufficient to register the shared tests. For examples of shared tests, see the Shared tests section in the main documentation for this trait.
Attributes
- Inherited from:
- AnyFunSuiteLike
Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking toString on each of the nested suites, separated by commas and surrounded by parentheses.
Returns a user friendly string for this suite, composed of the simple name of the class (possibly simplified further by removing dollar signs if added by the Scala interpeter) and, if this suite contains nested suites, the result of invoking toString on each of the nested suites, separated by commas and surrounded by parentheses.
Attributes
- Returns
-
a user-friendly string for this suite
- Definition Classes
-
AnyFunSuite -> AnyFunSuiteLike -> Any
- Inherited from:
- AnyFunSuite
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 theConstraint.areEqualmethod will delegate to determine equality. - ev
-
evidence that
Bis a subype of A
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[A]. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
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
wheneverwill evaluate thefunfunction (conditionis true) or throwsDiscardedEvaluationException(conditionis false) - fun
-
the function to evaluate if the specified
conditionis true
Attributes
- Inherited from:
- Whenever
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
clueisnull - Inherited from:
- Assertions
Run the passed test function in the context of a fixture established by this method.
Run the passed test function in the context of a fixture established by this method.
This method should set up the fixture needed by the tests of the current suite, invoke the test function, and if needed, perform any clean up needed after the test completes. Because the NoArgTest function passed to this method takes no parameters, preparing the fixture will require side effects, such as reassigning instance vars in this Suite or initializing a globally accessible external database. If you want to avoid reassigning instance vars you can use FixtureSuite.
This trait's implementation of runTest invokes this method for each test, passing in a NoArgTest whose apply method will execute the code of the test.
This trait's implementation of this method simply invokes the passed NoArgTest function.
Value parameters
- test
-
the no-arg test function to run with a fixture
Attributes
- Inherited from:
- TestSuite
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
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
Bto A - equivalenceOfA
-
an
Equivalence[A]type class to which theConstraint.areEqualmethod will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[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
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
Ato B - equalityOfB
-
an
Equivalence[B]type class to which theConstraint.areEqualmethod will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[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
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
Bto A - equivalenceOfA
-
an
Equivalence[A]type class to which theConstraint.areEqualmethod will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[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
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
Ato B - equalityOfB
-
an
Equivalence[B]type class to which theConstraint.areEqualmethod will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEquivalentmethod of the passedEquivalence[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
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
Attributes
- Inherited from:
- Assertions
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
Deprecated and Inherited fields
The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0 will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName.
Attributes
- Deprecated
-
[Since version 3.1.0]The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement. - Inherited from:
- AnyFunSuiteLike
Givens
Inherited givens
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Attributes
- Inherited from:
- ArbitraryInstances
Extensions
Inherited extensions
Attributes
- Inherited from:
- Assertions
Attributes
- Inherited from:
- Assertions
Implicits
Inherited implicits
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
leftisnull. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals
Implicit PropertyCheckConfig value providing default configuration values.
Implicit PropertyCheckConfig value providing default configuration values.
Attributes
- Inherited from:
- Configuration
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 theConstraint.areEqualmethod will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual Binstance whoseareEqualmethod delegates to theareEqualmethod of the passedEquality[A]. - Definition Classes
-
TripleEquals -> TripleEqualsSupport
- Inherited from:
- TripleEquals