How to mock the new HttpClientFactory in .NET Core 2.1 using Moq

by

The HttpClientFactory is derived from IHttpClientFactory Interface So it is just a matter of creating a mock of the interface

var mockFactory = new Mock<IHttpClientFactory>();

Depending on what you need the client for, you would then need to setup the mock to return a HttpClient for the test.

This however requires an actual HttpClient.

var clientHandlerStub = new DelegatingHandlerStub();
var client = new HttpClient(clientHandlerStub);

mockFactory.Setup(_ => _.CreateClient(It.IsAny<string>())).Returns(client);

IHttpClientFactory factory = mockFactory.Object;

The factory can then be injected into the dependent system under test when exercising the test.

If you do not want the client calling actual endpoints then you will need to create a fake delegate handler to intercept the requests.

Example of the handler stub used to fake the requests

public class DelegatingHandlerStub : DelegatingHandler {
    private readonly Func<HttpRequestMessage, CancellationToken, Task<HttpResponseMessage>> _handlerFunc;
    public DelegatingHandlerStub() {
        _handlerFunc = (request, cancellationToken) => Task.FromResult(request.CreateResponse(HttpStatusCode.OK));
    }

    public DelegatingHandlerStub(Func<HttpRequestMessage, CancellationToken, Task<HttpResponseMessage>> handlerFunc) {
        _handlerFunc = handlerFunc;
    }

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) {
        return _handlerFunc(request, cancellationToken);
    }
}

Taken from an answer I gave here

Reference Mock HttpClient using Moq

Suppose you have a controller

[Route("api/[controller]")]
public class ValuesController : Controller {
    private readonly IHttpClientFactory _httpClientFactory;

    public ValuesController(IHttpClientFactory httpClientFactory) {
        _httpClientFactory = httpClientFactory;
    }

    [HttpGet]
    public async Task<IActionResult> Get() {
        var client = _httpClientFactory.CreateClient();
        var url = "http://example.com";
        var result = await client.GetStringAsync(url);
        return Ok(result);
    }
}

and wanted to test the Get() action.

public async Task Should_Return_Ok() {
    //Arrange
    var expected = "Hello World";
    var mockFactory = new Mock<IHttpClientFactory>();
    var configuration = new HttpConfiguration();
    var clientHandlerStub = new DelegatingHandlerStub((request, cancellationToken) => {
        request.SetConfiguration(configuration);
        var response = request.CreateResponse(HttpStatusCode.OK, expected);
        return Task.FromResult(response);
    });
    var client = new HttpClient(clientHandlerStub);
    
    mockFactory.Setup(_ => _.CreateClient(It.IsAny<string>())).Returns(client);
    
    IHttpClientFactory factory = mockFactory.Object;
    
    var controller = new ValuesController(factory);
    
    //Act
    var result = await controller.Get();
    
    //Assert
    result.Should().NotBeNull();
    
    var okResult = result as OkObjectResult;
    
    var actual = (string) okResult.Value;
    
    actual.Should().Be(expected);
}

More Related Contents:

  1. Mocking Extension Methods with Moq
  2. Mocking HttpClient in unit tests
  3. How to mock an async repository with Entity Framework Core
  4. Mocking Static Methods
  5. How to mock static methods in c# using MOQ framework?
  6. Mock static property with moq
  7. How can I tell Moq to return a Task?
  8. Why am I getting an Exception with the message “Invalid setup on a non-virtual (overridable in VB) member…”?
  9. Using Moq to mock an asynchronous method for a unit test
  10. Is it possible to mock out a .NET HttpWebResponse?
  11. Using Moq to determine if a method is called
  12. Moq + Unit Testing – System.Reflection.TargetParameterCountException: Parameter count mismatch
  13. How to unit test with ILogger in ASP.NET Core
  14. How to mock ConfigurationManager.AppSettings with moq
  15. Mocking EF DbContext with Moq
  16. Why does the property I want to mock need to be virtual?
  17. How to test method call order with Moq
  18. Moq: unit testing a method relying on HttpContext
  19. Configure HttpClientFactory to use data from the current request context
  20. Moq – Non-overridable members may not be used in setup / verification expressions
  21. How do I mock User.Identity.GetUserId()?
  22. How do I Moq a method that has an optional argument in its signature without explicitly specifying it or using an overload?
  23. How to mock Controller.User using moq
  24. Unit testing with EF Core and in memory database
  25. Using Moq to override virtual methods in the same class
  26. Mocking using Moq in c#
  27. How to (should I) mock DocumentClient for DocumentDb unit testing?
  28. How to write this EF Mock setup code as a reusable Generic Boilerplate?
  29. Execute unit tests serially (rather than in parallel)
  30. How do you test private methods with NUnit?

Leave a Comment