Class HttpTriggerTestExtensions

Provides Azure Functions HTTP-trigger helpers for constructing request and response data in tests.

Inheritance

object

HttpTriggerTestExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FastMoq.AzureFunctions.Extensions

Assembly: FastMoq.AzureFunctions.dll

Syntax

public static class HttpTriggerTestExtensions

Methods

CreateHttpRequestData(Mocker, Action<HttpRequestDataBuilder>?)

Creates a concrete HttpRequestData for the current Mocker instance.

Declaration

public static HttpRequestData CreateHttpRequestData(this Mocker mocker, Action<HttpRequestDataBuilder>? configureRequest = null)

Parameters

Type	Name	Description
Mocker	mocker	The current Mocker instance.
Action<HttpRequestDataBuilder>	configureRequest	Optional request-builder configuration.

Returns

Type	Description
HttpRequestData	A concrete HttpRequestData suitable for Azure Functions trigger tests.

CreateHttpRequestData(FunctionContext, Action<HttpRequestDataBuilder>?)

Creates a concrete HttpRequestData for the supplied FunctionContext.

Declaration

public static HttpRequestData CreateHttpRequestData(this FunctionContext functionContext, Action<HttpRequestDataBuilder>? configureRequest = null)

Parameters

Type	Name	Description
FunctionContext	functionContext	The function context to associate with the request.
Action<HttpRequestDataBuilder>	configureRequest	Optional request-builder configuration.

Returns

Type	Description
HttpRequestData	A concrete HttpRequestData suitable for Azure Functions trigger tests.

CreateHttpResponseData(Mocker, Action<HttpResponseDataBuilder>?)

Creates a concrete HttpResponseData for the current Mocker instance.

Declaration

public static HttpResponseData CreateHttpResponseData(this Mocker mocker, Action<HttpResponseDataBuilder>? configureResponse = null)

Parameters

Type	Name	Description
Mocker	mocker	The current Mocker instance.
Action<HttpResponseDataBuilder>	configureResponse	Optional response-builder configuration.

Returns

Type	Description
HttpResponseData	A concrete HttpResponseData suitable for Azure Functions trigger tests.

CreateHttpResponseData(FunctionContext, Action<HttpResponseDataBuilder>?)

Creates a concrete HttpResponseData for the supplied FunctionContext.

Declaration

public static HttpResponseData CreateHttpResponseData(this FunctionContext functionContext, Action<HttpResponseDataBuilder>? configureResponse = null)

Parameters

Type	Name	Description
FunctionContext	functionContext	The function context to associate with the response.
Action<HttpResponseDataBuilder>	configureResponse	Optional response-builder configuration.

Returns

Type	Description
HttpResponseData	A concrete HttpResponseData suitable for Azure Functions trigger tests.

ReadBodyAsJsonAsync<TValue>(HttpRequestData, JsonSerializerOptions?, CancellationToken)

Reads the current request body as JSON and rewinds the stream when possible.

Declaration

public static Task<TValue?> ReadBodyAsJsonAsync<TValue>(this HttpRequestData request, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
HttpRequestData	request	The current request.
JsonSerializerOptions	jsonSerializerOptions	Optional serializer options.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<TValue>	The deserialized body value.

Type Parameters

Name	Description
TValue	The expected JSON type.

ReadBodyAsJsonAsync<TValue>(HttpResponseData, JsonSerializerOptions?, CancellationToken)

Reads the current response body as JSON and rewinds the stream when possible.

Declaration

public static Task<TValue?> ReadBodyAsJsonAsync<TValue>(this HttpResponseData response, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
HttpResponseData	response	The current response.
JsonSerializerOptions	jsonSerializerOptions	Optional serializer options.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<TValue>	The deserialized body value.

Type Parameters

Name	Description
TValue	The expected JSON type.

ReadBodyAsStringAsync(HttpRequestData, Encoding?)

Reads the current request body as a string and rewinds the stream when possible.

Declaration

public static Task<string> ReadBodyAsStringAsync(this HttpRequestData request, Encoding? encoding = null)

Parameters

Type	Name	Description
HttpRequestData	request	The current request.
Encoding	encoding	The text encoding. Defaults to UTF-8.

Returns

Type	Description
Task<string>	The body text.

ReadBodyAsStringAsync(HttpResponseData, Encoding?)

Reads the current response body as a string and rewinds the stream when possible.

Declaration

public static Task<string> ReadBodyAsStringAsync(this HttpResponseData response, Encoding? encoding = null)

Parameters

Type	Name	Description
HttpResponseData	response	The current response.
Encoding	encoding	The text encoding. Defaults to UTF-8.

Returns

Type	Description
Task<string>	The body text.