HTTP2TransportTests.swift 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755
  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. // Workaround https://github.com/grpc/grpc-swift-nio-transport/issues/43
  1249. for try await _ in response.messages {}
  1250. }
  1251. }
  1252. }
  1253. func testClientStreamingScheme() async throws {
  1254. try await self.forEachTransportPair { control, _, pair in
  1255. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1256. let input = ControlInput.with {
  1257. $0.echoMetadataInHeaders = true
  1258. $0.numberOfMessages = 1
  1259. }
  1260. try await writer.write(input)
  1261. }
  1262. try await control.clientStream(request: request) { response in
  1263. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1264. }
  1265. }
  1266. }
  1267. func testBidiStreamingScheme() async throws {
  1268. try await self.forEachTransportPair { control, _, pair in
  1269. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1270. let input = ControlInput.with {
  1271. $0.echoMetadataInHeaders = true
  1272. $0.numberOfMessages = 1
  1273. }
  1274. try await writer.write(input)
  1275. }
  1276. try await control.bidiStream(request: request) { response in
  1277. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1278. // Workaround https://github.com/grpc/grpc-swift-nio-transport/issues/43
  1279. for try await _ in response.messages {}
  1280. }
  1281. }
  1282. }
  1283. func testServerCancellation() async throws {
  1284. for kind in [CancellationKind.awaitCancelled, .withCancellationHandler] {
  1285. try await self.forEachTransportPair { control, server, pair in
  1286. let request = ClientRequest(message: kind)
  1287. try await control.waitForCancellation(request: request) { response in
  1288. // Shutdown the client so that it doesn't attempt to reconnect when the server closes.
  1289. control.client.beginGracefulShutdown()
  1290. // Shutdown the server to cancel the RPC.
  1291. server.beginGracefulShutdown()
  1292. // The RPC should complete without any error or response.
  1293. let responses = try await response.messages.reduce(into: []) { $0.append($1) }
  1294. XCTAssert(responses.isEmpty)
  1295. }
  1296. }
  1297. }
  1298. }
  1299. func testUppercaseClientMetadataKey() async throws {
  1300. try await self.forEachTransportPair { control, _, _ in
  1301. let request = ClientRequest<ControlInput>(
  1302. message: .with {
  1303. $0.echoMetadataInHeaders = true
  1304. $0.numberOfMessages = 1
  1305. },
  1306. metadata: ["UPPERCASE-KEY": "value"]
  1307. )
  1308. try await control.unary(request: request) { response in
  1309. // Keys will be lowercase before being sent over the wire.
  1310. XCTAssertEqual(Array(response.metadata["echo-uppercase-key"]), ["value"])
  1311. }
  1312. }
  1313. }
  1314. func testUppercaseServerMetadataKey() async throws {
  1315. try await self.forEachTransportPair { control, _, _ in
  1316. let request = ClientRequest<ControlInput>(
  1317. message: .with {
  1318. $0.initialMetadataToAdd["UPPERCASE-KEY"] = "initial"
  1319. $0.trailingMetadataToAdd["UPPERCASE-KEY"] = "trailing"
  1320. $0.numberOfMessages = 1
  1321. }
  1322. )
  1323. try await control.unary(request: request) { response in
  1324. XCTAssertEqual(Array(response.metadata["uppercase-key"]), ["initial"])
  1325. XCTAssertEqual(Array(response.trailingMetadata["uppercase-key"]), ["trailing"])
  1326. }
  1327. }
  1328. }
  1329. private func checkAuthority(
  1330. client: GRPCClient<NIOClientTransport>,
  1331. expected: String
  1332. ) async throws {
  1333. let control = ControlClient(wrapping: client)
  1334. let input = ControlInput.with {
  1335. $0.echoMetadataInHeaders = true
  1336. $0.echoMetadataInTrailers = true
  1337. $0.numberOfMessages = 1
  1338. $0.payloadParameters = .with {
  1339. $0.content = 0
  1340. $0.size = 1024
  1341. }
  1342. }
  1343. try await control.unary(request: ClientRequest(message: input)) { response in
  1344. let initial = response.metadata
  1345. XCTAssertEqual(Array(initial["echo-authority"]), [.string(expected)])
  1346. }
  1347. }
  1348. private func testAuthority(
  1349. serverAddress: SocketAddress,
  1350. authorityOverride override: String? = nil,
  1351. clientTarget: (SocketAddress) -> any ResolvableTarget,
  1352. expectedAuthority: (SocketAddress) -> String
  1353. ) async throws {
  1354. try await withGRPCServer(
  1355. transport: .http2NIOPosix(
  1356. address: serverAddress,
  1357. transportSecurity: .plaintext
  1358. ),
  1359. services: [ControlService()]
  1360. ) { server in
  1361. guard let listeningAddress = try await server.listeningAddress else {
  1362. XCTFail("No listening address")
  1363. return
  1364. }
  1365. let target = clientTarget(listeningAddress)
  1366. try await withGRPCClient(
  1367. transport: NIOClientTransport(
  1368. .http2NIOPosix(
  1369. target: target,
  1370. transportSecurity: .plaintext,
  1371. config: .defaults {
  1372. $0.http2.authority = override
  1373. }
  1374. )
  1375. )
  1376. ) { client in
  1377. try await self.checkAuthority(client: client, expected: expectedAuthority(listeningAddress))
  1378. }
  1379. }
  1380. }
  1381. func testAuthorityDNS() async throws {
  1382. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1383. return .dns(host: "localhost", port: address.ipv4!.port)
  1384. } expectedAuthority: { address in
  1385. return "localhost:\(address.ipv4!.port)"
  1386. }
  1387. }
  1388. func testOverrideAuthorityDNS() async throws {
  1389. try await self.testAuthority(
  1390. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1391. authorityOverride: "respect-my-authority"
  1392. ) { address in
  1393. return .dns(host: "localhost", port: address.ipv4!.port)
  1394. } expectedAuthority: { _ in
  1395. return "respect-my-authority"
  1396. }
  1397. }
  1398. func testAuthorityIPv4() async throws {
  1399. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1400. return .ipv4(host: "127.0.0.1", port: address.ipv4!.port)
  1401. } expectedAuthority: { address in
  1402. return "127.0.0.1:\(address.ipv4!.port)"
  1403. }
  1404. }
  1405. func testOverrideAuthorityIPv4() async throws {
  1406. try await self.testAuthority(
  1407. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1408. authorityOverride: "respect-my-authority"
  1409. ) { address in
  1410. return .ipv4(host: "127.0.0.1", port: address.ipv4!.port)
  1411. } expectedAuthority: { _ in
  1412. return "respect-my-authority"
  1413. }
  1414. }
  1415. func testAuthorityIPv6() async throws {
  1416. try await self.testAuthority(serverAddress: .ipv6(host: "::1", port: 0)) { address in
  1417. return .ipv6(host: "::1", port: address.ipv6!.port)
  1418. } expectedAuthority: { address in
  1419. return "[::1]:\(address.ipv6!.port)"
  1420. }
  1421. }
  1422. func testOverrideAuthorityIPv6() async throws {
  1423. try await self.testAuthority(
  1424. serverAddress: .ipv6(host: "::1", port: 0),
  1425. authorityOverride: "respect-my-authority"
  1426. ) { address in
  1427. return .ipv6(host: "::1", port: address.ipv6!.port)
  1428. } expectedAuthority: { _ in
  1429. return "respect-my-authority"
  1430. }
  1431. }
  1432. func testAuthorityUDS() async throws {
  1433. let path = "test-authority-uds"
  1434. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1435. return .unixDomainSocket(path: path)
  1436. } expectedAuthority: { _ in
  1437. return path
  1438. }
  1439. }
  1440. func testAuthorityLocalUDSOverride() async throws {
  1441. let path = "test-authority-local-uds-override"
  1442. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1443. return .unixDomainSocket(path: path, authority: "respect-my-authority")
  1444. } expectedAuthority: { _ in
  1445. return "respect-my-authority"
  1446. }
  1447. }
  1448. func testOverrideAuthorityUDS() async throws {
  1449. let path = "test-override-authority-uds"
  1450. try await self.testAuthority(
  1451. serverAddress: .unixDomainSocket(path: path),
  1452. authorityOverride: "respect-my-authority"
  1453. ) { _ in
  1454. return .unixDomainSocket(path: path, authority: "should-be-ignored")
  1455. } expectedAuthority: { _ in
  1456. return "respect-my-authority"
  1457. }
  1458. }
  1459. func testPeerInfoIPv4() async throws {
  1460. try await self.forEachTransportPair(
  1461. serverAddress: .ipv4(host: "127.0.0.1", port: 0)
  1462. ) { control, _, _ in
  1463. let peerInfo = try await control.peerInfo()
  1464. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1465. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1466. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1467. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1468. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1469. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1470. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1471. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1472. }
  1473. }
  1474. func testPeerInfoIPv6() async throws {
  1475. try await self.forEachTransportPair(
  1476. serverAddress: .ipv6(host: "::1", port: 0)
  1477. ) { control, _, _ in
  1478. let peerInfo = try await control.peerInfo()
  1479. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1480. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1481. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1482. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1483. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1484. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1485. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1486. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1487. }
  1488. }
  1489. func testPeerInfoUDS() async throws {
  1490. let path = "peer-info-uds"
  1491. try await self.forEachTransportPair(
  1492. serverAddress: .unixDomainSocket(path: path)
  1493. ) { control, _, _ in
  1494. let peerInfo = try await control.peerInfo()
  1495. XCTAssertNotNil(peerInfo.server.remote.wholeMatch(of: /unix:peer-info-uds/))
  1496. XCTAssertNotNil(peerInfo.server.local.wholeMatch(of: /unix:peer-info-uds/))
  1497. XCTAssertNotNil(peerInfo.client.remote.wholeMatch(of: /unix:peer-info-uds/))
  1498. XCTAssertNotNil(peerInfo.client.local.wholeMatch(of: /unix:peer-info-uds/))
  1499. }
  1500. }
  1501. }
  1502. extension [HTTP2TransportTests.Transport] {
  1503. static let supported: [HTTP2TransportTests.Transport] = TransportKind.allCases.flatMap { server in
  1504. TransportKind.allCases.map { client in
  1505. HTTP2TransportTests.Transport(server: server, client: client)
  1506. }
  1507. }
  1508. }
  1509. extension ControlInput {
  1510. fileprivate static let echoMetadata = Self.with {
  1511. $0.echoMetadataInHeaders = true
  1512. }
  1513. fileprivate static let noOp = Self()
  1514. fileprivate static func messages(
  1515. _ numberOfMessages: Int,
  1516. repeating: UInt8,
  1517. count: Int
  1518. ) -> Self {
  1519. return Self.with {
  1520. $0.numberOfMessages = numberOfMessages
  1521. $0.payloadParameters = .with {
  1522. $0.content = repeating
  1523. $0.size = count
  1524. }
  1525. }
  1526. }
  1527. fileprivate static func status(
  1528. code: GRPCCore.Status.Code,
  1529. message: String,
  1530. echoMetadata: Bool
  1531. ) -> Self {
  1532. return Self.with {
  1533. $0.echoMetadataInTrailers = echoMetadata
  1534. $0.status = .with {
  1535. $0.code = code
  1536. $0.message = message
  1537. }
  1538. }
  1539. }
  1540. fileprivate static func trailersOnly(
  1541. code: GRPCCore.Status.Code,
  1542. message: String,
  1543. echoMetadata: Bool
  1544. ) -> Self {
  1545. return Self.with {
  1546. $0.echoMetadataInTrailers = echoMetadata
  1547. $0.isTrailersOnly = true
  1548. $0.status = .with {
  1549. $0.code = code
  1550. $0.message = message
  1551. }
  1552. }
  1553. }
  1554. }
  1555. extension CompressionAlgorithm {
  1556. var name: String {
  1557. switch self {
  1558. case .deflate:
  1559. return "deflate"
  1560. case .gzip:
  1561. return "gzip"
  1562. case .none:
  1563. return "identity"
  1564. default:
  1565. return ""
  1566. }
  1567. }
  1568. }