Class that supports the registration of a “subject” being specified and tested via the
instance referenced from FixtureFlatSpec's behavior field.
Class used via an implicit conversion to enable any two objects to be compared with=== in assertions in tests.
The type of the configMap, which is Map[String, Any].
The type of the configMap, which is Map[String, Any].
Class that supports registration of ignored tests via the IgnoreWord instance referenced
from FixtureFlatSpec's ignore field.
Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
from FixtureFlatSpec's ignore field.
Class that supports registration of ignored tests via the instance referenced from FixtureFlatSpec's ignore field.
Class that supports test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
Class that supports test registration via the instance referenced from FixtureFlatSpec's it field.
Class that supports the registration of tagged tests via the ItWord instance
referenced from FixtureFlatSpec's it field.
Class that supports test (and shared test) registration via the instance referenced from FixtureFlatSpec's it field.
A test function taking no arguments, which also provides a test name and config map.
Trait whose instances encapsulate a test function that takes a fixture and config map.
This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec,
and FixtureWordSpec.
This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec,
and FixtureWordSpec.
This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec,
and FixtureWordSpec.
o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
This method is used to cast the receiver object to be of type T0.
This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as
part of compilation it is not possible to check whether the contents of the list are of the requested typed.
the receiver object.
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the Stringvalue of the Some included in the TestFailedException's
detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b)
For more information on how this mechanism works, see the documentation forEqualizer.
the Option[String] to assert
Assert that an Option[String] is None.
Assert that an Option[String] is None.
If the condition is None, this method returns normally.
Else, it throws TestFailedException with the Stringvalue of the Some, as well as theString obtained by invoking toString on the
specified message,
included in the TestFailedException's detail message.
This form of assert is usually called in conjunction with an
implicit conversion to Equalizer, using a === comparison, as in:
assert(a === b, "extra info reported if assertion fails")
For more information on how this mechanism works, see the documentation forEqualizer.
the Option[String] to assert
An objects whose toString method returns a message to include in a failure report.
Assert that a boolean condition, described in Stringmessage, is true.
Assert that a boolean condition, described in Stringmessage, is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException with theString obtained by invoking toString on the
specified message as the exception's detail message.
the boolean condition to assert
An objects whose toString method returns a message to include in a failure report.
Assert that a boolean condition is true.
Assert that a boolean condition is true.
If the condition is true, this method returns normally.
Else, it throws TestFailedException.
the boolean condition to assert
Supports shared test registration in FixtureFlatSpecs.
Supports shared test registration in FixtureFlatSpecs.
This field supports syntax such as the following:
it should behave like nonFullStack(stackWithOneItem)
For more information and examples of the use of behave, see the Shared tests sectionin the main documentation for trait FlatSpec.
Supports the registration of a “subject” being specified and tested.
Supports the registration of a “subject” being specified and tested.
This field enables syntax such as the following subject registration:
behavior of "A Stack"
For more information and examples of the use of the behavior field, see the main documentationfor trait FlatSpec.
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
Implicit conversion from Any to Equalizer, used to enable
assertions with === comparisons.
Implicit conversion from Any to Equalizer, used to enable
assertions with === comparisons.
For more information on this mechanism, see the documentation for Equalizer.
Because trait Suite mixes in Assertions, this implicit conversion will always be
available by default in ScalaTest Suites. This is the only implicit conversion that is in scope by default in every
ScalaTest Suite. Other implicit conversions offered by ScalaTest, such as those that support the matchers DSL
or invokePrivate, must be explicitly invited into your test code, either by mixing in a trait or importing the
members of its companion object. The reason ScalaTest requires you to invite in implicit conversions (with the exception of the
implicit conversion for === operator) is because if one of ScalaTest's implicit conversions clashes with an
implicit conversion used in the code you are trying to test, your program won't compile. Thus there is a chance that if you
are ever trying to use a library or test some code that also offers an implicit conversion involving a === operator,
you could run into the problem of a compiler error due to an ambiguous implicit conversion. If that happens, you can turn off
the implicit conversion offered by this convertToEqualizer method simply by overriding the method in yourSuite subclass, but not marking it as implicit:
// In your Suite subclass override def convertToEqualizer(left: Any) = new Equalizer(left)
the object whose type to convert to Equalizer.
Implicitly converts an object of type ResultOfStringPassedToVerb to anInAndIgnoreMethods, to enable in and ignoremethods to be invokable on that object.
Implicitly converts an object of type ResultOfStringPassedToVerb to anInAndIgnoreMethods, to enable in and ignoremethods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation to anInAndIgnoreMethodsAfterTaggedAs, to enable in and ignoremethods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation to anInAndIgnoreMethodsAfterTaggedAs, to enable in and ignoremethods to be invokable on that object.
Implicitly converts an object of type String to a StringCanWrapper,
to enable can methods to be invokable on that object.
Implicitly converts an object of type String to a StringCanWrapper,
to enable can methods to be invokable on that object.
Implicitly converts an object of type String to a StringMustWrapper,
to enable must methods to be invokable on that object.
Implicitly converts an object of type String to a StringMustWrapper,
to enable must methods to be invokable on that object.
Implicitly converts an object of type String to a StringShouldWrapperForVerb,
to enable should methods to be invokable on that object.
Implicitly converts an object of type String to a StringShouldWrapperForVerb,
to enable should methods to be invokable on that object.
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
* null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence
relation]:
* It is reflexive: for any instance x of type Any, x.equals(x) should return true.
* It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and
only if y.equals(x) returns true.
* It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and
y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects
that are "equal" (o1.equals(o2) returns true) hash to the same
scala.Int
(o1.hashCode.equals(o2.hashCode)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
Executes the test specified as testName in this Suite with the specified configMap, printing
results to the standard output.
Executes the test specified as testName in this Suite with the specified configMap, printing
results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Some(testName)reporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set() for tagsToExcludeconfigMap - the specified configMap Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to execute a single test, passing in some objects via the configMap, especially from
within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().
the name of one test to run.
a Map of key-value pairs that can be used by the executing Suite of tests.
Executes the test specified as testName in this Suite, printing results to the standard output.
Executes the test specified as testName in this Suite, printing results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Some(testName)reporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set() for tagsToExcludeconfigMap - an empty Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to run a single test, especially from within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().
the name of one test to run.
Executes this Suite with the specified configMap, printing results to the standard output.
Executes this Suite with the specified configMap, printing results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Nonereporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set() for tagsToExcludeconfigMap - the specified configMap Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to execute a Suite, passing in some objects via the configMap, especially from within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named run is described the documentation of the overloaded form that
takes no parameters: execute().
a Map of key-value pairs that can be used by the executing Suite of tests.
Executes this Suite, printing results to the standard output.
Executes this Suite, printing results to the standard output.
This method implementation calls run on this Suite, passing in:
testName - Nonereporter - a reporter that prints to the standard outputstopper - a Stopper whose apply method always returns falsefilter - a Filter constructed with None for tagsToInclude and Set() for tagsToExcludeconfigMap - an empty Map[String, Any]distributor - Nonetracker - a new TrackerThis method serves as a convenient way to execute a Suite, especially from
within the Scala interpreter.
Note: In ScalaTest, the terms "execute" and "run" basically mean the same thing and
can be used interchangably. The reason this convenience method and its three overloaded forms
aren't named runis because junit.framework.TestCase declares a run method
that takes no arguments but returns a junit.framework.TestResult. Thatrun method would not overload with this method if it were named run,
because it would have the same parameters but a different return type than the one
defined in TestCase. To facilitate integration with JUnit 3, therefore,
these convenience "run" methods are named execute. In particular, this allows traitorg.scalatest.junit.JUnit3Suite to extend both org.scalatest.Suite andjunit.framework.TestCase, which enables the creating of classes that
can be run with either ScalaTest or JUnit 3.
Expect that the value passed as expected equals the value passed as actual.
Expect that the value passed as expected equals the value passed as actual.
If the actual value equals the expected value
(as determined by ==), expect returns
normally. Else, expect throws anTestFailedException whose detail message includes the expected and actual values.
the expected value
the actual value, which should equal the passed expected value
Expect that the value passed as expected equals the value passed as actual.
Expect that the value passed as expected equals the value passed as actual.
If the actual equals the expected(as determined by ==), expect returns
normally. Else, if actual is not equal to expected, expect throws anTestFailedException whose detail message includes the expected and actual values, as well as the Stringobtained by invoking toString on the passed message.
the expected value
An object whose toString method returns a message to include in a failure report.
the actual value, which should equal the passed expected value
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:
testNames List, minus the number of tests marked as ignoredexpectedTestCount on every nested Suite contained in
nestedSuitesa Filter with which to filter tests to count based on their tags
Throws TestFailedException, with the passedThrowable cause, to indicate a test failed.
Throws TestFailedException, with the passedThrowable cause, to indicate a test failed.
The getMessage method of the thrown TestFailedExceptionwill return cause.toString().
a Throwable that indicates the cause of the failure.
Throws TestFailedException, with the passedString message as the exception's detail
message and Throwable cause, to indicate a test failed.
Throws TestFailedException, with the passedString message as the exception's detail
message and Throwable cause, to indicate a test failed.
A message describing the failure.
A Throwable that indicates the cause of the failure.
Throws TestFailedException, with the passedString message as the exception's detail
message, to indicate a test failed.
Throws TestFailedException, with the passedString message as the exception's detail
message, to indicate a test failed.
A message describing the failure.
Throws TestFailedException to indicate a test failed.
Throws TestFailedException to indicate a test failed.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
The groups methods has been deprecated and will be removed in a future version of ScalaTest.
The groups methods has been deprecated and will be removed in a future version of ScalaTest.
Please call (and override) tags instead.
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
the hash code value for the object.
Supports registration of ignored tests in FixtureFlatSpecs.
Supports registration of ignored tests in FixtureFlatSpecs.
This field enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... }For more information and examples of the use of the ignore field, see theIgnored tests section in the main documentation for trait FlatSpec.
Returns an Informer that during test execution will forward strings (and other objects) passed to itsapply method to the current reporter.
Returns an Informer that during test execution will forward strings (and other objects) passed to itsapply 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 thisFixtureFlatSpec 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
throw an exception. This method can be called safely by any thread.
Intercept and return an exception that's expected to be thrown by the passed function value.
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 ofAnyRef, 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.
the function value that should throw the expected exception
an implicit Manifest representing the type of the specified
type parameter.
the intercepted exception, if it is of the expected type
This method is used to test whether the dynamic type of the receiver object is T0.
This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will
return true. In the latter example, because the type argument is erased as part of compilation it is not
possible to check whether the contents of the list are of the requested typed.
true if the receiver object is an instance of erasure of type T0; false otherwise.
Supports test (and shared test) registration in FixtureFlatSpecs.
Supports test (and shared test) registration in FixtureFlatSpecs.
This field enables syntax such as the following test registration:
it should "pop values in last-in-first-out order" in { ... }It also enables syntax such as the following shared test registration:
it should behave like nonEmptyStack(lastItemPushed)
For more information and examples of the use of the it field, see the main documentation
for trait FlatSpec.
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
A List of this Suite object's nested Suites.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
this method returns an empty List. This trait's implementation of this method returns an empty List.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
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 Specto 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.
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, apendingUntilFixed 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 TestFailedExceptionwith 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.
a block of code, which if it completes abruptly, should trigger a TestPendingException
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(report, stopper, tagsToInclude, tagsToExclude, configMap, distributor)runTests(testName, report, stopper, tagsToInclude, tagsToExclude, configMap)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. (TheOneInstancePerTest 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, traitBeforeAndAfterEach overrides runTestss. In a Suitesubclass that no longer invokes runTests from run, theBeforeAndAfterEach 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 BeforeAndAfterEachis trying to override runTests, which is a final method in your trait.)
an optional name of one test to run. If None, all relevant tests should be run.
I.e., None acts like a wildcard that means run all relevant tests in this Suite.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Run zero to many of this Suite's nested Suites.
Run zero to many of this Suite's nested Suites.
If the passed distributor is None, this trait's
implementation of this method invokes run on each
nested Suite in the List obtained by invoking nestedSuites.
If a nested Suite's runmethod completes abruptly with an exception, this trait's implementation of this
method reports that the Suite aborted and attempts to run the
next nested Suite.
If the passed distributor is defined, this trait's implementation
puts each nested Suiteinto the Distributor contained in the Some, in the order in which theSuites appear in the List returned by nestedSuites, passing
in a new Tracker obtained by invoking nextTracker on the Trackerpassed to this method.
Implementations of this method are responsible for ensuring SuiteStarting events
are fired to the Reporter before executing any nested Suite, and either SuiteCompletedor SuiteAborted after executing any nested Suite.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by the executing Suite of tests.
an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified bytestName. Each test's name is a concatenation of the text of all describers surrounding a test,
from outside in, and the test's spec text, with one space placed between each item. (See the documenation
for testNames for an example.)
the name of one test to execute.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Map of properties that can be used by this Spec's executing tests.
a Tracker tracking Ordinals being fired by the current thread.
Run zero to many of this Spec's tests.
Run zero to many of this Spec's tests.
This method takes a testName parameter that optionally specifies a test to invoke.
If testName is Some, this trait's implementation of this method
invokes runTest on this object, passing in:
testName - the String value of the testName Option passed
to this methodreporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itThis method takes a Set of tag names that should be included (tagsToInclude), and a Setthat should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute.
If tagsToInclude is empty, all tests will be executed
except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests
belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExcludewill be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored.
Only if testName is None will tagsToInclude and tagsToExclude be consulted to
determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.
If testName is None, this trait's implementation of this method
invokes testNames on this Suite to get a Set of names of tests to potentially execute.
(A testNames value of None essentially acts as a wildcard that means all tests in
this Suite that are selected by tagsToInclude and tagsToExclude should be executed.)
For each test in the testName Set, in the order
they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation
of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets.
If so, this implementation invokes runTest, passing in:
testName - the String name of the test to run (which will be one of the names in the testNames Set)reporter - the Reporter passed to this method, or one that wraps and delegates to itstopper - the Stopper passed to this method, or one that wraps and delegates to itconfigMap - the configMap passed to this method, or one that wraps and delegates to itan optional name of one test to execute. If None, all relevant tests should be executed.
I.e., None acts like a wildcard that means execute all relevant tests in this Spec.
the Reporter to which results will be reported
the Stopper that will be consulted to determine whether to stop execution early.
a Filter with which to filter tests based on their tags
a Map of key-value pairs that can be used by this Spec's executing tests.
an optional Distributor, into which to put nested Suites to be run
by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
a Tracker tracking Ordinals being fired by the current thread.
Supports the shorthand form of shared test registration.
Supports the shorthand form of shared test registration.
For example, this method enables syntax such as the following:
"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
This function is passed as an implicit parameter to a should method
provided in ShouldVerb, a must method
provided in MustVerb, and a can method
provided in CanVerb. When invoked, this function registers the
subject description (the parameter to the function) and returns a BehaveWord.
Supports the shorthand form of test registration.
Supports the shorthand form of test registration.
For example, this method enables syntax such as the following:
"A Stack (when empty)" should "be empty" in { ... }
This function is passed as an implicit parameter to a should method
provided in ShouldVerb, a must method
provided in MustVerb, and a can method
provided in CanVerb. When invoked, this function registers the
subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerbinitialized with the verb and rest parameters (the second and third parameters to
the function, respectively).
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.
this Suite object's suite name.
A Map whose keys are String tag names to which tests in this Spec belong, and values
the Set of test names that belong to each tag.
A Map whose keys are String tag names to which tests in this Spec belong, and values
the Set of test names that belong to each tag. If this FlatSpec 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.
An immutable Set of test names.
An immutable Set of test names. If this FixtureFlatSpec 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. Each test's name is composed of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the example itself, with all components separated by a space.
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
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.
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
Invoke the test function, passing to the the test function the configMapobtained by invoking configMap on the passed OneArgTest.
Invoke the test function, passing to the the test function the configMapobtained by invoking configMap on the passed OneArgTest.
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.
the no-arg test function to run with a fixture
A sister trait to
org.scalatest.FlatSpecthat can pass multiple types of fixture objects into its tests.This trait behaves similarly to trait
org.scalatest.FlatSpec, except that tests may take a fixture object, and unlike aFixtureFlatSpec, different tests may take different types of fixtures. This trait extendsFixtureFlatSpecand mixes inConfigMapFixture, which defines theFixturetype to be theconfigMap's type (Map[String, Any]) and defines thewithFixturemethod to simply pass theconfigMapto the test function. To write tests that take fixtures of types other thanFixture(i.e.,Map[String, Any]), you can define implicit conversions from a function of type(<the fixture type>) => Unitto a function of type(FixtureParam) => Unit. Each implicit conversion method serves as the with-fixture method for that type.Subclasses of this trait must, therefore, do two things differently from a plain old
org.scalatest.FlatSpec:with<type>FixturemethodsFixture.)Here's an example that has two fixture types,
StringandList[Int]:The first method in this class,
withStringFixture, is the implicit conversion function for tests that take a fixture of typeString. In this contrived example, the hard-coded string"howdy"is passed into the test:implicit def withStringFixture(testFunction: String => Unit): FixtureParam => Unit = testFunction("howdy")Although the result type of this implicit conversion method is
FixtureParam => Unit, if a fixture doesn't need anything from theconfigMap, you can leave off theconfigMap =>at the beginning of the result function. The reason this works is thatMultipleFixtureFlatSpecinherits an implicit conversion from a by-name parameter toFixtureParam => Unitfrom supertraitFixtureFlatSpec. This implicit conversion is used to enable tests that take no fixture (such as the one namedtakes no fixturein this example) to be included in the same class as tests that take typeFixture. That same implicit conversion is used here to allow you to leave off theconfigMap =>except when you actually need something from theconfigMap. By leaving it off, you indicte to readers of the code that this fixture doesn't require anything from theconfigMap.The next method in this class,
withListFixture, is the implicit conversion function for tests that take a fixture of typeList[Int]. In this contrived example, aList[Int]that contains one element, the size of theconfigMap, is passed to the test function. Because the fixture uses theconfigMap, it has an explicitconfigMap =>parameter at the beginning of the result. (Remember, theFixturetype is defined to beMap[String, Any], the type of theconfigMap, in supertraitConfigMapFixture.Following the implicit conversion methods are the test declarations. One test is written to take the
Stringfixture:it should "take a string fixture" in { (s: String) => assert(s === "howdy") }What happens at compile time is that because the
Fixturetype isMap[String, Any], thetestmethod should be passed a function from type(Map[String, Any]) => Unit, or using the type alias,(FixtureParam) => Unit. Passing a function of typeString => Unitas is attempted here is a type error. Thus the compiler will look around for an implicit conversion that will fix the type error, and will find thewithStringFixturemethod. Because this is the only implicit conversion that fixes the type error, it will apply it, effectively generating this code:// after the implicit withStringFixture method is applied by the compiler it should "take a string fixture" in { withStringFixture { (s: String) => assert(s === "howdy") } }After passing the
(String) => Unitfunction towithStringFixture, the result will be of type(FixtureParam) => Unit, which thetestmethod expects.The next test is written to take the
List[Int]fixture:it should "take a list fixture" in { (list: List[Int]) => assert(list.size === 1) }The compiler will apply the
withListFixtureimplicit conversion in this case, effectively generating the following code:it should "take a list fixture" in { withListFixture { (list: List[Int]) => assert(list.size === 1) } }Note that in a
FixtureFlatSpec, you need to specify the type of the fixture explicitly so the compiler knows the type to convert from. So you must, for example, write:it should "take a list fixture" in { (list: List[Int]) => assert(list.size === 1) }The following attempt will fail to compile:
// won't compile, because list is inferred to be of type FixtureParam it should "take a list fixture" in { list => assert(list.size === 1) }authors:
Bill Venners