PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder Class Reference

Builds a RequestDelegateTestArena, which makes testing middleware a lot easier. More...

Public Member Functions
RequestDelegateTestArena	Build ()
	Build the arena.
RequestDelegateTestArenaBuilder	ForOptionsRequest ()
	Generate the request delegate arena for a random OPTIONS request.
RequestDelegateTestArenaBuilder	WithContextMutator (Action< HttpContextBuilder > mutator)
	Fluent mechanism for adding an http context mutation.
RequestDelegateTestArenaBuilder	WithRequestMutator (Action< HttpRequest > mutator)
	Add a mutation on the request for the context.
RequestDelegateTestArenaBuilder	WithResponseMutator (Action< HttpResponse > mutator)
	Add a mutation on the response for the context.
RequestDelegateTestArenaBuilder	WithResponse (HttpResponse response)
	Set the entire response for the context.
RequestDelegateTestArenaBuilder	WithRequest (HttpRequest request)
	Set the entire request for the context.
RequestDelegateTestArenaBuilder	WithDelegateLogic (Action< HttpContext > logic)
	Fluent mechanism for setting the delegate logic (overrides any existing logic)
RequestDelegateTestArenaBuilder	WithContext (HttpContext context)
	Fluent mechanism for setting the HttpContext.
RequestDelegateTestArenaBuilder	WithOriginHeader ()
	Sets the origin header on the request to be the root of the request url.
RequestDelegateTestArenaBuilder	WithOriginHeader (string origin)
	Sets the Origin header on the request to the provided value.

Static Public Member Functions
static RequestDelegateTestArenaBuilder	Create ()
	Create the arena for fluent syntax usage.
static RequestDelegateTestArena	BuildDefault ()
	Builds the default RequestDelegateTestArena.

Detailed Description

Builds a RequestDelegateTestArena, which makes testing middleware a lot easier.

Member Function Documentation

Build()

RequestDelegateTestArena PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.Build

(

)

Build the arena.

Returns

Exceptions

NotImplementedException

BuildDefault()

RequestDelegateTestArena PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.BuildDefault ( )

static

Builds the default RequestDelegateTestArena.

Returns

Create()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.Create ( )

static

Create the arena for fluent syntax usage.

Returns

ForOptionsRequest()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.ForOptionsRequest

(

)

Generate the request delegate arena for a random OPTIONS request.

Returns

WithContext()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithContext

(

HttpContext

context

)

Fluent mechanism for setting the HttpContext.

Parameters

context

Returns

WithContextMutator()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithContextMutator

(

Action< HttpContextBuilder >

mutator

)

Fluent mechanism for adding an http context mutation.

Parameters

mutator

Returns

WithDelegateLogic()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithDelegateLogic

(

Action< HttpContext >

logic

)

Fluent mechanism for setting the delegate logic (overrides any existing logic)

Parameters

logic

Returns

WithOriginHeader() [1/2]

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithOriginHeader

(

)

Sets the origin header on the request to be the root of the request url.

Returns

WithOriginHeader() [2/2]

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithOriginHeader

(

string

origin

)

Sets the Origin header on the request to the provided value.

Parameters

origin

Returns

WithRequest()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithRequest

(

HttpRequest

request

)

Set the entire request for the context.

Parameters

request

Returns

WithRequestMutator()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithRequestMutator

(

Action< HttpRequest >

mutator

)

Add a mutation on the request for the context.

Parameters

mutator

Returns

WithResponse()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithResponse

(

HttpResponse

response

)

Set the entire response for the context.

Parameters

response

Returns

WithResponseMutator()

RequestDelegateTestArenaBuilder PeanutButter.TestUtils.AspNetCore.Utils.RequestDelegateTestArenaBuilder.WithResponseMutator

(

Action< HttpResponse >

mutator

)

Add a mutation on the response for the context.

Parameters

mutator

Returns

---

The documentation for this class was generated from the following file:

• source/TestUtils/PeanutButter.TestUtils.AspNetCore/Utils/RequestDelegateTestArenaBuilder.cs