grpc-swift-nio-transport/IntegrationTests/grpc-interop-tests/Sources/InteroperabilityTestsExecutable.swift

/*
 * Copyright 2024, gRPC Authors All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import ArgumentParser
import GRPCCore
import GRPCInteropTests
import GRPCNIOTransportHTTP2

@main
struct InteroperabilityTestsExecutable: AsyncParsableCommand {
  static let configuration = CommandConfiguration(
    abstract: "gRPC Swift Interoperability Runner",
    subcommands: [StartServer.self, ListTests.self, RunTests.self]
  )

  struct StartServer: AsyncParsableCommand {
    static let configuration = CommandConfiguration(
      abstract: "Start the gRPC Swift interoperability test server."
    )

    @Option(help: "The port to listen on for new connections")
    var port: Int

    @Option(help: "The host to listen on for new connections")
    var host: String = "127.0.0.1"

    func run() async throws {
      let server = GRPCServer(
        transport: .http2NIOPosix(
          address: .ipv4(host: self.host, port: self.port),
          config: .defaults(transportSecurity: .plaintext) {
            $0.compression.enabledAlgorithms = .all
          }
        ),
        services: [TestService()]
      )

      try await withThrowingDiscardingTaskGroup { group in
        group.addTask {
          try await server.serve()
        }

        if let address = try await server.listeningAddress {
          print("listening address: \(address)")
        }
      }
    }
  }

  struct ListTests: ParsableCommand {
    static let configuration = CommandConfiguration(
      abstract: "List all interoperability test names."
    )

    func run() throws {
      for testCase in InteroperabilityTestCase.allCases {
        print(testCase.name)
      }
    }
  }

  struct RunTests: AsyncParsableCommand {
    static let configuration = CommandConfiguration(
      abstract: """
          Run gRPC interoperability tests using a gRPC Swift client.
          You can specify a test name as an argument to run a single test.
          If no test name is given, all interoperability tests will be run.
        """
    )

    @Option(help: "The host the server is running on")
    var host: String

    @Option(help: "The port to connect to")
    var port: Int

    @Argument(help: "The name of the tests to run. If none, all tests will be run.")
    var testNames: [String] = InteroperabilityTestCase.allCases.map { $0.name }

    func run() async throws {
      let client = try self.buildClient(host: self.host, port: self.port)

      try await withThrowingDiscardingTaskGroup { group in
        group.addTask {
          try await client.run()
        }

        for testName in testNames {
          guard let testCase = InteroperabilityTestCase(rawValue: testName) else {
            print(InteroperabilityTestError.testNotFound(name: testName))
            continue
          }
          await self.runTest(testCase, using: client)
        }

        client.beginGracefulShutdown()
      }
    }

    private func buildClient(host: String, port: Int) throws -> GRPCClient {
      let serviceConfig = ServiceConfig(loadBalancingConfig: [.roundRobin])
      return GRPCClient(
        transport: try .http2NIOPosix(
          target: .ipv4(host: host, port: port),
          config: .defaults(transportSecurity: .plaintext) {
            $0.compression.enabledAlgorithms = .all
          },
          serviceConfig: serviceConfig
        )
      )
    }

    private func runTest(
      _ testCase: InteroperabilityTestCase,
      using client: GRPCClient
    ) async {
      print("Running '\(testCase.name)' ... ", terminator: "")
      do {
        try await testCase.makeTest().run(client: client)
        print("PASSED")
      } catch {
        print("FAILED\n" + String(describing: InteroperabilityTestError.testFailed(cause: error)))
      }
    }
  }
}

enum InteroperabilityTestError: Error, CustomStringConvertible {
  case testNotFound(name: String)
  case testFailed(cause: any Error)

  var description: String {
    switch self {
    case .testNotFound(let name):
      return "Test \"\(name)\" not found."
    case .testFailed(let cause):
      return "Test failed with error: \(String(describing: cause))"
    }
  }
}