-
Notifications
You must be signed in to change notification settings - Fork 911
Expand file tree
/
Copy pathHttpForwarderTests.cs
More file actions
3024 lines (2478 loc) · 127 KB
/
HttpForwarderTests.cs
File metadata and controls
3024 lines (2478 loc) · 127 KB
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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
using System.IO;
using System.IO.Pipelines;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Features;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Net.Http.Headers;
using Moq;
using Xunit;
using Yarp.Tests.Common;
using Yarp.ReverseProxy.Utilities;
using System.Net.Http.Headers;
using Microsoft.Extensions.Primitives;
namespace Yarp.ReverseProxy.Forwarder.Tests;
public class HttpForwarderTests
{
private IHttpForwarder CreateProxy()
{
var services = new ServiceCollection();
services.AddLogging();
services.AddHttpForwarder();
var provider = services.BuildServiceProvider();
return provider.GetRequiredService<IHttpForwarder>();
}
[Fact]
public void Constructor_Works()
{
Assert.NotNull(CreateProxy());
}
// Tests normal (as opposed to upgradeable) request proxying.
[Fact]
public async Task NormalRequest_Works()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.Scheme = "http";
httpContext.Request.Host = new HostString("example.com:3456");
httpContext.Request.Path = "/path/base/dropped";
httpContext.Request.Path = "/api/test";
httpContext.Request.QueryString = new QueryString("?a=b&c=d");
httpContext.Request.Headers.Add(":authority", "example.com:3456");
httpContext.Request.Headers.Add("x-ms-request-test", "request");
httpContext.Request.Headers.Add("Content-Language", "requestLanguage");
var requestBody = "request content";
httpContext.Request.Headers.Add("Content-Length", requestBody.Length.ToString());
httpContext.Request.Body = StringToStream(requestBody);
httpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
var proxyResponseStream = new MemoryStream();
httpContext.Response.Body = proxyResponseStream;
var destinationPrefix = "https://localhost:123/a/b/";
var targetUri = "https://localhost:123/a/b/api/test?a=b&c=d";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(HttpMethod.Post, request.Method);
Assert.Equal(targetUri, request.RequestUri.AbsoluteUri);
Assert.Contains("request", request.Headers.GetValues("x-ms-request-test"));
Assert.Null(request.Headers.Host);
Assert.False(request.Headers.TryGetValues(":authority", out var value));
Assert.NotNull(request.Content);
Assert.Contains("requestLanguage", request.Content.Headers.GetValues("Content-Language"));
var capturedRequestContent = new MemoryStream();
// Use CopyToAsync as this is what HttpClient and friends use internally
await request.Content.CopyToWithCancellationAsync(capturedRequestContent);
capturedRequestContent.Position = 0;
var capturedContentText = StreamToString(capturedRequestContent);
Assert.Equal("request content", capturedContentText);
var response = new HttpResponseMessage((HttpStatusCode)234);
response.ReasonPhrase = "Test Reason Phrase";
response.Headers.TryAddWithoutValidation("x-ms-response-test", "response");
response.Content = new StreamContent(StringToStream("response content"));
response.Content.Headers.TryAddWithoutValidation("Content-Language", "responseLanguage");
return response;
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(234, httpContext.Response.StatusCode);
var reasonPhrase = httpContext.Features.Get<IHttpResponseFeature>().ReasonPhrase;
Assert.Equal("Test Reason Phrase", reasonPhrase);
Assert.Contains("response", httpContext.Response.Headers["x-ms-response-test"].ToArray());
Assert.Contains("responseLanguage", httpContext.Response.Headers["Content-Language"].ToArray());
proxyResponseStream.Position = 0;
var proxyResponseText = StreamToString(proxyResponseStream);
Assert.Equal("response content", proxyResponseText);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages();
}
[Fact]
public async Task NormalRequestWithTransforms_Works()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.Protocol = "http/2";
httpContext.Request.Scheme = "http";
httpContext.Request.Host = new HostString("example.com:3456");
httpContext.Request.Path = "/path/base/dropped";
httpContext.Request.Path = "/api/test";
httpContext.Request.QueryString = new QueryString("?a=b&c=d");
httpContext.Request.Headers.Add(":authority", "example.com:3456");
httpContext.Request.Headers.Add("x-ms-request-test", "request");
httpContext.Request.Headers.Add("Content-Language", "requestLanguage");
httpContext.Request.Body = StringToStream("request content");
httpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
httpContext.Features.Set<IHttpResponseTrailersFeature>(new TestTrailersFeature());
var proxyResponseStream = new MemoryStream();
httpContext.Response.Body = proxyResponseStream;
var destinationPrefix = "https://localhost:123/a/b/";
var transforms = new DelegateHttpTransforms()
{
OnRequest = (context, request, destination) =>
{
request.RequestUri = new Uri(destination + "prefix"
+ context.Request.Path + context.Request.QueryString);
request.Headers.Remove("transformHeader");
request.Headers.TryAddWithoutValidation("transformHeader", "value");
request.Headers.TryAddWithoutValidation("x-ms-request-test", "transformValue");
request.Headers.Host = null;
return Task.CompletedTask;
},
OnResponse = (context, response) =>
{
context.Response.Headers["transformHeader"] = "value";
context.Response.Headers.Append("x-ms-response-test", "value");
return new(true);
},
OnResponseTrailers = (context, response) =>
{
context.Response.AppendTrailer("trailerTransform", "value");
return Task.CompletedTask;
}
};
var targetUri = "https://localhost:123/a/b/prefix/api/test?a=b&c=d";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(HttpMethod.Post, request.Method);
Assert.Equal(targetUri, request.RequestUri.AbsoluteUri);
Assert.Equal(new[] { "value" }, request.Headers.GetValues("transformHeader"));
Assert.Equal(new[] { "request", "transformValue" }, request.Headers.GetValues("x-ms-request-test"));
Assert.Null(request.Headers.Host);
Assert.False(request.Headers.TryGetValues(":authority", out var value));
Assert.NotNull(request.Content);
Assert.Contains("requestLanguage", request.Content.Headers.GetValues("Content-Language"));
var capturedRequestContent = new MemoryStream();
// Use CopyToAsync as this is what HttpClient and friends use internally
await request.Content.CopyToWithCancellationAsync(capturedRequestContent);
capturedRequestContent.Position = 0;
var capturedContentText = StreamToString(capturedRequestContent);
Assert.Equal("request content", capturedContentText);
var response = new HttpResponseMessage((HttpStatusCode)234);
response.ReasonPhrase = "Test Reason Phrase";
response.Headers.TryAddWithoutValidation("x-ms-response-test", "response");
response.Content = new StreamContent(StringToStream("response content"));
response.Content.Headers.TryAddWithoutValidation("Content-Language", "responseLanguage");
return response;
});
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, ForwarderRequestConfig.Empty, transforms);
Assert.Equal(ForwarderError.None, proxyError);
Assert.Equal(234, httpContext.Response.StatusCode);
var reasonPhrase = httpContext.Features.Get<IHttpResponseFeature>().ReasonPhrase;
Assert.Null(reasonPhrase); // We don't set the ReasonPhrase for HTTP/2+
Assert.Equal(new[] { "response", "value" }, httpContext.Response.Headers["x-ms-response-test"].ToArray());
Assert.Contains("responseLanguage", httpContext.Response.Headers["Content-Language"].ToArray());
Assert.Contains("value", httpContext.Response.Headers["transformHeader"].ToArray());
Assert.Equal(new[] { "value" }, httpContext.Features.Get<IHttpResponseTrailersFeature>().Trailers?["trailerTransform"].ToArray());
proxyResponseStream.Position = 0;
var proxyResponseText = StreamToString(proxyResponseStream);
Assert.Equal("response content", proxyResponseText);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages();
}
[Fact]
public async Task NormalRequestWithCopyRequestHeadersDisabled_Works()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.Scheme = "http";
httpContext.Request.Host = new HostString("example.com:3456");
httpContext.Request.PathBase = "/api";
httpContext.Request.Path = "/test";
httpContext.Request.QueryString = new QueryString("?a=b&c=d");
httpContext.Request.Headers.Add(":authority", "example.com:3456");
httpContext.Request.Headers.Add("x-ms-request-test", "request");
httpContext.Request.Headers.Add("Content-Language", "requestLanguage");
httpContext.Request.Headers.Add("Transfer-Encoding", "chunked");
httpContext.Request.Body = StringToStream("request content");
httpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
var proxyResponseStream = new MemoryStream();
httpContext.Response.Body = proxyResponseStream;
var destinationPrefix = "https://localhost:123/a/b/";
var transforms = new DelegateHttpTransforms()
{
CopyRequestHeaders = false,
OnRequest = (context, request, destination) =>
{
request.Headers.TryAddWithoutValidation("x-ms-request-test", "transformValue");
return Task.CompletedTask;
}
};
var targetUri = "https://localhost:123/a/b/test?a=b&c=d";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(HttpMethod.Post, request.Method);
Assert.Equal(targetUri, request.RequestUri.AbsoluteUri);
Assert.Equal(new[] { "transformValue" }, request.Headers.GetValues("x-ms-request-test"));
Assert.Null(request.Headers.Host);
Assert.False(request.Headers.TryGetValues(":authority", out var _));
Assert.NotNull(request.Content);
Assert.False(request.Content.Headers.TryGetValues("Content-Language", out var _));
var capturedRequestContent = new MemoryStream();
// Use CopyToAsync as this is what HttpClient and friends use internally
await request.Content.CopyToWithCancellationAsync(capturedRequestContent);
capturedRequestContent.Position = 0;
var capturedContentText = StreamToString(capturedRequestContent);
Assert.Equal("request content", capturedContentText);
var response = new HttpResponseMessage((HttpStatusCode)234);
response.ReasonPhrase = "Test Reason Phrase";
response.Headers.TryAddWithoutValidation("x-ms-response-test", "response");
response.Content = new StreamContent(StringToStream("response content"));
response.Content.Headers.TryAddWithoutValidation("Content-Language", "responseLanguage");
return response;
});
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, ForwarderRequestConfig.Empty, transforms);
Assert.Equal(ForwarderError.None, proxyError);
Assert.Equal(234, httpContext.Response.StatusCode);
var reasonPhrase = httpContext.Features.Get<IHttpResponseFeature>().ReasonPhrase;
Assert.Equal("Test Reason Phrase", reasonPhrase);
Assert.Contains("response", httpContext.Response.Headers["x-ms-response-test"].ToArray());
Assert.Contains("responseLanguage", httpContext.Response.Headers["Content-Language"].ToArray());
proxyResponseStream.Position = 0;
var proxyResponseText = StreamToString(proxyResponseStream);
Assert.Equal("response content", proxyResponseText);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages();
}
[Fact]
public async Task TransformRequestAsync_ReplaceBody()
{
var events = TestEventListener.Collect();
var replaced = "should be replaced";
var replacing = "request content";
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.Protocol = "HTTP/2";
httpContext.Request.Body = StringToStream(replaced);
var destinationPrefix = "https://localhost/";
var transforms = new DelegateHttpTransforms()
{
CopyRequestHeaders = true,
OnRequest = (context, request, destination) =>
{
context.Request.Body = new MemoryStream(Encoding.UTF8.GetBytes(replacing));
return Task.CompletedTask;
}
};
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(HttpMethod.Post, request.Method);
Assert.NotNull(request.Content);
var capturedRequestContent = new MemoryStream();
// Use CopyToAsync as this is what HttpClient and friends use internally
await request.Content.CopyToWithCancellationAsync(capturedRequestContent);
capturedRequestContent.Position = 0;
var capturedContentText = StreamToString(capturedRequestContent);
Assert.Equal(replacing, capturedContentText);
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(Array.Empty<byte>()) };
});
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, ForwarderRequestConfig.Empty, transforms);
Assert.Equal(ForwarderError.None, proxyError);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
var resultStream = (MemoryStream)httpContext.Request.Body;
Assert.Equal(Encoding.UTF8.GetBytes(replacing), resultStream.ToArray());
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages();
}
[Fact]
public async Task TransformRequestAsync_SetsStatus_ShortCircuits()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.Protocol = "HTTP/2";
var destinationPrefix = "https://localhost/";
var transforms = new DelegateHttpTransforms()
{
CopyRequestHeaders = true,
OnRequest = (context, request, destination) =>
{
context.Response.StatusCode = 401;
return Task.CompletedTask;
}
};
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
(HttpRequestMessage request, CancellationToken cancellationToken) =>
{
throw new NotImplementedException();
});
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, ForwarderRequestConfig.Empty, transforms);
Assert.Equal(ForwarderError.None, proxyError);
Assert.Equal(StatusCodes.Status401Unauthorized, httpContext.Response.StatusCode);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(new ForwarderStage[0]);
}
[Fact]
public async Task TransformRequestAsync_StartsResponse_ShortCircuits()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
var responseBody = new TestResponseBody();
httpContext.Features.Set<IHttpResponseFeature>(responseBody);
httpContext.Features.Set<IHttpResponseBodyFeature>(responseBody);
httpContext.Request.Method = "POST";
httpContext.Request.Protocol = "HTTP/2";
var destinationPrefix = "https://localhost/";
var transforms = new DelegateHttpTransforms()
{
CopyRequestHeaders = true,
OnRequest = (context, request, destination) =>
{
return context.Response.StartAsync();
}
};
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
(HttpRequestMessage request, CancellationToken cancellationToken) =>
{
throw new NotImplementedException();
});
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, ForwarderRequestConfig.Empty, transforms);
Assert.Equal(ForwarderError.None, proxyError);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
Assert.True(httpContext.Response.HasStarted);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(new ForwarderStage[0]);
}
[Fact]
public async Task TransformRequestAsync_WritesToResponse_ShortCircuits()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
var resultStream = new MemoryStream();
var responseBody = new TestResponseBody(resultStream);
httpContext.Features.Set<IHttpResponseFeature>(responseBody);
httpContext.Features.Set<IHttpResponseBodyFeature>(responseBody);
httpContext.Request.Method = "POST";
httpContext.Request.Protocol = "HTTP/2";
var destinationPrefix = "https://localhost/";
var transforms = new DelegateHttpTransforms()
{
CopyRequestHeaders = true,
OnRequest = (context, request, destination) =>
{
return context.Response.Body.WriteAsync(Encoding.UTF8.GetBytes("Hello World")).AsTask();
}
};
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
(HttpRequestMessage request, CancellationToken cancellationToken) =>
{
throw new NotImplementedException();
});
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, ForwarderRequestConfig.Empty, transforms);
Assert.Equal(ForwarderError.None, proxyError);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
Assert.True(httpContext.Response.HasStarted);
Assert.Equal("Hello World", Encoding.UTF8.GetString(resultStream.ToArray()));
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(new ForwarderStage[0]);
}
// Tests proxying an upgradeable request.
[Theory]
[InlineData("WebSocket")]
[InlineData("SPDY/3.1")]
public async Task UpgradableRequest_Works(string upgradeHeader)
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "GET";
httpContext.Request.Scheme = "http";
httpContext.Request.Host = new HostString("example.com:3456");
httpContext.Request.Path = "/api/test";
httpContext.Request.QueryString = new QueryString("?a=b&c=d");
httpContext.Request.Headers.Add(":authority", "example.com:3456");
httpContext.Request.Headers.Add("x-ms-request-test", "request");
httpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
// TODO: https://github.com/microsoft/reverse-proxy/issues/255
// https://github.com/microsoft/reverse-proxy/issues/467
httpContext.Request.Headers.Add("Upgrade", upgradeHeader);
var downstreamStream = new DuplexStream(
readStream: StringToStream("request content"),
writeStream: new MemoryStream());
DuplexStream upstreamStream = null;
var upgradeFeatureMock = new Mock<IHttpUpgradeFeature>();
upgradeFeatureMock.SetupGet(u => u.IsUpgradableRequest).Returns(true);
upgradeFeatureMock.Setup(u => u.UpgradeAsync()).ReturnsAsync(downstreamStream);
httpContext.Features.Set(upgradeFeatureMock.Object);
var destinationPrefix = "https://localhost:123/a/b/";
var targetUri = "https://localhost:123/a/b/api/test?a=b&c=d";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(1, 1), request.Version);
Assert.Equal(HttpMethod.Get, request.Method);
Assert.Equal(targetUri, request.RequestUri.AbsoluteUri);
Assert.Contains("request", request.Headers.GetValues("x-ms-request-test"));
Assert.Null(request.Headers.Host);
Assert.False(request.Headers.TryGetValues(":authority", out var value));
Assert.Null(request.Content);
var response = new HttpResponseMessage(HttpStatusCode.SwitchingProtocols);
response.Headers.TryAddWithoutValidation("x-ms-response-test", "response");
upstreamStream = new DuplexStream(
readStream: StringToStream("response content"),
writeStream: new MemoryStream());
response.Content = new RawStreamContent(upstreamStream);
return response;
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(StatusCodes.Status101SwitchingProtocols, httpContext.Response.StatusCode);
Assert.Contains("response", httpContext.Response.Headers["x-ms-response-test"].ToArray());
downstreamStream.WriteStream.Position = 0;
var returnedToDownstream = StreamToString(downstreamStream.WriteStream);
Assert.Equal("response content", returnedToDownstream);
Assert.NotNull(upstreamStream);
upstreamStream.WriteStream.Position = 0;
var sentToUpstream = StreamToString(upstreamStream.WriteStream);
Assert.Equal("request content", sentToUpstream);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(upgrade: true);
}
[Fact]
public async Task NonUpgradableRequestReturns101_Aborted()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "GET";
DuplexStream upstreamStream = null;
var destinationPrefix = "https://localhost:123/a/b/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(HttpMethod.Get, request.Method);
Assert.Null(request.Content);
var response = new HttpResponseMessage(HttpStatusCode.SwitchingProtocols);
upstreamStream = new DuplexStream(
readStream: StringToStream("response content"),
writeStream: new MemoryStream());
response.Content = new RawStreamContent(upstreamStream);
return response;
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(StatusCodes.Status502BadGateway, httpContext.Response.StatusCode);
AssertProxyStartFailedStop(events, destinationPrefix, httpContext.Response.StatusCode, ForwarderError.UpgradeResponseDestination);
events.AssertContainProxyStages(upgrade: true, hasRequestContent: false, hasResponseContent: false);
}
// Tests proxying an upgradeable request where the destination refused to upgrade.
// We should still proxy back the response.
[Fact]
public async Task UpgradableRequestFailsToUpgrade_ProxiesResponse()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "GET";
httpContext.Request.Scheme = "https";
httpContext.Request.Host = new HostString("example.com");
httpContext.Request.Path = "/api/test";
httpContext.Request.QueryString = new QueryString("?a=b&c=d");
httpContext.Request.Headers.Add(":host", "example.com");
httpContext.Request.Headers.Add("x-ms-request-test", "request");
// TODO: https://github.com/microsoft/reverse-proxy/issues/255
httpContext.Request.Headers.Add("Upgrade", "WebSocket");
var proxyResponseStream = new MemoryStream();
httpContext.Response.Body = proxyResponseStream;
var upgradeFeatureMock = new Mock<IHttpUpgradeFeature>(MockBehavior.Strict);
upgradeFeatureMock.SetupGet(u => u.IsUpgradableRequest).Returns(true);
httpContext.Features.Set(upgradeFeatureMock.Object);
var destinationPrefix = "https://localhost:123/a/b/";
var targetUri = "https://localhost:123/a/b/api/test?a=b&c=d";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(1, 1), request.Version);
Assert.Equal(HttpMethod.Get, request.Method);
Assert.Equal(targetUri, request.RequestUri.AbsoluteUri);
Assert.Contains("request", request.Headers.GetValues("x-ms-request-test"));
Assert.Null(request.Content);
var response = new HttpResponseMessage((HttpStatusCode)234);
response.ReasonPhrase = "Test Reason Phrase";
response.Headers.TryAddWithoutValidation("x-ms-response-test", "response");
response.Content = new StreamContent(StringToStream("response content"));
response.Content.Headers.TryAddWithoutValidation("Content-Language", "responseLanguage");
return response;
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(234, httpContext.Response.StatusCode);
var reasonPhrase = httpContext.Features.Get<IHttpResponseFeature>().ReasonPhrase;
Assert.Equal("Test Reason Phrase", reasonPhrase);
Assert.Contains("response", httpContext.Response.Headers["x-ms-response-test"].ToArray());
Assert.Contains("responseLanguage", httpContext.Response.Headers["Content-Language"].ToArray());
proxyResponseStream.Position = 0;
var proxyResponseText = StreamToString(proxyResponseStream);
Assert.Equal("response content", proxyResponseText);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(hasRequestContent: false, upgrade: false);
}
[Fact]
public async Task UpgradableRequest_CancelsIfIdle()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "GET";
httpContext.Request.Scheme = "http";
httpContext.Request.Path = "/api/test";
httpContext.Connection.RemoteIpAddress = IPAddress.Loopback;
// TODO: https://github.com/microsoft/reverse-proxy/issues/255
// https://github.com/microsoft/reverse-proxy/issues/467
httpContext.Request.Headers.Add("Upgrade", "WebSocket");
var _idleTcs = new TaskCompletionSource<int>(TaskCreationOptions.RunContinuationsAsynchronously);
var downstreamStream = new DuplexStream(
readStream: new StallStream(ct =>
{
ct.Register(() => _idleTcs.TrySetCanceled());
return _idleTcs.Task;
}),
writeStream: new MemoryStream());
DuplexStream upstreamStream = null;
var upgradeFeatureMock = new Mock<IHttpUpgradeFeature>();
upgradeFeatureMock.SetupGet(u => u.IsUpgradableRequest).Returns(true);
upgradeFeatureMock.Setup(u => u.UpgradeAsync()).ReturnsAsync(downstreamStream);
httpContext.Features.Set(upgradeFeatureMock.Object);
var destinationPrefix = "https://localhost:123/a/b/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
await Task.Yield();
Assert.Equal(new Version(1, 1), request.Version);
Assert.Equal(HttpMethod.Get, request.Method);
Assert.Null(request.Content);
var response = new HttpResponseMessage(HttpStatusCode.SwitchingProtocols);
upstreamStream = new DuplexStream(
readStream: new StallStream(ct =>
{
ct.Register(() => _idleTcs.TrySetCanceled());
return _idleTcs.Task;
}),
writeStream: new MemoryStream());
response.Content = new RawStreamContent(upstreamStream);
return response;
});
var result = await sut.SendAsync(httpContext, destinationPrefix, client, new ForwarderRequestConfig
{
ActivityTimeout = TimeSpan.FromSeconds(1)
}).DefaultTimeout();
Assert.Equal(StatusCodes.Status101SwitchingProtocols, httpContext.Response.StatusCode);
// When both are idle it's a race which gets reported as canceled first.
Assert.True(ForwarderError.UpgradeRequestCanceled == result
|| ForwarderError.UpgradeResponseCanceled == result);
events.AssertContainProxyStages(upgrade: true);
}
[Theory]
[InlineData("TRACE", "HTTP/1.1", "")]
[InlineData("TRACE", "HTTP/2", "")]
[InlineData("GET", "HTTP/1.1", "")]
[InlineData("GET", "HTTP/2", "")]
[InlineData("GET", "HTTP/1.1", "Content-Length:0")]
[InlineData("HEAD", "HTTP/1.1", "")]
[InlineData("POST", "HTTP/1.1", "")]
[InlineData("POST", "HTTP/1.1", "Content-Length:0")]
[InlineData("POST", "HTTP/1.1", "Content-Length:0;Content-Type:text/plain")]
[InlineData("POST", "HTTP/2", "Content-Length:0")]
[InlineData("POST", "HTTP/2", "Content-Length:0;Content-Type:text/plain")]
[InlineData("PATCH", "HTTP/1.1", "")]
[InlineData("DELETE", "HTTP/1.1", "")]
[InlineData("Unknown", "HTTP/1.1", "")]
// [InlineData("CONNECT", "HTTP/1.1", "")] Blocked in HttpUtilities.GetHttpMethod
[InlineData("GET", "HTTP/1.1", "Allow:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-Disposition:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-Encoding:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-Language:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-Location:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-MD5:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-Range:Foo")]
[InlineData("GET", "HTTP/1.1", "Content-Type:Foo")]
[InlineData("GET", "HTTP/1.1", "Expires:Foo")]
[InlineData("GET", "HTTP/1.1", "Last-Modified:Foo")]
public async Task RequestWithoutBodies_NoHttpContent(string method, string protocol, string headerList)
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = method;
httpContext.Request.Protocol = protocol;
var headers = headerList
.Split(';', StringSplitOptions.RemoveEmptyEntries)
.Select(header => (Key: header.Split(':')[0], Value: header.Split(':')[1]))
.ToArray();
foreach (var (key, value) in headers)
{
httpContext.Request.Headers[key] = value;
}
var destinationPrefix = "https://localhost/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(method, request.Method.Method, StringComparer.OrdinalIgnoreCase);
// When adding content-specific headers, we will inject an EmptyHttpContent if no other content is present
if (headers.Any())
{
Assert.NotNull(request.Content);
Assert.IsType<EmptyHttpContent>(request.Content);
Assert.Empty(await request.Content.ReadAsByteArrayAsync());
foreach (var (key, value) in headers)
{
Assert.True(request.Content.Headers.TryGetValues(key, out var values));
Assert.Equal(value, Assert.Single(values));
}
// If a custom content is injected, so is a "Content-Length: 0" header
Assert.True(request.Content.Headers.TryGetValues(HeaderNames.ContentLength, out var contentLength));
Assert.Equal("0", Assert.Single(contentLength));
}
else
{
Assert.Null(request.Content);
}
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(Array.Empty<byte>()) };
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(hasRequestContent: false);
}
[Theory]
[InlineData("POST", "HTTP/2", "", "")]
[InlineData("PATCH", "HTTP/2", "", "")]
[InlineData("UNKNOWN", "HTTP/2", "", "")]
[InlineData("UNKNOWN", "HTTP/1.1", "Content-Length:10", "aaaaaaaaaa")]
[InlineData("UNKNOWN", "HTTP/1.1", "transfer-encoding:Chunked", "")]
[InlineData("GET", "HTTP/1.1", "Content-Length:10", "aaaaaaaaaa")]
[InlineData("GET", "HTTP/2", "Content-Length:10", "aaaaaaaaaa")]
[InlineData("HEAD", "HTTP/1.1", "transfer-encoding:Chunked", "")]
[InlineData("HEAD", "HTTP/2", "transfer-encoding:Chunked", "")]
public async Task RequestWithBodies_HasHttpContent(string method, string protocol, string headers, string body)
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = method;
httpContext.Request.Protocol = protocol;
foreach (var header in headers.Split(';', StringSplitOptions.RemoveEmptyEntries))
{
var parts = header.Split(':');
var key = parts[0];
var value = parts[1];
httpContext.Request.Headers[key] = value;
}
httpContext.Request.Body = StringToStream(body);
var destinationPrefix = "https://localhost/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
Assert.Equal(new Version(2, 0), request.Version);
Assert.Equal(method, request.Method.Method, StringComparer.OrdinalIgnoreCase);
Assert.NotNull(request.Content);
// Must consume the body
await request.Content.CopyToWithCancellationAsync(Stream.Null);
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(Array.Empty<byte>()) };
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages();
}
[Theory]
[InlineData("1.1", 1, "")]
[InlineData("1.1", 1, "aa")]
[InlineData("1.1", 2, "a")]
[InlineData("2.0", 1, "")]
[InlineData("2.0", 1, "aa")]
[InlineData("2.0", 2, "a")]
public async Task RequestWithBodies_WrongContentLength(string version, long contentLength, string body)
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.ContentLength = contentLength;
httpContext.Request.Body = StringToStream(body);
var destinationPrefix = "https://localhost/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
Assert.Equal(new Version(version), request.Version);
Assert.NotNull(request.Content);
// Must throw
try
{
await request.Content.CopyToWithCancellationAsync(Stream.Null);
}
catch (HttpRequestException ex)
{
Assert.Contains("Content-Length", ex.InnerException.InnerException.Message);
throw ex;
}
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(Array.Empty<byte>()) };
});
var options = new ForwarderRequestConfig
{
Version = new Version(version),
};
var proxyError = await sut.SendAsync(httpContext, destinationPrefix, client, options);
Assert.Equal(ForwarderError.RequestBodyClient, proxyError);
Assert.Equal(StatusCodes.Status400BadRequest, httpContext.Response.StatusCode);
var errorFeature = httpContext.Features.Get<IForwarderErrorFeature>();
Assert.Equal(ForwarderError.RequestBodyClient, errorFeature.Error);
Assert.IsType<AggregateException>(errorFeature.Exception);
AssertProxyStartFailedStop(events, destinationPrefix, httpContext.Response.StatusCode, errorFeature.Error);
events.AssertContainProxyStages(new[] { ForwarderStage.SendAsyncStart, ForwarderStage.RequestContentTransferStart });
}
[Fact]
public async Task RequestWithBodies_WithoutContentLength()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = "POST";
httpContext.Request.Protocol = "HTTP/2";
httpContext.Request.Body = StringToStream("request content");
var destinationPrefix = "https://localhost/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
Assert.Equal(new Version(2, 0), request.Version);
Assert.NotNull(request.Content);
// Must consume the body
await request.Content.CopyToWithCancellationAsync(Stream.Null);
return new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(Array.Empty<byte>()) };
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages();
}
[Fact]
public async Task BodyDetectionFeatureSaysNo_NoHttpContent()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = HttpMethods.Post;
httpContext.Features.Set<IHttpRequestBodyDetectionFeature>(new TestBodyDetector() { CanHaveBody = false });
var destinationPrefix = "https://localhost/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
(HttpRequestMessage request, CancellationToken cancellationToken) =>
{
Assert.Equal(new Version(2, 0), request.Version);
Assert.Null(request.Content);
var response = new HttpResponseMessage(HttpStatusCode.OK) { Content = new ByteArrayContent(Array.Empty<byte>()) };
return Task.FromResult(response);
});
await sut.SendAsync(httpContext, destinationPrefix, client);
Assert.Equal(StatusCodes.Status200OK, httpContext.Response.StatusCode);
AssertProxyStartStop(events, destinationPrefix, httpContext.Response.StatusCode);
events.AssertContainProxyStages(hasRequestContent: false);
}
[Fact]
public async Task BodyDetectionFeatureSaysYes_HasHttpContent()
{
var events = TestEventListener.Collect();
var httpContext = new DefaultHttpContext();
httpContext.Request.Method = HttpMethods.Get;
httpContext.Features.Set<IHttpRequestBodyDetectionFeature>(new TestBodyDetector() { CanHaveBody = true });
var destinationPrefix = "https://localhost/";
var sut = CreateProxy();
var client = MockHttpHandler.CreateClient(
async (HttpRequestMessage request, CancellationToken cancellationToken) =>
{
Assert.Equal(new Version(2, 0), request.Version);
Assert.NotNull(request.Content);
// Must consume the body
await request.Content.CopyToWithCancellationAsync(Stream.Null);