PeanutButter
Loading...
Searching...
No Matches
PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder Class Reference

Builds ActionContexts. More...

Inheritance diagram for PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder:
PeanutButter.TestUtils.AspNetCore.Builders.RandomizableBuilder< TBuilder, TSubject > PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >

Public Member Functions

 ActionContextBuilder ()
ActionContextBuilder WithRouteData (RouteData routeData)
 Sets the RouteData on the ActionContext.
ActionContextBuilder WithActionDescriptor (ActionDescriptor actionDescriptor)
 Sets the ActionDescriptor on the ActionContext.
ActionContextBuilder WithHttpContext (HttpContext httpContext)
 Sets the HttpContext on the ActionContext.
override ActionContextBuilder Randomize ()
ActionContextBuilder WithRouteDataValue (string key, string value)
 Set a RouteData Value.
ActionContextBuilder WithRouteDataMutator (Action< RouteData > mutator)
 Mutate the RouteData on the ActionDescriptor.
Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.RandomizableBuilder< TBuilder, TSubject >
TBuilder Randomize ()
 Derivatives must implement this so that BuildRandom can work.
Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
TBuilder With (Action< TSubject > action)
 Adds a mutator for the artifact.
virtual TSubject Build ()
 Builds the subject artifact.
 Mutator (Action< T > action, string identifier)

Protected Member Functions

override ActionContext ConstructEntity ()
 Override in a derivative builder to provide a custom implementation for TSubject.
Returns
Exceptions
CustomConstructEntityRequired

Protected Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
TBuilder With (Action< TSubject > action, string identifier)
 Adds an identified mutator for the artifact - if a mutator with the same identity already exists, it will be removed.
TBuilder With< TCast > (Action< TCast > action)
 Adds a mutator for the artifact, cast to TCast.
TBuilder With< TCast > (Action< TCast > action, string identifier)
 Adds an identified mutator for the artifact, cast to TCast.
TBuilder WithRandomTimes (Action< TSubject > action)
 Applies the given mutator a random (1-4) number of times.
TBuilder WithRandomTimes< TCast > (Action< TCast > action)
 Applies the given mutator on a cast item a random (1-4) number of times.
TBuilder WithPreCursor (Action toRun)
 Run a precursor before your entity is constructed - use when your entity requires constructor parameters you'd like to make user-tweakable via builder methods.
TBuilder WithPostBuild (Action< TSubject > action)
 Add post-build actions.

Additional Inherited Members

Static Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.RandomizableBuilder< TBuilder, TSubject >
static TSubject BuildRandom ()
 Builds a random variant output artifact.
Static Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
static TBuilder Create ()
 Returns a new instance of the builder.
static TSubject BuildDefault ()
 Builds the default output artifact.
Static Protected Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
static void WarnIf (bool condition, string message)
 Print a traced warning if the condition is found to be false.
static void ErrorIf (bool condition, string message)
 Print a traced warning if the condition is found to be false.
Protected Attributes inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
TSubject CurrentEntity
 During build, CurrentEntity will be set to the currently-building entity. You may implement actualizer(s) in your derivative to pull this value in lazily to consumers.
Properties inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
Action< T > Action [get]
string Identifier [get]

Detailed Description

Builds ActionContexts.

Member Function Documentation

◆ ConstructEntity()

override ActionContext PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder.ConstructEntity ( )
protectedvirtual

Override in a derivative builder to provide a custom implementation for TSubject.

Returns
Exceptions
CustomConstructEntityRequired

Reimplemented from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.

◆ WithActionDescriptor()

ActionContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder.WithActionDescriptor ( ActionDescriptor actionDescriptor)

Sets the ActionDescriptor on the ActionContext.

Parameters
actionDescriptor
Returns

◆ WithHttpContext()

ActionContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder.WithHttpContext ( HttpContext httpContext)

Sets the HttpContext on the ActionContext.

Parameters
httpContext
Returns

◆ WithRouteData()

ActionContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder.WithRouteData ( RouteData routeData)

Sets the RouteData on the ActionContext.

Parameters
routeData
Returns

◆ WithRouteDataMutator()

ActionContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder.WithRouteDataMutator ( Action< RouteData > mutator)

Mutate the RouteData on the ActionDescriptor.

Parameters
mutator
Returns

◆ WithRouteDataValue()

ActionContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder.WithRouteDataValue ( string key,
string value )

Set a RouteData Value.

Parameters
key
value
Returns

The documentation for this class was generated from the following file:
  • source/TestUtils/PeanutButter.TestUtils.AspNetCore/Builders/ActionContextBuilder.cs