Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer 1.1.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer --version 1.1.0
                    


                    

                
NuGet\Install-Package Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer -Version 1.1.0
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="Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer" />
                    


                            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 Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer --version 1.1.0
                    


                    

                
#r "nuget: Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer, 1.1.0"
#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 Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer@1.1.0
#: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=Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Learn.AzureFunctionsTesting.Extension.MockHttpServer&version=1.1.0
                    


                            Install as a Cake Tool

Azure Functions Integration Testing Framework - Mocking HTTP Dependencies

If your function app makes HTTP requests to downstream services, you can use this package to mock those services in your tests. This allows you to test your function app in isolation without needing to call real services.

Prerequisites

There are no prerequisites for this package.

Setup

For simple usage, the easiest way to mock HTTP requests is to use the builder.UseMockServer(name, handler) method in your TestStartup and provide the handler logic inline:

var someServer = builder.UseMockServer("someServer", (req, res) =>
{
	var obj = new { id = "abc", name = "test obj", timestamp = DateTimeOffset.UtcNow };
	res.FromJson(obj);
});

The handler delegate is passed an HttpListenerRequest and MockHttpResponse object, which you can use to inspect the request and write a response. You can set the response status code, headers, and body as needed. The res.FromJson(obj) method is a convenience method to write a JSON responses with a single line.

If you need to mock more complex behavior, you can write a custom class that derives from HttpServer and call the .UseMockServer() overloads that use this type instead of the handler delegate.

var commentServer = builder.UseMockServer<CommentServer>("commentServer"); // an instance of CommentServer will be created automatically

var orderServer = builder.UseMockServer<OrderServer>("orderServer", new OrderServer()); // you can pass in an instance of the server if you need to configure it

Every server that you create will be assigned a unique port number, so you can run multiple servers in parallel. The .UseMockServer() method returns an object with the URL of the server, which you can use to configure your function app however you would normally pass in your service URL:

builder.ConfigureEnvironmentVariables(env =>
{
	env.Add("SomeServiceUrl", someServer.Url);
	env.Add("CommentServiceUrl", commentServer.Url);
	env.Add("OrderServiceUrl", orderServer.Url);
});

Usage

Since you passed in the url of the servers to your function app, you dont generally have to do anything else at all.

However, if you need to control the mock server behavior from your tests, you can use the fixture.GetHttpServer(name) method to get an HttpServer object that you can use to manipulate the mock server behavior.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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
1.1.0 3,428 9/24/2024
1.0.0 225 8/15/2024