TestClient

zio.http.TestClient
See theTestClient companion object
final case class TestClient(behavior: Ref[Routes[Any, Response]], serverSocketBehavior: Ref[WebSocketApp[Any]], missingRouteHandler: Ref[Handler[Any, Response, Request, Response]]) extends Driver[Any, Scope, Throwable]

Enables tests that use a client without needing a live Server

Value parameters

behavior

Contains the user-specified behavior that takes the place of the usual Server

Attributes

Companion
object
Source
TestClient.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Driver[Any, Scope, Throwable]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addRequestResponse(expectedRequest: Request, response: Response): ZIO[Any, Nothing, Unit]

Adds an exact 1-1 behavior

Adds an exact 1-1 behavior

Value parameters

expectedRequest

The request that will trigger the response

response

The response to be returned when a user submits the response

Attributes

Example 
  TestClient.addRequestResponse(Request.get(URL.root), Response.ok)
Source
TestClient.scala
def addRoute[R](route: Route[R, Response]): ZIO[R, Nothing, Unit]

Adds a route definition to handle requests that are submitted by test cases

Adds a route definition to handle requests that are submitted by test cases

Type parameters

R

Environment of the new route

Value parameters

route

New route to be added to the TestClient

Attributes

Example 
  TestClient.addRoute { Method.ANY / trailing -> handler(Response.ok) }
Source
TestClient.scala
def addRoutes(routes: Routes[Any, Response]): ZIO[Any, Nothing, Unit]

Adds Routes to the TestClient

Adds Routes to the TestClient

Attributes

Source
TestClient.scala
def addRoutes[R](route: Route[R, Response], routes: Route[R, Response]*): ZIO[R, Nothing, Unit]

Adds routes to handle requests that are submitted by test cases

Adds routes to handle requests that are submitted by test cases

Type parameters

R

Environment of the new route

Value parameters

routes

New routes to be added to the TestClient

Attributes

Example 
 TestClient.addRoutes {
   Routes(
     Method.GET / trailing          -> handler { Response.text("fallback") },
     Method.GET / "hello" / "world" -> handler { Response.text("Hey there!") },
   )
 }
Source
TestClient.scala
def headers: Headers

Attributes

Source
TestClient.scala
def installSocketApp[Env1](app: WebSocketApp[Any]): ZIO[Env1, Nothing, Unit]

Attributes

Source
TestClient.scala
def method: Method

Attributes

Source
TestClient.scala
override def request(version: Version, method: Method, url: URL, headers: Headers, body: Body, sslConfig: Option[ClientSSLConfig], proxy: Option[Proxy])(implicit trace: Trace): ZIO[Scope, Throwable, Response]

Attributes

Definition Classes
Source
TestClient.scala
def setFallbackHandler[R](fallbackFunction: Request => ZIO[R, Response, Response]): ZIO[R, Nothing, Unit]

Sets a fallback behaviour for when the TestClient attempts to access any unspecified routes

Sets a fallback behaviour for when the TestClient attempts to access any unspecified routes

Type parameters

R

Environment of the handler

Value parameters

fallbackHandler

The function to execute when the client attempts to perform a request not part of it's behavior

Attributes

Example 
 ref <- Ref.Synchronized.make[Seq[Request]](Nil)
 _ <- TestClient.setFallbackHandler(req => ref.update(_.appended(req))
Source
TestClient.scala
def socket[Env1](version: Version, url: URL, headers: Headers, app: WebSocketApp[Env1])(implicit trace: Trace, ev: Scope =:= Scope): ZIO[Env1 & Scope, Throwable, Response]

Attributes

Source
TestClient.scala
def url: URL

Attributes

Source
TestClient.scala
def version: Version

Attributes

Source
TestClient.scala

Inherited methods

final def apply(request: Request)(implicit trace: Trace): ZIO[Any & Scope, Throwable, Response]

Attributes

Inherited from:
Driver
Source
ZClient.scala
def disableStreaming(implicit ev1: Scope =:= Scope): Driver[Any, Any, Throwable]

Attributes

Inherited from:
Driver
Source
ZClient.scala
final def mapError[Err2](f: Throwable => Err2): Driver[Any, Scope, Err2]

Attributes

Inherited from:
Driver
Source
ZClient.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def refineOrDie[Err2](pf: PartialFunction[Throwable, Err2])(implicit ev1: IsSubtypeOfError[Throwable, Throwable], ev2: CanFail[Throwable], trace: Trace): Driver[Any, Scope, Err2]

Attributes

Inherited from:
Driver
Source
ZClient.scala
final def request(req: Request)(implicit trace: Trace): ZIO[Any & Scope, Throwable, Response]

Attributes

Inherited from:
Driver
Source
ZClient.scala
final def retry[Env1, Err1 >: Throwable](policy: Schedule[Env1, Err1, Any]): Driver[Env1, Scope, Err1]

Attributes

Inherited from:
Driver
Source
ZClient.scala