FakeHttpMessageHandler 1.0.0
See the version list below for details.
dotnet add package FakeHttpMessageHandler --version 1.0.0
NuGet\Install-Package FakeHttpMessageHandler -Version 1.0.0
<PackageReference Include="FakeHttpMessageHandler" Version="1.0.0" />
paket add FakeHttpMessageHandler --version 1.0.0
#r "nuget: FakeHttpMessageHandler, 1.0.0"
// Install FakeHttpMessageHandler as a Cake Addin
#addin nuget:?package=FakeHttpMessageHandler&version=1.0.0
// Install FakeHttpMessageHandler as a Cake Tool
#tool nuget:?package=FakeHttpMessageHandler&version=1.0.0
FakeHttpMessageHandler
FakeHttpMessageHandler seamlessly fakes http request sent from System.Net.Http.HttpClient for purpose of unit testing code that previously could only be integration tested.
Examples
If FakeHttpMessageHandler is initialized with no parameters, it will create an instance of T, serialize it as JSON and return it in a content of HttpResponse.
using(var httpMessageHandler = new FakeHttpMessageHandler<OutputType>())
using(var httpClient = new HttpClient(httpMessageHandler))
{
var response = await httpClient.GetAsync("http://zheludov.com");
}
You may also choose to override returned object by either passing an instance of returned object to a constructor or a function that will retrieve it. In both cases an object will be serialized into JSON unless serializer is overwritten or T is string;
// Passing an instance of output object
var output = new OutputType();
using(var httpMessageHandler = new FakeHttpMessageHandler<OutputType>(output))
using(var httpClient = new HttpClient(httpMessageHandler))
{
var response = await httpClient.GetAsync("http://zheludov.com");
}
// Passing a function that will retrieve output object.
var outputRetrieverMock = new Mock<IResponceObjectRetriever>();
outputRetrieverMock.Setup(retriever => retriever.RetrieveResponseObject()).Returns(new FakeOutput());
using (var httpMessageHandler = new FakeHttpMessageHandler<FakeOutput>(() => outputRetrieverMock.Object.RetrieveResponseObject()))
using (var httpClient = new HttpClient(httpMessageHandler))
{
var response = await httpClient.GetAsync("http://zheludov.com");
}
// Passing an asynchronous function that will retrieve output object.
var outputRetrieverMock = new Mock<IResponceObjectRetriever>();
outputRetrieverMock.Setup(retriever => retriever.RetrieveResponseObjectAsync()).ReturnsAsync(new FakeOutput());
using (var httpMessageHandler = new FakeHttpMessageHandler<FakeOutput>(() => outputRetrieverMock.Object.RetrieveResponseObject()))
using (var httpClient = new HttpClient(httpMessageHandler))
{
var response = await httpClient.GetAsync("http://zheludov.com");
}
Additionally you can override serializer function that is called to serilize response content.
var responseString = "zheludov.com";
var serializerMock = new Mock<ISerializer>();
var responseObjectRetrieverMock = new Mock<IResponceObjectRetriever>();
serializerMock.Setup(serializer => serializer.Serialize(It.IsAny<object>())).Returns(responseString);
var handler = new FakeHttpMessageHandler<FakeOutput>(() => responseObjectRetrieverMock.Object.RetrieveResponseObjectAsync(),
(FakeOutput output) => serializerMock.Object.Serialize(output));
using (var httpClient = new HttpClient(httpMessageHandler))
{
var response = await httpClient.GetAsync("http://zheludov.com");
}
Sample Class and Unit Test
ApiClient.cs
public class ApiClient : IDisposable
{
private readonly HttpMessageHandler _httpMessageHandler;
public ApiClient(HttpMessageHandler httpMessageHandler = null)
{
_httpMessageHandler = httpMessageHandler;
}
public async Task<string> GetResponseAsync()
{
using (var httpClient = new HttpClient(_httpMessageHandler ?? new HttpClientHandler()))
{
var response = await httpClient.GetAsync("http://zheludov.com");
if(response.IsSuccessStatusCode)
{
return await response.Content.ReadAsStringAsync();
}
return null;
}
}
public void Dispose()
{
_httpMessageHandler?.Dispose();
}
}
ApiClientTest.cs
[TestClass]
public class ApiClientTest
{
[TestMethod]
public async Task ApiClient_GetResponseAsync_VerifyHttpRequestIsMade()
{
var httpHandler = new FakeHttpMessageHandler<string>("Response");
using (var client = new ApiClient(httpHandler))
{
var response = await client.GetResponseAsync();
response.Should().NotBeNullOrWhiteSpace();
}
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 10.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.