akka.grpc.interop.GrpcInteropTests.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of akka-grpc-interop-tests_2.13 Show documentation
Akka gRPC - Support for building streaming gRPC servers and clients on top of Akka Streams.
There is a newer version: 2.3.4
Show newest version
/*
 * Copyright (C) 2018-2023 Lightbend Inc. 
 */

package akka.grpc.interop

import io.grpc.StatusRuntimeException
import org.scalatest.{ Assertion, Succeeded }

import scala.util.control.NonFatal
import org.scalatest.matchers
import org.scalatest.wordspec.AnyWordSpec

class GrpcInteropTests(serverProvider: GrpcServerProvider, clientProvider: GrpcClientProvider) extends AnyWordSpec {
  import matchers.should.Matchers._

  // see https://github.com/grpc/grpc/blob/master/tools/run_tests/run_interop_tests.py#L543
  val testCases = Seq(
    "large_unary",
    "empty_unary",
    "ping_pong",
    "empty_stream",
    "client_streaming",
    "server_streaming",
    "cancel_after_begin",
    "cancel_after_first_response",
    "timeout_on_sleeping_server",
    // Currently fails often, the client seems to prematurely close
    // the stream. #219
    // "custom_metadata",
    "status_code_and_message",
    "unimplemented_method",
    "client_compressed_unary",
    // hangs (https://github.com/akka/akka-grpc/issues/214)
    // "client_compressed_streaming",
    "server_compressed_unary",
    "server_compressed_streaming",
    "unimplemented_service")

  val server = serverProvider.server
  val client = clientProvider.client

  serverProvider.label + " with " + clientProvider.label should {
    testCases.foreach { testCaseName =>
      s"pass the $testCaseName integration test" in {
        // It is useful to be able to disable TLS locally to diagnose problems with wireshark:
        val tls = true
        val allPending = serverProvider.pendingCases ++ clientProvider.pendingCases
        pendingTestCaseSupport(allPending(testCaseName)) {
          withGrpcServer(server, Array(s"--use_tls=$tls")) { port =>
            runGrpcClient(
              client,
              Array(
                s"--use_tls=$tls",
                s"--server_port=$port",
                "--server_host_override=foo.test.google.fr",
                "--use_test_ca=true",
                s"--test_case=$testCaseName"))
          }
        }
      }
    }
  }

  private def withGrpcServer[T](server: GrpcServer[T], args: Array[String])(block: Int => Unit): Assertion =
    try {
      val binding = server.start(args)
      try {
        block(server.getPort(binding))
      } catch {
        case ex: AssertionError                => throw ex // expected to see these
        case ex: UnsupportedOperationException => throw ex // these as well
        case ex: Throwable                     =>
          // give us some hints what is wrong with everything else
          println("Exception: " + ex.getClass.getName + ": " + ex.getMessage)
          throw ex
      } finally {
        server.stop(binding)
      }
      Succeeded
    } catch {
      case e: StatusRuntimeException =>
        // 'Status' is not serializable, so we have to unpack the exception
        // to avoid trouble when running tests from sbt
        e.printStackTrace()
        if (e.getCause == null) fail(e.getMessage)
        else fail(e.getMessage, e.getCause)
      case NonFatal(t) => fail(t)
    }

  private def runGrpcClient(client: GrpcClient, args: Array[String]): Unit =
    client.run(args)

  private def pendingTestCaseSupport(expectedToFail: Boolean)(block: => Unit): Assertion = {
    val result =
      try {
        block
        Succeeded
      } catch {
        case NonFatal(_) if expectedToFail => pending
        case NonFatal(e) =>
          e.printStackTrace()
          throw e
      }

    result match {
      case Succeeded if expectedToFail => fail("Succeeded against expectations")
      case res                         => res
    }
  }
}

trait GrpcServerProvider {
  def label: String
  def pendingCases: Set[String]

  def server: GrpcServer[_]
}

trait GrpcClientProvider {
  def label: String
  def pendingCases: Set[String]

  def client: GrpcClient
}

object IoGrpcJavaServerProvider extends GrpcServerProvider {
  val label: String = "grpc-java server"

  val pendingCases =
    Set()

  val server = IoGrpcServer
}

object IoGrpcJavaClientProvider extends GrpcClientProvider {
  val label: String = "grpc-java client tester"

  val pendingCases =
    Set()

  val client = IoGrpcClient
}

trait AkkaHttpServerProvider extends GrpcServerProvider

trait AkkaClientProvider extends GrpcClientProvider {
  // All client implementations currently support the same set of interop tests.
  // When adding support for further interop tests, we should either implement them
  // for all client implementations simultaneously, or distribute `pendingCases` over
  // the actual implementations again (also in the scripted GrpcInteropSpec).
  val pendingCases =
    Set(
      "cancel_after_begin",
      "cancel_after_first_response",
      "timeout_on_sleeping_server",
      "custom_metadata",
      "client_compressed_unary",
      "client_compressed_streaming",
      "server_compressed_unary")
}