zio-http-2559 Update the test kit so that it supports the current dev…

…elopment style as supported ... Add documentation Took 8 minutes
zio · Dec 22, 2023 · 6a4444b · 6a4444b
1 parent 365bbc9
commit 6a4444b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/zio-http-testkit/src/main/scala/zio/http/TestServer.scala b/zio-http-testkit/src/main/scala/zio/http/TestServer.scala
@@ -75,6 +75,28 @@ final case class TestServer(driver: Driver, bindPort: Int) extends Server {
       _ <- driver.addApp(app, r)
     } yield ()
 
+  /**
+   * @param routes new routes
+   * @tparam Env environment
+   * @return
+   *
+   * @example
+   * {{{
+   *   for{
+          client <- ZIO.service[Client]
+          testRequest <- requestToCorrectPort
+          _ <- TestServer.addRoutes(
+            Routes(
+              Method.GET / PathCodec.empty -> handler {
+                Response.ok
+              }
+            )
+          )
+          response <- client(testRequest)
+
+        } yield assertTrue(status(response)==Status.Ok)
+   * }}}
+   */
   def addRoutes[Env](routes : Routes[Env,Response]): ZIO[Env, Nothing, Unit] =
     for{
       env <- ZIO.environment[Env]

diff --git a/zio-http-testkit/src/test/scala/zio/http/TestServerSpec.scala b/zio-http-testkit/src/test/scala/zio/http/TestServerSpec.scala
@@ -90,7 +90,7 @@ object TestServerSpec extends ZIOHttpSpec {
         Scope.default,
       ),
     suite("Test Routes")(
-      test("Get A Respones Ok"){
+      test("Get a Response for Ok"){
         for{
           client <- ZIO.service[Client]
           testRequest <- requestToCorrectPort