Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess 1.1.0

Prefix Reserved
dotnet add package Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess --version 1.1.0
                    
NuGet\Install-Package Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess -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.DebugProcess" 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.DebugProcess" Version="1.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess" />
                    
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.DebugProcess --version 1.1.0
                    
#r "nuget: Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess, 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.DebugProcess@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.DebugProcess&version=1.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess&version=1.1.0
                    
Install as a Cake Tool

Azure Functions Integration Testing Framework - Debugging

Since these are integration tests, they test the code like a client would by making requests and inspecting the result. However, it is often useful to be able to see what the server is doing and step through the code. Since the tests and the functions host run in two (or three) different processes, that can be tricky. The solution is the Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess package.

Setup

Test Project

Add a reference to this package from your test project. In your TestStartup, call builder.DebugIntoFunctions(), which will cause Visual Studio to automatically attach to the func.exe process when the tests are being debugged.

Function App

Since the code has to wait until the process starts in order to attach to it, there can be timing issues where you may not be able to debug the very earliest lines of code in your app. To solve that, add a reference to Microsoft.Learn.AzureFunctionsTesting.Extension.DebugProcess.Core to your function app (not tests app) and call DebugHelper.WaitForDebuggerToAttach() as the very first line of code (in your Startup.cs or Program.cs)

Usage

When you Debug your tests, VS will automatically attach to the function process as well (including the worker process for Isolated functions) so you can set breakpoints and step through both the test code and the functions being tested.

When you Run your tests, and when the code is directly outside of tests (including when deployed to Azure), the DebugHelper.WaitForDebuggerToAttach() is a no-op and wont cause any harm.

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 9,267 9/24/2024
1.0.0 209 8/15/2024