Add tests to ensure that server-side timeouts are handled as expected.

Author: MrMage

Tests/LinuxMain.swift

@@ -18,5 +18,7 @@ import XCTest
 
 XCTMain([
   testCase(gRPCTests.allTests),
-  testCase(EchoTests.allTests)
+  testCase(EchoTests.allTests),
+  testCase(ErrorHandlingTests.allTests),
+  testCase(ServerTimeoutTests.allTests)
 ])

Tests/SwiftGRPCTests/EchoTests.swift

@@ -41,7 +41,7 @@ class EchoTests: XCTestCase {
 
   static let lotsOfStrings = (0..<1000).map { String(describing: $0) }
 
-  let defaultTimeout: TimeInterval = 5.0
+  let defaultTimeout: TimeInterval = 1.0
 
   let provider = EchoProvider()
   var server: Echo_EchoServer!

Tests/SwiftGRPCTests/ErrorHandlingTests.swift

@@ -31,7 +31,7 @@ class ErrorHandlingTests: XCTestCase {
 
   let address = "localhost:5050"
 
-  let defaultTimeout: TimeInterval = 1.0
+  let defaultTimeout: TimeInterval = 0.5
 }
 
 extension ErrorHandlingTests {

Tests/SwiftGRPCTests/ServerTimeoutTests.swift

@@ -0,0 +1,157 @@
+/*
+ * Copyright 2018, 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 Dispatch
+import Foundation
+@testable import SwiftGRPC
+import XCTest
+
+fileprivate class TimingOutEchoProvider: Echo_EchoProvider {
+  func get(request: Echo_EchoRequest, session _: Echo_EchoGetSession) throws -> Echo_EchoResponse {
+    Thread.sleep(forTimeInterval: 0.2)
+    return Echo_EchoResponse()
+  }
+  
+  func expand(request: Echo_EchoRequest, session: Echo_EchoExpandSession) throws {
+    Thread.sleep(forTimeInterval: 0.2)
+  }
+  
+  func collect(session: Echo_EchoCollectSession) throws {
+    Thread.sleep(forTimeInterval: 0.2)
+  }
+  
+  func update(session: Echo_EchoUpdateSession) throws {
+    Thread.sleep(forTimeInterval: 0.2)
+  }
+}
+
+class ServerTimeoutTests: XCTestCase {
+  static var allTests: [(String, (ServerTimeoutTests) -> () throws -> Void)] {
+    return [
+      ("testTimeoutUnary", testTimeoutUnary),
+      ("testTimeoutClientStreaming", testTimeoutClientStreaming),
+      ("testTimeoutServerStreaming", testTimeoutServerStreaming),
+      ("testTimeoutBidirectionalStreaming", testTimeoutBidirectionalStreaming)
+    ]
+  }
+  
+  let defaultTimeout: TimeInterval = 0.1
+  
+  fileprivate let provider = TimingOutEchoProvider()
+  var server: Echo_EchoServer!
+  var client: Echo_EchoServiceClient!
+  
+  override func setUp() {
+    super.setUp()
+    
+    let address = "localhost:5050"
+    server = Echo_EchoServer(address: address, provider: provider)
+    server.start(queue: DispatchQueue.global())
+    client = Echo_EchoServiceClient(address: address, secure: false)
+    
+    client.timeout = defaultTimeout
+  }
+  
+  override func tearDown() {
+    client = nil
+    
+    server.server.stop()
+    server = nil
+    
+    super.tearDown()
+  }
+}
+
+extension ServerTimeoutTests {
+  func testTimeoutUnary() {
+    do {
+      _ = try client.get(Echo_EchoRequest(text: "foo")).text
+      XCTFail("should have thrown")
+    } catch {
+      guard case let .callError(callResult) = error as! RPCError
+        else { XCTFail("unexpected error \(error)"); return }
+      XCTAssertEqual(.deadlineExceeded, callResult.statusCode)
+      XCTAssertEqual("Deadline Exceeded", callResult.statusMessage)
+    }
+  }
+  
+  func testTimeoutClientStreaming() {
+    let completionHandlerExpectation = expectation(description: "final completion handler called")
+    let call = try! client.collect { callResult in
+      XCTAssertEqual(.deadlineExceeded, callResult.statusCode)
+      completionHandlerExpectation.fulfill()
+    }
+    
+    let sendExpectation = expectation(description: "send completion handler 1 called")
+    try! call.send(Echo_EchoRequest(text: "foo")) { [sendExpectation] in
+      // The server only times out later in its lifecycle, so we shouldn't get an error when trying to send a message.
+      XCTAssertNil($0)
+      sendExpectation.fulfill()
+    }
+    call.waitForSendOperationsToFinish()
+    
+    do {
+      _ = try call.closeAndReceive()
+      XCTFail("should have thrown")
+    } catch let receiveError {
+      XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
+    }
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+  
+  func testTimeoutServerStreaming() {
+    let completionHandlerExpectation = expectation(description: "completion handler called")
+    let call = try! client.expand(Echo_EchoRequest(text: "foo bar baz")) { callResult in
+      XCTAssertEqual(.deadlineExceeded, callResult.statusCode)
+      completionHandlerExpectation.fulfill()
+    }
+    
+    // TODO(danielalm): Why doesn't `call.receive()` throw once the call times out?
+    XCTAssertNil(try! call.receive())
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+  
+  func testTimeoutBidirectionalStreaming() {
+    let completionHandlerExpectation = expectation(description: "completion handler called")
+    let call = try! client.update { callResult in
+      XCTAssertEqual(.deadlineExceeded, callResult.statusCode)
+      completionHandlerExpectation.fulfill()
+    }
+    
+    let sendExpectation = expectation(description: "send completion handler 1 called")
+    try! call.send(Echo_EchoRequest(text: "foo")) { [sendExpectation] in
+      // The server only times out later in its lifecycle, so we shouldn't get an error when trying to send a message.
+      XCTAssertNil($0)
+      sendExpectation.fulfill()
+    }
+    call.waitForSendOperationsToFinish()
+    
+    // FIXME(danielalm): Why does `call.receive()` only throw on Linux once the call times out?
+    #if os(Linux)
+    do {
+      _ = try call.receive()
+      XCTFail("should have thrown")
+    } catch let receiveError {
+      XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
+    }
+    #else
+    XCTAssertNil(try! call.receive())
+    #endif
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+}