Class TestWebExtensions

Class TestWebExtensions.

Inheritance

object

TestWebExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FastMoq.Web.Extensions

Assembly: FastMoq.Web.dll

Syntax

public static class TestWebExtensions

Methods

AddHttpContext(Mocker, HttpContext?, bool, params string[])

Registers an HttpContext for controller, middleware, or accessor-based tests.

Declaration

public static Mocker AddHttpContext(this Mocker mocker, HttpContext? httpContext = null, bool replace = false, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	mocker
HttpContext	httpContext
bool	replace
string[]	roleNames

Returns

Type	Description
Mocker

AddHttpContextAccessor(Mocker, HttpContext?, bool, params string[])

Registers an IHttpContextAccessor backed by the provided or generated HttpContext.

Declaration

public static Mocker AddHttpContextAccessor(this Mocker mocker, HttpContext? httpContext = null, bool replace = false, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	mocker
HttpContext	httpContext
bool	replace
string[]	roleNames

Returns

Type	Description
Mocker

AddRequestDelegate(Mocker, RequestDelegate?, bool)

Registers a RequestDelegate for middleware tests.

Declaration

public static Mocker AddRequestDelegate(this Mocker mocker, RequestDelegate? next = null, bool replace = false)

Parameters

Type	Name	Description
Mocker	mocker
RequestDelegate	next
bool	replace

Returns

Type	Description
Mocker

CreateControllerContext(Mocker, TestClaimsPrincipalOptions, params string[])

Creates a ControllerContext with an authenticated test user using the provided identity options.

Declaration

public static ControllerContext CreateControllerContext(this Mocker mocker, TestClaimsPrincipalOptions principalOptions, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	mocker
TestClaimsPrincipalOptions	principalOptions
string[]	roleNames

Returns

Type	Description
ControllerContext

CreateControllerContext(Mocker, HttpContext)

Creates a ControllerContext from an existing HttpContext.

Declaration

public static ControllerContext CreateControllerContext(this Mocker mocker, HttpContext httpContext)

Parameters

Type	Name	Description
Mocker	mocker
HttpContext	httpContext

Returns

Type	Description
ControllerContext

CreateControllerContext(Mocker, IEnumerable<Claim>)

Creates a ControllerContext with a principal composed from the supplied claims and compatibility defaults.

Declaration

public static ControllerContext CreateControllerContext(this Mocker mocker, IEnumerable<Claim> claims)

Parameters

Type	Name	Description
Mocker	mocker
IEnumerable<Claim>	claims

Returns

Type	Description
ControllerContext

CreateControllerContext(Mocker, IEnumerable<Claim>, TestClaimsPrincipalOptions)

Creates a ControllerContext with a principal composed from the supplied claims and compatibility defaults.

Declaration

public static ControllerContext CreateControllerContext(this Mocker mocker, IEnumerable<Claim> claims, TestClaimsPrincipalOptions principalOptions)

Parameters

Type	Name	Description
Mocker	mocker
IEnumerable<Claim>	claims
TestClaimsPrincipalOptions	principalOptions

Returns

Type	Description
ControllerContext

CreateControllerContext(Mocker, ClaimsPrincipal)

Creates a ControllerContext from an existing principal.

Declaration

public static ControllerContext CreateControllerContext(this Mocker mocker, ClaimsPrincipal principal)

Parameters

Type	Name	Description
Mocker	mocker
ClaimsPrincipal	principal

Returns

Type	Description
ControllerContext

CreateControllerContext(Mocker, params string[])

Creates a ControllerContext with an authenticated test user.

Declaration

public static ControllerContext CreateControllerContext(this Mocker mocker, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	mocker
string[]	roleNames

Returns

Type	Description
ControllerContext

CreateHttpContext(Mocker, TestClaimsPrincipalOptions, params string[])

Creates an HttpContext with an authenticated test user using the provided identity options.

Declaration

public static HttpContext CreateHttpContext(this Mocker mocker, TestClaimsPrincipalOptions principalOptions, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	mocker
TestClaimsPrincipalOptions	principalOptions
string[]	roleNames

Returns

Type	Description
HttpContext

CreateHttpContext(Mocker, IEnumerable<Claim>)

Creates an HttpContext with a principal composed from the supplied claims and compatibility defaults.

Declaration

public static HttpContext CreateHttpContext(this Mocker mocker, IEnumerable<Claim> claims)

Parameters

Type	Name	Description
Mocker	mocker
IEnumerable<Claim>	claims

Returns

Type	Description
HttpContext

CreateHttpContext(Mocker, IEnumerable<Claim>, TestClaimsPrincipalOptions)

Creates an HttpContext with a principal composed from the supplied claims and compatibility defaults.

Declaration

public static HttpContext CreateHttpContext(this Mocker mocker, IEnumerable<Claim> claims, TestClaimsPrincipalOptions principalOptions)

Parameters

Type	Name	Description
Mocker	mocker
IEnumerable<Claim>	claims
TestClaimsPrincipalOptions	principalOptions

Returns

Type	Description
HttpContext

CreateHttpContext(Mocker, ClaimsPrincipal)

Creates an HttpContext from an existing principal.

Declaration

public static HttpContext CreateHttpContext(this Mocker mocker, ClaimsPrincipal principal)

Parameters

Type	Name	Description
Mocker	mocker
ClaimsPrincipal	principal

Returns

Type	Description
HttpContext

CreateHttpContext(Mocker, params string[])

Creates an HttpContext with an authenticated test user.

Declaration

public static HttpContext CreateHttpContext(this Mocker mocker, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	mocker
string[]	roleNames

Returns

Type	Description
HttpContext

GetBadRequestObjectResult(IActionResult)

Gets a BadRequestObjectResult from an IActionResult.

Declaration

public static BadRequestObjectResult GetBadRequestObjectResult(this IActionResult result)

Parameters

Type	Name	Description
IActionResult	result

Returns

Type	Description
BadRequestObjectResult

GetConflictObjectResult(IActionResult)

Gets a ConflictObjectResult from an IActionResult.

Declaration

public static ConflictObjectResult GetConflictObjectResult(this IActionResult result)

Parameters

Type	Name	Description
IActionResult	result

Returns

Type	Description
ConflictObjectResult

GetNoContentResult(IActionResult)

Gets a NoContentResult from an IActionResult.

Declaration

public static NoContentResult GetNoContentResult(this IActionResult result)

Parameters

Type	Name	Description
IActionResult	result

Returns

Type	Description
NoContentResult

GetObjectResult(IActionResult)

Gets an ObjectResult from an IActionResult.

Declaration

public static ObjectResult GetObjectResult(this IActionResult result)

Parameters

Type	Name	Description
IActionResult	result

Returns

Type	Description
ObjectResult

GetObjectResultContent<T>(ActionResult<T>)

Gets the content of the object result.

Declaration

public static T GetObjectResultContent<T>(this ActionResult<T> result)

Parameters

Type	Name	Description
ActionResult<T>	result	The result.

Returns

Type	Description
T	T.

Type Parameters

Name	Description
T

GetObjectResultContent<T>(IActionResult)

Gets the content of an IActionResult as a typed object result payload.

Declaration

public static T GetObjectResultContent<T>(this IActionResult result)

Parameters

Type	Name	Description
IActionResult	result

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetOkObjectResult(IActionResult)

Gets an OkObjectResult from an IActionResult.

Declaration

public static OkObjectResult GetOkObjectResult(this IActionResult result)

Parameters

Type	Name	Description
IActionResult	result

Returns

Type	Description
OkObjectResult

SetQueryParameter(HttpContext, string, string?)

Sets or replaces a single query parameter on an HttpContext.

Declaration

public static HttpContext SetQueryParameter(this HttpContext httpContext, string name, string? value)

Parameters

Type	Name	Description
HttpContext	httpContext
string	name
string	value

Returns

Type	Description
HttpContext

SetQueryParameters(HttpContext, IEnumerable<KeyValuePair<string, string?>>)

Sets the request query collection and synchronized raw query string on an HttpContext.

Declaration

public static HttpContext SetQueryParameters(this HttpContext httpContext, IEnumerable<KeyValuePair<string, string?>> parameters)

Parameters

Type	Name	Description
HttpContext	httpContext
IEnumerable<KeyValuePair<string, string>>	parameters

Returns

Type	Description
HttpContext

SetQueryString(HttpContext, string?)

Sets the raw query string on an HttpContext.

Declaration

public static HttpContext SetQueryString(this HttpContext httpContext, string? queryString)

Parameters

Type	Name	Description
HttpContext	httpContext
string	queryString

Returns

Type	Description
HttpContext

SetRequestHeader(HttpContext, string, params string[])

Sets or replaces a request header value on an HttpContext.

Declaration

public static HttpContext SetRequestHeader(this HttpContext httpContext, string name, params string[] values)

Parameters

Type	Name	Description
HttpContext	httpContext
string	name
string[]	values

Returns

Type	Description
HttpContext

SetRequestHeaders(HttpContext, IEnumerable<KeyValuePair<string, string[]>>)

Sets multiple request header values on an HttpContext.

Declaration

public static HttpContext SetRequestHeaders(this HttpContext httpContext, IEnumerable<KeyValuePair<string, string[]>> headers)

Parameters

Type	Name	Description
HttpContext	httpContext
IEnumerable<KeyValuePair<string, string[]>>	headers

Returns

Type	Description
HttpContext

SetupClaimsPrincipal(Mocker, TestClaimsPrincipalOptions, params string[])

Creates an authenticated ClaimsPrincipal using the provided identity options and roles.

Declaration

public static ClaimsPrincipal SetupClaimsPrincipal(this Mocker _, TestClaimsPrincipalOptions principalOptions, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	_
TestClaimsPrincipalOptions	principalOptions
string[]	roleNames

Returns

Type	Description
ClaimsPrincipal

SetupClaimsPrincipal(Mocker, IEnumerable<Claim>)

Creates an authenticated ClaimsPrincipal by combining custom claims with compatibility defaults. Existing custom claim types are preserved.

Declaration

public static ClaimsPrincipal SetupClaimsPrincipal(this Mocker _, IEnumerable<Claim> claims)

Parameters

Type	Name	Description
Mocker	_
IEnumerable<Claim>	claims

Returns

Type	Description
ClaimsPrincipal

SetupClaimsPrincipal(Mocker, IEnumerable<Claim>, TestClaimsPrincipalOptions)

Creates an authenticated ClaimsPrincipal by combining custom claims with compatibility defaults. Existing custom claim types are preserved.

Declaration

public static ClaimsPrincipal SetupClaimsPrincipal(this Mocker _, IEnumerable<Claim> claims, TestClaimsPrincipalOptions principalOptions)

Parameters

Type	Name	Description
Mocker	_
IEnumerable<Claim>	claims
TestClaimsPrincipalOptions	principalOptions

Returns

Type	Description
ClaimsPrincipal

SetupClaimsPrincipal(Mocker, params string[])

Creates an authenticated ClaimsPrincipal with compatibility-focused default claims.

Declaration

public static ClaimsPrincipal SetupClaimsPrincipal(this Mocker _, params string[] roleNames)

Parameters

Type	Name	Description
Mocker	_
string[]	roleNames

Returns

Type	Description
ClaimsPrincipal