Trait

akka.http.javadsl.testkit

TestRoute

Related Doc: package testkit

Permalink

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. All

Abstract Value Members

  1. abstract def run(request: HttpRequest): TestRouteResult

    Permalink

    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 runWithRejections(request: HttpRequest): TestRouteResult

    Permalink

    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.

  3. abstract def underlying: Route

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to any2stringadd[TestRoute] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TestRoute, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to ArrowAssoc[TestRoute] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (TestRoute) ⇒ Boolean, msg: ⇒ Any): TestRoute

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to Ensuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TestRoute) ⇒ Boolean): TestRoute

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to Ensuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): TestRoute

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to Ensuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TestRoute

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to Ensuring[TestRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to StringFormat[TestRoute] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (TestRoute, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from TestRoute to ArrowAssoc[TestRoute] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TestRoute to any2stringadd[TestRoute]

Inherited by implicit conversion StringFormat from TestRoute to StringFormat[TestRoute]

Inherited by implicit conversion Ensuring from TestRoute to Ensuring[TestRoute]

Inherited by implicit conversion ArrowAssoc from TestRoute to ArrowAssoc[TestRoute]

Ungrouped