TeubDev.Moq.AutoMock.HttpClient 0.0.1

Suggested Alternatives

Moq.Contrib.HttpClient

Additional Details

Moq.Contrib.HttpClient has almost all the features of TeubDev.Moq.AutoMock.HttpClient, plus more.

dotnet add package TeubDev.Moq.AutoMock.HttpClient --version 0.0.1
                    
NuGet\Install-Package TeubDev.Moq.AutoMock.HttpClient -Version 0.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TeubDev.Moq.AutoMock.HttpClient" Version="0.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TeubDev.Moq.AutoMock.HttpClient" Version="0.0.1" />
                    
Directory.Packages.props
<PackageReference Include="TeubDev.Moq.AutoMock.HttpClient" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TeubDev.Moq.AutoMock.HttpClient --version 0.0.1
                    
#r "nuget: TeubDev.Moq.AutoMock.HttpClient, 0.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package TeubDev.Moq.AutoMock.HttpClient@0.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TeubDev.Moq.AutoMock.HttpClient&version=0.0.1
                    
Install as a Cake Addin
#tool nuget:?package=TeubDev.Moq.AutoMock.HttpClient&version=0.0.1
                    
Install as a Cake Tool

Moq.AutoMock.HttpClient

A NuGet package for making HttpClients slightly easier to test.

This wraps and mocks the HttpMessageHandler class used by the HttpClient class and internally creates an HttpClient to be used by classes under test.

Usage

Setup

After creating an instance of the AutoMocker class (see Moq.AutoMocker), use the GetHttpClientMock extension method to create an instance of the HttpClientMock class.

var mocker = new AutoMocker();
var mockClient = mocker.GetHttpClientMock();

To set up to watch for a request, use the SetupRequest method, passing in a function that will determine if a particular request matches the setup or not.

var url = "https://google.com/";
mockClient
    .SetupRequest(m =>
        m.RequestUri == new Uri(url)
        && m.Method == HttpMethod.Get)
    .ReturnsAsync(new HttpResponseMessage
    {
        Content = new StringContent("This is the response"),
        StatusCode = System.Net.HttpStatusCode.OK,
    });

Note: If using relative URIs instead of absolute URIs (like in the example above), create base address and pass it into the optional parameter in GetHttpClientMock, and any request matching will need to account for both URIs.

var url = "stuff";
var baseAddress = new Uri("https://google.com/");
var mockClient = mocker.GetHttpClientMock(baseAddress);
// ...
    m.RequestUri == new Uri(baseAddress, url)

Verify

Similar to regular Moq mocks, verification is similar to setup.

mockClient.Verify(m =>
    m.RequestUri == new Uri(url)
    && m.Method == HttpMethod.Get, Times.Once);
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.0.1 481 1/1/2023 0.0.1 is deprecated because it is no longer maintained.