Packages

trait TestRoute extends AnyRef

A wrapped route that has a run method to run a request through the underlying route to create a TestResponse.

A TestRoute is created by deriving a test class from the concrete RouteTest implementation for your testing framework (like JUnitRouteTest for JUnit) and then using its testRoute method to wrap a route with testing support.

Source
TestRoute.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestRoute
  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 run(request: HttpRequest): TestRouteResult

    Run the request against the sealed route, meaning that exceptions and rejections will be handled by the default exception and rejection handlers.

    Run the request against the sealed route, meaning that exceptions and rejections will be handled by the default exception and rejection handlers. The default handlers will convert exceptions and rejections into HTTP responses with corresponding status codes (like 404 when no route matches the path or 500 in cases of exceptions).

    If you want to assert on the original rejections instead, use TestRoute#runWithRejections.

  2. abstract def runClientServer(request: HttpRequest): TestRouteResult

    Similar to TestRoute#run but runs the request through a full HTTP client and server stack.

    Similar to TestRoute#run but runs the request through a full HTTP client and server stack.

    Run the request against the sealed route, meaning that exceptions and rejections will be handled by the default exception and rejection handlers. The default handlers will convert exceptions and rejections into HTTP responses with corresponding status codes (like 404 when no route matches the path or 500 in cases of exceptions).

    If you want to assert on the original rejections instead, use TestRoute#runWithRejections.

  3. abstract def runWithRejections(request: HttpRequest): TestRouteResult

    Run the request against the "semi-sealed" route, meaning that exceptions will be handled by the default exception handler but rejections will not be handled.

    Run the request against the "semi-sealed" route, meaning that exceptions will be handled by the default exception handler but rejections will not be handled. This means that the test will not see HTTP responses with error status codes for routes that rejected a request. Instead, the TestRouteResult allows access to the original rejection containing all the rejection details in structured form. Use TestRouteResult#assertRejections to check that a route rejected a request with expected rejections.

    Otherwise, to assert on the actual error HTTP response generated by the default rejection handler, use the TestRoute#run method, instead.

  4. abstract def underlying: Route

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 TestRoute toany2stringadd[TestRoute] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TestRoute, B)
    Implicit
    This member is added by an implicit conversion from TestRoute toArrowAssoc[TestRoute] 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: (TestRoute) => Boolean, msg: => Any): TestRoute
    Implicit
    This member is added by an implicit conversion from TestRoute toEnsuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TestRoute) => Boolean): TestRoute
    Implicit
    This member is added by an implicit conversion from TestRoute toEnsuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TestRoute
    Implicit
    This member is added by an implicit conversion from TestRoute toEnsuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TestRoute
    Implicit
    This member is added by an implicit conversion from TestRoute toEnsuring[TestRoute] 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 TestRoute toStringFormat[TestRoute] 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): (TestRoute, B)
    Implicit
    This member is added by an implicit conversion from TestRoute toArrowAssoc[TestRoute] 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 fromTestRoute to any2stringadd[TestRoute]

Inherited by implicit conversion StringFormat fromTestRoute to StringFormat[TestRoute]

Inherited by implicit conversion Ensuring fromTestRoute to Ensuring[TestRoute]

Inherited by implicit conversion ArrowAssoc fromTestRoute to ArrowAssoc[TestRoute]

Ungrouped