forked from octokit/octokit.net
/
CachingHttpClientTests.cs
418 lines (346 loc) · 18.9 KB
/
CachingHttpClientTests.cs
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
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using NSubstitute;
using NSubstitute.ExceptionExtensions;
using NSubstitute.ReturnsExtensions;
using Octokit.Caching;
using Octokit.Internal;
using Octokit.Tests.Helpers;
using Xunit;
namespace Octokit.Tests.Caching
{
public class CachingHttpClientTests
{
public class TheSendMethod
{
[Fact]
public async Task EnsuresNonNullArguments()
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act + assert
await Assert.ThrowsAsync<ArgumentNullException>(() => cachingHttpClient.Send(null, CancellationToken.None));
}
[Theory]
[MemberData(nameof(NonGetHttpMethods))]
public async Task CallsUnderlyingHttpClientMethodForNonGetRequests(HttpMethod method)
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var request = Substitute.For<IRequest>();
var cancellationToken = CancellationToken.None;
var expectedResponse = Substitute.For<IResponse>();
request.Method.Returns(method);
underlyingClient.Send(request, cancellationToken).Returns(expectedResponse);
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
var response = await cachingHttpClient.Send(request, CancellationToken.None);
// assert
Assert.Equal(expectedResponse, response);
Assert.Empty(responseCache.ReceivedCalls());
Assert.Single(underlyingClient.ReceivedCalls());
underlyingClient.Received(1).Send(request, cancellationToken);
}
public static IEnumerable<object[]> NonGetHttpMethods()
{
yield return new object[] { HttpMethod.Delete };
yield return new object[] { HttpMethod.Post };
yield return new object[] { HttpMethod.Put };
yield return new object[] { HttpMethod.Trace };
yield return new object[] { HttpMethod.Options };
yield return new object[] { HttpMethod.Head };
}
[Fact]
public async Task UsesCachedResponseIfEtagIsPresentAndGithubReturns304()
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
const string etag = "my-etag";
var request = Substitute.For<IRequest>();
request.Method.Returns(HttpMethod.Get);
request.Headers.Returns(new Dictionary<string, string>());
var cachedResponse = Substitute.For<IResponse>();
cachedResponse.Headers.Returns(new Dictionary<string, string> { { "ETag", etag } });
var cachedV1Response = CachedResponse.V1.Create(cachedResponse);
var cancellationToken = CancellationToken.None;
var githubResponse = Substitute.For<IResponse>();
githubResponse.StatusCode.Returns(HttpStatusCode.NotModified);
underlyingClient.Send(Arg.Is<IRequest>(req => req == request && req.Headers["If-None-Matched"] == etag), cancellationToken).ReturnsForAnyArgs(githubResponse);
responseCache.GetAsync(request).Returns(cachedV1Response);
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
var response = await cachingHttpClient.Send(request, cancellationToken);
// assert
Assert.Equal(cachedV1Response.ToResponse(), response, new ResponseComparer());
Assert.Single(underlyingClient.ReceivedCalls());
underlyingClient.Received(1).Send(request, cancellationToken);
Assert.Single(responseCache.ReceivedCalls());
responseCache.Received(1).GetAsync(request);
}
[Theory]
[MemberData(nameof(SuccessHttpStatusCodesWithSetCacheFailure))]
public async Task UsesGithubResponseIfEtagIsPresentAndGithubReturnsSuccessCode(HttpStatusCode httpStatusCode, bool setCacheThrows)
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
const string etag = "my-etag";
var request = Substitute.For<IRequest>();
request.Method.Returns(HttpMethod.Get);
request.Headers.Returns(new Dictionary<string, string>());
var cachedResponse = Substitute.For<IResponse>();
cachedResponse.Headers.Returns(new Dictionary<string, string> { { "ETag", etag } });
var cachedV1Response = CachedResponse.V1.Create(cachedResponse);
var cancellationToken = CancellationToken.None;
var githubResponse = Substitute.For<IResponse>();
githubResponse.StatusCode.Returns(httpStatusCode);
underlyingClient.Send(Arg.Is<IRequest>(req => req == request && req.Headers["If-None-Matched"] == etag), cancellationToken).ReturnsForAnyArgs(githubResponse);
responseCache.GetAsync(request).Returns(cachedV1Response);
if (setCacheThrows)
{
responseCache.SetAsync(request, Arg.Any<CachedResponse.V1>()).ThrowsForAnyArgs<Exception>();
}
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
var response = await cachingHttpClient.Send(request, cancellationToken);
// assert
Assert.Equal(githubResponse, response, new ResponseComparer());
Assert.Single(underlyingClient.ReceivedCalls());
underlyingClient.Received(1).Send(request, cancellationToken);
Assert.Equal(2, responseCache.ReceivedCalls().Count());
responseCache.Received(1).GetAsync(request);
responseCache.Received(1).SetAsync(request, Arg.Is<CachedResponse.V1>(v1 => new ResponseComparer().Equals(v1, CachedResponse.V1.Create(githubResponse))));
}
public static IEnumerable<object[]> SuccessHttpStatusCodesWithSetCacheFailure()
{
var setCacheFails = new[] { true, false };
foreach (var cacheFail in setCacheFails)
{
foreach (var statusCode in _successStatusCodes.Cast<object>())
{
yield return new[] { statusCode, cacheFail };
yield return new[] { statusCode, cacheFail };
}
}
}
private static readonly IImmutableList<HttpStatusCode> _successStatusCodes = Enumerable
.Range(200, 100)
.Where(code => Enum.IsDefined(typeof(HttpStatusCode), code))
.Cast<HttpStatusCode>()
.ToImmutableList();
private static readonly IImmutableList<string> _invalidETags = new[]
{
null, string.Empty
}.ToImmutableList();
public static IEnumerable<object[]> SuccessHttpStatusCodesWithSetCacheFailureAndInvalidETags()
{
var setCacheFails = new[] { true, false };
foreach (var etag in _invalidETags)
{
foreach (var cacheFail in setCacheFails)
{
foreach (var statusCode in _successStatusCodes.Cast<object>())
{
yield return new[] { statusCode, cacheFail, etag };
yield return new[] { statusCode, cacheFail, etag };
}
}
}
}
[Theory]
[MemberData(nameof(SuccessHttpStatusCodesWithSetCacheFailure))]
public async Task UsesGithubResponseIfCachedEntryIsNull(HttpStatusCode httpStatusCode, bool setCacheThrows)
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var request = Substitute.For<IRequest>();
request.Method.Returns(HttpMethod.Get);
request.Headers.Returns(new Dictionary<string, string>());
var cancellationToken = CancellationToken.None;
var githubResponse = Substitute.For<IResponse>();
githubResponse.StatusCode.Returns(httpStatusCode);
underlyingClient.Send(Arg.Is<IRequest>(req => req == request && !req.Headers.Any()), cancellationToken).ReturnsForAnyArgs(githubResponse);
responseCache.GetAsync(request).ReturnsNull();
if (setCacheThrows)
{
responseCache.SetAsync(request, Arg.Any<CachedResponse.V1>()).ThrowsForAnyArgs<Exception>();
}
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
var response = await cachingHttpClient.Send(request, cancellationToken);
// assert
Assert.Equal(githubResponse, response, new ResponseComparer());
Assert.Single(underlyingClient.ReceivedCalls());
underlyingClient.Received(1).Send(request, cancellationToken);
Assert.Equal(2, responseCache.ReceivedCalls().Count());
responseCache.Received(1).GetAsync(request);
responseCache.Received(1).SetAsync(request, Arg.Is<CachedResponse.V1>(v1 => new ResponseComparer().Equals(v1, CachedResponse.V1.Create(githubResponse))));
}
[Theory]
[MemberData(nameof(SuccessHttpStatusCodesWithSetCacheFailure))]
public async Task UsesGithubResponseIfGetCachedEntryThrows(HttpStatusCode httpStatusCode, bool setCacheThrows)
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var request = Substitute.For<IRequest>();
request.Method.Returns(HttpMethod.Get);
request.Headers.Returns(new Dictionary<string, string>());
var cancellationToken = CancellationToken.None;
var githubResponse = Substitute.For<IResponse>();
githubResponse.StatusCode.Returns(httpStatusCode);
underlyingClient.Send(Arg.Is<IRequest>(req => req == request && !req.Headers.Any()), cancellationToken).ReturnsForAnyArgs(githubResponse);
responseCache.GetAsync(Args.Request).ThrowsForAnyArgs<Exception>();
if (setCacheThrows)
{
responseCache.SetAsync(request, Arg.Any<CachedResponse.V1>()).ThrowsForAnyArgs<Exception>();
}
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
var response = await cachingHttpClient.Send(request, cancellationToken);
// assert
Assert.Equal(githubResponse, response, new ResponseComparer());
Assert.Single(underlyingClient.ReceivedCalls());
underlyingClient.Received(1).Send(request, cancellationToken);
Assert.Equal(2, responseCache.ReceivedCalls().Count());
responseCache.Received(1).GetAsync(request);
responseCache.Received(1).SetAsync(request, Arg.Is<CachedResponse.V1>(v1 => new ResponseComparer().Equals(v1, CachedResponse.V1.Create(githubResponse))));
}
[Theory]
[MemberData(nameof(SuccessHttpStatusCodesWithSetCacheFailureAndInvalidETags))]
public async Task UsesGithubResponseIfCachedEntryEtagIsNullOrEmpty(HttpStatusCode httpStatusCode, bool setCacheThrows, string etag)
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var request = Substitute.For<IRequest>();
request.Method.Returns(HttpMethod.Get);
request.Headers.Returns(new Dictionary<string, string>());
var cachedResponse = Substitute.For<IResponse>();
cachedResponse.Headers.Returns(etag == null ? new Dictionary<string, string>() : new Dictionary<string, string> { { "ETag", etag } });
var cachedV1Response = CachedResponse.V1.Create(cachedResponse);
var cancellationToken = CancellationToken.None;
var githubResponse = Substitute.For<IResponse>();
githubResponse.StatusCode.Returns(httpStatusCode);
underlyingClient.Send(Arg.Is<IRequest>(req => req == request && !req.Headers.Any()), cancellationToken).ReturnsForAnyArgs(githubResponse);
responseCache.GetAsync(request).Returns(cachedV1Response);
if (setCacheThrows)
{
responseCache.SetAsync(request, Arg.Any<CachedResponse.V1>()).ThrowsForAnyArgs<Exception>();
}
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
var response = await cachingHttpClient.Send(request, cancellationToken);
// assert
Assert.Equal(githubResponse, response, new ResponseComparer());
Assert.Single(underlyingClient.ReceivedCalls());
underlyingClient.Received(1).Send(request, cancellationToken);
Assert.Equal(2, responseCache.ReceivedCalls().Count());
responseCache.Received(1).GetAsync(request);
responseCache.Received(1).SetAsync(request, Arg.Is<CachedResponse.V1>(v1 => new ResponseComparer().Equals(v1, CachedResponse.V1.Create(githubResponse))));
}
public static IEnumerable<object[]> DoesNotUpdateCacheData()
{
var codesToExclude = _successStatusCodes
.Add(HttpStatusCode.NotModified);
var failureCodes = Enum
.GetValues(typeof(HttpStatusCode))
.Cast<HttpStatusCode>()
.Except(codesToExclude)
.ToList();
var hasCachedResponses = new[] { false, true };
foreach (var etag in _invalidETags)
{
foreach (var hasCachedResponse in hasCachedResponses)
{
foreach (var statusCode in failureCodes)
{
yield return new object[]
{
statusCode, hasCachedResponse, etag
};
}
}
}
}
[Theory]
[MemberData(nameof(DoesNotUpdateCacheData))]
public async Task DoesNotUpdateCacheIfGitHubResponseIsNotSuccessCode(HttpStatusCode httpStatusCode, bool hasCachedResponse, string etag)
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var request = Substitute.For<IRequest>();
request.Method.Returns(HttpMethod.Get);
request.Headers.Returns(new Dictionary<string, string>());
var cachedResponse = Substitute.For<IResponse>();
cachedResponse.Headers.Returns(etag == null ? new Dictionary<string, string>() : new Dictionary<string, string> { { "ETag", etag } });
var cachedV1Response = CachedResponse.V1.Create(cachedResponse);
var githubResponse = Substitute.For<IResponse>();
githubResponse.StatusCode.Returns(httpStatusCode);
underlyingClient.Send(request).Returns(githubResponse);
responseCache.GetAsync(request).Returns(hasCachedResponse ? cachedV1Response : null);
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
_ = await cachingHttpClient.Send(request, CancellationToken.None);
// assert
responseCache.DidNotReceiveWithAnyArgs().SetAsync(Arg.Any<IRequest>(), Arg.Any<CachedResponse.V1>());
}
}
public class TheSetRequestTimeoutMethod
{
[Fact]
public void SetsRequestTimeoutForUnderlyingClient()
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var timeout = TimeSpan.Zero;
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
cachingHttpClient.SetRequestTimeout(timeout);
// assert
underlyingClient.Received(1).SetRequestTimeout(timeout);
}
}
public class TheDisposeMethod
{
[Fact]
public void CallsDisposeForUnderlyingClient()
{
// arrange
var underlyingClient = Substitute.For<IHttpClient>();
var responseCache = Substitute.For<IResponseCache>();
var cachingHttpClient = new CachingHttpClient(underlyingClient, responseCache);
// act
cachingHttpClient.Dispose();
// assert
underlyingClient.Received(1).Dispose();
}
}
public class TheCtor
{
[Theory]
[InlineData(true, true)]
[InlineData(true, false)]
[InlineData(false, true)]
public void EnsuresNonNullArguments(bool httpClientIsNull, bool responseCacheIsNull)
{
var httpClient = httpClientIsNull ? null : Substitute.For<IHttpClient>();
var responseCache = responseCacheIsNull ? null : Substitute.For<IResponseCache>();
Assert.Throws<ArgumentNullException>(() => new CachingHttpClient(httpClient, responseCache));
}
}
}
}