From 92e10991df0d168d1972d4618fcc7e02e2e0a0fa Mon Sep 17 00:00:00 2001 From: Sam Guymer Date: Thu, 17 May 2018 20:11:22 +1000 Subject: Move backend tests into their projects Instead of having a single project which tests all backends, each backend now implements a http test trait along with a streaming test trait if it supports streaming. The test http server has been moved into its own project and is started automatically before running a backends test. This allows each backend to be tested without the possibility of dependency eviction from another backend or the test http server. It also has the side effect of parallelizing the tests providing a speed up when run with multiple cores. --- build.sbt | 60 ++++++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 48 insertions(+), 12 deletions(-) (limited to 'build.sbt') diff --git a/build.sbt b/build.sbt index 1f510e1..461a88e 100644 --- a/build.sbt +++ b/build.sbt @@ -34,9 +34,12 @@ val akkaStreams = "com.typesafe.akka" %% "akka-stream" % "2.5.12" val scalaTest = "org.scalatest" %% "scalatest" % "3.0.5" +val testServerPort = settingKey[Int]("Port to run the http test server on") +val startTestServer = taskKey[Unit]("Start a http server used by tests") + lazy val rootProject = (project in file(".")) .settings(commonSettings: _*) - .settings(publishArtifact := false, name := "sttp") + .settings(skip in publish := true, name := "sttp") .aggregate( core, cats, @@ -55,7 +58,8 @@ lazy val rootProject = (project in file(".")) json4s, braveBackend, prometheusBackend, - tests + tests, + testServer ) lazy val core: Project = (project in file("core")) @@ -63,9 +67,10 @@ lazy val core: Project = (project in file("core")) .settings( name := "core", libraryDependencies ++= Seq( - "org.scalacheck" %% "scalacheck" % "1.14.0" % "test", + "com.github.pathikrit" %% "better-files" % "3.4.0" % "test", scalaTest % "test" - ) + ), + publishArtifact in Test := true // allow implementations outside of this repo ) //----- implementations @@ -97,6 +102,7 @@ lazy val scalaz: Project = (project in file("implementations/scalaz")) //-- akka lazy val akkaHttpBackend: Project = (project in file("akka-http-backend")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings( name := "akka-http-backend", libraryDependencies ++= Seq( @@ -106,42 +112,45 @@ lazy val akkaHttpBackend: Project = (project in file("akka-http-backend")) akkaStreams % "provided" ) ) - .dependsOn(core) + .dependsOn(core % "compile->compile;test->test") //-- async http client lazy val asyncHttpClientBackend: Project = { (project in file("async-http-client-backend")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings( name := "async-http-client-backend", libraryDependencies ++= Seq( "org.asynchttpclient" % "async-http-client" % "2.4.7" ) ) - .dependsOn(core) + .dependsOn(core % "compile->compile;test->test") } def asyncHttpClientBackendProject(proj: String): Project = { Project(s"asyncHttpClientBackend${proj.capitalize}", file(s"async-http-client-backend/$proj")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings(name := s"async-http-client-backend-$proj") .dependsOn(asyncHttpClientBackend) } lazy val asyncHttpClientFutureBackend: Project = asyncHttpClientBackendProject("future") + .dependsOn(core % "compile->compile;test->test") lazy val asyncHttpClientScalazBackend: Project = asyncHttpClientBackendProject("scalaz") - .dependsOn(scalaz) + .dependsOn(scalaz % "compile->compile;test->test") lazy val asyncHttpClientMonixBackend: Project = asyncHttpClientBackendProject("monix") - .dependsOn(monix) + .dependsOn(monix % "compile->compile;test->test") lazy val asyncHttpClientCatsBackend: Project = asyncHttpClientBackendProject("cats") - .dependsOn(cats) + .dependsOn(cats % "compile->compile;test->test") lazy val asyncHttpClientFs2Backend: Project = asyncHttpClientBackendProject("fs2") @@ -150,28 +159,31 @@ lazy val asyncHttpClientFs2Backend: Project = "com.github.zainab-ali" %% "fs2-reactive-streams" % "0.5.1" ) ) + .dependsOn(core % "compile->compile;test->test") //-- okhttp lazy val okhttpBackend: Project = (project in file("okhttp-backend")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings( name := "okhttp-backend", libraryDependencies ++= Seq( "com.squareup.okhttp3" % "okhttp" % "3.10.0" ) ) - .dependsOn(core) + .dependsOn(core % "compile->compile;test->test") def okhttpBackendProject(proj: String): Project = { Project(s"okhttpBackend${proj.capitalize}", file(s"okhttp-backend/$proj")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings(name := s"okhttp-backend-$proj") .dependsOn(okhttpBackend) } lazy val okhttpMonixBackend: Project = okhttpBackendProject("monix") - .dependsOn(monix) + .dependsOn(monix % "compile->compile;test->test") lazy val circeVersion = "0.9.3" @@ -225,8 +237,9 @@ lazy val prometheusBackend: Project = (project in file("metrics/prometheus-backe lazy val tests: Project = (project in file("tests")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings( - publishArtifact := false, + skip in publish := true, name := "tests", libraryDependencies ++= Seq( akkaHttp, @@ -251,3 +264,26 @@ lazy val tests: Project = (project in file("tests")) asyncHttpClientFs2Backend, okhttpMonixBackend ) + +// https://stackoverflow.com/questions/25766797/how-do-i-start-a-server-before-running-a-test-suite-in-sbt +lazy val testServer: Project = project + .in(file("test-server")) + .settings(commonSettings: _*) + .settings( + name := "test-server", + libraryDependencies ++= Seq(akkaHttp, akkaStreams), + mainClass in reStart := Some("com.softwaremill.sttp.server.TestHttpServer"), + reStartArgs := Seq(s"${testServerPort.value}"), + testServerPort := 51823, + startTestServer := (reStart in Test).toTask("").value + ) + +// maybe use IntegrationTest instead of Test? +lazy val testServerSettings = Seq( + test in Test := (test in Test).dependsOn(startTestServer in testServer).value, + testOnly in Test := (testOnly in Test).dependsOn(startTestServer in testServer).evaluated, + testOptions in Test += Tests.Setup(() => { + val port = (testServerPort in testServer).value + PollingUtils.waitUntilServerAvailable(new URL(s"http://localhost:$port")) + }) +) -- cgit v1.2.3 From bcb94e252a96c78b1db29aebe47b18bfd337e764 Mon Sep 17 00:00:00 2001 From: Sam Guymer Date: Sun, 20 May 2018 21:02:37 +1000 Subject: Code review updates Remove tests sub project, all tests are now in core. Remove TestStreamingBackend, StreamingTest now has the required abstract methods. --- .../sttp/akkahttp/AkkaHttpStreamingTest.scala | 30 +++++++ .../sttp/akkahttp/AkkaHttpStreamingTests.scala | 40 --------- .../fs2/AsyncHttpClientFs2HttpStreamingTest.scala | 11 +-- .../monix/AsyncHttpClientMonixStreamingTest.scala | 19 +--- build.sbt | 37 ++------ .../scala/com/softwaremill/sttp/MonadError.scala | 9 -- .../sttp/HttpURLConnectionHttpTest.scala | 10 +++ .../com/softwaremill/sttp/IllTypedTests.scala | 37 ++++++++ .../sttp/TryHttpURLConnectionHttpTest.scala | 12 +++ .../com/softwaremill/sttp/testing/EvalScala.scala | 11 +++ .../sttp/testing/streaming/StreamingTest.scala | 14 ++- .../testing/streaming/TestStreamingBackend.scala | 16 ---- docs/backends/custom.rst | 29 +++++- .../sttp/impl/monix/MonixStreamingTest.scala | 26 ++++++ .../impl/monix/MonixTestStreamingBackend.scala | 28 ------ .../okhttp/monix/OkHttpMonixStreamingTest.scala | 19 +--- tests/src/test/resources/binaryfile.jpg | Bin 42010 -> 0 bytes tests/src/test/resources/logback.xml | 12 --- tests/src/test/resources/textfile.txt | 100 --------------------- .../scala/com/softwaremill/sttp/EvalScala.scala | 11 --- .../sttp/HttpURLConnectionHttpTest.scala | 9 -- .../com/softwaremill/sttp/IllTypedTests.scala | 34 ------- .../sttp/TryHttpURLConnectionHttpTest.scala | 11 --- 23 files changed, 175 insertions(+), 350 deletions(-) create mode 100644 akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTest.scala delete mode 100644 akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTests.scala create mode 100644 core/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala create mode 100644 core/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala create mode 100644 core/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala create mode 100644 core/src/test/scala/com/softwaremill/sttp/testing/EvalScala.scala delete mode 100644 core/src/test/scala/com/softwaremill/sttp/testing/streaming/TestStreamingBackend.scala create mode 100644 implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixStreamingTest.scala delete mode 100644 implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixTestStreamingBackend.scala delete mode 100644 tests/src/test/resources/binaryfile.jpg delete mode 100644 tests/src/test/resources/logback.xml delete mode 100644 tests/src/test/resources/textfile.txt delete mode 100644 tests/src/test/scala/com/softwaremill/sttp/EvalScala.scala delete mode 100644 tests/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala delete mode 100644 tests/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala delete mode 100644 tests/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala (limited to 'build.sbt') diff --git a/akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTest.scala b/akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTest.scala new file mode 100644 index 0000000..494ecd2 --- /dev/null +++ b/akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTest.scala @@ -0,0 +1,30 @@ +package com.softwaremill.sttp.akkahttp + +import akka.NotUsed +import akka.actor.ActorSystem +import akka.stream.ActorMaterializer +import akka.stream.scaladsl.Source +import akka.util.ByteString +import com.softwaremill.sttp.SttpBackend +import com.softwaremill.sttp.testing.ConvertToFuture +import com.softwaremill.sttp.testing.streaming.StreamingTest + +import scala.concurrent.Future + +class AkkaHttpStreamingTest extends StreamingTest[Future, Source[ByteString, Any]] { + + private implicit val actorSystem: ActorSystem = ActorSystem("sttp-test") + private implicit val materializer: ActorMaterializer = ActorMaterializer() + + override implicit val backend: SttpBackend[Future, Source[ByteString, Any]] = + AkkaHttpBackend.usingActorSystem(actorSystem) + + override implicit val convertToFuture: ConvertToFuture[Future] = + ConvertToFuture.future + + override def bodyProducer(body: String): Source[ByteString, NotUsed] = + Source.single(ByteString(body)) + + override def bodyConsumer(stream: Source[ByteString, Any]): Future[String] = + stream.map(_.utf8String).runReduce(_ + _) +} diff --git a/akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTests.scala b/akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTests.scala deleted file mode 100644 index e8ab9d7..0000000 --- a/akka-http-backend/src/test/scala/com/softwaremill/sttp/akkahttp/AkkaHttpStreamingTests.scala +++ /dev/null @@ -1,40 +0,0 @@ -package com.softwaremill.sttp.akkahttp - -import akka.NotUsed -import akka.actor.ActorSystem -import akka.stream.{ActorMaterializer, Materializer} -import akka.stream.scaladsl.Source -import akka.util.ByteString -import com.softwaremill.sttp.SttpBackend -import com.softwaremill.sttp.testing.ConvertToFuture -import com.softwaremill.sttp.testing.streaming.{StreamingTest, TestStreamingBackend} - -import scala.concurrent.Future - -class AkkaHttpStreamingTest extends StreamingTest[Future, Source[ByteString, Any]] { - - private implicit val actorSystem: ActorSystem = ActorSystem("sttp-test") - private implicit val materializer: ActorMaterializer = ActorMaterializer() - - override val testStreamingBackend: TestStreamingBackend[Future, Source[ByteString, Any]] = - new AkkaHttpTestStreamingBackend(actorSystem) -} - -class AkkaHttpTestStreamingBackend( - actorSystem: ActorSystem -)(implicit materializer: Materializer) - extends TestStreamingBackend[Future, Source[ByteString, Any]] { - - override implicit val backend: SttpBackend[Future, Source[ByteString, Any]] = - AkkaHttpBackend.usingActorSystem(actorSystem) - - override implicit val convertToFuture: ConvertToFuture[Future] = - ConvertToFuture.future - - override def bodyProducer(body: String): Source[ByteString, NotUsed] = - Source.single(ByteString(body)) - - override def bodyConsumer(stream: Source[ByteString, Any]): Future[String] = - stream.map(_.utf8String).runReduce(_ + _) - -} diff --git a/async-http-client-backend/fs2/src/test/scala/com/softwaremill/sttp/asynchttpclient/fs2/AsyncHttpClientFs2HttpStreamingTest.scala b/async-http-client-backend/fs2/src/test/scala/com/softwaremill/sttp/asynchttpclient/fs2/AsyncHttpClientFs2HttpStreamingTest.scala index 565db5c..56bb18b 100644 --- a/async-http-client-backend/fs2/src/test/scala/com/softwaremill/sttp/asynchttpclient/fs2/AsyncHttpClientFs2HttpStreamingTest.scala +++ b/async-http-client-backend/fs2/src/test/scala/com/softwaremill/sttp/asynchttpclient/fs2/AsyncHttpClientFs2HttpStreamingTest.scala @@ -5,21 +5,14 @@ import java.nio.ByteBuffer import cats.effect.IO import cats.instances.string._ import com.softwaremill.sttp.SttpBackend -import com.softwaremill.sttp.testing.streaming.{StreamingTest, TestStreamingBackend} +import com.softwaremill.sttp.testing.streaming.StreamingTest import com.softwaremill.sttp.testing.ConvertToFuture import fs2.{Chunk, Stream, text} import scala.concurrent.Future class AsyncHttpClientFs2HttpStreamingTest extends StreamingTest[IO, Stream[IO, ByteBuffer]] { - override val testStreamingBackend: TestStreamingBackend[IO, Stream[IO, ByteBuffer]] = - new AsyncHttpClientFs2TestStreamingBackend -} - -class AsyncHttpClientFs2TestStreamingBackend extends TestStreamingBackend[IO, Stream[IO, ByteBuffer]] { - - override implicit val backend: SttpBackend[IO, Stream[IO, ByteBuffer]] = - AsyncHttpClientFs2Backend[IO]() + override implicit val backend: SttpBackend[IO, Stream[IO, ByteBuffer]] = AsyncHttpClientFs2Backend[IO]() override implicit val convertToFuture: ConvertToFuture[IO] = new ConvertToFuture[IO] { diff --git a/async-http-client-backend/monix/src/test/scala/com/softwaremill/sttp/asynchttpclient/monix/AsyncHttpClientMonixStreamingTest.scala b/async-http-client-backend/monix/src/test/scala/com/softwaremill/sttp/asynchttpclient/monix/AsyncHttpClientMonixStreamingTest.scala index 34c15ff..8e93074 100644 --- a/async-http-client-backend/monix/src/test/scala/com/softwaremill/sttp/asynchttpclient/monix/AsyncHttpClientMonixStreamingTest.scala +++ b/async-http-client-backend/monix/src/test/scala/com/softwaremill/sttp/asynchttpclient/monix/AsyncHttpClientMonixStreamingTest.scala @@ -3,24 +3,11 @@ package com.softwaremill.sttp.asynchttpclient.monix import java.nio.ByteBuffer import com.softwaremill.sttp.SttpBackend -import com.softwaremill.sttp.impl.monix.MonixTestStreamingBackend -import com.softwaremill.sttp.testing.streaming.{StreamingTest, TestStreamingBackend} +import com.softwaremill.sttp.impl.monix.MonixStreamingTest import monix.eval.Task import monix.reactive.Observable -class AsyncHttpClientMonixStreamingTest extends StreamingTest[Task, Observable[ByteBuffer]] { +class AsyncHttpClientMonixStreamingTest extends MonixStreamingTest { - override val testStreamingBackend: TestStreamingBackend[Task, Observable[ByteBuffer]] = - new AsyncHttpClientMonixTestStreamingBackend -} - -class AsyncHttpClientMonixTestStreamingBackend extends MonixTestStreamingBackend[ByteBuffer] { - - import monix.execution.Scheduler.Implicits.global - - override def toByteArray(v: ByteBuffer): Array[Byte] = v.array() - override def fromByteArray(v: Array[Byte]): ByteBuffer = ByteBuffer.wrap(v) - - override implicit val backend: SttpBackend[Task, Observable[ByteBuffer]] = - AsyncHttpClientMonixBackend() + override implicit val backend: SttpBackend[Task, Observable[ByteBuffer]] = AsyncHttpClientMonixBackend() } diff --git a/build.sbt b/build.sbt index 461a88e..6bcaf1a 100644 --- a/build.sbt +++ b/build.sbt @@ -58,16 +58,17 @@ lazy val rootProject = (project in file(".")) json4s, braveBackend, prometheusBackend, - tests, testServer ) lazy val core: Project = (project in file("core")) .settings(commonSettings: _*) + .settings(testServerSettings: _*) .settings( name := "core", libraryDependencies ++= Seq( "com.github.pathikrit" %% "better-files" % "3.4.0" % "test", + "org.scala-lang" % "scala-compiler" % scalaVersion.value % "test", scalaTest % "test" ), publishArtifact in Test := true // allow implementations outside of this repo @@ -78,6 +79,7 @@ lazy val cats: Project = (project in file("implementations/cats")) .settings(commonSettings: _*) .settings( name := "cats", + publishArtifact in Test := true, libraryDependencies ++= Seq("org.typelevel" %% "cats-effect" % "1.0.0-RC") ) .dependsOn(core % "compile->compile;test->test") @@ -86,6 +88,7 @@ lazy val monix: Project = (project in file("implementations/monix")) .settings(commonSettings: _*) .settings( name := "monix", + publishArtifact in Test := true, libraryDependencies ++= Seq("io.monix" %% "monix" % "3.0.0-RC1") ) .dependsOn(core % "compile->compile;test->test") @@ -94,6 +97,7 @@ lazy val scalaz: Project = (project in file("implementations/scalaz")) .settings(commonSettings: _*) .settings( name := "scalaz", + publishArtifact in Test := true, libraryDependencies ++= Seq("org.scalaz" %% "scalaz-concurrent" % "7.2.22") ) .dependsOn(core % "compile->compile;test->test") @@ -235,36 +239,6 @@ lazy val prometheusBackend: Project = (project in file("metrics/prometheus-backe ) .dependsOn(core) -lazy val tests: Project = (project in file("tests")) - .settings(commonSettings: _*) - .settings(testServerSettings: _*) - .settings( - skip in publish := true, - name := "tests", - libraryDependencies ++= Seq( - akkaHttp, - akkaStreams, - scalaTest, - "com.typesafe.scala-logging" %% "scala-logging" % "3.9.0", - "com.github.pathikrit" %% "better-files" % "3.4.0", - "ch.qos.logback" % "logback-classic" % "1.2.3", - "org.scala-lang" % "scala-compiler" % scalaVersion.value - ).map(_ % "test") - ) - .dependsOn( - core % "compile->compile;test->test", - cats % "compile->compile;test->test", - monix % "compile->compile;test->test", - scalaz % "compile->compile;test->test", - akkaHttpBackend, - asyncHttpClientFutureBackend, - asyncHttpClientScalazBackend, - asyncHttpClientMonixBackend, - asyncHttpClientCatsBackend, - asyncHttpClientFs2Backend, - okhttpMonixBackend - ) - // https://stackoverflow.com/questions/25766797/how-do-i-start-a-server-before-running-a-test-suite-in-sbt lazy val testServer: Project = project .in(file("test-server")) @@ -278,7 +252,6 @@ lazy val testServer: Project = project startTestServer := (reStart in Test).toTask("").value ) -// maybe use IntegrationTest instead of Test? lazy val testServerSettings = Seq( test in Test := (test in Test).dependsOn(startTestServer in testServer).value, testOnly in Test := (testOnly in Test).dependsOn(startTestServer in testServer).evaluated, diff --git a/core/src/main/scala/com/softwaremill/sttp/MonadError.scala b/core/src/main/scala/com/softwaremill/sttp/MonadError.scala index b5b1852..a783765 100644 --- a/core/src/main/scala/com/softwaremill/sttp/MonadError.scala +++ b/core/src/main/scala/com/softwaremill/sttp/MonadError.scala @@ -31,15 +31,6 @@ trait MonadAsyncError[R[_]] extends MonadError[R] { def async[T](register: (Either[Throwable, T] => Unit) => Unit): R[T] } -object syntax { - - implicit final class MonadErrorOps[R[_], A](val r: R[A]) extends AnyVal { - def map[B](f: A => B)(implicit ME: MonadError[R]): R[B] = ME.map(r)(f) - def flatMap[B](f: A => R[B])(implicit ME: MonadError[R]): R[B] = - ME.flatMap(r)(f) - } -} - object IdMonad extends MonadError[Id] { override def unit[T](t: T): Id[T] = t override def map[T, T2](fa: Id[T])(f: (T) => T2): Id[T2] = f(fa) diff --git a/core/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala b/core/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala new file mode 100644 index 0000000..807209a --- /dev/null +++ b/core/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala @@ -0,0 +1,10 @@ +package com.softwaremill.sttp + +import com.softwaremill.sttp.testing.ConvertToFuture +import com.softwaremill.sttp.testing.HttpTest + +class HttpURLConnectionHttpTest extends HttpTest[Id] { + + override implicit val backend: SttpBackend[Id, Nothing] = HttpURLConnectionBackend() + override implicit val convertToFuture: ConvertToFuture[Id] = ConvertToFuture.id +} diff --git a/core/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala b/core/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala new file mode 100644 index 0000000..4336a0c --- /dev/null +++ b/core/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala @@ -0,0 +1,37 @@ +package com.softwaremill.sttp + +import com.softwaremill.sttp.testing.EvalScala +import org.scalatest.{FlatSpec, Matchers} + +import scala.tools.reflect.ToolBoxError + +class IllTypedTests extends FlatSpec with Matchers { + "compilation" should "fail when trying to stream using the default backend" in { + val thrown = intercept[ToolBoxError] { + EvalScala(""" + import com.softwaremill.sttp._ + + class MyStream[T]() + + implicit val sttpBackend = HttpURLConnectionBackend() + sttp.get(uri"http://example.com").response(asStream[MyStream[Byte]]).send() + """) + } + + thrown.getMessage should include( + "could not find implicit value for parameter backend: com.softwaremill.sttp.SttpBackend[R,MyStream[Byte]]" + ) + } + + "compilation" should "fail when trying to send a request without giving an URL" in { + val thrown = intercept[ToolBoxError] { + EvalScala(""" + import com.softwaremill.sttp._ + implicit val sttpBackend = HttpURLConnectionBackend() + sttp.send() + """) + } + + thrown.getMessage should include("This is a partial request, the method & url are not specified") + } +} diff --git a/core/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala b/core/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala new file mode 100644 index 0000000..aad1669 --- /dev/null +++ b/core/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala @@ -0,0 +1,12 @@ +package com.softwaremill.sttp + +import scala.util.Try + +import com.softwaremill.sttp.testing.ConvertToFuture +import com.softwaremill.sttp.testing.HttpTest + +class TryHttpURLConnectionHttpTest extends HttpTest[Try] { + + override implicit val backend: SttpBackend[Try, Nothing] = TryHttpURLConnectionBackend() + override implicit val convertToFuture: ConvertToFuture[Try] = ConvertToFuture.scalaTry +} diff --git a/core/src/test/scala/com/softwaremill/sttp/testing/EvalScala.scala b/core/src/test/scala/com/softwaremill/sttp/testing/EvalScala.scala new file mode 100644 index 0000000..255755d --- /dev/null +++ b/core/src/test/scala/com/softwaremill/sttp/testing/EvalScala.scala @@ -0,0 +1,11 @@ +package com.softwaremill.sttp.testing + +object EvalScala { + import scala.tools.reflect.ToolBox + + def apply(code: String): Any = { + val m = scala.reflect.runtime.currentMirror + val tb = m.mkToolBox() + tb.eval(tb.parse(code)) + } +} diff --git a/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala b/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala index aa0af07..27a6eda 100644 --- a/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala +++ b/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala @@ -3,16 +3,22 @@ package com.softwaremill.sttp.testing.streaming import com.softwaremill.sttp._ import com.softwaremill.sttp.testing.ForceWrapped import org.scalatest.{AsyncFreeSpec, BeforeAndAfterAll, Matchers} - import scala.language.higherKinds +import com.softwaremill.sttp.testing.ConvertToFuture + trait StreamingTest[R[_], S] extends AsyncFreeSpec with Matchers with BeforeAndAfterAll with ForceWrapped { private val endpoint = "localhost:51823" private val body = "streaming test" - val testStreamingBackend: TestStreamingBackend[R, S] - import testStreamingBackend._ + implicit def backend: SttpBackend[R, S] + + implicit def convertToFuture: ConvertToFuture[R] + + def bodyProducer(body: String): S + + def bodyConsumer(stream: S): R[String] "stream request body" in { sttp @@ -58,7 +64,7 @@ trait StreamingTest[R[_], S] extends AsyncFreeSpec with Matchers with BeforeAndA } override protected def afterAll(): Unit = { - testStreamingBackend.backend.close() + backend.close() super.afterAll() } diff --git a/core/src/test/scala/com/softwaremill/sttp/testing/streaming/TestStreamingBackend.scala b/core/src/test/scala/com/softwaremill/sttp/testing/streaming/TestStreamingBackend.scala deleted file mode 100644 index 3ea63a3..0000000 --- a/core/src/test/scala/com/softwaremill/sttp/testing/streaming/TestStreamingBackend.scala +++ /dev/null @@ -1,16 +0,0 @@ -package com.softwaremill.sttp.testing.streaming - -import com.softwaremill.sttp.SttpBackend -import com.softwaremill.sttp.testing.ConvertToFuture - -import scala.language.higherKinds - -trait TestStreamingBackend[R[_], S] { - implicit def backend: SttpBackend[R, S] - - implicit def convertToFuture: ConvertToFuture[R] - - def bodyProducer(body: String): S - - def bodyConsumer(stream: S): R[String] -} diff --git a/docs/backends/custom.rst b/docs/backends/custom.rst index 17571e1..86bfb9d 100644 --- a/docs/backends/custom.rst +++ b/docs/backends/custom.rst @@ -3,10 +3,10 @@ Custom backends, logging, metrics ================================= -It is also entirely possible to write custom backends (if doing so, please consider contributing!) or wrap an existing one. One can even write completely generic wrappers for any delegate backend, as each backend comes equipped with a monad for the response type. This brings the possibility to ``map`` and ``flatMap`` over responses. +It is also entirely possible to write custom backends (if doing so, please consider contributing!) or wrap an existing one. One can even write completely generic wrappers for any delegate backend, as each backend comes equipped with a monad for the response type. This brings the possibility to ``map`` and ``flatMap`` over responses. Possible use-cases for wrapper-backend include: - + * logging * capturing metrics * request signing (transforming the request before sending it to the delegate) @@ -60,7 +60,7 @@ Below is an example on how to implement a backend wrapper, which sends metrics f class MetricWrapper[S](delegate: SttpBackend[Future, S], metrics: MetricsServer) extends SttpBackend[Future, S] { - + override def send[T](request: Request[T, S]): Future[Response[T]] = { val start = System.currentTimeMillis() @@ -138,3 +138,26 @@ In some cases it's possible to implement a generic retry mechanism; such a mecha } Note that some backends also have built-in retry mechanisms, e.g. `akka-http `_ or `OkHttp `_ (see the builder's ``retryOnConnectionFailure`` method). + +Example new backend +-------------------------------- + +Implementing a new backend is made easy as the tests are published in the ``core`` jar file under the ``tests`` classifier. Simply add the follow dependencies to your ``build.sbt``:: + + "com.softwaremill.sttp" %% "core" % sttpVersion % "test" classifier "tests", + "com.github.pathikrit" %% "better-files" % "3.4.0" % "test", + "org.scalatest" %% "scalatest" % "3.0.5" % "test" + +Implement your backend and extend the ``HttpTest`` class:: + + import com.softwaremill.sttp.SttpBackend + import com.softwaremill.sttp.testing.{ConvertToFuture, HttpTest} + + class MyCustomBackendHttpTest extends HttpTest[Future] { + + override implicit val convertToFuture: ConvertToFuture[Future] = ConvertToFuture.future + override implicit lazy val backend: SttpBackend[Future, Nothing] = new MyCustomBackend() + + } + +You can find a more detailed example in the `sttp-vertx `_ repository. diff --git a/implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixStreamingTest.scala b/implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixStreamingTest.scala new file mode 100644 index 0000000..d00c056 --- /dev/null +++ b/implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixStreamingTest.scala @@ -0,0 +1,26 @@ +package com.softwaremill.sttp.impl.monix + +import java.nio.ByteBuffer + +import com.softwaremill.sttp.testing.ConvertToFuture +import com.softwaremill.sttp.testing.streaming.StreamingTest +import monix.eval.Task +import monix.reactive.Observable + +abstract class MonixStreamingTest extends StreamingTest[Task, Observable[ByteBuffer]] { + + override implicit val convertToFuture: ConvertToFuture[Task] = convertMonixTaskToFuture + + override def bodyProducer(body: String): Observable[ByteBuffer] = + Observable + .fromIterable( + body.getBytes("utf-8") + ) + .map(v => ByteBuffer.wrap(Array(v))) + + override def bodyConsumer(stream: Observable[ByteBuffer]): Task[String] = + stream + .flatMap(v => Observable.fromIterable(v.array())) + .toListL + .map(bs => new String(bs.toArray, "utf8")) +} diff --git a/implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixTestStreamingBackend.scala b/implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixTestStreamingBackend.scala deleted file mode 100644 index f1b262b..0000000 --- a/implementations/monix/src/test/scala/com/softwaremill/sttp/impl/monix/MonixTestStreamingBackend.scala +++ /dev/null @@ -1,28 +0,0 @@ -package com.softwaremill.sttp.impl.monix - -import com.softwaremill.sttp.testing.ConvertToFuture -import com.softwaremill.sttp.testing.streaming.TestStreamingBackend -import monix.eval.Task -import monix.reactive.Observable - -trait MonixTestStreamingBackend[T] extends TestStreamingBackend[Task, Observable[T]] { - - def toByteArray(v: T): Array[Byte] - def fromByteArray(v: Array[Byte]): T - - override implicit def convertToFuture: ConvertToFuture[Task] = convertMonixTaskToFuture - - override def bodyProducer(body: String): Observable[T] = - Observable - .fromIterable( - body.getBytes("utf-8") - ) - .map(v => fromByteArray(Array(v))) - - override def bodyConsumer(stream: Observable[T]): Task[String] = - stream - .flatMap(v => Observable.fromIterable(toByteArray(v))) - .toListL - .map(bs => new String(bs.toArray, "utf8")) - -} diff --git a/okhttp-backend/monix/src/test/scala/com/softwaremill/sttp/okhttp/monix/OkHttpMonixStreamingTest.scala b/okhttp-backend/monix/src/test/scala/com/softwaremill/sttp/okhttp/monix/OkHttpMonixStreamingTest.scala index af9ea9c..dd08214 100644 --- a/okhttp-backend/monix/src/test/scala/com/softwaremill/sttp/okhttp/monix/OkHttpMonixStreamingTest.scala +++ b/okhttp-backend/monix/src/test/scala/com/softwaremill/sttp/okhttp/monix/OkHttpMonixStreamingTest.scala @@ -3,24 +3,11 @@ package com.softwaremill.sttp.okhttp.monix import java.nio.ByteBuffer import com.softwaremill.sttp.SttpBackend -import com.softwaremill.sttp.impl.monix.MonixTestStreamingBackend -import com.softwaremill.sttp.testing.streaming.{StreamingTest, TestStreamingBackend} +import com.softwaremill.sttp.impl.monix.MonixStreamingTest import monix.eval.Task import monix.reactive.Observable -class OkHttpMonixStreamingTest extends StreamingTest[Task, Observable[ByteBuffer]] { +class OkHttpMonixStreamingTest extends MonixStreamingTest { - override val testStreamingBackend: TestStreamingBackend[Task, Observable[ByteBuffer]] = - new OkHttpMonixTestStreamingBackend -} - -class OkHttpMonixTestStreamingBackend extends MonixTestStreamingBackend[ByteBuffer] { - - import monix.execution.Scheduler.Implicits.global - - override def toByteArray(v: ByteBuffer): Array[Byte] = v.array() - override def fromByteArray(v: Array[Byte]): ByteBuffer = ByteBuffer.wrap(v) - - override implicit val backend: SttpBackend[Task, Observable[ByteBuffer]] = - OkHttpMonixBackend() + override implicit val backend: SttpBackend[Task, Observable[ByteBuffer]] = OkHttpMonixBackend() } diff --git a/tests/src/test/resources/binaryfile.jpg b/tests/src/test/resources/binaryfile.jpg deleted file mode 100644 index b9f5c5a..0000000 Binary files a/tests/src/test/resources/binaryfile.jpg and /dev/null differ diff --git a/tests/src/test/resources/logback.xml b/tests/src/test/resources/logback.xml deleted file mode 100644 index 1470b51..0000000 --- a/tests/src/test/resources/logback.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n - - - - - - - diff --git a/tests/src/test/resources/textfile.txt b/tests/src/test/resources/textfile.txt deleted file mode 100644 index 9904f90..0000000 --- a/tests/src/test/resources/textfile.txt +++ /dev/null @@ -1,100 +0,0 @@ -- Lorem ipsum dolor sit amet -- Vivamus sem ipsum. -- Ut molestie. -- Donec. -- Fusce non porta. -- Nulla ac metus. Morbi mattis. -- Etiam varius. -- Nulla. -- Phasellus id mollis. -- Suspendisse at. -- Quisque nec leo velit. -- Fusce. -- Maecenas nec tristique senectus et. -- Integer vestibulum lorem fermentum. -- Vestibulum consectetuer dolor. -- Lorem ipsum in. -- Fusce condimentum auctor scelerisque, wisi. -- Quisque. -- Curae. -- Curae, Nullam. -- Curae, Integer. -- Vestibulum dignissim massa. Donec. -- Pellentesque sed sem. -- Vivamus est. -- Maecenas elit sed est. -- Quisque sed tellus. -- Cum sociis natoque penatibus et. -- Fusce aliquam. -- Donec. -- Sed elementum, sapien accumsan odio. -- Nam mattis, magna lectus, tincidunt. -- Pellentesque scelerisque a, sodales. -- Sed sed condimentum. -- Curae, In nonummy. Phasellus adipiscing. -- Vestibulum quis diam mollis. -- Sed eros. Duis ipsum. -- Aenean pellentesque at, mollis tempus. -- Cras ornare facilisis sodales. Aenean. -- Cum sociis natoque penatibus. -- Donec id nulla. -- Quisque ut sapien. -- Phasellus purus. Proin ultricies. -- Aliquam auctor neque. Nunc. -- Nam nunc fringilla non, vehicula. -- Morbi molestie, felis ut lobortis. -- Nulla quis. -- In. -- Phasellus laoreet urna. -- Lorem ipsum. -- Phasellus. -- Class aptent taciti sociosqu ad. -- Sed lacinia. -- Pellentesque dapibus diam. Duis. -- Suspendisse est. Curabitur. -- Fusce condimentum justo. -- Aenean congue quis, faucibus. -- Ut pharetra leo. Donec. -- Fusce. -- Donec porta. -- Pellentesque orci. -- Sed. -- Quisque rutrum, wisi vulputate wisi. -- Cum sociis. -- Cras. -- Sed eros. Curabitur. -- Proin in velit wisi, tempor. -- Quisque eu. -- Proin. -- Nam pellentesque sed, imperdiet aliquam. -- Mauris euismod. Sed euismod orci. -- Etiam. -- Donec. -- Fusce wisi a metus. Proin. -- Phasellus quis. -- Donec non imperdiet. -- Aenean vel bibendum a, laoreet. -- Fusce non enim. Phasellus vulputate. -- Donec urna elit, sit. -- Pellentesque habitant morbi. -- Nulla ante. Curabitur elit. Donec. -- Cum sociis natoque penatibus. -- Maecenas eget leo at. -- Cum sociis natoque penatibus et. -- Vivamus lacus. -- Integer. -- Curae. -- Maecenas rhoncus. Morbi. -- Aenean posuere. -- Duis. -- Suspendisse a odio fermentum libero. -- Nam enim. Fusce enim. In. -- Maecenas. -- Lorem ipsum primis. -- Curabitur ac turpis semper sed. -- Quisque condimentum. Donec sit. -- Integer convallis non, posuere. -- Etiam vulputate, odio. -- Proin id lorem. Donec quis. -- Curae, Sed nec augue. -- Aliquam ut turpis. \ No newline at end of file diff --git a/tests/src/test/scala/com/softwaremill/sttp/EvalScala.scala b/tests/src/test/scala/com/softwaremill/sttp/EvalScala.scala deleted file mode 100644 index bac1537..0000000 --- a/tests/src/test/scala/com/softwaremill/sttp/EvalScala.scala +++ /dev/null @@ -1,11 +0,0 @@ -package com.softwaremill.sttp - -object EvalScala { - import scala.tools.reflect.ToolBox - - def apply(code: String): Any = { - val m = scala.reflect.runtime.currentMirror - val tb = m.mkToolBox() - tb.eval(tb.parse(code)) - } -} diff --git a/tests/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala b/tests/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala deleted file mode 100644 index 599913f..0000000 --- a/tests/src/test/scala/com/softwaremill/sttp/HttpURLConnectionHttpTest.scala +++ /dev/null @@ -1,9 +0,0 @@ -package com.softwaremill.sttp - -import com.softwaremill.sttp.testing.{ConvertToFuture, HttpTest} - -class HttpURLConnectionHttpTest extends HttpTest[Id] { - - override implicit val backend: SttpBackend[Id, Nothing] = HttpURLConnectionBackend() - override implicit val convertToFuture: ConvertToFuture[Id] = ConvertToFuture.id -} diff --git a/tests/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala b/tests/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala deleted file mode 100644 index 881c60e..0000000 --- a/tests/src/test/scala/com/softwaremill/sttp/IllTypedTests.scala +++ /dev/null @@ -1,34 +0,0 @@ -package com.softwaremill.sttp - -import org.scalatest.{FlatSpec, Matchers} - -import scala.tools.reflect.ToolBoxError - -class IllTypedTests extends FlatSpec with Matchers { - "compilation" should "fail when trying to stream using the default backend" in { - val thrown = intercept[ToolBoxError] { - EvalScala(""" - import com.softwaremill.sttp._ - import akka.stream.scaladsl.Source - import akka.util.ByteString - implicit val sttpBackend = HttpURLConnectionBackend() - sttp.get(uri"http://example.com").response(asStream[Source[ByteString, Any]]).send() - """) - } - - thrown.getMessage should include( - "could not find implicit value for parameter backend: com.softwaremill.sttp.SttpBackend[R,akka.stream.scaladsl.Source[akka.util.ByteString,Any]]") - } - - "compilation" should "fail when trying to send a request without giving an URL" in { - val thrown = intercept[ToolBoxError] { - EvalScala(""" - import com.softwaremill.sttp._ - implicit val sttpBackend = HttpURLConnectionBackend() - sttp.send() - """) - } - - thrown.getMessage should include("This is a partial request, the method & url are not specified") - } -} diff --git a/tests/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala b/tests/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala deleted file mode 100644 index 19b48fd..0000000 --- a/tests/src/test/scala/com/softwaremill/sttp/TryHttpURLConnectionHttpTest.scala +++ /dev/null @@ -1,11 +0,0 @@ -package com.softwaremill.sttp - -import com.softwaremill.sttp.testing.{ConvertToFuture, HttpTest} - -import scala.util.Try - -class TryHttpURLConnectionHttpTest extends HttpTest[Try] { - - override implicit val backend: SttpBackend[Try, Nothing] = TryHttpURLConnectionBackend() - override implicit val convertToFuture: ConvertToFuture[Try] = ConvertToFuture.scalaTry -} -- cgit v1.2.3 From ccb1afe90e938fc2b8619dd960a1df1937f212be Mon Sep 17 00:00:00 2001 From: Sam Guymer Date: Mon, 21 May 2018 20:54:10 +1000 Subject: Code review updates Start the test server before each backend test --- build.sbt | 36 +--- core/src/test/resources/binaryfile.jpg | Bin 0 -> 42010 bytes core/src/test/resources/textfile.txt | 100 +++++++++ .../com/softwaremill/sttp/testing/HttpTest.scala | 40 ++-- .../softwaremill/sttp/testing/TestHttpServer.scala | 236 +++++++++++++++++++++ .../sttp/testing/streaming/StreamingTest.scala | 9 +- docs/backends/custom.rst | 2 + project/PollingUtils.scala | 45 ---- project/plugins.sbt | 5 +- test-server/src/main/resources/binaryfile.jpg | Bin 42010 -> 0 bytes test-server/src/main/resources/textfile.txt | 100 --------- .../softwaremill/sttp/server/TestHttpServer.scala | 197 ----------------- 12 files changed, 368 insertions(+), 402 deletions(-) create mode 100644 core/src/test/resources/binaryfile.jpg create mode 100644 core/src/test/resources/textfile.txt create mode 100644 core/src/test/scala/com/softwaremill/sttp/testing/TestHttpServer.scala delete mode 100644 project/PollingUtils.scala delete mode 100644 test-server/src/main/resources/binaryfile.jpg delete mode 100644 test-server/src/main/resources/textfile.txt delete mode 100644 test-server/src/main/scala/com/softwaremill/sttp/server/TestHttpServer.scala (limited to 'build.sbt') diff --git a/build.sbt b/build.sbt index 6bcaf1a..2acfbf6 100644 --- a/build.sbt +++ b/build.sbt @@ -34,9 +34,6 @@ val akkaStreams = "com.typesafe.akka" %% "akka-stream" % "2.5.12" val scalaTest = "org.scalatest" %% "scalatest" % "3.0.5" -val testServerPort = settingKey[Int]("Port to run the http test server on") -val startTestServer = taskKey[Unit]("Start a http server used by tests") - lazy val rootProject = (project in file(".")) .settings(commonSettings: _*) .settings(skip in publish := true, name := "sttp") @@ -57,18 +54,18 @@ lazy val rootProject = (project in file(".")) circe, json4s, braveBackend, - prometheusBackend, - testServer + prometheusBackend ) lazy val core: Project = (project in file("core")) .settings(commonSettings: _*) - .settings(testServerSettings: _*) .settings( name := "core", libraryDependencies ++= Seq( "com.github.pathikrit" %% "better-files" % "3.4.0" % "test", "org.scala-lang" % "scala-compiler" % scalaVersion.value % "test", + akkaHttp % "test", + akkaStreams % "test", scalaTest % "test" ), publishArtifact in Test := true // allow implementations outside of this repo @@ -106,7 +103,6 @@ lazy val scalaz: Project = (project in file("implementations/scalaz")) //-- akka lazy val akkaHttpBackend: Project = (project in file("akka-http-backend")) .settings(commonSettings: _*) - .settings(testServerSettings: _*) .settings( name := "akka-http-backend", libraryDependencies ++= Seq( @@ -122,7 +118,6 @@ lazy val akkaHttpBackend: Project = (project in file("akka-http-backend")) lazy val asyncHttpClientBackend: Project = { (project in file("async-http-client-backend")) .settings(commonSettings: _*) - .settings(testServerSettings: _*) .settings( name := "async-http-client-backend", libraryDependencies ++= Seq( @@ -135,7 +130,6 @@ lazy val asyncHttpClientBackend: Project = { def asyncHttpClientBackendProject(proj: String): Project = { Project(s"asyncHttpClientBackend${proj.capitalize}", file(s"async-http-client-backend/$proj")) .settings(commonSettings: _*) - .settings(testServerSettings: _*) .settings(name := s"async-http-client-backend-$proj") .dependsOn(asyncHttpClientBackend) } @@ -168,7 +162,6 @@ lazy val asyncHttpClientFs2Backend: Project = //-- okhttp lazy val okhttpBackend: Project = (project in file("okhttp-backend")) .settings(commonSettings: _*) - .settings(testServerSettings: _*) .settings( name := "okhttp-backend", libraryDependencies ++= Seq( @@ -180,7 +173,6 @@ lazy val okhttpBackend: Project = (project in file("okhttp-backend")) def okhttpBackendProject(proj: String): Project = { Project(s"okhttpBackend${proj.capitalize}", file(s"okhttp-backend/$proj")) .settings(commonSettings: _*) - .settings(testServerSettings: _*) .settings(name := s"okhttp-backend-$proj") .dependsOn(okhttpBackend) } @@ -238,25 +230,3 @@ lazy val prometheusBackend: Project = (project in file("metrics/prometheus-backe ) ) .dependsOn(core) - -// https://stackoverflow.com/questions/25766797/how-do-i-start-a-server-before-running-a-test-suite-in-sbt -lazy val testServer: Project = project - .in(file("test-server")) - .settings(commonSettings: _*) - .settings( - name := "test-server", - libraryDependencies ++= Seq(akkaHttp, akkaStreams), - mainClass in reStart := Some("com.softwaremill.sttp.server.TestHttpServer"), - reStartArgs := Seq(s"${testServerPort.value}"), - testServerPort := 51823, - startTestServer := (reStart in Test).toTask("").value - ) - -lazy val testServerSettings = Seq( - test in Test := (test in Test).dependsOn(startTestServer in testServer).value, - testOnly in Test := (testOnly in Test).dependsOn(startTestServer in testServer).evaluated, - testOptions in Test += Tests.Setup(() => { - val port = (testServerPort in testServer).value - PollingUtils.waitUntilServerAvailable(new URL(s"http://localhost:$port")) - }) -) diff --git a/core/src/test/resources/binaryfile.jpg b/core/src/test/resources/binaryfile.jpg new file mode 100644 index 0000000..b9f5c5a Binary files /dev/null and b/core/src/test/resources/binaryfile.jpg differ diff --git a/core/src/test/resources/textfile.txt b/core/src/test/resources/textfile.txt new file mode 100644 index 0000000..9904f90 --- /dev/null +++ b/core/src/test/resources/textfile.txt @@ -0,0 +1,100 @@ +- Lorem ipsum dolor sit amet +- Vivamus sem ipsum. +- Ut molestie. +- Donec. +- Fusce non porta. +- Nulla ac metus. Morbi mattis. +- Etiam varius. +- Nulla. +- Phasellus id mollis. +- Suspendisse at. +- Quisque nec leo velit. +- Fusce. +- Maecenas nec tristique senectus et. +- Integer vestibulum lorem fermentum. +- Vestibulum consectetuer dolor. +- Lorem ipsum in. +- Fusce condimentum auctor scelerisque, wisi. +- Quisque. +- Curae. +- Curae, Nullam. +- Curae, Integer. +- Vestibulum dignissim massa. Donec. +- Pellentesque sed sem. +- Vivamus est. +- Maecenas elit sed est. +- Quisque sed tellus. +- Cum sociis natoque penatibus et. +- Fusce aliquam. +- Donec. +- Sed elementum, sapien accumsan odio. +- Nam mattis, magna lectus, tincidunt. +- Pellentesque scelerisque a, sodales. +- Sed sed condimentum. +- Curae, In nonummy. Phasellus adipiscing. +- Vestibulum quis diam mollis. +- Sed eros. Duis ipsum. +- Aenean pellentesque at, mollis tempus. +- Cras ornare facilisis sodales. Aenean. +- Cum sociis natoque penatibus. +- Donec id nulla. +- Quisque ut sapien. +- Phasellus purus. Proin ultricies. +- Aliquam auctor neque. Nunc. +- Nam nunc fringilla non, vehicula. +- Morbi molestie, felis ut lobortis. +- Nulla quis. +- In. +- Phasellus laoreet urna. +- Lorem ipsum. +- Phasellus. +- Class aptent taciti sociosqu ad. +- Sed lacinia. +- Pellentesque dapibus diam. Duis. +- Suspendisse est. Curabitur. +- Fusce condimentum justo. +- Aenean congue quis, faucibus. +- Ut pharetra leo. Donec. +- Fusce. +- Donec porta. +- Pellentesque orci. +- Sed. +- Quisque rutrum, wisi vulputate wisi. +- Cum sociis. +- Cras. +- Sed eros. Curabitur. +- Proin in velit wisi, tempor. +- Quisque eu. +- Proin. +- Nam pellentesque sed, imperdiet aliquam. +- Mauris euismod. Sed euismod orci. +- Etiam. +- Donec. +- Fusce wisi a metus. Proin. +- Phasellus quis. +- Donec non imperdiet. +- Aenean vel bibendum a, laoreet. +- Fusce non enim. Phasellus vulputate. +- Donec urna elit, sit. +- Pellentesque habitant morbi. +- Nulla ante. Curabitur elit. Donec. +- Cum sociis natoque penatibus. +- Maecenas eget leo at. +- Cum sociis natoque penatibus et. +- Vivamus lacus. +- Integer. +- Curae. +- Maecenas rhoncus. Morbi. +- Aenean posuere. +- Duis. +- Suspendisse a odio fermentum libero. +- Nam enim. Fusce enim. In. +- Maecenas. +- Lorem ipsum primis. +- Curabitur ac turpis semper sed. +- Quisque condimentum. Donec sit. +- Integer convallis non, posuere. +- Etiam vulputate, odio. +- Proin id lorem. Donec quis. +- Curae, Sed nec augue. +- Aliquam ut turpis. \ No newline at end of file diff --git a/core/src/test/scala/com/softwaremill/sttp/testing/HttpTest.scala b/core/src/test/scala/com/softwaremill/sttp/testing/HttpTest.scala index f1fa002..5598aa2 100644 --- a/core/src/test/scala/com/softwaremill/sttp/testing/HttpTest.scala +++ b/core/src/test/scala/com/softwaremill/sttp/testing/HttpTest.scala @@ -22,26 +22,23 @@ trait HttpTest[R[_]] with OptionValues with IntegrationPatience with BeforeAndAfterEach - with BeforeAndAfterAll { - - private val endpoint = "localhost:51823" + with BeforeAndAfterAll + with TestHttpServer { override def afterEach() { val file = File(outPath) if (file.exists) file.delete() } - private val textFile = - new java.io.File("test-server/src/main/resources/textfile.txt") - private val binaryFile = - new java.io.File("test-server/src/main/resources/binaryfile.jpg") + private val textFile = new java.io.File(getClass.getResource("/textfile.txt").getFile) + private val binaryFile = new java.io.File(getClass.getResource("/binaryfile.jpg").getFile) private val outPath = File.newTemporaryDirectory().path private val textWithSpecialCharacters = "Żółć!" implicit val backend: SttpBackend[R, Nothing] implicit val convertToFuture: ConvertToFuture[R] - private val postEcho = sttp.post(uri"$endpoint/echo") + private def postEcho = sttp.post(uri"$endpoint/echo") private val testBody = "this is the body" private val testBodyBytes = testBody.getBytes("UTF-8") private val expectedPostEchoResponse = "POST /echo this is the body" @@ -172,7 +169,7 @@ trait HttpTest[R[_]] } "headers" - { - val getHeaders = sttp.get(uri"$endpoint/set_headers") + def getHeaders = sttp.get(uri"$endpoint/set_headers") "read response headers" in { val response = getHeaders.response(sttpIgnore).send().force() @@ -187,7 +184,7 @@ trait HttpTest[R[_]] } "errors" - { - val getHeaders = sttp.post(uri"$endpoint/set_headers") + def getHeaders = sttp.post(uri"$endpoint/set_headers") "return 405 when method not allowed" in { val response = getHeaders.response(sttpIgnore).send().force() @@ -236,7 +233,7 @@ trait HttpTest[R[_]] } "auth" - { - val secureBasic = sttp.get(uri"$endpoint/secure_basic") + def secureBasic = sttp.get(uri"$endpoint/secure_basic") "return a 401 when authorization fails" in { val req = secureBasic @@ -254,7 +251,7 @@ trait HttpTest[R[_]] } "compression" - { - val compress = sttp.get(uri"$endpoint/compress") + def compress = sttp.get(uri"$endpoint/compress") val decompressedBody = "I'm compressed!" "decompress using the default accept encoding header" in { @@ -374,7 +371,7 @@ trait HttpTest[R[_]] } "multipart" - { - val mp = sttp.post(uri"$endpoint/multipart") + def mp = sttp.post(uri"$endpoint/multipart") "send a multipart message" in { val req = mp.multipartBody(multipart("p1", "v1"), multipart("p2", "v2")) @@ -400,11 +397,11 @@ trait HttpTest[R[_]] } "redirect" - { - val r1 = sttp.post(uri"$endpoint/redirect/r1") - val r2 = sttp.post(uri"$endpoint/redirect/r2") - val r3 = sttp.post(uri"$endpoint/redirect/r3") + def r1 = sttp.post(uri"$endpoint/redirect/r1") + def r2 = sttp.post(uri"$endpoint/redirect/r2") + def r3 = sttp.post(uri"$endpoint/redirect/r3") val r4response = "819" - val loop = sttp.post(uri"$endpoint/redirect/loop") + def loop = sttp.post(uri"$endpoint/redirect/loop") "not redirect when redirects shouldn't be followed (temporary)" in { val resp = r1.followRedirects(false).send().force() @@ -499,10 +496,11 @@ trait HttpTest[R[_]] } "empty response" - { - val postEmptyResponse = sttp - .post(uri"$endpoint/empty_unauthorized_response") - .body("{}") - .contentType("application/json") + def postEmptyResponse = + sttp + .post(uri"$endpoint/empty_unauthorized_response") + .body("{}") + .contentType("application/json") "parse an empty error response as empty string" in { val response = postEmptyResponse.send().force() diff --git a/core/src/test/scala/com/softwaremill/sttp/testing/TestHttpServer.scala b/core/src/test/scala/com/softwaremill/sttp/testing/TestHttpServer.scala new file mode 100644 index 0000000..11fc692 --- /dev/null +++ b/core/src/test/scala/com/softwaremill/sttp/testing/TestHttpServer.scala @@ -0,0 +1,236 @@ +package com.softwaremill.sttp.testing + +import akka.Done +import akka.actor.ActorSystem +import akka.http.scaladsl.Http +import akka.http.scaladsl.coding.{Deflate, Gzip, NoCoding} +import akka.http.scaladsl.model._ +import akka.http.scaladsl.model.headers.CacheDirectives._ +import akka.http.scaladsl.model.headers._ +import akka.http.scaladsl.server.Directives.{entity, path, _} +import akka.http.scaladsl.server.Route +import akka.http.scaladsl.server.directives.Credentials +import akka.stream.ActorMaterializer +import akka.util.ByteString +import scala.concurrent.duration._ +import scala.concurrent.{Await, Future} + +import org.scalatest.BeforeAndAfterAll +import org.scalatest.Suite + +trait TestHttpServer extends BeforeAndAfterAll { this: Suite => + + private val server = new HttpServer(0) + protected var endpoint = "localhost:51823" + + override protected def beforeAll(): Unit = { + import scala.concurrent.ExecutionContext.Implicits.global + + super.beforeAll() + Await.result( + server.start().map { binding => + endpoint = s"localhost:${binding.localAddress.getPort}" + }, + 10.seconds + ) + } + + override protected def afterAll(): Unit = { + server.close() + super.afterAll() + } + +} + +object HttpServer { + + def main(args: Array[String]): Unit = { + val port = args.headOption.map(_.toInt).getOrElse(51823) + + Await.result(new HttpServer(port).start(), 10.seconds) + } +} + +private class HttpServer(port: Int) extends AutoCloseable { + + import scala.concurrent.ExecutionContext.Implicits.global + + private var server: Option[Future[Http.ServerBinding]] = None + + private implicit val actorSystem: ActorSystem = ActorSystem("sttp-test-server") + private implicit val materializer: ActorMaterializer = ActorMaterializer() + + private def paramsToString(m: Map[String, String]): String = + m.toList.sortBy(_._1).map(p => s"${p._1}=${p._2}").mkString(" ") + + private val textFile = new java.io.File(getClass.getResource("/textfile.txt").getFile) + private val binaryFile = new java.io.File(getClass.getResource("/binaryfile.jpg").getFile) + private val textWithSpecialCharacters = "Żółć!" + + val serverRoutes: Route = + pathPrefix("echo") { + pathPrefix("form_params") { + formFieldMap { params => + path("as_string") { + complete(paramsToString(params)) + } ~ + path("as_params") { + complete(FormData(params)) + } + } + } ~ get { + parameterMap { params => + complete(List("GET", "/echo", paramsToString(params)) + .filter(_.nonEmpty) + .mkString(" ")) + } + } ~ + post { + parameterMap { params => + entity(as[String]) { body: String => + complete(List("POST", "/echo", paramsToString(params), body) + .filter(_.nonEmpty) + .mkString(" ")) + } + } + } + } ~ pathPrefix("streaming") { + path("echo") { + post { + parameterMap { _ => + entity(as[String]) { body: String => + complete(body) + } + } + } + } + } ~ path("set_headers") { + get { + respondWithHeader(`Cache-Control`(`max-age`(1000L))) { + respondWithHeader(`Cache-Control`(`no-cache`)) { + complete("ok") + } + } + } + } ~ pathPrefix("set_cookies") { + path("with_expires") { + setCookie(HttpCookie("c", "v", expires = Some(DateTime(1997, 12, 8, 12, 49, 12)))) { + complete("ok") + } + } ~ get { + setCookie( + HttpCookie( + "cookie1", + "value1", + secure = true, + httpOnly = true, + maxAge = Some(123L) + ) + ) { + setCookie(HttpCookie("cookie2", "value2")) { + setCookie( + HttpCookie( + "cookie3", + "", + domain = Some("xyz"), + path = Some("a/b/c") + ) + ) { + complete("ok") + } + } + } + } + } ~ path("secure_basic") { + authenticateBasic("test realm", { + case c @ Credentials.Provided(un) if un == "adam" && c.verify("1234") => + Some(un) + case _ => None + }) { userName => + complete(s"Hello, $userName!") + } + } ~ path("compress") { + encodeResponseWith(Gzip, Deflate, NoCoding) { + complete("I'm compressed!") + } + } ~ pathPrefix("download") { + path("binary") { + getFromFile(binaryFile) + } ~ path("text") { + getFromFile(textFile) + } + } ~ pathPrefix("multipart") { + entity(as[akka.http.scaladsl.model.Multipart.FormData]) { fd => + complete { + fd.parts + .mapAsync(1) { p => + val fv = p.entity.dataBytes.runFold(ByteString())(_ ++ _) + fv.map(_.utf8String) + .map(v => p.name + "=" + v + p.filename.fold("")(fn => s" ($fn)")) + } + .runFold(Vector.empty[String])(_ :+ _) + .map(v => v.mkString(", ")) + } + } + } ~ pathPrefix("redirect") { + path("r1") { + redirect("/redirect/r2", StatusCodes.TemporaryRedirect) + } ~ + path("r2") { + redirect("/redirect/r3", StatusCodes.PermanentRedirect) + } ~ + path("r3") { + redirect("/redirect/r4", StatusCodes.Found) + } ~ + path("r4") { + complete("819") + } ~ + path("loop") { + redirect("/redirect/loop", StatusCodes.Found) + } + } ~ pathPrefix("timeout") { + complete { + akka.pattern.after(1.second, using = actorSystem.scheduler)( + Future.successful("Done") + ) + } + } ~ path("empty_unauthorized_response") { + post { + import akka.http.scaladsl.model._ + complete( + HttpResponse( + status = StatusCodes.Unauthorized, + headers = Nil, + entity = HttpEntity.Empty, + protocol = HttpProtocols.`HTTP/1.1` + )) + } + } ~ path("respond_with_iso_8859_2") { + get { ctx => + val entity = + HttpEntity(MediaTypes.`text/plain`.withCharset(HttpCharset.custom("ISO-8859-2")), textWithSpecialCharacters) + ctx.complete(HttpResponse(200, entity = entity)) + } + } + + def start(): Future[Http.ServerBinding] = { + unbindServer().flatMap { _ => + val server = Http().bindAndHandle(serverRoutes, "localhost", port) + this.server = Some(server) + server + } + } + + def close(): Unit = { + val unbind = unbindServer() + unbind.onComplete(_ => actorSystem.terminate()) + Await.result( + unbind, + 10.seconds + ) + } + + private def unbindServer(): Future[Done] = { + server.map(_.flatMap(_.unbind())).getOrElse(Future.successful(Done)) + } +} diff --git a/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala b/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala index 27a6eda..40aaf82 100644 --- a/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala +++ b/core/src/test/scala/com/softwaremill/sttp/testing/streaming/StreamingTest.scala @@ -6,10 +6,15 @@ import org.scalatest.{AsyncFreeSpec, BeforeAndAfterAll, Matchers} import scala.language.higherKinds import com.softwaremill.sttp.testing.ConvertToFuture +import com.softwaremill.sttp.testing.TestHttpServer -trait StreamingTest[R[_], S] extends AsyncFreeSpec with Matchers with BeforeAndAfterAll with ForceWrapped { +trait StreamingTest[R[_], S] + extends AsyncFreeSpec + with Matchers + with ForceWrapped + with BeforeAndAfterAll + with TestHttpServer { - private val endpoint = "localhost:51823" private val body = "streaming test" implicit def backend: SttpBackend[R, S] diff --git a/docs/backends/custom.rst b/docs/backends/custom.rst index 86bfb9d..c36b1d2 100644 --- a/docs/backends/custom.rst +++ b/docs/backends/custom.rst @@ -146,6 +146,8 @@ Implementing a new backend is made easy as the tests are published in the ``core "com.softwaremill.sttp" %% "core" % sttpVersion % "test" classifier "tests", "com.github.pathikrit" %% "better-files" % "3.4.0" % "test", + "com.typesafe.akka" %% "akka-http" % "10.1.1" % "test", + "com.typesafe.akka" %% "akka-stream" % "2.5.12" % "test", "org.scalatest" %% "scalatest" % "3.0.5" % "test" Implement your backend and extend the ``HttpTest`` class:: diff --git a/project/PollingUtils.scala b/project/PollingUtils.scala deleted file mode 100644 index 34b92ac..0000000 --- a/project/PollingUtils.scala +++ /dev/null @@ -1,45 +0,0 @@ -import java.io.FileNotFoundException -import java.net.{ConnectException, URL} - -import scala.concurrent.TimeoutException -import scala.concurrent.duration._ - -object PollingUtils { - - def waitUntilServerAvailable(url: URL): Unit = { - val connected = poll(5.seconds, 250.milliseconds)({ - urlConnectionAvailable(url) - }) - if (!connected) { - throw new TimeoutException(s"Failed to connect to $url") - } - } - - def poll(timeout: FiniteDuration, interval: FiniteDuration)(poll: => Boolean): Boolean = { - val start = System.nanoTime() - - def go(): Boolean = { - if (poll) { - true - } else if ((System.nanoTime() - start) > timeout.toNanos) { - false - } else { - Thread.sleep(interval.toMillis) - go() - } - } - go() - } - - def urlConnectionAvailable(url: URL): Boolean = { - try { - url.openConnection() - .getInputStream - .close() - true - } catch { - case _: ConnectException => false - case _: FileNotFoundException => true // on 404 - } - } -} diff --git a/project/plugins.sbt b/project/plugins.sbt index b334460..fa55342 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,5 +1,4 @@ -// using '-coursier' because of https://github.com/lucidsoftware/neo-sbt-scalafmt/issues/64 -addSbtPlugin("com.lucidchart" % "sbt-scalafmt-coursier" % "1.15") +addSbtPlugin("com.lucidchart" % "sbt-scalafmt" % "1.15") addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "2.0") @@ -8,5 +7,3 @@ addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.0") addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.7") addSbtPlugin("com.updateimpact" % "updateimpact-sbt-plugin" % "2.1.3") - -addSbtPlugin("io.spray" % "sbt-revolver" % "0.9.1") diff --git a/test-server/src/main/resources/binaryfile.jpg b/test-server/src/main/resources/binaryfile.jpg deleted file mode 100644 index b9f5c5a..0000000 Binary files a/test-server/src/main/resources/binaryfile.jpg and /dev/null differ diff --git a/test-server/src/main/resources/textfile.txt b/test-server/src/main/resources/textfile.txt deleted file mode 100644 index 9904f90..0000000 --- a/test-server/src/main/resources/textfile.txt +++ /dev/null @@ -1,100 +0,0 @@ -- Lorem ipsum dolor sit amet -- Vivamus sem ipsum. -- Ut molestie. -- Donec. -- Fusce non porta. -- Nulla ac metus. Morbi mattis. -- Etiam varius. -- Nulla. -- Phasellus id mollis. -- Suspendisse at. -- Quisque nec leo velit. -- Fusce. -- Maecenas nec tristique senectus et. -- Integer vestibulum lorem fermentum. -- Vestibulum consectetuer dolor. -- Lorem ipsum in. -- Fusce condimentum auctor scelerisque, wisi. -- Quisque. -- Curae. -- Curae, Nullam. -- Curae, Integer. -- Vestibulum dignissim massa. Donec. -- Pellentesque sed sem. -- Vivamus est. -- Maecenas elit sed est. -- Quisque sed tellus. -- Cum sociis natoque penatibus et. -- Fusce aliquam. -- Donec. -- Sed elementum, sapien accumsan odio. -- Nam mattis, magna lectus, tincidunt. -- Pellentesque scelerisque a, sodales. -- Sed sed condimentum. -- Curae, In nonummy. Phasellus adipiscing. -- Vestibulum quis diam mollis. -- Sed eros. Duis ipsum. -- Aenean pellentesque at, mollis tempus. -- Cras ornare facilisis sodales. Aenean. -- Cum sociis natoque penatibus. -- Donec id nulla. -- Quisque ut sapien. -- Phasellus purus. Proin ultricies. -- Aliquam auctor neque. Nunc. -- Nam nunc fringilla non, vehicula. -- Morbi molestie, felis ut lobortis. -- Nulla quis. -- In. -- Phasellus laoreet urna. -- Lorem ipsum. -- Phasellus. -- Class aptent taciti sociosqu ad. -- Sed lacinia. -- Pellentesque dapibus diam. Duis. -- Suspendisse est. Curabitur. -- Fusce condimentum justo. -- Aenean congue quis, faucibus. -- Ut pharetra leo. Donec. -- Fusce. -- Donec porta. -- Pellentesque orci. -- Sed. -- Quisque rutrum, wisi vulputate wisi. -- Cum sociis. -- Cras. -- Sed eros. Curabitur. -- Proin in velit wisi, tempor. -- Quisque eu. -- Proin. -- Nam pellentesque sed, imperdiet aliquam. -- Mauris euismod. Sed euismod orci. -- Etiam. -- Donec. -- Fusce wisi a metus. Proin. -- Phasellus quis. -- Donec non imperdiet. -- Aenean vel bibendum a, laoreet. -- Fusce non enim. Phasellus vulputate. -- Donec urna elit, sit. -- Pellentesque habitant morbi. -- Nulla ante. Curabitur elit. Donec. -- Cum sociis natoque penatibus. -- Maecenas eget leo at. -- Cum sociis natoque penatibus et. -- Vivamus lacus. -- Integer. -- Curae. -- Maecenas rhoncus. Morbi. -- Aenean posuere. -- Duis. -- Suspendisse a odio fermentum libero. -- Nam enim. Fusce enim. In. -- Maecenas. -- Lorem ipsum primis. -- Curabitur ac turpis semper sed. -- Quisque condimentum. Donec sit. -- Integer convallis non, posuere. -- Etiam vulputate, odio. -- Proin id lorem. Donec quis. -- Curae, Sed nec augue. -- Aliquam ut turpis. \ No newline at end of file diff --git a/test-server/src/main/scala/com/softwaremill/sttp/server/TestHttpServer.scala b/test-server/src/main/scala/com/softwaremill/sttp/server/TestHttpServer.scala deleted file mode 100644 index 906154d..0000000 --- a/test-server/src/main/scala/com/softwaremill/sttp/server/TestHttpServer.scala +++ /dev/null @@ -1,197 +0,0 @@ -package com.softwaremill.sttp.server - -import akka.actor.ActorSystem -import akka.http.scaladsl.Http -import akka.http.scaladsl.coding.{Deflate, Gzip, NoCoding} -import akka.http.scaladsl.model._ -import akka.http.scaladsl.model.headers.CacheDirectives._ -import akka.http.scaladsl.model.headers._ -import akka.http.scaladsl.server.Directives.{entity, path, _} -import akka.http.scaladsl.server.Route -import akka.http.scaladsl.server.directives.Credentials -import akka.stream.ActorMaterializer -import akka.util.ByteString - -import scala.concurrent.duration._ -import scala.concurrent.{Await, Future} - -object TestHttpServer { - - def main(args: Array[String]): Unit = { - val port = args.headOption.map(_.toInt).getOrElse(51823) - - Await.result(new TestHttpServer(port).start(), 10.seconds) - } -} - -class TestHttpServer(port: Int) extends AutoCloseable { - - import scala.concurrent.ExecutionContext.Implicits.global - - private implicit val actorSystem: ActorSystem = ActorSystem("sttp-test-server") - private implicit val materializer: ActorMaterializer = ActorMaterializer() - - private def paramsToString(m: Map[String, String]): String = - m.toList.sortBy(_._1).map(p => s"${p._1}=${p._2}").mkString(" ") - - private val textFile = new java.io.File("src/main/resources/textfile.txt") - private val binaryFile = new java.io.File("src/main/resources/binaryfile.jpg") - private val textWithSpecialCharacters = "Żółć!" - - val serverRoutes: Route = - pathPrefix("echo") { - pathPrefix("form_params") { - formFieldMap { params => - path("as_string") { - complete(paramsToString(params)) - } ~ - path("as_params") { - complete(FormData(params)) - } - } - } ~ get { - parameterMap { params => - complete(List("GET", "/echo", paramsToString(params)) - .filter(_.nonEmpty) - .mkString(" ")) - } - } ~ - post { - parameterMap { params => - entity(as[String]) { body: String => - complete(List("POST", "/echo", paramsToString(params), body) - .filter(_.nonEmpty) - .mkString(" ")) - } - } - } - } ~ pathPrefix("streaming") { - path("echo") { - post { - parameterMap { _ => - entity(as[String]) { body: String => - complete(body) - } - } - } - } - } ~ path("set_headers") { - get { - respondWithHeader(`Cache-Control`(`max-age`(1000L))) { - respondWithHeader(`Cache-Control`(`no-cache`)) { - complete("ok") - } - } - } - } ~ pathPrefix("set_cookies") { - path("with_expires") { - setCookie(HttpCookie("c", "v", expires = Some(DateTime(1997, 12, 8, 12, 49, 12)))) { - complete("ok") - } - } ~ get { - setCookie( - HttpCookie( - "cookie1", - "value1", - secure = true, - httpOnly = true, - maxAge = Some(123L) - ) - ) { - setCookie(HttpCookie("cookie2", "value2")) { - setCookie( - HttpCookie( - "cookie3", - "", - domain = Some("xyz"), - path = Some("a/b/c") - ) - ) { - complete("ok") - } - } - } - } - } ~ path("secure_basic") { - authenticateBasic("test realm", { - case c @ Credentials.Provided(un) if un == "adam" && c.verify("1234") => - Some(un) - case _ => None - }) { userName => - complete(s"Hello, $userName!") - } - } ~ path("compress") { - encodeResponseWith(Gzip, Deflate, NoCoding) { - complete("I'm compressed!") - } - } ~ pathPrefix("download") { - path("binary") { - getFromFile(binaryFile) - } ~ path("text") { - getFromFile(textFile) - } - } ~ pathPrefix("multipart") { - entity(as[akka.http.scaladsl.model.Multipart.FormData]) { fd => - complete { - fd.parts - .mapAsync(1) { p => - val fv = p.entity.dataBytes.runFold(ByteString())(_ ++ _) - fv.map(_.utf8String) - .map(v => p.name + "=" + v + p.filename.fold("")(fn => s" ($fn)")) - } - .runFold(Vector.empty[String])(_ :+ _) - .map(v => v.mkString(", ")) - } - } - } ~ pathPrefix("redirect") { - path("r1") { - redirect("/redirect/r2", StatusCodes.TemporaryRedirect) - } ~ - path("r2") { - redirect("/redirect/r3", StatusCodes.PermanentRedirect) - } ~ - path("r3") { - redirect("/redirect/r4", StatusCodes.Found) - } ~ - path("r4") { - complete("819") - } ~ - path("loop") { - redirect("/redirect/loop", StatusCodes.Found) - } - } ~ pathPrefix("timeout") { - complete { - akka.pattern.after(1.second, using = actorSystem.scheduler)( - Future.successful("Done") - ) - } - } ~ path("empty_unauthorized_response") { - post { - import akka.http.scaladsl.model._ - complete( - HttpResponse( - status = StatusCodes.Unauthorized, - headers = Nil, - entity = HttpEntity.Empty, - protocol = HttpProtocols.`HTTP/1.1` - )) - } - } ~ path("respond_with_iso_8859_2") { - get { ctx => - val entity = - HttpEntity(MediaTypes.`text/plain`.withCharset(HttpCharset.custom("ISO-8859-2")), textWithSpecialCharacters) - ctx.complete(HttpResponse(200, entity = entity)) - } - } - - def start(): Future[Http.ServerBinding] = { - Http().bindAndHandle(serverRoutes, "localhost", port) - } - - def close(): Unit = { - Await.result( - actorSystem.terminate(), - 10.seconds - ) - } -} -- cgit v1.2.3