Packages

trait LoggingTestKit extends AnyRef

Facilities for verifying logs.

Requires Logback.

See the companion object for convenient factory methods.

Not for user extension.

Annotations
@DoNotInherit()
Source
LoggingTestKit.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LoggingTestKit
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def expect[T](code: => T)(implicit system: typed.ActorSystem[_]): T

    Run the given code block and assert that the criteria of this LoggingTestKit has matched within the configured akka.actor.testkit.typed.filter-leeway as often as requested by its occurrences parameter specifies.

    Run the given code block and assert that the criteria of this LoggingTestKit has matched within the configured akka.actor.testkit.typed.filter-leeway as often as requested by its occurrences parameter specifies.

    Care is taken to remove the testkit when the block is finished or aborted.

  2. abstract def matches(event: LoggingEvent): Boolean

    returns

    true if the event matches the conditions of the filter.

  3. abstract def withCause[A <: Throwable](implicit arg0: ClassTag[A]): LoggingTestKit

    Matching events with an included throwable that is a class or subclass of the given Throwable ClassTag.

  4. abstract def withCheckExcess(checkExcess: Boolean): LoggingTestKit

    After matching the expected number of hits, check for excess messages

  5. abstract def withCustom(newCustom: Function[LoggingEvent, Boolean]): LoggingTestKit

    Matching events for which the supplied function returnstrue.

  6. abstract def withLogLevel(newLogLevel: Level): LoggingTestKit

    Matching events with the given log level.

  7. abstract def withLoggerName(newLoggerName: String): LoggingTestKit

    Matching events with the given logger name or sub-names in the same way as configuration loggers are configured in logback.xml.

    Matching events with the given logger name or sub-names in the same way as configuration loggers are configured in logback.xml. By default the root logger is used.

  8. abstract def withMdc(newMdc: Map[String, String]): LoggingTestKit

    Matching events with MDC containing all entries of the given Map.

    Matching events with MDC containing all entries of the given Map. The event MDC may have more entries than the given Map.

  9. abstract def withMessageContains(newMessageContains: String): LoggingTestKit

    Matching events with a message that contains the given value.

  10. abstract def withMessageRegex(newMessageRegex: String): LoggingTestKit

    Matching events with a message that matches the given regular expression.

  11. abstract def withOccurrences(newOccurrences: Int): LoggingTestKit

    Number of events the testkit is supposed to match.

    Number of events the testkit is supposed to match. By default 1.

    When occurrences > 0 it will not look for excess messages that are logged asynchronously outside (after) the expect thunk and it has already found expected number.

    When occurrences is 0 it will look for unexpected matching events, and then it will also look for excess messages during the configured akka.actor.testkit.typed.expect-no-message-default duration.

  12. abstract def withSource(newSource: String): LoggingTestKit

    Matching events that have "akkaSource" MDC value equal to the given value.

    Matching events that have "akkaSource" MDC value equal to the given value. "akkaSource" is typically the actor path.

  13. abstract def intercept[T](code: => T)(implicit system: typed.ActorSystem[_]): T

    Run the given code block and assert that the criteria of this LoggingTestKit has matched within the configured akka.actor.testkit.typed.filter-leeway as often as requested by its occurrences parameter specifies.

    Run the given code block and assert that the criteria of this LoggingTestKit has matched within the configured akka.actor.testkit.typed.filter-leeway as often as requested by its occurrences parameter specifies.

    Care is taken to remove the testkit when the block is finished or aborted.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use expect instead.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toany2stringadd[LoggingTestKit] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LoggingTestKit, B)
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toArrowAssoc[LoggingTestKit] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (LoggingTestKit) => Boolean, msg: => Any): LoggingTestKit
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toEnsuring[LoggingTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (LoggingTestKit) => Boolean): LoggingTestKit
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toEnsuring[LoggingTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): LoggingTestKit
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toEnsuring[LoggingTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): LoggingTestKit
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toEnsuring[LoggingTestKit] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toStringFormat[LoggingTestKit] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (LoggingTestKit, B)
    Implicit
    This member is added by an implicit conversion from LoggingTestKit toArrowAssoc[LoggingTestKit] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromLoggingTestKit to any2stringadd[LoggingTestKit]

Inherited by implicit conversion StringFormat fromLoggingTestKit to StringFormat[LoggingTestKit]

Inherited by implicit conversion Ensuring fromLoggingTestKit to Ensuring[LoggingTestKit]

Inherited by implicit conversion ArrowAssoc fromLoggingTestKit to ArrowAssoc[LoggingTestKit]

Ungrouped