Class AzureFunctionTestHostBuilder

Fluently builds a dependency-injection host for isolated-worker function tests.

public sealed class AzureFunctionTestHostBuilder

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, Action<SnapshotSettings>, CancellationToken, string, string)

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, string, CancellationToken, string, string)

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, SnapshotSettings?, CancellationToken, string, string)

Methods

Adds a function class that can be resolved from the test host.

public AzureFunctionTestHostBuilder AddFunction<TFunction>() where TFunction : class

TFunction: The reference-type function class registered with transient lifetime.

Creates the configured function test host.

public AzureFunctionTestHost Build()

AzureFunctionTestHost: A new host that owns its service provider and must be disposed. Registered singleton and scoped disposable services are released with the host or invocation scope respectively.

Configures dependencies used by function instances and invocation contexts.

public AzureFunctionTestHostBuilder ConfigureServices(Action<IServiceCollection> configure)

configure Action<IServiceCollection>: A non-null callback invoked synchronously once with the builder-owned mutable service collection. It may add, remove, or replace registrations but must not retain the collection.

Adds inline middleware to the test invocation pipeline.

public AzureFunctionTestHostBuilder UseMiddleware(Func<FunctionContext, FunctionExecutionDelegate, Task> middleware)

middleware Func<FunctionContext, FunctionExecutionDelegate, Task>: A non-null asynchronous delegate retained by the host and invoked once per invocation in registration order. It may short-circuit by not invoking the supplied next delegate.

Adds isolated-worker middleware to the test invocation pipeline.

public AzureFunctionTestHostBuilder UseMiddleware<TMiddleware>() where TMiddleware : class, IFunctionsWorkerMiddleware

AzureFunctionTestHostBuilder: This builder, for chaining. Middleware executes in registration order.

TMiddleware: The middleware class registered transiently and resolved once per invocation from its scope.

Registers borrowed mutable state for scenario reset and failure diagnostics.

public AzureFunctionTestHostBuilder UseScenarioResource(string name, ITestScenarioResource resource)

name string: A non-empty, case-insensitively unique name other than the reserved $Invocation.
resource ITestScenarioResource: The non-null resource. The caller owns and disposes it.

Resources are reset before and after explicit scenarios. Register them separately in DI if functions need them.