Allow using Route Test Kit for testing local/remote web services about akka-http HOT 9 CLOSED

Comment by ktoso
Saturday Apr 30, 2016 at 00:21 GMT

It's an interesting idea, and we might consider pull requests if you'd like to contribute it as a feature.
In the team we won't be able to focus on this for now - there's more urgent fish to fry.

from akka-http.

This would be a useful feature to have and would enable running a similar test suite against a remote server to perform integration testing.

from akka-http.

Actually I think this might be covered by the ~!> feature introduced in #3014 and available on version 10.2.0-M1, https://doc.akka.io//docs/akka-http/snapshot/routing-dsl/testkit.html#integration-testing-routes

Closing this issue with that reference - feel free to reopen when you think this is not quite covered yet.

from akka-http.

~!> indeed looks the right one. Only thing not sure if it can be used to run against a pre existing running server instead of always starting a new one. Would give it a try

from akka-http.

Only thing not sure if it can be used to run against a pre existing running server instead of always starting a new one

~!> will start a server for you. If you want to test against a preexisting running server I'd use a regular Http().singleRequest call. I don't think you can use the ~> check notation then, though - but that might not make sense anyway, since that exposes things (rejections etc) that aren't visible over the network anyway.

from akka-http.

Ack. So here is I want to do. I have a existing test suite which checks my API implementation. For example below snippet just check if the server responds with same message json

    val msg = readJson[Message]("message.json")
    val msgEntity = Marshal(msg).to[MessageEntity].futureValue
    val request = Post("/message").withEntity(msgEntity)
    
    request ~> api.routes ~> check {
      responseAs[Message] shouldBe msg
    }

Now I would also like to leverage the same test suite against an existing running server say a server instance running in stage environment. Currently to perform integration testing I would need to implement logic similar to above but using Http().singleRequest. However if I can leverage the same code to do both kind of test it would be greatly help!

I see that some semantics like rejections cannot be preserved. But if the test mostly relies on actual response like status and response headers etc then it should mostly work transparently.

from akka-http.

Also sorry for the noise with similar discussion on #3014. We can keep the discussion here (or there) as you prefer

from akka-http.

I think the easiest way to do that might be to pass in a HttpRequest => Future[HttpResponse] that is implemented either with api.routes or with a call to the integration tests service, and then do your assertions on the HttpResponse. On Akka HTTP 10.2.0 there is an implicit conversion available from Route to HttpRequest => Future[HttpResponse] so that is fairly easy to do.

I don't see an easy way to make the test usable both 'in-process' and calling an external service using the testkit ~> tools (though I see how it'd be neat).

from akka-http.

Thanks @raboof for the pointers. Would look into them. Though having them done with benefit of Tesk kit DSL would be very neat

from akka-http.