class TestFailedException extends StackDepthException with ModifiableMessage[TestFailedException] with PayloadField with ModifiablePayload[TestFailedException]
Exception that indicates a test failed.
One purpose of this exception is to encapsulate information about the stack depth at which the line of test code that failed resides, so that information can be presented to the user that makes it quick to find the failing line of test code. (In other words, the user need not scan through the stack trace to find the correct filename and line number of the failing test.)
Another purpose of this exception is to encapsulate a payload, an object to be included in a TestFailed
event
as its payload, so it can be consumed by a custom reporter that understands the payload. For example, tests could take a screen
shot image of a GUI when a test fails, and include that as a payload. A custom reporter could listen for such payloads and
display the screen shots to the user.
- Source
- TestFailedException.scala
- Exceptions thrown
NullArgumentException
if eithermessageFun
,cause
orfailedCodeStackDepthFun
isnull
, orSome(null)
.
- Alphabetic
- By Inheritance
- TestFailedException
- ModifiablePayload
- PayloadField
- ModifiableMessage
- StackDepthException
- StackDepth
- RuntimeException
- Exception
- Throwable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TestFailedException(messageFun: (StackDepthException) => Option[String], cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) => Int, payload: Option[Any])
Constructs a
TestFailedException
with the given error message function, optional cause, stack depth function and optional payload.Constructs a
TestFailedException
with the given error message function, optional cause, stack depth function and optional payload.- messageFun
a function that return an optional detail message for this
TestFailedException
.- cause
an optional cause, the
Throwable
that caused thisTestFailedException
to be thrown.- failedCodeStackDepthFun
a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.
- payload
an optional payload, which ScalaTest will include in a resulting
TestFailedException
event
- new TestFailedException(message: String, cause: Throwable, failedCodeStackDepth: Int)
Create a
TestFailedException
with the specified stack depth, detail message, and cause.Create a
TestFailedException
with the specified stack depth, detail message, and cause.Note that the detail message associated with cause is not automatically incorporated in this throwable's detail message.
- message
A detail message for this
TestFailedException
.- cause
the cause, the
Throwable
that caused thisTestFailedException
to be thrown.- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of test code that failed resides.
- Exceptions thrown
NullArgumentException
if eithermessage
orcause
isnull
.
- new TestFailedException(cause: Throwable, failedCodeStackDepth: Int)
Create a
TestFailedException
with the specified stack depth and cause.Create a
TestFailedException
with the specified stack depth and cause. Themessage
field of this exception object will be initialized toif (cause.getMessage == null) "" else cause.getMessage
.- cause
the cause, the
Throwable
that caused thisTestFailedException
to be thrown.- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of test code that failed resides.
- Exceptions thrown
NullArgumentException
ifcause
isnull
.
- new TestFailedException(message: String, failedCodeStackDepth: Int)
Create a
TestFailedException
with a specified stack depth and detail message.Create a
TestFailedException
with a specified stack depth and detail message.- message
A detail message for this
TestFailedException
.- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of test code that failed resides.
- Exceptions thrown
NullArgumentException
ifmessage
isnull
.
- new TestFailedException(failedCodeStackDepth: Int)
Create a
TestFailedException
with specified stack depth and no detail message or cause.Create a
TestFailedException
with specified stack depth and no detail message or cause.- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of test code that failed resides.
- new TestFailedException(message: Option[String], cause: Option[Throwable], failedCodeStackDepth: Int)
Constructs a
TestFailedException
with pre-determinedmessage
andfailedCodeStackDepth
.Constructs a
TestFailedException
with pre-determinedmessage
andfailedCodeStackDepth
. (This was the primary constructor form prior to ScalaTest 1.5.)- message
an optional detail message for this
TestFailedException
.- cause
an optional cause, the
Throwable
that caused thisTestFailedException
to be thrown.- failedCodeStackDepth
the depth in the stack trace of this exception at which the line of test code that failed resides.
- Exceptions thrown
NullArgumentException
if eithermessage
ofcause
isnull
, orSome(null)
.
- new TestFailedException(messageFun: (StackDepthException) => Option[String], cause: Option[Throwable], failedCodeStackDepthFun: (StackDepthException) => Int)
Constructs a
TestFailedException
with pre-determinedmessage
andfailedCodeStackDepth
.Constructs a
TestFailedException
with pre-determinedmessage
andfailedCodeStackDepth
. (This was the primary constructor form from ScalaTest 1.5 to 1.8.)- messageFun
a function that produces an optional detail message for this
TestFailedException
.- cause
an optional cause, the
Throwable
that caused thisTestFailedException
to be thrown.- failedCodeStackDepthFun
a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.
- Exceptions thrown
NullArgumentException
if eithermessage
ofcause
isnull
, orSome(null)
.
- new TestFailedException(messageFun: (StackDepthException) => Option[String], cause: Option[Throwable], pos: Position)
Constructs a
TestFailedException
with the given error message function, optional cause and source position.Constructs a
TestFailedException
with the given error message function, optional cause and source position.- messageFun
a function that return an optional detail message for this
TestFailedException
.- cause
an optional cause, the
Throwable
that caused thisTestFailedException
to be thrown.- pos
a source position
- new TestFailedException(messageFun: (StackDepthException) => Option[String], cause: Option[Throwable], pos: Position, payload: Option[Any])
Constructs a
TestFailedException
with the given error message function, optional cause, source position and optional payload.Constructs a
TestFailedException
with the given error message function, optional cause, source position and optional payload.- messageFun
a function that return an optional detail message for this
TestFailedException
.- cause
an optional cause, the
Throwable
that caused thisTestFailedException
to be thrown.- pos
a source position
- payload
an optional payload, which ScalaTest will include in a resulting
TestFailedException
event
- new TestFailedException(messageFun: (StackDepthException) => Option[String], cause: Option[Throwable], posOrStackDepthFun: Either[Position, (StackDepthException) => Int], payload: Option[Any], analysis: IndexedSeq[String])
- messageFun
a function that produces an optional detail message for this
TestFailedException
.- cause
an optional cause, the
Throwable
that caused thisTestFailedException
to be thrown.- posOrStackDepthFun
a source position or a function that produces the depth in the stack trace of this exception at which the line of test code that failed resides.
- payload
an optional payload, which ScalaTest will include in a resulting
TestFailed
event
- Exceptions thrown
NullArgumentException
if eithermessageFun
,cause
orfailedCodeStackDepthFun
isnull
, orSome(null)
.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def addSuppressed(arg0: Throwable): Unit
- Definition Classes
- Throwable
- val analysis: IndexedSeq[String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canEqual(other: Any): Boolean
Indicates whether this object can be equal to the passed object.
Indicates whether this object can be equal to the passed object.
- Definition Classes
- TestFailedException → StackDepthException
- val cause: Option[Throwable]
An optional cause, the
Throwable
that caused thisStackDepth
exception to be thrown.An optional cause, the
Throwable
that caused thisStackDepth
exception to be thrown.- Definition Classes
- StackDepthException → StackDepth
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Any): Boolean
Indicates whether this object is equal to the passed object.
Indicates whether this object is equal to the passed object. If the passed object is a
TestFailedException
, equality requires equalmessage
,cause
, andfailedCodeStackDepth
fields, as well as equal return values ofgetStackTrace
.- Definition Classes
- TestFailedException → StackDepthException → AnyRef → Any
- def failedCodeFileName: Option[String]
A string that provides the filename of the line of code that failed, suitable for presenting to a user, which is taken from this exception's
StackTraceElement
at the depth specified byfailedCodeStackDepth
.A string that provides the filename of the line of code that failed, suitable for presenting to a user, which is taken from this exception's
StackTraceElement
at the depth specified byfailedCodeStackDepth
.This is a
def
instead of aval
because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by theSeveredStackTraces
trait.- returns
a string containing the filename that caused the failed test
- Definition Classes
- StackDepth
- def failedCodeFileNameAndLineNumberString: Option[String]
A string that provides the filename and line number of the line of code that failed, suitable for presenting to a user of the failing line.
A string that provides the filename and line number of the line of code that failed, suitable for presenting to a user of the failing line. It calls
failedCodeFileName
andfailedCodeLineNumber
to get the failing filename and line number.failedCodeFileName
andfailedCodeLineNumber
will fall back to exception stack trace whenPosition
is not avaiable, this is the reason it is adef
instead of aval
, because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by theSeveredStackTraces
trait.- returns
a user-presentable string containing the filename and line number that caused the failed test
- Definition Classes
- StackDepth
- lazy val failedCodeFilePathname: Option[String]
A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.
A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.
- returns
a string containing the full pathname of the source file containing the line of code that caused this exception
- Definition Classes
- StackDepthException → StackDepth
- lazy val failedCodeFilePathnameAndLineNumberString: Option[String]
A string that provides the absolute filename and line number of the line of code that failed, suitable for presenting to a user of the failing line.
A string that provides the absolute filename and line number of the line of code that failed, suitable for presenting to a user of the failing line. It calls
failedCodeFilePathname
andfailedCodeLineNumber
to get the failing absolute filename and line number.- returns
a user-presentable string containing the absolute filename and line number that caused the failed test
- Definition Classes
- StackDepth
- def failedCodeLineNumber: Option[Int]
A string that provides the line number of the line of code that failed, suitable for presenting to a user, which is taken from this exception's
StackTraceElement
at the depth specified byfailedCodeStackDepth
.A string that provides the line number of the line of code that failed, suitable for presenting to a user, which is taken from this exception's
StackTraceElement
at the depth specified byfailedCodeStackDepth
.This is a
def
instead of aval
because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by theSeveredStackTraces
trait.- returns
a string containing the line number that caused the failed test
- Definition Classes
- StackDepth
- lazy val failedCodeStackDepth: Int
The depth in the stack trace of this exception at which the line of test code that failed resides.
The depth in the stack trace of this exception at which the line of test code that failed resides.
One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property will often be
StackDepthException
s, but whosefailedCodeStackDepth
will never be used. Another reason is to remove the need to create a different exception before creating this one just for the purpose of searching through its stack trace for the proper stack depth. Still one more reason is to allow the message to contain information about the stack depth, such as the failed file name and line number.- Definition Classes
- StackDepthException → StackDepth
- def fillInStackTrace(): Throwable
- Definition Classes
- Throwable
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getCause(): Throwable
- Definition Classes
- Throwable
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getLocalizedMessage(): String
- Definition Classes
- Throwable
- def getMessage(): String
Returns the detail message string of this
StackDepthException
.Returns the detail message string of this
StackDepthException
.- returns
the detail message string of this
StackDepthException
instance (which may benull
).
- Definition Classes
- StackDepthException → Throwable
- def getStackTrace(): Array[StackTraceElement]
- Definition Classes
- Throwable
- final def getSuppressed(): Array[Throwable]
- Definition Classes
- Throwable
- def hashCode(): Int
Returns a hash code value for this object.
Returns a hash code value for this object.
- Definition Classes
- TestFailedException → StackDepthException → AnyRef → Any
- final def initCause(throwable: Throwable): Throwable
- Definition Classes
- StackDepthException → Throwable
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- lazy val message: Option[String]
An optional detail message for this
StackDepth
exception.An optional detail message for this
StackDepth
exception.One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property will often be
StackDepthException
s, but whosemessage
will never be used. Another related reason is to remove the need to create a different exception before creating this one just for the purpose of searching through its stack trace for the proper stack depth. Still one more reason is to allow the message to contain information about the stack depth, such as the failed file name and line number.- Definition Classes
- StackDepthException → StackDepth
- val messageFun: (StackDepthException) => Option[String]
- Definition Classes
- StackDepthException
- def modifyMessage(fun: (Option[String]) => Option[String]): TestFailedException
Returns an instance of this exception's class, identical to this exception, except with the detail message option string replaced with the result of passing the current detail message to the passed function,
fun
.Returns an instance of this exception's class, identical to this exception, except with the detail message option string replaced with the result of passing the current detail message to the passed function,
fun
.- fun
A function that, given the current optional detail message, will produce the modified optional detail message for the result instance of
TestFailedException
.
- Definition Classes
- TestFailedException → ModifiableMessage
- def modifyPayload(fun: (Option[Any]) => Option[Any]): TestFailedException
Returns an instance of this exception's class, identical to this exception, except with the payload option replaced with the result of passing the current payload option to the passed function,
fun
.Returns an instance of this exception's class, identical to this exception, except with the payload option replaced with the result of passing the current payload option to the passed function,
fun
.- fun
A function that, given the current optional payload, will produce the modified optional payload for the result instance of
TestFailedException
.
- Definition Classes
- TestFailedException → ModifiablePayload
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val payload: Option[Any]
The optional payload.
The optional payload.
- Definition Classes
- TestFailedException → PayloadField
- val position: Option[Position]
An optional source position describing the line of test code that caused this exception.
An optional source position describing the line of test code that caused this exception.
- Definition Classes
- StackDepthException → StackDepth
- def printStackTrace(arg0: PrintWriter): Unit
- Definition Classes
- Throwable
- def printStackTrace(arg0: PrintStream): Unit
- Definition Classes
- Throwable
- def printStackTrace(): Unit
- Definition Classes
- Throwable
- def setStackTrace(arg0: Array[StackTraceElement]): Unit
- Definition Classes
- Throwable
- def severedAtStackDepth: TestFailedException
Returns an exception of class
TestFailedException
withfailedExceptionStackDepth
set to 0 and all frames above this stack depth severed off.Returns an exception of class
TestFailedException
withfailedExceptionStackDepth
set to 0 and all frames above this stack depth severed off. This can be useful when working with tools (such as IDEs) that do not directly support ScalaTest. (Tools that directly support ScalaTest can use the stack depth information delivered in the StackDepth exceptions.)- Definition Classes
- TestFailedException → StackDepth
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Throwable → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()