AnyFlatSpecLike
Related Doc:
package flatspec
Class that supports the registration of a “subject” being specified and tested via the
instance referenced from AnyFlatSpec's behavior field.
Class that supports the registration of a “subject” being specified and tested via the
instance referenced from AnyFlatSpec's behavior field.
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 documentation
for trait AnyFlatSpec.
Class that supports registration of ignored tests via the IgnoreWord instance referenced
from AnyFlatSpec's ignore field.
Class that supports registration of ignored tests via the IgnoreWord instance referenced
from AnyFlatSpec's ignore field.
This class enables syntax such as the following registration of an ignored test:
ignore should "pop values in last-in-first-out order" in { ... }
^
In addition, it enables syntax such as the following registration of an ignored, pending test:
ignore should "pop values in last-in-first-out order" is (pending)
^
Note: the is method is provided for completeness and design symmetry, given there's no way
to prevent changing is to ignore and marking a pending test as ignored that way.
Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
And finally, it also enables syntax such as the following ignored, tagged test registration:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
^
For more information and examples of the use of the ignore field, see the Ignored tests section
in the main documentation for trait AnyFlatSpec.
Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
from AnyFlatSpec's ignore field.
Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
from AnyFlatSpec's ignore field.
This class enables syntax such as the following registration of an ignored, tagged test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
^
In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
^
Note: the is method is provided for completeness and design symmetry, given there's no way
to prevent changing is to ignore and marking a pending test as ignored that way.
Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
For more information and examples of the use of the ignore field, see the Ignored tests section
in the main documentation for trait AnyFlatSpec. For examples of tagged test registration, see
the Tagging tests section in the main documentation for trait AnyFlatSpec.
Class that supports registration of ignored tests via the ItWord instance
referenced from AnyFlatSpec's ignore field.
Class that supports registration of ignored tests via the ItWord instance
referenced from AnyFlatSpec's ignore field.
This class 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 Ignored tests section
in the main documentation for this trait.
Class that supports test registration in shorthand form.
Class that supports test registration in shorthand form.
For example, this class enables syntax such as the following test registration in shorthand form:
"A Stack (when empty)" should "be empty" in { ... }
^
This class also enables syntax such as the following ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" ignore { ... }
^
This class is used via an implicit conversion (named convertToInAndIgnoreMethods)
from ResultOfStringPassedToVerb. The ResultOfStringPassedToVerb class
does not declare any methods named in, because the
type passed to in differs in a AnyFlatSpec and a FixtureAnyFlatSpec.
A FixtureAnyFlatSpec needs two in methods, one that takes a no-arg
test function and another that takes a one-arg test function (a test that takes a
Fixture as its parameter). By constrast, a AnyFlatSpec needs
only one in method that takes a by-name parameter. As a result,
AnyFlatSpec and FixtureAnyFlatSpec each provide an implicit conversion
from ResultOfStringPassedToVerb to a type that provides the appropriate
in methods.
Class that supports tagged test registration in shorthand form.
Class that supports tagged test registration in shorthand form.
For example, this class enables syntax such as the following tagged test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs() in { ... }
^
This class also enables syntax such as the following tagged, ignored test registration in shorthand form:
"A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... }
^
This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs)
from ResultOfTaggedAsInvocation. The ResultOfTaggedAsInvocation class
does not declare any methods named in, because the
type passed to in differs in a AnyFlatSpec and a FixtureAnyFlatSpec.
A FixtureAnyFlatSpec needs two in methods, one that takes a no-arg
test function and another that takes a one-arg test function (a test that takes a
Fixture as its parameter). By constrast, a AnyFlatSpec needs
only one in method that takes a by-name parameter. As a result,
AnyFlatSpec and FixtureAnyFlatSpec each provide an implicit conversion
from ResultOfTaggedAsInvocation to a type that provides the appropriate
in methods.
Class that supports test registration via the ItWord instance referenced from AnyFlatSpec's it field.
Class that supports test registration via the ItWord instance referenced from AnyFlatSpec's it field.
This class 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 registration of an ignored test:
it should "pop values in last-in-first-out order" ignore { ... }
^
In addition, it enables syntax such as the following registration of a pending test:
it should "pop values in last-in-first-out order" is (pending)
^
And finally, it also enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
^
For more information and examples of the use of the it field, see the main documentation
for trait AnyFlatSpec.
Class that supports the registration of tagged tests via the ItWord instance
referenced from AnyFlatSpec's it field.
Class that supports the registration of tagged tests via the ItWord instance
referenced from AnyFlatSpec's it field.
This class enables syntax such as the following tagged test registration:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
^
It also enables syntax such as the following registration of an ignored, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
^
In addition, it enables syntax such as the following registration of a pending, tagged test:
it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
^
For more information and examples of the use of the it field to register tagged tests, see
the Tagging tests section in the main documentation for trait AnyFlatSpec.
For examples of tagged test registration, see
the Tagging tests section in the main documentation for trait AnyFlatSpec.
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec's it field.
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec's it field.
This class 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 this trait.
Class that supports test registration via the TheyWord instance referenced from AnyFlatSpec's they field.
Class that supports test registration via the TheyWord instance referenced from AnyFlatSpec's they field.
This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... }
^
It also enables syntax such as the following registration of an ignored test:
they should "pop values in last-in-first-out order" ignore { ... }
^
In addition, it enables syntax such as the following registration of a pending test:
they should "pop values in last-in-first-out order" is (pending)
^
And finally, it also enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
^
For more information and examples of the use of the it field, see the main documentation
for trait AnyFlatSpec.
Class that supports the registration of tagged tests via the TheyWord instance
referenced from AnyFlatSpec's they field.
Class that supports the registration of tagged tests via the TheyWord instance
referenced from AnyFlatSpec's they field.
This class enables syntax such as the following tagged test registration:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
^
It also enables syntax such as the following registration of an ignored, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
^
In addition, it enables syntax such as the following registration of a pending, tagged test:
they should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
^
For more information and examples of the use of the they field to register tagged tests, see
the Tagging tests section in the main documentation for trait AnyFlatSpec.
For examples of tagged test registration, see
the Tagging tests section in the main documentation for trait AnyFlatSpec.
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec's it field.
Class that supports test (and shared test) registration via the instance referenced from AnyFlatSpec's it field.
This class enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... }
^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it field, see the main documentation
for this trait.
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
AnyFlatSpec 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 AnyFlatSpecs.
Supports shared test registration in AnyFlatSpecs.
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 section
in the main documentation for this trait.
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 documentation
for this trait.
Implicitly converts an object of type ResultOfStringPassedToVerb to an
InAndIgnoreMethods, to enable in and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfStringPassedToVerb to an
InAndIgnoreMethods, to enable in and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation to an
InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
methods to be invokable on that object.
Implicitly converts an object of type ResultOfTaggedAsInvocation to an
InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
methods to be invokable on that object.
Supports registration of ignored tests in AnyFlatSpecs.
Supports registration of ignored tests in AnyFlatSpecs.
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 the Ignored tests section
in the main documentation for this trait.
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 test (and shared test) registration in AnyFlatSpecs.
Supports test (and shared test) registration in AnyFlatSpecs.
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 this trait.
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
AnyFlatSpec 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 AnyFlatSpec's tests.
Run zero to many of this AnyFlatSpec'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 execute. If None, all relevant tests should be executed.
I.e., None acts like a wildcard that means execute all relevant tests in this AnyFlatSpec.
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.
NullArgumentException if any of testName, reporter, stopper, tagsToInclude,
tagsToExclude, or configMap is null.
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 in:
"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 ResultOfStringPassedToVerb
initialized with the verb and rest parameters (the second and third parameters to
the function, respectively).
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 AnyFlatSpec 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 AnyFlatSpec 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 AnyFlatSpec:
import org.scalatest.flatspec.AnyFlatSpec
class StackSpec extends AnyFlatSpec {
"A Stack (when not empty)" must "allow me to pop" in {}
it must "not be empty" in {}
"A Stack (when not full)" must "allow me to push" in {}
it must "not be full" in {}
}
Invoking testNames on this AnyFlatSpec 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 empty) must not be empty" "A Stack (when not full) must allow me to push" "A Stack (when not full) must not be full"
Supports test (and shared test) registration in AnyFlatSpecs.
Supports test (and shared test) registration in AnyFlatSpecs.
This field enables syntax such as the following test registration:
they should "pop values in last-in-first-out order" in { ... }
^
It also enables syntax such as the following shared test registration:
they should behave like nonEmptyStack(lastItemPushed) ^
For more information and examples of the use of the it field, see the main documentation
for this trait.
(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
AnyFlatSpec, which facilitates a “behavior-driven” style of development (BDD), in which tests are combined with text that specifies the behavior the tests verify.AnyFlatSpecis 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 ofAnyFlatSpecinto some other class, you can use this trait instead, because classAnyFlatSpecdoes nothing more than extend this trait and add a nicetoStringimplementation.See the documentation of the class for a detailed overview of
AnyFlatSpec.