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
- Alphabetic
- By Inheritance
- TestRoute
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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.
- 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.
- 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.
- abstract def underlying: Route
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (TestRoute, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (TestRoute) => Boolean, msg: => Any): TestRoute
- def ensuring(cond: (TestRoute) => Boolean): TestRoute
- def ensuring(cond: Boolean, msg: => Any): TestRoute
- def ensuring(cond: Boolean): TestRoute
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- 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()
Deprecated Value Members
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.