Class/Object

sttp.client.testing

SttpBackendStub

Related Docs: object SttpBackendStub | package testing

Permalink

class SttpBackendStub[F[_], S, WS_HANDLER[_]] extends SttpBackend[F, S, WS_HANDLER]

A stub backend to use in tests.

The stub can be configured to respond with a given response if the request matches a predicate (see the whenRequestMatches() method).

Note however, that this is not type-safe with respect to the type of the response body - the stub doesn't have a way to check if the type of the body in the configured response is the same as the one specified by the request. Some conversions will be attempted (e.g. from a String to a custom mapped type, as specified in the request, see the documentation for more details).

Hence, the predicates can match requests basing on the URI or headers. A ClassCastException might occur if for a given request, a response is specified with the incorrect or inconvertible body type.

Linear Supertypes
SttpBackend[F, S, WS_HANDLER], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SttpBackendStub
  2. SttpBackend
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SttpBackendStub(monad: MonadError[F], matchers: PartialFunction[Request[_, _], F[Response[_]]], wsMatchers: PartialFunction[Request[_, _], WhenOpenWebsocket[F, WS_HANDLER]], fallback: Option[SttpBackend[F, S, WS_HANDLER]])

    Permalink

Type Members

  1. class WhenRequest extends AnyRef

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. def close(): F[Unit]

    Permalink
    Definition Classes
    SttpBackendStub → SttpBackend

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  15. def openWebsocket[T, WR](request: Request[T, S], handler: WS_HANDLER[WR]): F[WebSocketResponse[WR]]

    Permalink

    Opens a websocket, using the given backend-specific handler.

    Opens a websocket, using the given backend-specific handler.

    If the connection doesn't result in a websocket being opened, a failed effect is returned, or an exception is thrown (depending on F).

    Definition Classes
    SttpBackendStub → SttpBackend

  16. def responseMonad: MonadError[F]

    Permalink

    The effect wrapper for responses.

    The effect wrapper for responses. Allows writing wrapper backends, which map/flatMap over the return value of send and openWebsocket.

    Definition Classes
    SttpBackendStub → SttpBackend

  17. def send[T](request: Request[T, S]): F[Response[T]]

    Permalink
    Definition Classes
    SttpBackendStub → SttpBackend

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. def whenAnyRequest: WhenRequest

    Permalink

    Specify how the stub backend should respond to any request (catch-all).

    Specify how the stub backend should respond to any request (catch-all).

    Note that the stubs are immutable, and each new specification that is added yields a new stub instance.

  24. def whenRequestMatches(p: (Request[_, _]) ⇒ Boolean): WhenRequest

    Permalink

    Specify how the stub backend should respond to requests matching the given predicate.

    Specify how the stub backend should respond to requests matching the given predicate.

    Note that the stubs are immutable, and each new specification that is added yields a new stub instance.

  25. def whenRequestMatchesPartial(partial: PartialFunction[Request[_, _], Response[_]]): SttpBackendStub[F, S, WS_HANDLER]

    Permalink

    Specify how the stub backend should respond to requests using the given partial function.

    Specify how the stub backend should respond to requests using the given partial function.

    Note that the stubs are immutable, and each new specification that is added yields a new stub instance.

  26. def whenRequestMatchesPartialHandleOpenWebsocket[WS_RESULT](partial: PartialFunction[Request[_, _], (Headers, (WS_HANDLER[WS_RESULT]) ⇒ WS_RESULT)]): SttpBackendStub[F, S, WS_HANDLER]

    Permalink

    Specify how the stub backend should use web socket handler using the given partial function.

    Specify how the stub backend should use web socket handler using the given partial function. Meant mainly for akka backend or cases when implementing a custom WS_HANDLER.

  27. def whenRequestMatchesPartialReturnWebSocketResponse[WS_RESULT](partial: PartialFunction[Request[_, _], (Headers, WS_RESULT)]): SttpBackendStub[F, S, WS_HANDLER]

    Permalink

    Specify how the stub backend should respond to open websocket requests using the given partial function.

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from SttpBackend[F, S, WS_HANDLER]

Inherited from AnyRef

Inherited from Any

Ungrouped