File: shared_examples.rb

package info (click to toggle)
ruby-async-http 0.59.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 572 kB
  • sloc: ruby: 4,164; javascript: 40; makefile: 4
file content (553 lines) | stat: -rw-r--r-- 13,453 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

require_relative '../server_context'

require 'async'
require 'async/clock'
require 'async/http/client'
require 'async/http/server'
require 'async/http/endpoint'
require 'async/http/body/hijack'
require 'tempfile'

require 'protocol/http/body/file'

require 'async/rspec/profile'

RSpec.shared_examples_for Async::HTTP::Protocol do
	include_context Async::HTTP::Server
	
	it "should have valid scheme" do
		expect(client.scheme).to be == "http"
	end
	
	context "huge body", timeout: 600 do
		let(:body) {Protocol::HTTP::Body::File.open("/dev/zero", size: 512*1024**2)}
		
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Protocol::HTTP::Response[200, {}, body]
			end
		end
		
		it "client can download data quickly" do |example|
			response = client.get("/")
			expect(response).to be_success
			
			data_size = 0
			duration = Async::Clock.measure do
				while chunk = response.body.read
					data_size += chunk.bytesize
					chunk.clear
				end
				
				response.finish
			end
			
			size_mbytes = data_size / 1024**2
			
			example.reporter.message "Data size: #{size_mbytes}MB Duration: #{duration.round(2)}s Throughput: #{(size_mbytes / duration).round(2)}MB/s"
		end
	end
	
	context 'buffered body' do
		let(:body) {Async::HTTP::Body::Buffered.new(["Hello World"])}
		let(:response) {Protocol::HTTP::Response[200, {}, body]}
		
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				response
			end
		end
		
		it "response body should be closed" do
			expect(body).to receive(:close).and_call_original
			# expect(response).to receive(:close).and_call_original
			
			expect(client.get("/", {}).read).to be == "Hello World"
		end
	end
	
	context 'empty body' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Protocol::HTTP::Response[204]
			end
		end
		
		it 'properly handles no content responses' do
			expect(client.get("/", {}).read).to be_nil
		end
	end
	
	context 'with trailer', if: described_class.bidirectional? do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				if trailer = request.headers['trailer']
					expect(request.headers).to_not include('etag')
					request.finish
					expect(request.headers).to include('etag')
					
					Protocol::HTTP::Response[200, [], "request trailer"]
				else
					headers = Protocol::HTTP::Headers.new
					headers.add('trailer', 'etag')
					
					body = Async::HTTP::Body::Writable.new
					
					Async do |task|
						body.write("response trailer")
						task.sleep(0.01)
						headers.add('etag', 'abcd')
						body.close
					end
					
					Protocol::HTTP::Response[200, headers, body]
				end
			end
		end
		
		it "can send request trailer" do
			headers = Protocol::HTTP::Headers.new
			headers.add('trailer', 'etag')
			body = Async::HTTP::Body::Writable.new
			
			Async do |task|
				body.write("Hello")
				task.sleep(0.01)
				headers.add('etag', 'abcd')
				body.close
			end
			
			response = client.post("/", headers, body)
			expect(response.read).to be == "request trailer"
			
			expect(response).to be_success
		end
		
		it "can receive response trailer" do
			response = client.get("/")
			expect(response.headers).to include('trailer')
			headers = response.headers
			expect(headers).to_not include('etag')
			
			expect(response.read).to be == "response trailer"
			expect(response).to be_success
			
			# It was sent as a trailer.
			expect(headers).to include('etag')
		end
	end
	
	context 'with working server' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				if request.method == 'POST'
					# We stream the request body directly to the response.
					Protocol::HTTP::Response[200, {}, request.body]
				elsif request.method == 'GET'
					expect(request.body).to be nil
					
					Protocol::HTTP::Response[200, {
						'remote-address' => request.remote_address.inspect
					}, ["#{request.method} #{request.version}"]]
				else
					Protocol::HTTP::Response[200, {}, ["Hello World"]]
				end
			end
		end
		
		it "should have valid scheme" do
			expect(server.scheme).to be == "http"
		end
		
		it "disconnects slow clients" do
			response = client.get("/")
			response.read
			
			# We expect this connection to be closed:
			connection = response.connection
			
			reactor.sleep(1.0)
			
			response = client.get("/")
			response.read
			
			expect(connection).to_not be_reusable
			
			# client.close
			# reactor.sleep(0.1)
			# reactor.print_hierarchy
		end
		
		context 'using GET method' do
			let(:expected) {"GET #{protocol::VERSION}"}
			
			it "can handle many simultaneous requests", timeout: 10 do |example|
				duration = Async::Clock.measure do
					10.times do
						tasks = 100.times.collect do
							Async do
								client.get("/")
							end
						end
						
						tasks.each do |task|
							response = task.wait
							expect(response).to be_success
							expect(response.read).to eq expected
						end
					end
				end
				
				example.reporter.message "Pool: #{client.pool}"
				example.reporter.message "Duration = #{duration.round(2)}"
			end
			
			context 'with response' do
				let(:response) {client.get("/")}
				after {response.finish}
				
				it "can finish gracefully" do
					expect(response).to be_success
				end
				
				it "is successful" do
					expect(response).to be_success
					expect(response.read).to eq expected
				end
				
				it "provides content length" do
					expect(response.body.length).to_not be_nil
				end
				
				let(:tempfile) {Tempfile.new}
				
				it "can save to disk" do
					response.save(tempfile.path)
					expect(tempfile.read).to eq expected
					
					tempfile.close
				end
				
				it "has remote-address header" do
					expect(response.headers['remote-address']).to_not be_nil
				end
				
				it "has protocol version" do
					expect(response.version).to_not be_nil
				end
			end
		end
		
		context 'HEAD' do
			let(:response) {client.head("/")}
			after {response.finish}
			
			it "is successful and without body" do
				expect(response).to be_success
				expect(response.body).to_not be_nil
				expect(response.body).to be_empty
				expect(response.body.length).to_not be_nil
				expect(response.read).to be_nil
			end
		end
		
		context 'POST' do
			let(:response) {client.post("/", {}, ["Hello", " ", "World"])}
			
			after {response.finish}
			
			it "is successful" do
				expect(response).to be_success
				expect(response.read).to be == "Hello World"
				
				expect(client.pool).to_not be_busy
			end
			
			it "can buffer response" do
				buffer = response.finish
				
				expect(buffer.join).to be == "Hello World"
				
				expect(client.pool).to_not be_busy
			end
			
			it "should not contain content-length response header" do
				expect(response.headers).to_not include('content-length')
			end
			
			it "fails gracefully when closing connection" do
				client.pool.acquire do |connection|
					connection.stream.close
				end
			end
		end
	end
	
	context 'content length' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Protocol::HTTP::Response[200, [], ["Content Length: #{request.body.length}"]]
			end
		end
		
		it "can send push promises" do
			response = client.post("/test", [], ["Hello World!"])
			expect(response).to be_success
			
			expect(response.body.length).to be == 18
			expect(response.read).to be == "Content Length: 12"
		end
	end
	
	context 'hijack with nil response' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				nil
			end
		end
		
		it "fails with appropriate error" do
			response = client.get("/")
			
			expect(response).to be_server_failure
		end
	end
	
	context 'partial hijack' do
		let(:content) {"Hello World!"}
		
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Async::HTTP::Body::Hijack.response(request, 200, {}) do |stream|
					stream.write content
					stream.write content
					stream.close
				end
			end
		end
		
		it "reads hijacked body" do
			response = client.get("/")
			
			expect(response.read).to be == (content*2)
		end
	end
	
	context 'body with incorrect length' do
		let(:bad_body) {Async::HTTP::Body::Buffered.new(["Borked"], 10)}
		
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Protocol::HTTP::Response[200, {}, bad_body]
			end
		end
		
		it "fails with appropriate error" do
			response = client.get("/")
			
			expect do
				response.read
			end.to raise_error(EOFError)
		end
	end
	
	context 'streaming server' do
		let!(:sent_chunks) {[]}
		
		let(:server) do
			chunks = sent_chunks
			
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				body = Async::HTTP::Body::Writable.new
				
				Async::Reactor.run do |task|
					10.times do |i|
						chunk = "Chunk #{i}"
						chunks << chunk
						
						body.write chunk
						task.sleep 0.25
					end
					
					body.finish
				end
				
				Protocol::HTTP::Response[200, {}, body]
			end
		end
		
		it "can cancel response" do
			response = client.get("/")
			
			expect(response.body.read).to be == "Chunk 0"
			
			response.close
			
			expect(sent_chunks).to be == ["Chunk 0"]
		end
	end
	
	context 'hijack server' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				if request.hijack?
					io = request.hijack!
					io.write "HTTP/1.1 200 Okay\r\nContent-Length: 16\r\n\r\nHijack Succeeded"
					io.flush
					io.close
				else
					Protocol::HTTP::Response[200, {}, ["Hijack Failed"]]
				end
			end
		end
		
		it "will hijack response if possible" do
			response = client.get("/")
			
			expect(response.read).to include("Hijack")
		end
	end
	
	context 'broken server' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				raise RuntimeError.new('simulated failure')
			end
		end
		
		it "can't get /" do
			expect do
				response = client.get("/")
			end.to raise_error(Exception)
		end
	end
	
	context 'slow server' do
		let(:endpoint) {Async::HTTP::Endpoint.parse('http://127.0.0.1:9294', reuse_port: true, timeout: 0.1)}
		
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Async::Task.current.sleep(endpoint.timeout * 2)
				Protocol::HTTP::Response[200, {}, []]
			end
		end
		
		it "can't get /" do
			expect do
				client.get("/")
			end.to raise_error(Async::TimeoutError)
		end
	end
	
	context 'bi-directional streaming', if: described_class.bidirectional? do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				# Echo the request body back to the client.
				Protocol::HTTP::Response[200, {}, request.body]
			end
		end
		
		it "can read from request body and write response body simultaneously" do
			body = Async::HTTP::Body::Writable.new
			
			# Ideally, the flow here is as follows:
			# 1/ Client writes headers to server.
			# 2/ Client starts writing data to server (in async task).
			# 3/ Client reads headers from server.
			# 4a/ Client reads data from server.
			# 4b/ Client finishes sending data to server.
			response = client.post(endpoint.path, [], body)
			
			expect(response).to be_success
			
			body.write "."
			count = 0
			
			response.each do |chunk|
				if chunk.bytesize > 32
					body.close
				else
					count += 1
					body.write chunk*2
					Async::Task.current.sleep(0.1)
				end
			end
			
			expect(count).to be == 6
		end
	end
	
	context 'multiple client requests' do
		let(:server) do
			Async::HTTP::Server.for(@bound_endpoint) do |request|
				Protocol::HTTP::Response[200, {}, [request.path]]
			end
		end
		
		around do |example|
			current = Console.logger.level
			Console.logger.fatal!
			
			example.run
		ensure
			Console.logger.level = current
		end
		
		it "doesn't cancel all requests" do
			tasks = []
			task = Async::Task.current
			stopped = []
			
			10.times do
				tasks << task.async {
					begin
						loop do
							client.get('http://127.0.0.1:8080/a').finish
						end
					ensure
						stopped << 'a'
					end
				}
			end
			
			10.times do
				tasks << task.async {
					begin
						loop do
							client.get('http://127.0.0.1:8080/b').finish
						end
					ensure
						stopped << 'b'
					end
				}
			end
			
			tasks.each do |child|
				task.sleep 0.01
				child.stop
			end
			
			expect(stopped.sort).to be == stopped
		end
	end
end