HTTP2TransportTests.swift 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751
  1. /*
  2. * Copyright 2024, gRPC Authors All rights reserved.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. import GRPCCore
  17. import GRPCNIOTransportCore
  18. import GRPCNIOTransportHTTP2Posix
  19. import GRPCNIOTransportHTTP2TransportServices
  20. import XCTest
  21. final class HTTP2TransportTests: XCTestCase {
  22. // A combination of client and server transport kinds.
  23. struct Transport: Sendable, CustomStringConvertible {
  24. var server: TransportKind
  25. var client: TransportKind
  26. var description: String {
  27. "server=\(self.server) client=\(self.client)"
  28. }
  29. }
  30. func forEachTransportPair(
  31. _ transport: [Transport] = [.init(server: .posix, client: .posix)],
  32. serverAddress: SocketAddress = .ipv4(host: "127.0.0.1", port: 0),
  33. enableControlService: Bool = true,
  34. clientCompression: CompressionAlgorithm = .none,
  35. clientEnabledCompression: CompressionAlgorithmSet = .none,
  36. serverCompression: CompressionAlgorithmSet = .none,
  37. _ execute: (
  38. ControlClient<NIOClientTransport>,
  39. GRPCServer<NIOServerTransport>,
  40. Transport
  41. ) async throws -> Void
  42. ) async throws {
  43. for pair in transport {
  44. try await withThrowingTaskGroup(of: Void.self) { group in
  45. let (server, address) = try await self.runServer(
  46. in: &group,
  47. address: serverAddress,
  48. kind: pair.server,
  49. enableControlService: enableControlService,
  50. compression: serverCompression
  51. )
  52. let target: any ResolvableTarget
  53. if let ipv4 = address.ipv4 {
  54. target = .ipv4(host: ipv4.host, port: ipv4.port)
  55. } else if let ipv6 = address.ipv6 {
  56. target = .ipv6(host: ipv6.host, port: ipv6.port)
  57. } else if let uds = address.unixDomainSocket {
  58. target = .unixDomainSocket(path: uds.path)
  59. } else {
  60. XCTFail("Unexpected address to connect to")
  61. return
  62. }
  63. let client = try self.makeClient(
  64. kind: pair.client,
  65. target: target,
  66. compression: clientCompression,
  67. enabledCompression: clientEnabledCompression
  68. )
  69. group.addTask {
  70. try await client.runConnections()
  71. }
  72. do {
  73. let control = ControlClient(wrapping: client)
  74. try await execute(control, server, pair)
  75. } catch {
  76. XCTFail("Unexpected error: '\(error)' (\(pair))")
  77. }
  78. server.beginGracefulShutdown()
  79. client.beginGracefulShutdown()
  80. }
  81. }
  82. }
  83. func forEachClientAndHTTPStatusCodeServer(
  84. _ kind: [TransportKind] = TransportKind.supported,
  85. _ execute: (ControlClient<NIOClientTransport>, TransportKind) async throws -> Void
  86. ) async throws {
  87. for clientKind in kind {
  88. try await withThrowingTaskGroup(of: Void.self) { group in
  89. let server = HTTP2StatusCodeServer()
  90. group.addTask {
  91. try await server.run()
  92. }
  93. let address = try await server.listeningAddress
  94. let client = try self.makeClient(
  95. kind: clientKind,
  96. target: .ipv4(host: address.host, port: address.port),
  97. compression: .none,
  98. enabledCompression: .none
  99. )
  100. group.addTask {
  101. try await client.runConnections()
  102. }
  103. do {
  104. let control = ControlClient(wrapping: client)
  105. try await execute(control, clientKind)
  106. } catch {
  107. XCTFail("Unexpected error: '\(error)' (\(clientKind))")
  108. }
  109. group.cancelAll()
  110. }
  111. }
  112. }
  113. private func runServer(
  114. in group: inout ThrowingTaskGroup<Void, any Error>,
  115. address: SocketAddress,
  116. kind: TransportKind,
  117. enableControlService: Bool,
  118. compression: CompressionAlgorithmSet
  119. ) async throws -> (GRPCServer<NIOServerTransport>, GRPCNIOTransportCore.SocketAddress) {
  120. let services = enableControlService ? [ControlService()] : []
  121. switch kind {
  122. case .posix:
  123. let server = GRPCServer(
  124. transport: NIOServerTransport(
  125. .http2NIOPosix(
  126. address: address,
  127. transportSecurity: .plaintext,
  128. config: .defaults {
  129. $0.compression.enabledAlgorithms = compression
  130. }
  131. )
  132. ),
  133. services: services
  134. )
  135. group.addTask {
  136. try await server.serve()
  137. }
  138. let address = try await server.listeningAddress!
  139. return (server, address)
  140. #if canImport(Network)
  141. case .transportServices:
  142. let server = GRPCServer(
  143. transport: NIOServerTransport(
  144. .http2NIOTS(
  145. address: address,
  146. transportSecurity: .plaintext,
  147. config: .defaults {
  148. $0.compression.enabledAlgorithms = compression
  149. }
  150. )
  151. ),
  152. services: services
  153. )
  154. group.addTask {
  155. try await server.serve()
  156. }
  157. let address = try await server.listeningAddress!
  158. return (server, address)
  159. #endif
  160. }
  161. }
  162. private func makeClient(
  163. kind: TransportKind,
  164. target: any ResolvableTarget,
  165. compression: CompressionAlgorithm,
  166. enabledCompression: CompressionAlgorithmSet
  167. ) throws -> GRPCClient<NIOClientTransport> {
  168. let transport: NIOClientTransport
  169. switch kind {
  170. case .posix:
  171. var serviceConfig = ServiceConfig()
  172. serviceConfig.loadBalancingConfig = [.roundRobin]
  173. let posix = try HTTP2ClientTransport.Posix(
  174. target: target,
  175. transportSecurity: .plaintext,
  176. config: .defaults {
  177. $0.compression.algorithm = compression
  178. $0.compression.enabledAlgorithms = enabledCompression
  179. },
  180. serviceConfig: serviceConfig
  181. )
  182. transport = NIOClientTransport(posix)
  183. #if canImport(Network)
  184. case .transportServices:
  185. var serviceConfig = ServiceConfig()
  186. serviceConfig.loadBalancingConfig = [.roundRobin]
  187. let transportServices = try HTTP2ClientTransport.TransportServices(
  188. target: target,
  189. transportSecurity: .plaintext,
  190. config: .defaults {
  191. $0.compression.algorithm = compression
  192. $0.compression.enabledAlgorithms = enabledCompression
  193. },
  194. serviceConfig: serviceConfig
  195. )
  196. transport = NIOClientTransport(transportServices)
  197. #endif
  198. }
  199. return GRPCClient(transport: transport, interceptors: [PeerInfoClientInterceptor()])
  200. }
  201. func testUnaryOK() async throws {
  202. // Client sends one message, server sends back metadata, a single message, and an ok status with
  203. // trailing metadata.
  204. try await self.forEachTransportPair { control, _, pair in
  205. let input = ControlInput.with {
  206. $0.echoMetadataInHeaders = true
  207. $0.echoMetadataInTrailers = true
  208. $0.numberOfMessages = 1
  209. $0.payloadParameters = .with {
  210. $0.content = 0
  211. $0.size = 1024
  212. }
  213. }
  214. let metadata: Metadata = ["test-key": "test-value"]
  215. let request = ClientRequest(message: input, metadata: metadata)
  216. try await control.unary(request: request) { response in
  217. let message = try response.message
  218. XCTAssertEqual(message.payload, Data(repeating: 0, count: 1024), "\(pair)")
  219. let initial = response.metadata
  220. XCTAssertEqual(Array(initial["echo-test-key"]), ["test-value"], "\(pair)")
  221. let trailing = response.trailingMetadata
  222. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  223. }
  224. }
  225. }
  226. func testUnaryNotOK() async throws {
  227. // Client sends one message, server sends back metadata, a single message, and a non-ok status
  228. // with trailing metadata.
  229. try await self.forEachTransportPair { control, _, pair in
  230. let input = ControlInput.with {
  231. $0.echoMetadataInTrailers = true
  232. $0.numberOfMessages = 1
  233. $0.payloadParameters = .with {
  234. $0.content = 0
  235. $0.size = 1024
  236. }
  237. $0.status = .with {
  238. $0.code = .aborted
  239. $0.message = "\(#function)"
  240. }
  241. }
  242. let metadata: Metadata = ["test-key": "test-value"]
  243. let request = ClientRequest(message: input, metadata: metadata)
  244. try await control.unary(request: request) { response in
  245. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  246. XCTAssertEqual(error.code, .aborted)
  247. XCTAssertEqual(error.message, "\(#function)")
  248. let trailing = error.metadata
  249. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  250. }
  251. let trailing = response.trailingMetadata
  252. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  253. }
  254. }
  255. }
  256. func testUnaryRejected() async throws {
  257. // Client sends one message, server sends non-ok status with trailing metadata.
  258. try await self.forEachTransportPair { control, _, pair in
  259. let metadata: Metadata = ["test-key": "test-value"]
  260. let request = ClientRequest<ControlInput>(
  261. message: .trailersOnly(code: .aborted, message: "\(#function)", echoMetadata: true),
  262. metadata: metadata
  263. )
  264. try await control.unary(request: request) { response in
  265. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  266. XCTAssertEqual(error.code, .aborted, "\(pair)")
  267. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  268. let trailing = error.metadata
  269. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  270. }
  271. // No initial metadata for trailers-only.
  272. XCTAssertEqual(response.metadata, [:])
  273. let trailing = response.trailingMetadata
  274. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  275. }
  276. }
  277. }
  278. func testClientStreamingOK() async throws {
  279. try await self.forEachTransportPair { control, _, pair in
  280. let metadata: Metadata = ["test-key": "test-value"]
  281. let request = StreamingClientRequest(
  282. of: ControlInput.self,
  283. metadata: metadata
  284. ) { writer in
  285. try await writer.write(.echoMetadata)
  286. // Send a few messages which are ignored.
  287. try await writer.write(.noOp)
  288. try await writer.write(.noOp)
  289. try await writer.write(.noOp)
  290. // Send a message.
  291. try await writer.write(.messages(1, repeating: 42, count: 1024))
  292. // ... and the final status.
  293. try await writer.write(.status(code: .ok, message: "", echoMetadata: true))
  294. }
  295. try await control.clientStream(request: request) { response in
  296. let message = try response.message
  297. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  298. let initial = response.metadata
  299. XCTAssertEqual(Array(initial["echo-test-key"]), ["test-value"], "\(pair)")
  300. let trailing = response.trailingMetadata
  301. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  302. }
  303. }
  304. }
  305. func testClientStreamingNotOK() async throws {
  306. try await self.forEachTransportPair { control, _, pair in
  307. let metadata: Metadata = ["test-key": "test-value"]
  308. let request = StreamingClientRequest(
  309. of: ControlInput.self,
  310. metadata: metadata
  311. ) { writer in
  312. try await writer.write(.echoMetadata)
  313. // Send a few messages which are ignored.
  314. try await writer.write(.noOp)
  315. try await writer.write(.noOp)
  316. try await writer.write(.noOp)
  317. // Send a message.
  318. try await writer.write(.messages(1, repeating: 42, count: 1024))
  319. // Send the final status.
  320. try await writer.write(.status(code: .aborted, message: "\(#function)", echoMetadata: true))
  321. }
  322. try await control.clientStream(request: request) { response in
  323. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  324. XCTAssertEqual(error.code, .aborted, "\(pair)")
  325. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  326. let trailing = error.metadata
  327. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  328. }
  329. let initial = response.metadata
  330. XCTAssertEqual(Array(initial["echo-test-key"]), ["test-value"], "\(pair)")
  331. let trailing = response.trailingMetadata
  332. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  333. }
  334. }
  335. }
  336. func testClientStreamingRejected() async throws {
  337. // Client sends one message, server sends non-ok status with trailing metadata.
  338. try await self.forEachTransportPair { control, _, pair in
  339. let metadata: Metadata = ["test-key": "test-value"]
  340. let request = StreamingClientRequest(
  341. of: ControlInput.self,
  342. metadata: metadata
  343. ) { writer in
  344. let message: ControlInput = .trailersOnly(
  345. code: .aborted,
  346. message: "\(#function)",
  347. echoMetadata: true
  348. )
  349. try await writer.write(message)
  350. }
  351. try await control.clientStream(request: request) { response in
  352. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  353. XCTAssertEqual(error.code, .aborted, "\(pair)")
  354. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  355. let trailing = error.metadata
  356. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  357. }
  358. // No initial metadata for trailers-only.
  359. XCTAssertEqual(response.metadata, [:])
  360. let trailing = response.trailingMetadata
  361. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  362. }
  363. }
  364. }
  365. func testServerStreamingOK() async throws {
  366. try await self.forEachTransportPair { control, _, pair in
  367. let metadata: Metadata = ["test-key": "test-value"]
  368. let input = ControlInput.with {
  369. $0.echoMetadataInHeaders = true
  370. $0.echoMetadataInTrailers = true
  371. $0.numberOfMessages = 5
  372. $0.payloadParameters = .with {
  373. $0.content = 42
  374. $0.size = 1024
  375. }
  376. }
  377. let request = ClientRequest(message: input, metadata: metadata)
  378. try await control.serverStream(request: request) { response in
  379. switch response.accepted {
  380. case .success(let contents):
  381. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  382. var messagesReceived = 0
  383. for try await part in contents.bodyParts {
  384. switch part {
  385. case .message(let message):
  386. messagesReceived += 1
  387. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  388. case .trailingMetadata(let metadata):
  389. XCTAssertEqual(Array(metadata["echo-test-key"]), ["test-value"], "\(pair)")
  390. }
  391. }
  392. XCTAssertEqual(messagesReceived, 5)
  393. case .failure(let error):
  394. throw error
  395. }
  396. }
  397. }
  398. }
  399. func testServerStreamingEmptyOK() async throws {
  400. try await self.forEachTransportPair { control, _, pair in
  401. let metadata: Metadata = ["test-key": "test-value"]
  402. // Echo back metadata, but don't send any messages.
  403. let input = ControlInput.with {
  404. $0.echoMetadataInHeaders = true
  405. $0.echoMetadataInTrailers = true
  406. }
  407. let request = ClientRequest(message: input, metadata: metadata)
  408. try await control.serverStream(request: request) { response in
  409. switch response.accepted {
  410. case .success(let contents):
  411. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  412. for try await part in contents.bodyParts {
  413. switch part {
  414. case .message:
  415. XCTFail("Unexpected message")
  416. case .trailingMetadata(let metadata):
  417. XCTAssertEqual(Array(metadata["echo-test-key"]), ["test-value"], "\(pair)")
  418. }
  419. }
  420. case .failure(let error):
  421. throw error
  422. }
  423. }
  424. }
  425. }
  426. func testServerStreamingNotOK() async throws {
  427. try await self.forEachTransportPair { control, _, pair in
  428. let metadata: Metadata = ["test-key": "test-value"]
  429. let input = ControlInput.with {
  430. $0.echoMetadataInHeaders = true
  431. $0.echoMetadataInTrailers = true
  432. $0.numberOfMessages = 5
  433. $0.payloadParameters = .with {
  434. $0.content = 42
  435. $0.size = 1024
  436. }
  437. $0.status = .with {
  438. $0.code = .aborted
  439. $0.message = "\(#function)"
  440. }
  441. }
  442. let request = ClientRequest(message: input, metadata: metadata)
  443. try await control.serverStream(request: request) { response in
  444. switch response.accepted {
  445. case .success(let contents):
  446. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  447. var messagesReceived = 0
  448. do {
  449. for try await part in contents.bodyParts {
  450. switch part {
  451. case .message(let message):
  452. messagesReceived += 1
  453. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  454. case .trailingMetadata:
  455. XCTFail("Unexpected trailing metadata, should be provided in RPCError")
  456. }
  457. }
  458. XCTFail("Expected error to be thrown")
  459. } catch let error as RPCError {
  460. XCTAssertEqual(error.code, .aborted)
  461. XCTAssertEqual(error.message, "\(#function)")
  462. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  463. }
  464. XCTAssertEqual(messagesReceived, 5)
  465. case .failure(let error):
  466. throw error
  467. }
  468. }
  469. }
  470. }
  471. func testServerStreamingEmptyNotOK() async throws {
  472. try await self.forEachTransportPair { control, _, pair in
  473. let metadata: Metadata = ["test-key": "test-value"]
  474. let input = ControlInput.with {
  475. $0.echoMetadataInHeaders = true
  476. $0.echoMetadataInTrailers = true
  477. $0.status = .with {
  478. $0.code = .aborted
  479. $0.message = "\(#function)"
  480. }
  481. }
  482. let request = ClientRequest(message: input, metadata: metadata)
  483. try await control.serverStream(request: request) { response in
  484. switch response.accepted {
  485. case .success(let contents):
  486. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  487. do {
  488. for try await _ in contents.bodyParts {
  489. XCTFail("Unexpected message, \(pair)")
  490. }
  491. XCTFail("Expected error to be thrown")
  492. } catch let error as RPCError {
  493. XCTAssertEqual(error.code, .aborted)
  494. XCTAssertEqual(error.message, "\(#function)")
  495. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  496. }
  497. case .failure(let error):
  498. throw error
  499. }
  500. }
  501. }
  502. }
  503. func testServerStreamingRejected() async throws {
  504. try await self.forEachTransportPair { control, _, pair in
  505. let metadata: Metadata = ["test-key": "test-value"]
  506. let request = ClientRequest<ControlInput>(
  507. message: .trailersOnly(code: .aborted, message: "\(#function)", echoMetadata: true),
  508. metadata: metadata
  509. )
  510. try await control.serverStream(request: request) { response in
  511. switch response.accepted {
  512. case .success:
  513. XCTFail("Expected RPC to be rejected \(pair)")
  514. case .failure(let error):
  515. XCTAssertEqual(error.code, .aborted, "\(pair)")
  516. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  517. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  518. }
  519. }
  520. }
  521. }
  522. func testBidiStreamingOK() async throws {
  523. try await self.forEachTransportPair { control, _, pair in
  524. let metadata: Metadata = ["test-key": "test-value"]
  525. let request = StreamingClientRequest(
  526. of: ControlInput.self,
  527. metadata: metadata
  528. ) { writer in
  529. try await writer.write(.echoMetadata)
  530. // Send a few messages, each is echo'd back.
  531. try await writer.write(.messages(1, repeating: 42, count: 1024))
  532. try await writer.write(.messages(1, repeating: 42, count: 1024))
  533. try await writer.write(.messages(1, repeating: 42, count: 1024))
  534. // Send the final status.
  535. try await writer.write(.status(code: .ok, message: "", echoMetadata: true))
  536. }
  537. try await control.bidiStream(request: request) { response in
  538. switch response.accepted {
  539. case .success(let contents):
  540. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  541. var messagesReceived = 0
  542. for try await part in contents.bodyParts {
  543. switch part {
  544. case .message(let message):
  545. messagesReceived += 1
  546. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  547. case .trailingMetadata(let metadata):
  548. XCTAssertEqual(Array(metadata["echo-test-key"]), ["test-value"], "\(pair)")
  549. }
  550. }
  551. XCTAssertEqual(messagesReceived, 3)
  552. case .failure(let error):
  553. throw error
  554. }
  555. }
  556. }
  557. }
  558. func testBidiStreamingEmptyOK() async throws {
  559. try await self.forEachTransportPair { control, _, pair in
  560. let request = StreamingClientRequest(of: ControlInput.self) { _ in }
  561. try await control.bidiStream(request: request) { response in
  562. switch response.accepted {
  563. case .success(let contents):
  564. var receivedTrailingMetadata = false
  565. for try await part in contents.bodyParts {
  566. switch part {
  567. case .message:
  568. XCTFail("Unexpected message \(pair)")
  569. case .trailingMetadata:
  570. XCTAssertFalse(receivedTrailingMetadata, "\(pair)")
  571. receivedTrailingMetadata = true
  572. }
  573. }
  574. case .failure(let error):
  575. throw error
  576. }
  577. }
  578. }
  579. }
  580. func testBidiStreamingNotOK() async throws {
  581. try await self.forEachTransportPair { control, _, pair in
  582. let metadata: Metadata = ["test-key": "test-value"]
  583. let request = StreamingClientRequest(
  584. of: ControlInput.self,
  585. metadata: metadata
  586. ) { writer in
  587. try await writer.write(.echoMetadata)
  588. // Send a few messages, each is echo'd back.
  589. try await writer.write(.messages(1, repeating: 42, count: 1024))
  590. try await writer.write(.messages(1, repeating: 42, count: 1024))
  591. try await writer.write(.messages(1, repeating: 42, count: 1024))
  592. // Send the final status.
  593. try await writer.write(.status(code: .aborted, message: "\(#function)", echoMetadata: true))
  594. }
  595. try await control.bidiStream(request: request) { response in
  596. switch response.accepted {
  597. case .success(let contents):
  598. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  599. var messagesReceived = 0
  600. do {
  601. for try await part in contents.bodyParts {
  602. switch part {
  603. case .message(let message):
  604. messagesReceived += 1
  605. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  606. case .trailingMetadata:
  607. XCTFail("Trailing metadata should be provided by error")
  608. }
  609. }
  610. XCTFail("Should've thrown error \(pair)")
  611. } catch let error as RPCError {
  612. XCTAssertEqual(error.code, .aborted)
  613. XCTAssertEqual(error.message, "\(#function)")
  614. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  615. }
  616. XCTAssertEqual(messagesReceived, 3)
  617. case .failure(let error):
  618. throw error
  619. }
  620. }
  621. }
  622. }
  623. func testBidiStreamingRejected() async throws {
  624. try await self.forEachTransportPair { control, _, pair in
  625. let metadata: Metadata = ["test-key": "test-value"]
  626. let request = StreamingClientRequest(
  627. of: ControlInput.self,
  628. metadata: metadata
  629. ) { writer in
  630. try await writer.write(
  631. .trailersOnly(
  632. code: .aborted,
  633. message: "\(#function)",
  634. echoMetadata: true
  635. )
  636. )
  637. }
  638. try await control.bidiStream(request: request) { response in
  639. switch response.accepted {
  640. case .success:
  641. XCTFail("Expected RPC to fail \(pair)")
  642. case .failure(let error):
  643. XCTAssertEqual(error.code, .aborted)
  644. XCTAssertEqual(error.message, "\(#function)")
  645. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"])
  646. }
  647. }
  648. }
  649. }
  650. // MARK: - Not Implemented
  651. func testUnaryNotImplemented() async throws {
  652. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  653. let request = ClientRequest(message: ControlInput())
  654. try await control.unary(request: request) { response in
  655. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  656. XCTAssertEqual(error.code, .unimplemented)
  657. }
  658. }
  659. }
  660. }
  661. func testClientStreamingNotImplemented() async throws {
  662. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  663. let request = StreamingClientRequest(of: ControlInput.self) { _ in }
  664. try await control.clientStream(request: request) { response in
  665. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  666. XCTAssertEqual(error.code, .unimplemented)
  667. }
  668. }
  669. }
  670. }
  671. func testServerStreamingNotImplemented() async throws {
  672. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  673. let request = ClientRequest(message: ControlInput())
  674. try await control.serverStream(request: request) { response in
  675. XCTAssertThrowsError(ofType: RPCError.self, try response.accepted.get()) { error in
  676. XCTAssertEqual(error.code, .unimplemented)
  677. }
  678. }
  679. }
  680. }
  681. func testBidiStreamingNotImplemented() async throws {
  682. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  683. let request = StreamingClientRequest(of: ControlInput.self) { _ in }
  684. try await control.bidiStream(request: request) { response in
  685. XCTAssertThrowsError(ofType: RPCError.self, try response.accepted.get()) { error in
  686. XCTAssertEqual(error.code, .unimplemented)
  687. }
  688. }
  689. }
  690. }
  691. // MARK: - Compression tests
  692. private func testUnaryCompression(
  693. client: CompressionAlgorithm,
  694. server: CompressionAlgorithm,
  695. control: ControlClient<NIOClientTransport>,
  696. pair: Transport
  697. ) async throws {
  698. let message = ControlInput.with {
  699. $0.echoMetadataInHeaders = true
  700. $0.numberOfMessages = 1
  701. $0.payloadParameters = .with {
  702. $0.content = 42
  703. $0.size = 1024
  704. }
  705. }
  706. var options = CallOptions.defaults
  707. options.compression = client
  708. try await control.unary(
  709. request: ClientRequest(message: message),
  710. options: options
  711. ) { response in
  712. // Check the client algorithm.
  713. switch client {
  714. case .deflate, .gzip:
  715. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  716. let encoding = Array(response.metadata["echo-grpc-encoding"])
  717. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  718. case .none:
  719. ()
  720. default:
  721. XCTFail("Unhandled compression '\(client)'")
  722. }
  723. // Check the server algorithm.
  724. switch server {
  725. case .deflate, .gzip:
  726. let encoding = Array(response.metadata["grpc-encoding"])
  727. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  728. case .none:
  729. ()
  730. default:
  731. XCTFail("Unhandled compression '\(client)'")
  732. }
  733. let message = try response.message
  734. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  735. }
  736. }
  737. private func testClientStreamingCompression(
  738. client: CompressionAlgorithm,
  739. server: CompressionAlgorithm,
  740. control: ControlClient<NIOClientTransport>,
  741. pair: Transport
  742. ) async throws {
  743. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  744. try await writer.write(.echoMetadata)
  745. try await writer.write(.noOp)
  746. try await writer.write(.noOp)
  747. try await writer.write(.messages(1, repeating: 42, count: 1024))
  748. }
  749. var options = CallOptions.defaults
  750. options.compression = client
  751. try await control.clientStream(request: request, options: options) { response in
  752. // Check the client algorithm.
  753. switch client {
  754. case .deflate, .gzip:
  755. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  756. let encoding = Array(response.metadata["echo-grpc-encoding"])
  757. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  758. case .none:
  759. ()
  760. default:
  761. XCTFail("Unhandled compression '\(client)'")
  762. }
  763. // Check the server algorithm.
  764. switch server {
  765. case .deflate, .gzip:
  766. let encoding = Array(response.metadata["grpc-encoding"])
  767. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  768. case .none:
  769. ()
  770. default:
  771. XCTFail("Unhandled compression '\(client)'")
  772. }
  773. let message = try response.message
  774. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  775. }
  776. }
  777. private func testServerStreamingCompression(
  778. client: CompressionAlgorithm,
  779. server: CompressionAlgorithm,
  780. control: ControlClient<NIOClientTransport>,
  781. pair: Transport
  782. ) async throws {
  783. let message = ControlInput.with {
  784. $0.echoMetadataInHeaders = true
  785. $0.numberOfMessages = 5
  786. $0.payloadParameters = .with {
  787. $0.content = 42
  788. $0.size = 1024
  789. }
  790. }
  791. var options = CallOptions.defaults
  792. options.compression = client
  793. try await control.serverStream(
  794. request: ClientRequest(message: message),
  795. options: options
  796. ) { response in
  797. // Check the client algorithm.
  798. switch client {
  799. case .deflate, .gzip:
  800. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  801. let encoding = Array(response.metadata["echo-grpc-encoding"])
  802. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  803. case .none:
  804. ()
  805. default:
  806. XCTFail("Unhandled compression '\(client)'")
  807. }
  808. // Check the server algorithm.
  809. switch server {
  810. case .deflate, .gzip:
  811. let encoding = Array(response.metadata["grpc-encoding"])
  812. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  813. case .none:
  814. ()
  815. default:
  816. XCTFail("Unhandled compression '\(client)'")
  817. }
  818. for try await message in response.messages {
  819. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  820. }
  821. }
  822. }
  823. private func testBidiStreamingCompression(
  824. client: CompressionAlgorithm,
  825. server: CompressionAlgorithm,
  826. control: ControlClient<NIOClientTransport>,
  827. pair: Transport
  828. ) async throws {
  829. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  830. try await writer.write(.echoMetadata)
  831. try await writer.write(.messages(1, repeating: 42, count: 1024))
  832. try await writer.write(.messages(1, repeating: 42, count: 1024))
  833. try await writer.write(.messages(1, repeating: 42, count: 1024))
  834. }
  835. var options = CallOptions.defaults
  836. options.compression = client
  837. try await control.bidiStream(request: request, options: options) { response in
  838. // Check the client algorithm.
  839. switch client {
  840. case .deflate, .gzip:
  841. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  842. let encoding = Array(response.metadata["echo-grpc-encoding"])
  843. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  844. case .none:
  845. ()
  846. default:
  847. XCTFail("Unhandled compression '\(client)'")
  848. }
  849. // Check the server algorithm.
  850. switch server {
  851. case .deflate, .gzip:
  852. let encoding = Array(response.metadata["grpc-encoding"])
  853. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  854. case .none:
  855. ()
  856. default:
  857. XCTFail("Unhandled compression '\(client)'")
  858. }
  859. for try await message in response.messages {
  860. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  861. }
  862. }
  863. }
  864. func testUnaryDeflateCompression() async throws {
  865. try await self.forEachTransportPair(
  866. clientCompression: .deflate,
  867. clientEnabledCompression: .deflate,
  868. serverCompression: .deflate
  869. ) { control, _, pair in
  870. try await self.testUnaryCompression(
  871. client: .deflate,
  872. server: .deflate,
  873. control: control,
  874. pair: pair
  875. )
  876. }
  877. }
  878. func testUnaryGzipCompression() async throws {
  879. try await self.forEachTransportPair(
  880. clientCompression: .gzip,
  881. clientEnabledCompression: .gzip,
  882. serverCompression: .gzip
  883. ) { control, _, pair in
  884. try await self.testUnaryCompression(
  885. client: .gzip,
  886. server: .gzip,
  887. control: control,
  888. pair: pair
  889. )
  890. }
  891. }
  892. func testClientStreamingDeflateCompression() async throws {
  893. try await self.forEachTransportPair(
  894. clientCompression: .deflate,
  895. clientEnabledCompression: .deflate,
  896. serverCompression: .deflate
  897. ) { control, _, pair in
  898. try await self.testClientStreamingCompression(
  899. client: .deflate,
  900. server: .deflate,
  901. control: control,
  902. pair: pair
  903. )
  904. }
  905. }
  906. func testClientStreamingGzipCompression() async throws {
  907. try await self.forEachTransportPair(
  908. clientCompression: .gzip,
  909. clientEnabledCompression: .gzip,
  910. serverCompression: .gzip
  911. ) { control, _, pair in
  912. try await self.testClientStreamingCompression(
  913. client: .gzip,
  914. server: .gzip,
  915. control: control,
  916. pair: pair
  917. )
  918. }
  919. }
  920. func testServerStreamingDeflateCompression() async throws {
  921. try await self.forEachTransportPair(
  922. clientCompression: .deflate,
  923. clientEnabledCompression: .deflate,
  924. serverCompression: .deflate
  925. ) { control, _, pair in
  926. try await self.testServerStreamingCompression(
  927. client: .deflate,
  928. server: .deflate,
  929. control: control,
  930. pair: pair
  931. )
  932. }
  933. }
  934. func testServerStreamingGzipCompression() async throws {
  935. try await self.forEachTransportPair(
  936. clientCompression: .gzip,
  937. clientEnabledCompression: .gzip,
  938. serverCompression: .gzip
  939. ) { control, _, pair in
  940. try await self.testServerStreamingCompression(
  941. client: .gzip,
  942. server: .gzip,
  943. control: control,
  944. pair: pair
  945. )
  946. }
  947. }
  948. func testBidiStreamingDeflateCompression() async throws {
  949. try await self.forEachTransportPair(
  950. clientCompression: .deflate,
  951. clientEnabledCompression: .deflate,
  952. serverCompression: .deflate
  953. ) { control, _, pair in
  954. try await self.testBidiStreamingCompression(
  955. client: .deflate,
  956. server: .deflate,
  957. control: control,
  958. pair: pair
  959. )
  960. }
  961. }
  962. func testBidiStreamingGzipCompression() async throws {
  963. try await self.forEachTransportPair(
  964. clientCompression: .gzip,
  965. clientEnabledCompression: .gzip,
  966. serverCompression: .gzip
  967. ) { control, _, pair in
  968. try await self.testBidiStreamingCompression(
  969. client: .gzip,
  970. server: .gzip,
  971. control: control,
  972. pair: pair
  973. )
  974. }
  975. }
  976. func testUnaryUnsupportedCompression() async throws {
  977. try await self.forEachTransportPair(
  978. clientEnabledCompression: .all,
  979. serverCompression: .gzip
  980. ) { control, _, pair in
  981. let message = ControlInput.with {
  982. $0.numberOfMessages = 1
  983. $0.payloadParameters = .with {
  984. $0.content = 42
  985. $0.size = 1024
  986. }
  987. }
  988. let request = ClientRequest(message: message)
  989. var options = CallOptions.defaults
  990. options.compression = .deflate
  991. try await control.unary(request: request, options: options) { response in
  992. switch response.accepted {
  993. case .success:
  994. XCTFail("RPC should've been rejected")
  995. case .failure(let error):
  996. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  997. // "identity" may or may not be included, so only test for values which must be present.
  998. XCTAssertTrue(acceptEncoding.contains("gzip"))
  999. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1000. }
  1001. }
  1002. }
  1003. }
  1004. func testClientStreamingUnsupportedCompression() async throws {
  1005. try await self.forEachTransportPair(
  1006. clientEnabledCompression: .all,
  1007. serverCompression: .gzip
  1008. ) { control, _, pair in
  1009. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1010. try await writer.write(.noOp)
  1011. }
  1012. var options = CallOptions.defaults
  1013. options.compression = .deflate
  1014. try await control.clientStream(request: request, options: options) { response in
  1015. switch response.accepted {
  1016. case .success:
  1017. XCTFail("RPC should've been rejected")
  1018. case .failure(let error):
  1019. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1020. // "identity" may or may not be included, so only test for values which must be present.
  1021. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1022. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1023. }
  1024. }
  1025. }
  1026. }
  1027. func testServerStreamingUnsupportedCompression() async throws {
  1028. try await self.forEachTransportPair(
  1029. clientEnabledCompression: .all,
  1030. serverCompression: .gzip
  1031. ) { control, _, pair in
  1032. let message = ControlInput.with {
  1033. $0.numberOfMessages = 1
  1034. $0.payloadParameters = .with {
  1035. $0.content = 42
  1036. $0.size = 1024
  1037. }
  1038. }
  1039. let request = ClientRequest(message: message)
  1040. var options = CallOptions.defaults
  1041. options.compression = .deflate
  1042. try await control.serverStream(request: request, options: options) { response in
  1043. switch response.accepted {
  1044. case .success:
  1045. XCTFail("RPC should've been rejected")
  1046. case .failure(let error):
  1047. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1048. // "identity" may or may not be included, so only test for values which must be present.
  1049. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1050. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1051. }
  1052. }
  1053. }
  1054. }
  1055. func testBidiStreamingUnsupportedCompression() async throws {
  1056. try await self.forEachTransportPair(
  1057. clientEnabledCompression: .all,
  1058. serverCompression: .gzip
  1059. ) { control, _, pair in
  1060. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1061. try await writer.write(.noOp)
  1062. }
  1063. var options = CallOptions.defaults
  1064. options.compression = .deflate
  1065. try await control.bidiStream(request: request, options: options) { response in
  1066. switch response.accepted {
  1067. case .success:
  1068. XCTFail("RPC should've been rejected")
  1069. case .failure(let error):
  1070. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1071. // "identity" may or may not be included, so only test for values which must be present.
  1072. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1073. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1074. }
  1075. }
  1076. }
  1077. }
  1078. func testUnaryTimeoutPropagatedToServer() async throws {
  1079. try await self.forEachTransportPair { control, _, pair in
  1080. let message = ControlInput.with {
  1081. $0.echoMetadataInHeaders = true
  1082. $0.numberOfMessages = 1
  1083. }
  1084. let request = ClientRequest(message: message)
  1085. var options = CallOptions.defaults
  1086. options.timeout = .seconds(10)
  1087. try await control.unary(request: request, options: options) { response in
  1088. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1089. XCTAssertEqual(timeout.count, 1)
  1090. }
  1091. }
  1092. }
  1093. func testClientStreamingTimeoutPropagatedToServer() async throws {
  1094. try await self.forEachTransportPair { control, _, pair in
  1095. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1096. let message = ControlInput.with {
  1097. $0.echoMetadataInHeaders = true
  1098. $0.numberOfMessages = 1
  1099. }
  1100. try await writer.write(message)
  1101. }
  1102. var options = CallOptions.defaults
  1103. options.timeout = .seconds(10)
  1104. try await control.clientStream(request: request, options: options) { response in
  1105. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1106. XCTAssertEqual(timeout.count, 1)
  1107. }
  1108. }
  1109. }
  1110. func testServerStreamingTimeoutPropagatedToServer() async throws {
  1111. try await self.forEachTransportPair { control, _, pair in
  1112. let message = ControlInput.with {
  1113. $0.echoMetadataInHeaders = true
  1114. $0.numberOfMessages = 1
  1115. }
  1116. let request = ClientRequest(message: message)
  1117. var options = CallOptions.defaults
  1118. options.timeout = .seconds(10)
  1119. try await control.serverStream(request: request, options: options) { response in
  1120. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1121. XCTAssertEqual(timeout.count, 1)
  1122. }
  1123. }
  1124. }
  1125. func testBidiStreamingTimeoutPropagatedToServer() async throws {
  1126. try await self.forEachTransportPair { control, _, pair in
  1127. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1128. try await writer.write(.echoMetadata)
  1129. }
  1130. var options = CallOptions.defaults
  1131. options.timeout = .seconds(10)
  1132. try await control.bidiStream(request: request, options: options) { response in
  1133. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1134. XCTAssertEqual(timeout.count, 1)
  1135. }
  1136. }
  1137. }
  1138. private static let httpToStatusCodePairs: [(Int, RPCError.Code)] = [
  1139. // See https://github.com/grpc/grpc/blob/7f664c69b2a636386fbf95c16bc78c559734ce0f/doc/http-grpc-status-mapping.md
  1140. (400, .internalError),
  1141. (401, .unauthenticated),
  1142. (403, .permissionDenied),
  1143. (404, .unimplemented),
  1144. (418, .unknown),
  1145. (429, .unavailable),
  1146. (502, .unavailable),
  1147. (503, .unavailable),
  1148. (504, .unavailable),
  1149. (504, .unavailable),
  1150. ]
  1151. func testUnaryAgainstNonGRPCServer() async throws {
  1152. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1153. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1154. // Tell the server what to respond with.
  1155. let metadata: Metadata = ["response-status": "\(httpCode)"]
  1156. try await control.unary(
  1157. request: ClientRequest(message: .noOp, metadata: metadata)
  1158. ) { response in
  1159. switch response.accepted {
  1160. case .success:
  1161. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1162. case .failure(let error):
  1163. XCTAssertEqual(error.code, expectedStatus)
  1164. }
  1165. }
  1166. }
  1167. }
  1168. }
  1169. func testClientStreamingAgainstNonGRPCServer() async throws {
  1170. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1171. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1172. // Tell the server what to respond with.
  1173. let request = StreamingClientRequest(
  1174. of: ControlInput.self,
  1175. metadata: ["response-status": "\(httpCode)"]
  1176. ) { _ in
  1177. }
  1178. try await control.clientStream(request: request) { response in
  1179. switch response.accepted {
  1180. case .success:
  1181. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1182. case .failure(let error):
  1183. XCTAssertEqual(error.code, expectedStatus)
  1184. }
  1185. }
  1186. }
  1187. }
  1188. }
  1189. func testServerStreamingAgainstNonGRPCServer() async throws {
  1190. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1191. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1192. // Tell the server what to respond with.
  1193. let metadata: Metadata = ["response-status": "\(httpCode)"]
  1194. try await control.serverStream(
  1195. request: ClientRequest(message: .noOp, metadata: metadata)
  1196. ) { response in
  1197. switch response.accepted {
  1198. case .success:
  1199. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1200. case .failure(let error):
  1201. XCTAssertEqual(error.code, expectedStatus)
  1202. }
  1203. }
  1204. }
  1205. }
  1206. }
  1207. func testBidiStreamingAgainstNonGRPCServer() async throws {
  1208. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1209. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1210. // Tell the server what to respond with.
  1211. let request = StreamingClientRequest(
  1212. of: ControlInput.self,
  1213. metadata: ["response-status": "\(httpCode)"]
  1214. ) { _ in
  1215. }
  1216. try await control.bidiStream(request: request) { response in
  1217. switch response.accepted {
  1218. case .success:
  1219. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1220. case .failure(let error):
  1221. XCTAssertEqual(error.code, expectedStatus)
  1222. }
  1223. }
  1224. }
  1225. }
  1226. }
  1227. func testUnaryScheme() async throws {
  1228. try await self.forEachTransportPair { control, _, pair in
  1229. let input = ControlInput.with {
  1230. $0.echoMetadataInHeaders = true
  1231. $0.numberOfMessages = 1
  1232. }
  1233. let request = ClientRequest(message: input)
  1234. try await control.unary(request: request) { response in
  1235. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1236. }
  1237. }
  1238. }
  1239. func testServerStreamingScheme() async throws {
  1240. try await self.forEachTransportPair { control, _, pair in
  1241. let input = ControlInput.with {
  1242. $0.echoMetadataInHeaders = true
  1243. $0.numberOfMessages = 1
  1244. }
  1245. let request = ClientRequest(message: input)
  1246. try await control.serverStream(request: request) { response in
  1247. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1248. }
  1249. }
  1250. }
  1251. func testClientStreamingScheme() async throws {
  1252. try await self.forEachTransportPair { control, _, pair in
  1253. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1254. let input = ControlInput.with {
  1255. $0.echoMetadataInHeaders = true
  1256. $0.numberOfMessages = 1
  1257. }
  1258. try await writer.write(input)
  1259. }
  1260. try await control.clientStream(request: request) { response in
  1261. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1262. }
  1263. }
  1264. }
  1265. func testBidiStreamingScheme() async throws {
  1266. try await self.forEachTransportPair { control, _, pair in
  1267. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1268. let input = ControlInput.with {
  1269. $0.echoMetadataInHeaders = true
  1270. $0.numberOfMessages = 1
  1271. }
  1272. try await writer.write(input)
  1273. }
  1274. try await control.bidiStream(request: request) { response in
  1275. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1276. }
  1277. }
  1278. }
  1279. func testServerCancellation() async throws {
  1280. for kind in [CancellationKind.awaitCancelled, .withCancellationHandler] {
  1281. try await self.forEachTransportPair { control, server, pair in
  1282. let request = ClientRequest(message: kind)
  1283. try await control.waitForCancellation(request: request) { response in
  1284. // Shutdown the client so that it doesn't attempt to reconnect when the server closes.
  1285. control.client.beginGracefulShutdown()
  1286. // Shutdown the server to cancel the RPC.
  1287. server.beginGracefulShutdown()
  1288. // The RPC should complete without any error or response.
  1289. let responses = try await response.messages.reduce(into: []) { $0.append($1) }
  1290. XCTAssert(responses.isEmpty)
  1291. }
  1292. }
  1293. }
  1294. }
  1295. func testUppercaseClientMetadataKey() async throws {
  1296. try await self.forEachTransportPair { control, _, _ in
  1297. let request = ClientRequest<ControlInput>(
  1298. message: .with {
  1299. $0.echoMetadataInHeaders = true
  1300. $0.numberOfMessages = 1
  1301. },
  1302. metadata: ["UPPERCASE-KEY": "value"]
  1303. )
  1304. try await control.unary(request: request) { response in
  1305. // Keys will be lowercase before being sent over the wire.
  1306. XCTAssertEqual(Array(response.metadata["echo-uppercase-key"]), ["value"])
  1307. }
  1308. }
  1309. }
  1310. func testUppercaseServerMetadataKey() async throws {
  1311. try await self.forEachTransportPair { control, _, _ in
  1312. let request = ClientRequest<ControlInput>(
  1313. message: .with {
  1314. $0.initialMetadataToAdd["UPPERCASE-KEY"] = "initial"
  1315. $0.trailingMetadataToAdd["UPPERCASE-KEY"] = "trailing"
  1316. $0.numberOfMessages = 1
  1317. }
  1318. )
  1319. try await control.unary(request: request) { response in
  1320. XCTAssertEqual(Array(response.metadata["uppercase-key"]), ["initial"])
  1321. XCTAssertEqual(Array(response.trailingMetadata["uppercase-key"]), ["trailing"])
  1322. }
  1323. }
  1324. }
  1325. private func checkAuthority(
  1326. client: GRPCClient<NIOClientTransport>,
  1327. expected: String
  1328. ) async throws {
  1329. let control = ControlClient(wrapping: client)
  1330. let input = ControlInput.with {
  1331. $0.echoMetadataInHeaders = true
  1332. $0.echoMetadataInTrailers = true
  1333. $0.numberOfMessages = 1
  1334. $0.payloadParameters = .with {
  1335. $0.content = 0
  1336. $0.size = 1024
  1337. }
  1338. }
  1339. try await control.unary(request: ClientRequest(message: input)) { response in
  1340. let initial = response.metadata
  1341. XCTAssertEqual(Array(initial["echo-authority"]), [.string(expected)])
  1342. }
  1343. }
  1344. private func testAuthority(
  1345. serverAddress: SocketAddress,
  1346. authorityOverride override: String? = nil,
  1347. clientTarget: (SocketAddress) -> any ResolvableTarget,
  1348. expectedAuthority: (SocketAddress) -> String
  1349. ) async throws {
  1350. try await withGRPCServer(
  1351. transport: .http2NIOPosix(
  1352. address: serverAddress,
  1353. transportSecurity: .plaintext
  1354. ),
  1355. services: [ControlService()]
  1356. ) { server in
  1357. guard let listeningAddress = try await server.listeningAddress else {
  1358. XCTFail("No listening address")
  1359. return
  1360. }
  1361. let target = clientTarget(listeningAddress)
  1362. try await withGRPCClient(
  1363. transport: NIOClientTransport(
  1364. .http2NIOPosix(
  1365. target: target,
  1366. transportSecurity: .plaintext,
  1367. config: .defaults {
  1368. $0.http2.authority = override
  1369. }
  1370. )
  1371. )
  1372. ) { client in
  1373. try await self.checkAuthority(client: client, expected: expectedAuthority(listeningAddress))
  1374. }
  1375. }
  1376. }
  1377. func testAuthorityDNS() async throws {
  1378. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1379. return .dns(host: "localhost", port: address.ipv4!.port)
  1380. } expectedAuthority: { address in
  1381. return "localhost:\(address.ipv4!.port)"
  1382. }
  1383. }
  1384. func testOverrideAuthorityDNS() async throws {
  1385. try await self.testAuthority(
  1386. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1387. authorityOverride: "respect-my-authority"
  1388. ) { address in
  1389. return .dns(host: "localhost", port: address.ipv4!.port)
  1390. } expectedAuthority: { _ in
  1391. return "respect-my-authority"
  1392. }
  1393. }
  1394. func testAuthorityIPv4() async throws {
  1395. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1396. return .ipv4(host: "127.0.0.1", port: address.ipv4!.port)
  1397. } expectedAuthority: { address in
  1398. return "127.0.0.1:\(address.ipv4!.port)"
  1399. }
  1400. }
  1401. func testOverrideAuthorityIPv4() async throws {
  1402. try await self.testAuthority(
  1403. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1404. authorityOverride: "respect-my-authority"
  1405. ) { address in
  1406. return .ipv4(host: "127.0.0.1", port: address.ipv4!.port)
  1407. } expectedAuthority: { _ in
  1408. return "respect-my-authority"
  1409. }
  1410. }
  1411. func testAuthorityIPv6() async throws {
  1412. try await self.testAuthority(serverAddress: .ipv6(host: "::1", port: 0)) { address in
  1413. return .ipv6(host: "::1", port: address.ipv6!.port)
  1414. } expectedAuthority: { address in
  1415. return "[::1]:\(address.ipv6!.port)"
  1416. }
  1417. }
  1418. func testOverrideAuthorityIPv6() async throws {
  1419. try await self.testAuthority(
  1420. serverAddress: .ipv6(host: "::1", port: 0),
  1421. authorityOverride: "respect-my-authority"
  1422. ) { address in
  1423. return .ipv6(host: "::1", port: address.ipv6!.port)
  1424. } expectedAuthority: { _ in
  1425. return "respect-my-authority"
  1426. }
  1427. }
  1428. func testAuthorityUDS() async throws {
  1429. let path = "test-authority-uds"
  1430. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1431. return .unixDomainSocket(path: path)
  1432. } expectedAuthority: { _ in
  1433. return path
  1434. }
  1435. }
  1436. func testAuthorityLocalUDSOverride() async throws {
  1437. let path = "test-authority-local-uds-override"
  1438. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1439. return .unixDomainSocket(path: path, authority: "respect-my-authority")
  1440. } expectedAuthority: { _ in
  1441. return "respect-my-authority"
  1442. }
  1443. }
  1444. func testOverrideAuthorityUDS() async throws {
  1445. let path = "test-override-authority-uds"
  1446. try await self.testAuthority(
  1447. serverAddress: .unixDomainSocket(path: path),
  1448. authorityOverride: "respect-my-authority"
  1449. ) { _ in
  1450. return .unixDomainSocket(path: path, authority: "should-be-ignored")
  1451. } expectedAuthority: { _ in
  1452. return "respect-my-authority"
  1453. }
  1454. }
  1455. func testPeerInfoIPv4() async throws {
  1456. try await self.forEachTransportPair(
  1457. serverAddress: .ipv4(host: "127.0.0.1", port: 0)
  1458. ) { control, _, _ in
  1459. let peerInfo = try await control.peerInfo()
  1460. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1461. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1462. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1463. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1464. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1465. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1466. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1467. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1468. }
  1469. }
  1470. func testPeerInfoIPv6() async throws {
  1471. try await self.forEachTransportPair(
  1472. serverAddress: .ipv6(host: "::1", port: 0)
  1473. ) { control, _, _ in
  1474. let peerInfo = try await control.peerInfo()
  1475. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1476. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1477. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1478. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1479. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1480. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1481. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1482. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1483. }
  1484. }
  1485. func testPeerInfoUDS() async throws {
  1486. let path = "peer-info-uds"
  1487. try await self.forEachTransportPair(
  1488. serverAddress: .unixDomainSocket(path: path)
  1489. ) { control, _, _ in
  1490. let peerInfo = try await control.peerInfo()
  1491. XCTAssertNotNil(peerInfo.server.remote.wholeMatch(of: /unix:peer-info-uds/))
  1492. XCTAssertNotNil(peerInfo.server.local.wholeMatch(of: /unix:peer-info-uds/))
  1493. XCTAssertNotNil(peerInfo.client.remote.wholeMatch(of: /unix:peer-info-uds/))
  1494. XCTAssertNotNil(peerInfo.client.local.wholeMatch(of: /unix:peer-info-uds/))
  1495. }
  1496. }
  1497. }
  1498. extension [HTTP2TransportTests.Transport] {
  1499. static let supported: [HTTP2TransportTests.Transport] = TransportKind.allCases.flatMap { server in
  1500. TransportKind.allCases.map { client in
  1501. HTTP2TransportTests.Transport(server: server, client: client)
  1502. }
  1503. }
  1504. }
  1505. extension ControlInput {
  1506. fileprivate static let echoMetadata = Self.with {
  1507. $0.echoMetadataInHeaders = true
  1508. }
  1509. fileprivate static let noOp = Self()
  1510. fileprivate static func messages(
  1511. _ numberOfMessages: Int,
  1512. repeating: UInt8,
  1513. count: Int
  1514. ) -> Self {
  1515. return Self.with {
  1516. $0.numberOfMessages = numberOfMessages
  1517. $0.payloadParameters = .with {
  1518. $0.content = repeating
  1519. $0.size = count
  1520. }
  1521. }
  1522. }
  1523. fileprivate static func status(
  1524. code: GRPCCore.Status.Code,
  1525. message: String,
  1526. echoMetadata: Bool
  1527. ) -> Self {
  1528. return Self.with {
  1529. $0.echoMetadataInTrailers = echoMetadata
  1530. $0.status = .with {
  1531. $0.code = code
  1532. $0.message = message
  1533. }
  1534. }
  1535. }
  1536. fileprivate static func trailersOnly(
  1537. code: GRPCCore.Status.Code,
  1538. message: String,
  1539. echoMetadata: Bool
  1540. ) -> Self {
  1541. return Self.with {
  1542. $0.echoMetadataInTrailers = echoMetadata
  1543. $0.isTrailersOnly = true
  1544. $0.status = .with {
  1545. $0.code = code
  1546. $0.message = message
  1547. }
  1548. }
  1549. }
  1550. }
  1551. extension CompressionAlgorithm {
  1552. var name: String {
  1553. switch self {
  1554. case .deflate:
  1555. return "deflate"
  1556. case .gzip:
  1557. return "gzip"
  1558. case .none:
  1559. return "identity"
  1560. default:
  1561. return ""
  1562. }
  1563. }
  1564. }