Class FunctionScopedTest

Provides a borrowed Functions host and an isolated scenario runner for test classes.

public abstract class FunctionScopedTest

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

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)

Remarks

Independent of test frameworks. Each run creates and cleans up one fresh scenario.

Creates a test base that borrows a host and test cancellation token.

protected FunctionScopedTest(AzureFunctionTestHost host, CancellationToken cancellationToken = default)

host AzureFunctionTestHost: The non-null caller-owned function host, which this base never disposes.
cancellationToken CancellationToken: The token used by scope initialization and each test callback.

Gets the borrowed function host.

protected AzureFunctionTestHost Host { get; }

Gets the token used for every test run.

protected CancellationToken TestCancellationToken { get; }

CancellationToken: The caller-supplied token, or a non-cancelable token when omitted.

Runs a test in a fresh scenario with failure diagnostics and automatic cleanup.

protected Task RunAsync(Func<AzureFunctionTestScenarioScope, CancellationToken, Task> test)

test Func<AzureFunctionTestScenarioScope, CancellationToken, Task>: The non-null callback borrowing the scope and test token.

Runs a test function and returns detached data after cleanup.

protected Task<TResult> RunAsync<TResult>(Func<AzureFunctionTestScenarioScope, CancellationToken, Task<TResult>> test)

test Func<AzureFunctionTestScenarioScope, CancellationToken, Task<TResult>>: The non-null callback borrowing the scope and test token.

TResult: The detached result type; do not return scenario-owned resources.