Class whose instances are after words, which can be used to reduce text duplication.
Class that supports shorthand scope registration via the instance referenced from FixtureAnyWordSpecLike's it field.
Class that supports the registration of tagged tests.
Class that supports shorthand scope registration via the instance referenced from FixtureAnyWordSpecLike's they field.
A class that via an implicit conversion (named convertToWordSpecStringWrapper) enables
methods when, which, in, is, taggedAs
and ignore to be invoked on Strings.
Creates an after word that an be used to reduce text duplication.
Creates an after word that an be used to reduce text duplication.
If you are repeating a word or phrase at the beginning of each string inside
a block, you can "move the word or phrase" out of the block with an after word.
You create an after word by passing the repeated word or phrase to the afterWord method.
Once created, you can place the after word after when, a verb
(should, must, or can), or
which. (You can't place one after in or is, the
words that introduce a test.) Here's an example that has after words used in all three
places:
import org.scalatest._
import ConfigMapFixture
class ScalaTestGUISpec extends wordspec.FixtureAnyWordSpec with ConfigMapFixture {
def theUser = afterWord("the user")
def display = afterWord("display")
def is = afterWord("is")
"The ScalaTest GUI" when theUser {
"clicks on an event report in the list box" should display {
"a blue background in the clicked-on row in the list box" in { cm => }
"the details for the event in the details area" in { cm => }
"a rerun button," which is {
"enabled if the clicked-on event is rerunnable" in { cm => }
"disabled if the clicked-on event is not rerunnable" in { cm => }
}
}
}
}
Running the previous FixtureAnyWordSpec in the Scala interpreter would yield:
scala> (new ScalaTestGUISpec).run()
The ScalaTest GUI (when the user clicks on an event report in the list box)
- should display a blue background in the clicked-on row in the list box
- should display the details for the event in the details area
- should display a rerun button, which is enabled if the clicked-on event is rerunnable
- should display a rerun button, which is disabled if the clicked-on event is not rerunnable
the after word text
an instance of AfterWord
Returns an Alerter that during test execution will forward strings (and other objects) passed to its
apply method to the current reporter.
Returns an Alerter that during test execution will forward strings (and other objects) 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
FixtureAnyWordSpec 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.
Supports shared test registration in FixtureAnyWordSpecs.
Supports shared test registration in FixtureAnyWordSpecs.
This field enables syntax such as the following:
behave like nonFullStack(stackWithOneItem) ^
For more information and examples of the use of <cod>behave, see the Shared tests section
in the main documentation for trait org.scalatest.wordspec.AnyWordSpec.
Implicitly converts Strings to WordSpecStringWrapper, which enables
methods when, which, in, is, taggedAs
and ignore to be invoked on Strings.
Implicitly converts Strings to WordSpecStringWrapper, which enables
methods when, which, in, is, taggedAs
and ignore to be invoked on Strings.
String to be wrapped
an instance of WordSpecStringWrapper
Returns an Informer that during test execution will forward strings passed to its
apply method to the current reporter.
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.
Supports shorthand scope registration in FixtureAnyWordSpecLikes.
Supports shorthand scope registration in FixtureAnyWordSpecLikes.
This field enables syntax such as the following test registration:
"A Stack" when { ... }
it should { ... }
^
For more information and examples of the use of the it field, see the main documentation
for AnyWordSpec.
Returns a Documenter that during test execution will forward strings passed to its
apply method to the current reporter.
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 Notifier that during test execution will forward strings (and other objects) passed to its
apply method to the current reporter.
Returns a Notifier that during test execution will forward strings (and other objects) 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
FixtureAnyWordSpec 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.
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by
testName. 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 Args for this run
a Status object that indicates when the test started by this method has completed, and whether or not it failed .
if any of testName or args is null.
Run zero to many of this FixtureAnyWordSpec's tests.
Run zero to many of this FixtureAnyWordSpec'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 with passed args.
This method takes an args that contains a Set of tag names that should be included (tagsToInclude), and a Set
that 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 tagsToExclude
will 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 with passed args.
an 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 FixtureAnyWordSpec.
the Args for this run
a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
if any of testName or args is null.
Suite style name.
Suite style name.
org.scalatest.wordspec.FixtureAnyWordSpec
Supports the registration of subjects.
Supports the registration of subjects.
For example, this method enables syntax such as the following:
"A Stack" should { ...
^
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 and executes the block.
Supports the registration of subject descriptions with after words.
Supports the registration of subject descriptions with after words.
For example, this method enables syntax such as the following:
def provide = afterWord("provide")
"The ScalaTest Matchers DSL" can provide { ... }
^
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 and executes the block.
A Map whose keys are String tag names to which tests in this FixtureAnyWordSpec 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 FixtureAnyWordSpec belong, and values
the Set of test names that belong to each tag. If this FixtureAnyWordSpec 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 @Ignore.
An immutable Set of test names.
An immutable Set of test names. If this FixtureAnyWordSpec 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.
the Set of test names
Supports shorthand scope registration in FixtureAnyWordSpecLikes.
Supports shorthand scope registration in FixtureAnyWordSpecLikes.
This field enables syntax such as the following test registration:
"A Stack" when { ... }
they should { ... }
^
For more information and examples of the use of the they field, see the main documentation
for AnyWordSpec.
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.
a user-friendly string for this suite
(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.
(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.
(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.
(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.
A sister class to
org.scalatest.wordspec.AnyWordSpecthat can pass a fixture object into its tests.FixtureAnyWordSpecin situations for whichAnyWordSpecwould be a good choice, when all or most tests need the same fixture objects that must be cleaned up afterwards. Note:FixtureAnyWordSpecis intended for use in special situations, with classAnyWordSpecused for general needs. For more insight into whereFixtureAnyWordSpecfits in the big picture, see thewithFixture(OneArgTest)subsection of the Shared fixtures section in the documentation for classAnyWordSpec.Class
FixtureAnyWordSpecbehaves similarly to classorg.scalatest.wordspec.AnyWordSpec, except that tests may have a fixture parameter. The type of the fixture parameter is defined by the abstractFixtureParamtype, which is a member of this class. This class also has an abstractwithFixturemethod. ThiswithFixturemethod takes aOneArgTest, which is a nested trait defined as a member of this class.OneArgTesthas anapplymethod that takes aFixtureParam. Thisapplymethod is responsible for running a test. This class'srunTestmethod delegates the actual running of each test towithFixture(OneArgTest), passing in the test code to run via theOneArgTestargument. ThewithFixture(OneArgTest)method (abstract in this class) is responsible for creating the fixture argument and passing it to the test function.Subclasses of this class must, therefore, do three things differently from a plain old
org.scalatest.wordspec.AnyWordSpec:FixtureParamwithFixture(OneArgTest)methodIf the fixture you want to pass into your tests consists of multiple objects, you will need to combine them into one object to use this class. One good approach to passing multiple fixture objects is to encapsulate them in a case class. Here's an example:
To enable the stacking of traits that define
withFixture(NoArgTest), it is a good idea to letwithFixture(NoArgTest)invoke the test function instead of invoking the test function directly. To do so, you'll need to convert theOneArgTestto aNoArgTest. You can do that by passing the fixture object to thetoNoArgTestmethod ofOneArgTest. In other words, instead of writing “test(theFixture)”, you'd delegate responsibility for invoking the test function to thewithFixture(NoArgTest)method of the same instance by writing:Here's a complete example:
package org.scalatest.examples.wordspec.oneargtest import org.scalatest._ import java.io._ class ExampleSpec extends wordspec.FixtureAnyWordSpec { case class FixtureParam(file: File, writer: FileWriter) def withFixture(test: OneArgTest) = { // create the fixture val file = File.createTempFile("hello", "world") val writer = new FileWriter(file) val theFixture = FixtureParam(file, writer) try { writer.write("ScalaTest is ") // set up the fixture withFixture(test.toNoArgTest(theFixture)) // "loan" the fixture to the test } finally writer.close() // clean up the fixture } "Testing" should { "be easy" in { f => f.writer.write("easy!") f.writer.flush() assert(f.file.length === 18) } "be fun" in { f => f.writer.write("fun!") f.writer.flush() assert(f.file.length === 17) } } }If a test fails, the
OneArgTestfunction will result in a Failed wrapping the exception describing the failure. To ensure clean up happens even if a test fails, you should invoke the test function from inside atryblock and do the cleanup in afinallyclause, as shown in the previous example.Sharing fixtures across classes
If multiple test classes need the same fixture, you can define the
FixtureParamandwithFixture(OneArgTest)implementations in a trait, then mix that trait into the test classes that need it. For example, if your application requires a database and your integration tests use that database, you will likely have many test classes that need a database fixture. You can create a "database fixture" trait that creates a database with a unique name, passes the connector into the test, then removes the database once the test completes. This is shown in the following example:package org.scalatest.examples.fixture.wordspec.sharing import java.util.concurrent.ConcurrentHashMap import org.scalatest._ import DbServer._ import java.util.UUID.randomUUID object DbServer { // Simulating a database server type Db = StringBuffer private val databases = new ConcurrentHashMap[String, Db] def createDb(name: String): Db = { val db = new StringBuffer databases.put(name, db) db } def removeDb(name: String) { databases.remove(name) } } trait DbFixture { this: FixtureSuite => type FixtureParam = Db // Allow clients to populate the database after // it is created def populateDb(db: Db) {} def withFixture(test: OneArgTest) = { val dbName = randomUUID.toString val db = createDb(dbName) // create the fixture try { populateDb(db) // setup the fixture withFixture(test.toNoArgTest(db)) // "loan" the fixture to the test } finally removeDb(dbName) // clean up the fixture } } class ExampleSpec extends wordspec.FixtureAnyWordSpec with DbFixture { override def populateDb(db: Db) { // setup the fixture db.append("ScalaTest is ") } "Testing" should { "should be easy" in { db => db.append("easy!") assert(db.toString === "ScalaTest is easy!") } "should be fun" in { db => db.append("fun!") assert(db.toString === "ScalaTest is fun!") } } // This test doesn't need a Db "Test code" should { "should be clear" in { () => val buf = new StringBuffer buf.append("ScalaTest code is ") buf.append("clear!") assert(buf.toString === "ScalaTest code is clear!") } } }Often when you create fixtures in a trait like
DbFixture, you'll still need to enable individual test classes to "setup" a newly created fixture before it gets passed into the tests. A good way to accomplish this is to pass the newly created fixture into a setup method, likepopulateDbin the previous example, before passing it to the test function. Classes that need to perform such setup can override the method, as doesExampleSpec.If a test doesn't need the fixture, you can indicate that by providing a no-arg instead of a one-arg function, as is done in the third test in the previous example, “
Test code should be clear”. In other words, instead of starting your function literal with something like “db =>”, you'd start it with “() =>”. For such tests,runTestwill not invokewithFixture(OneArgTest). It will instead directly invokewithFixture(NoArgTest).Both examples shown above demonstrate the technique of giving each test its own "fixture sandbox" to play in. When your fixtures involve external side-effects, like creating files or databases, it is a good idea to give each file or database a unique name as is done in these examples. This keeps tests completely isolated, allowing you to run them in parallel if desired. You could mix
ParallelTestExecutioninto either of theseExampleSpecclasses, and the tests would run in parallel just fine.