trait FixtureAnyPropSpecLike extends FixtureTestSuite with FixtureTestRegistration with Informing with Notifying with Alerting with Documenting
Implementation trait for class FixtureAnyPropSpec, which is
a sister class to org.scalatest.propspec.AnyPropSpec that can pass a
fixture object into its tests.
FixtureAnyPropSpec is 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 of FixtureAnyPropSpec into some other
class, you can use this trait instead, because class
FixtureAnyPropSpec does nothing more than extend this trait and add a nice toString implementation.
See the documentation of the class for a detailed
overview of FixtureAnyPropSpec.
- Self Type
- FixtureAnyPropSpecLike
- Annotations
- @Finders()
- Source
- FixtureAnyPropSpecLike.scala
- Alphabetic
- By Inheritance
- FixtureAnyPropSpecLike
- Documenting
- Alerting
- Notifying
- Informing
- FixtureTestRegistration
- FixtureTestSuite
- TestSuite
- FixtureSuite
- Suite
- Serializable
- Serializable
- Assertions
- TripleEquals
- TripleEqualsSupport
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
CheckingEqualizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
-
class
Equalizer[L] extends AnyRef
- Definition Classes
- TripleEqualsSupport
-
abstract
type
FixtureParam
- Attributes
- protected
- Definition Classes
- FixtureSuite
-
trait
NoArgTest extends () ⇒ Outcome with TestData
- Attributes
- protected
- Definition Classes
- TestSuite
-
trait
OneArgTest extends (FixtureTestSuite.FixtureParam) ⇒ Outcome with TestData
- Attributes
- protected
- Definition Classes
- FixtureTestSuite
- class ResultOfIgnoreInvocation extends AnyRef
- class ResultOfPropertyInvocation extends AnyRef
Abstract Value Members
-
abstract
def
withFixture(test: OneArgTest): Outcome
- Attributes
- protected
- Definition Classes
- FixtureTestSuite
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
!==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
-
def
!==(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
-
def
!==[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]
- Definition Classes
- TripleEqualsSupport
-
def
===(right: Null): TripleEqualsInvocation[Null]
- Definition Classes
- TripleEqualsSupport
-
def
===[T](right: T): TripleEqualsInvocation[T]
- Definition Classes
- TripleEqualsSupport
-
def
alert: Alerter
Returns an
Alerterthat during test execution will forward strings (and other objects) passed to itsapplymethod to the current reporter.Returns an
Alerterthat during test execution will forward strings (and other objects) passed to itsapplymethod to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while thisFixtureAnyPropSpecis 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.- Attributes
- protected
- Definition Classes
- FixtureAnyPropSpecLike → Alerting
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
macro
def
assert(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
-
macro
def
assert(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
-
macro
def
assertCompiles(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
-
macro
def
assertDoesNotCompile(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
-
def
assertResult(expected: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
-
def
assertResult(expected: Any, clue: Any)(actual: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
-
def
assertThrows[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): Assertion
- Definition Classes
- Assertions
-
macro
def
assertTypeError(code: String)(implicit pos: Position): Assertion
- Definition Classes
- Assertions
-
macro
def
assume(condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
-
macro
def
assume(condition: Boolean)(implicit prettifier: Prettifier, pos: Position): Assertion
- Definition Classes
- Assertions
-
def
cancel(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
cancel(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
cancel(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
cancel()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
convertPendingToFixtureFunction(f: ⇒ PendingStatement): (FixtureParam) ⇒ Any
Implicitly converts a function that takes no parameters and results in
PendingStatementto a function fromFixtureParamtoAny, to enable pending tests to registered as by-name parameters by methods that require a test function that takes aFixtureParam.Implicitly converts a function that takes no parameters and results in
PendingStatementto a function fromFixtureParamtoAny, to enable pending tests to registered as by-name parameters by methods that require a test function that takes aFixtureParam.This method makes it possible to write pending tests as simply
(pending), without needing to write(fixture => pending).- f
a function
- returns
a function of
FixtureParam => Any
- Attributes
- protected
-
def
convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
convertToEqualizer[T](left: T): Equalizer[T]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
defaultEquality[A]: Equality[A]
- Definition Classes
- TripleEqualsSupport
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
execute(testName: String, configMap: ConfigMap, color: Boolean, durations: Boolean, shortstacks: Boolean, fullstacks: Boolean, stats: Boolean): Unit
- Definition Classes
- Suite
-
def
expectedTestCount(filter: Filter): Int
- Definition Classes
- Suite
-
def
fail(cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
fail(message: String, cause: Throwable)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
fail(message: String)(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
fail()(implicit pos: Position): Nothing
- Definition Classes
- Assertions
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
ignore(testName: String, testTags: Tag*): ResultOfIgnoreInvocation
Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments.
Register a property-based test to ignore, which has the specified name, optional tags, and function value that takes no arguments. This method will register the test for later ignoring via an invocation of one of the
runmethods. This method exists to make it easy to ignore an existing test by changing the call totesttoignorewithout deleting or commenting out the actual test code. The test will not be run, but a report will be sent that indicates the test was ignored. The passed test name must not have been registered previously on thisFixtureAnyPropSpecinstance.- testName
the name of the test
- testTags
the optional list of tags for this test
- Attributes
- protected
- Exceptions thrown
DuplicateTestNameExceptionif a test with the same name has been registered previouslyNotAllowedExceptioniftestNamehad been registered previouslyTestRegistrationClosedExceptionif invoked afterrunhas been invoked on this suite
-
def
info: Informer
Returns an
Informerthat during test execution will forward strings passed to itsapplymethod to the current reporter.Returns an
Informerthat during test execution will forward strings passed to itsapplymethod 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, asrecordedEventsof the test completed event, such asTestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- FixtureAnyPropSpecLike → Informing
-
def
intercept[T <: AnyRef](f: ⇒ Any)(implicit classTag: ClassTag[T], pos: Position): T
- Definition Classes
- Assertions
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: <:<[A, B]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
def
markup: Documenter
Returns a
Documenterthat during test execution will forward strings passed to itsapplymethod to the current reporter.Returns a
Documenterthat during test execution will forward strings passed to itsapplymethod 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, asrecordedEventsof the test completed event, such asTestSucceeded. If invoked at any other time, it will print to the standard output. This method can be called safely by any thread.- Attributes
- protected
- Definition Classes
- FixtureAnyPropSpecLike → Documenting
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nestedSuites: IndexedSeq[Suite]
- Definition Classes
- Suite
-
def
note: Notifier
Returns a
Notifierthat during test execution will forward strings (and other objects) passed to itsapplymethod to the current reporter.Returns a
Notifierthat during test execution will forward strings (and other objects) passed to itsapplymethod to the current reporter. If invoked in a constructor, it will register the passed string for forwarding later during test execution. If invoked while thisFixtureAnyPropSpecis 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.- Attributes
- protected
- Definition Classes
- FixtureAnyPropSpecLike → Notifying
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
pending: Assertion with PendingStatement
- Definition Classes
- Assertions
-
def
pendingUntilFixed(f: ⇒ Unit)(implicit pos: Position): Assertion with PendingStatement
- Definition Classes
- Assertions
-
def
propertiesFor(unit: Unit): Unit
Registers shared tests.
Registers shared tests.
This method enables the following syntax for shared tests in a
FixtureAnyPropSpec:propertiesFor(nonEmptyStack(lastValuePushed))
This method just provides syntax sugar intended to make the intent of the code clearer. Because the parameter passed to it is type
Unit, the expression will be evaluated before being passed, which is sufficient to register the shared tests. For examples of shared tests, see the Shared tests section in the main documentation for traitAnyPropSpec.- unit
a
Unit
- Attributes
- protected
-
def
property(testName: String, testTags: Tag*): ResultOfPropertyInvocation
Register a property-based test with the specified name, optional tags, and function value that takes no arguments.
Register a property-based test with the specified name, optional tags, and function value that takes no arguments. This method will register the test for later execution via an invocation of one of the
runmethods. The passed test name must not have been registered previously on thisFixtureAnyPropSpecinstance.- testName
the name of the test
- testTags
the optional list of tags for this test
- Attributes
- protected
- Exceptions thrown
DuplicateTestNameExceptionif a test with the same name has been registered previouslyNotAllowedExceptioniftestNamehad been registered previouslyNullArgumentExceptioniftestNameor any passed test tag isnullTestRegistrationClosedExceptionif invoked afterrunhas been invoked on this suite
-
final
def
registerIgnoredTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Any)(implicit pos: Position): Unit
- Definition Classes
- FixtureAnyPropSpecLike → FixtureTestRegistration
-
final
def
registerTest(testText: String, testTags: Tag*)(testFun: (FixtureParam) ⇒ Any)(implicit pos: Position): Unit
- Definition Classes
- FixtureAnyPropSpecLike → FixtureTestRegistration
-
def
rerunner: Option[String]
- Definition Classes
- Suite
-
def
run(testName: Option[String], args: Args): Status
- Definition Classes
- FixtureAnyPropSpecLike → Suite
-
def
runNestedSuites(args: Args): Status
- Attributes
- protected
- Definition Classes
- Suite
-
def
runTest(testName: String, args: Args): Status
Run a test.
Run a test. This trait's implementation runs the test registered with the name specified by
testName.- testName
the name of one test to run.
- args
the
Argsfor this run- returns
a
Statusobject that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Definition Classes
- FixtureAnyPropSpecLike → TestSuite → Suite
- Exceptions thrown
IllegalArgumentExceptioniftestNameis defined but a test with that name does not exist on thisFixtureAnyPropSpecNullArgumentExceptionif any oftestNameorargsisnull.
-
def
runTests(testName: Option[String], args: Args): Status
Run zero to many of this
FixtureAnyPropSpecLike's tests.Run zero to many of this
FixtureAnyPropSpecLike's tests.This method takes a
testNameparameter that optionally specifies a test to invoke. IftestNameisSome, this trait's implementation of this method invokesrunTeston this object with passedargs.This method takes an
argsthat contains aSetof tag names that should be included (tagsToInclude), and aSetthat should be excluded (tagsToExclude), when deciding which of thisSuite's tests to execute. IftagsToIncludeis empty, all tests will be executed except those those belonging to tags listed in thetagsToExcludeSet. IftagsToIncludeis non-empty, only tests belonging to tags mentioned intagsToInclude, and not mentioned intagsToExcludewill be executed. However, iftestNameisSome,tagsToIncludeandtagsToExcludeare essentially ignored. Only iftestNameisNonewilltagsToIncludeandtagsToExcludebe consulted to determine which of the tests named in thetestNamesSetshould be run. For more information on trait tags, see the main documentation for this trait.If
testNameisNone, this trait's implementation of this method invokestestNameson thisSuiteto get aSetof names of tests to potentially execute. (AtestNamesvalue ofNoneessentially acts as a wildcard that means all tests in thisSuitethat are selected bytagsToIncludeandtagsToExcludeshould be executed.) For each test in thetestNameSet, in the order they appear in the iterator obtained by invoking theelementsmethod on theSet, this trait's implementation of this method checks whether the test should be run based on thetagsToIncludeandtagsToExcludeSets. If so, this implementation invokesrunTestwith passedargs.- testName
an optional name of one test to execute. If
None, all relevant tests should be executed. I.e.,Noneacts like a wildcard that means execute all relevant tests in thisFunSpec.- args
the
Argsto which results will be reported- returns
a
Statusobject that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- FixtureAnyPropSpecLike → Suite
- Exceptions thrown
NullArgumentExceptionif any oftestNameorargsisnull.
-
final
val
succeed: Assertion
- Definition Classes
- Assertions
-
def
suiteId: String
- Definition Classes
- Suite
-
def
suiteName: String
- Definition Classes
- Suite
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tags: Map[String, Set[String]]
A
Mapwhose keys areStringtag names to which tests in thisFixtureAnyPropSpecbelong, and values theSetof test names that belong to each tag.A
Mapwhose keys areStringtag names to which tests in thisFixtureAnyPropSpecbelong, and values theSetof test names that belong to each tag. If thisFixtureAnyPropSpeccontains no tags, this method returns an emptyMap.This trait's implementation returns tags that were passed as strings contained in
Tagobjects passed to methodstestandignore.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.
- Definition Classes
- FixtureAnyPropSpecLike → Suite
-
def
testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData
- Definition Classes
- FixtureAnyPropSpecLike → Suite
-
def
testNames: Set[String]
An immutable
Setof test names.An immutable
Setof test names. If thisFixtureAnyPropSpeccontains no tests, this method returns an emptySet.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.
- returns
the
Setof test names
- Definition Classes
- FixtureAnyPropSpecLike → Suite
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: <:<[B, A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
implicit
def
unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withClue[T](clue: Any)(fun: ⇒ T): T
- Definition Classes
- Assertions
-
def
withFixture(test: NoArgTest): Outcome
- Attributes
- protected
- Definition Classes
- TestSuite
Deprecated Value Members
-
def
conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: (B) ⇒ A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(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.
-
def
convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: (A) ⇒ B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(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.
-
def
convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: (B) ⇒ A): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(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.
-
def
lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: (A) ⇒ B): CanEqual[A, B]
- Definition Classes
- TripleEquals → TripleEqualsSupport
- Annotations
- @deprecated
- Deprecated
(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.
-
final
val
styleName: String
The
styleNamelifecycle method has been deprecated and will be removed in a future version of ScalaTest.The
styleNamelifecycle 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.- Definition Classes
- FixtureAnyPropSpecLike → FixtureSuite → Suite
- Annotations
- @deprecated
- Deprecated
(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.