AnyWordSpecLike
Related Doc:
package wordspec
Class whose instances are after words, which can be used to reduce text duplication.
Class whose instances are after words, which can 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._
class ScalaTestGUISpec extends wordspec.AnyWordSpec {
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 {}
"the details for the event in the details area" in {}
"a rerun button" which is {
"enabled if the clicked-on event is rerunnable" in {}
"disabled if the clicked-on event is not rerunnable" in {}
}
}
}
}
Running the previous AnyWordSpec in the Scala interpreter would yield:
scala> (new ScalaTestGUISpec).execute()
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 that is enabled if the clicked-on event is rerunnable
- should display a rerun button that is disabled if the clicked-on event is not rerunnable
Class that supports shorthand scope registration via the instance referenced from AnyWordSpecLike's it field.
Class that supports shorthand scope registration via the instance referenced from AnyWordSpecLike's it field.
This class 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.
Class that supports the registration of tagged tests.
Class that supports the registration of tagged tests.
Instances of this class are returned by the taggedAs method of
class AnyWordSpecStringWrapper.
Class that supports shorthand scope registration via the instance referenced from AnyWordSpecLike's they field.
Class that supports shorthand scope registration via the instance referenced from AnyWordSpecLike's they field.
This class enables syntax such as the following test registration:
"Basketball players" when { ... }
they should { ... }
^
For more information and examples of the use of the they field, see the main documentation
for AnyWordSpec.
A class that via an implicit conversion (named convertToWordSpecStringWrapper) enables
methods when, which, in, is, taggedAs
and ignore to be invoked on Strings.
A class that via an implicit conversion (named convertToWordSpecStringWrapper) enables
methods when, which, in, is, taggedAs
and ignore to be invoked on Strings.
This class provides much of the syntax for AnyWordSpec, however, it does not add
the verb methods (should, must, and can) to String.
Instead, these are added via the ShouldVerb, MustVerb, and CanVerb
traits, which AnyWordSpec mixes in, to avoid a conflict with implicit conversions provided
in Matchers and MustMatchers.
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._
class ScalaTestGUISpec extends wordspec.AnyWordSpec {
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 {}
"the details for the event in the details area" in {}
"a rerun button" which is {
"enabled if the clicked-on event is rerunnable" in {}
"disabled if the clicked-on event is not rerunnable" in {}
}
}
}
}
Running the previous AnyWordSpec in the Scala interpreter would yield:
scala> (new ScalaTestGUISpec).execute()
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 that is enabled if the clicked-on event is rerunnable
- should display a rerun button that is disabled if the clicked-on event is not rerunnable
Returns an Alerter that during test execution will forward strings passed to its
apply method to the current reporter.
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
AnyWordSpec 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 AnyWordSpecs.
Supports shared test registration in AnyWordSpecs.
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 this trait.
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.
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 AnyWordSpecLikes.
Supports shorthand scope registration in AnyWordSpecLikes.
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 passed to its
apply method to the current reporter.
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
AnyWordSpec 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 .
NullArgumentException if any of testName, reporter, stopper, or configMap
is null.
Run zero to many of this AnyWordSpec's tests.
Run zero to many of this AnyWordSpec'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 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, 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 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 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.
IllegalArgumentException if testName is defined, but no test with the specified test name
exists in this Suite
NullArgumentException if any of the passed parameters is null.
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 names of tagged tests and whose associated values are
the Set of tags for the test.
A Map whose keys are String names of tagged tests and whose associated values are
the Set of tags for the test. If this AnyWordSpec 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
taggedAs.
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.
An immutable Set of test names.
An immutable Set of test names. If this AnyWordSpec 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. For example, consider this AnyWordSpec:
import org.scalatest._
class StackSpec {
"A Stack" when {
"not empty" must {
"allow me to pop" in {}
}
"not full" must {
"allow me to push" in {}
}
}
}
Invoking testNames on this AnyWordSpec will yield a set that contains the following
two test name strings:
"A Stack (when not empty) must allow me to pop" "A Stack (when not full) must allow me to push"
Supports shorthand scope registration in AnyWordSpecLikes.
Supports shorthand scope registration in AnyWordSpecLikes.
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.
(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.
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.
(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.
Implementation trait for class
AnyWordSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.AnyWordSpecis a class, not a trait, to minimize compile time given there is a slight compiler overhead to mixing in traits compared to extending classes. If you need to mix the behavior ofAnyWordSpecinto some other class, you can use this trait instead, because classAnyWordSpecdoes nothing more than extend this trait and add a nicetoStringimplementation.See the documentation of the class for a detailed overview of
AnyWordSpec.