TableFor4
Related Docs:
object TableFor4
| package prop
Applies the passed property check function to each row of this TableFor4.
Applies the passed property check function to each row of this TableFor4.
If the property checks for all rows succeed (the property check function returns normally when passed
the data for each row), this apply method returns normally. If the property check function
completes abruptly with an exception for any row, this apply method wraps that exception
in a TableDrivenPropertyCheckFailedException and completes abruptly with that exception. Once
the property check function throws an exception for a row, this apply method will complete
abruptly immediately and subsequent rows will not be checked against the function.
the property check function to apply to each row of this TableFor4
Selects a row of data by its index.
Selects a row of data by its index.
a tuple containing string names of the columns in this table
The number of rows of data in the table.
The number of rows of data in the table. (This does not include the heading tuple)
Creates a new Builder for TableFor4s.
Creates a new Builder for TableFor4s.
(Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.
A string representation of this object, which includes the heading strings as well as the rows of data.
A string representation of this object, which includes the heading strings as well as the rows of data.
(Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.
A table with 4 columns.
For an introduction to using tables, see the documentation for trait TableDrivenPropertyChecks.
This table is a sequence of
Tuple4objects, where each tuple represents one row of the table. The first element of each tuple comprise the first column of the table, the second element of each tuple comprise the second column, and so on. This table also carries with it a heading tuple that gives string names to the columns of the table.A handy way to create a
TableFor4is via anapplyfactory method in theTablesingleton object provided by theTablestrait. Here's an example:val examples = Table( ("a", "b", "c", "d"), ( 0, 0, 0, 0), ( 1, 1, 1, 1), ( 2, 2, 2, 2), ( 3, 3, 3, 3), ( 4, 4, 4, 4), ( 5, 5, 5, 5), ( 6, 6, 6, 6), ( 7, 7, 7, 7), ( 8, 8, 8, 8), ( 9, 9, 9, 9) )Because you supplied 4 members in each tuple, the type you'll get back will be a
TableFor4.The table provides an
applymethod that takes a function with a parameter list that matches the types and arity of the tuples contained in this table. Theapplymethod will invoke the function with the members of each row tuple passed as arguments, in ascending order by index. (I.e., the zeroth tuple is checked first, then the tuple with index 1, then index 2, and so on until all the rows have been checked (or until a failure occurs). The function represents a property of the code under test that should succeed for every row of the table. If the function returns normally, that indicates the property check succeeded for that row. If the function completes abruptly with an exception, that indicates the property check failed and theapplymethod will complete abruptly with aTableDrivenPropertyCheckFailedExceptionthat wraps the exception thrown by the supplied property function.The usual way you'd invoke the
applymethod that checks a property is via aforAllmethod provided by traitTableDrivenPropertyChecks. TheforAllmethod takes aTableFor4as its first argument, then in a curried argument list takes the property check function. It invokesapplyon theTableFor4, passing in the property check function. Here's an example:forAll (examples) { (a, b, c, d) => a + b + c + d should equal (a * 4) }Because
TableFor4is aSeq[(A, B, C, D)], you can use it as aSeq. For example, here's how you could get a sequence ofOutcomes for each row of the table, indicating whether a property check succeeded or failed on each row of the table:for (row <- examples) yield { outcomeOf { row._1 should not equal (7) } }Note: the
outcomeOfmethod, contained in theOutcomeOftrait, will execute the supplied code (a by-name parameter) and transform it to anOutcome. If no exception is thrown by the code,outcomeOfwill result in aSucceeded, indicating the "property check" succeeded. If the supplied code completes abruptly in an exception that would normally cause a test to fail,outcomeOfwill result in in aFailedinstance containing that exception. For example, the previous for expression would give you:Vector(Succeeded, Succeeded, Succeeded, Succeeded, Succeeded, Succeeded, Succeeded, Failed(org.scalatest.TestFailedException: 7 equaled 7), Succeeded, Succeeded)This shows that all the property checks succeeded, except for the one at index 7.