PeanutButter
Loading...
Searching...
No Matches
PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject > Class Template Referenceabstract

Provides the base builder for AspNetCore fakes. More...

Inheritance diagram for PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >:
PeanutButter.TestUtils.AspNetCore.Builders.ActionExecutedContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.ActionExecutingContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.AuthorizationFilterContextBuilder< TController > PeanutButter.TestUtils.AspNetCore.Builders.ControllerActionDescriptorBuilder PeanutButter.TestUtils.AspNetCore.Builders.ControllerBuilder< TController > PeanutButter.TestUtils.AspNetCore.Builders.ControllerContextBuilder PeanutButter.TestUtils.AspNetCore.Builders.RandomizableBuilder< TBuilder, TSubject > PeanutButter.TestUtils.AspNetCore.Builders.RouteDataBuilder PeanutButter.TestUtils.AspNetCore.Builders.ViewDataDictionaryBuilder

Public Member Functions

TBuilder With (Action< TSubject > action)
 Adds a mutator for the artifact.
virtual TSubject Build ()
 Builds the subject artifact.
 Mutator (Action< T > action, string identifier)

Static Public Member Functions

static TBuilder Create ()
 Returns a new instance of the builder.
static TSubject BuildDefault ()
 Builds the default output artifact.

Protected Member Functions

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.
virtual TSubject ConstructEntity ()
 Override in a derivative builder to provide a custom implementation for TSubject.
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.

Static Protected Member Functions

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

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

Action< T > Action [get]
string Identifier [get]

Detailed Description

Provides the base builder for AspNetCore fakes.

Template Parameters
TBuilder
TSubject
Type Constraints
TBuilder :Builder 
TBuilder :TBuilder 
TBuilder :TSubject 
TBuilder :new() 

Member Function Documentation

◆ Build()

virtual TSubject PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.Build ( )
virtual

Builds the subject artifact.

Returns

◆ BuildDefault()

TSubject PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.BuildDefault ( )
static

Builds the default output artifact.

Returns

◆ ConstructEntity()

virtual TSubject PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.ConstructEntity ( )
protectedvirtual

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

Returns
Exceptions
CustomConstructEntityRequired

Reimplemented in PeanutButter.TestUtils.AspNetCore.Builders.ActionContextBuilder, PeanutButter.TestUtils.AspNetCore.Builders.ActionExecutedContextBuilder, PeanutButter.TestUtils.AspNetCore.Builders.ActionExecutingContextBuilder, PeanutButter.TestUtils.AspNetCore.Builders.AuthorizationFilterContextBuilder< TController >, PeanutButter.TestUtils.AspNetCore.Builders.ControllerBuilder< TController >, PeanutButter.TestUtils.AspNetCore.Builders.FormBuilder, PeanutButter.TestUtils.AspNetCore.Builders.FormFileBuilder, PeanutButter.TestUtils.AspNetCore.Builders.HttpContextBuilder, PeanutButter.TestUtils.AspNetCore.Builders.HttpRequestBuilder, PeanutButter.TestUtils.AspNetCore.Builders.HttpResponseBuilder, PeanutButter.TestUtils.AspNetCore.Builders.ModelBindingContextBuilder, PeanutButter.TestUtils.AspNetCore.Builders.ModelMetadataBuilder< TModel >, PeanutButter.TestUtils.AspNetCore.Builders.RequestCookieCollectionBuilder, PeanutButter.TestUtils.AspNetCore.Builders.StringMapDerivativeBuilder< TBuilder, TInterface, TConcrete >, PeanutButter.TestUtils.AspNetCore.Builders.ViewDataDictionaryBuilder, PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder, and PeanutButter.TestUtils.AspNetCore.Builders.WebSocketManagerBuilder.

◆ Create()

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.Create ( )
static

Returns a new instance of the builder.

Returns

◆ ErrorIf()

void PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.ErrorIf ( bool condition,
string message )
staticprotected

Print a traced warning if the condition is found to be false.

  • useful to force actualization and print out if the actualization failed
Parameters
condition
message

◆ WarnIf()

void PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.WarnIf ( bool condition,
string message )
staticprotected

Print a traced warning if the condition is found to be false.

  • useful to force actualization and print out if the actualization failed
Parameters
condition
message

◆ With() [1/2]

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.With ( Action< TSubject > action)

Adds a mutator for the artifact.

Parameters
action
Returns

◆ With() [2/2]

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.With ( Action< TSubject > action,
string identifier )
protected

Adds an identified mutator for the artifact - if a mutator with the same identity already exists, it will be removed.

Parameters
action
identifier
Returns

◆ With< TCast >() [1/2]

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.With< TCast > ( Action< TCast > action)
protected

Adds a mutator for the artifact, cast to TCast.

Parameters
action
Template Parameters
TCast
Returns
Type Constraints
TCast :TSubject 

◆ With< TCast >() [2/2]

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.With< TCast > ( Action< TCast > action,
string identifier )
protected

Adds an identified mutator for the artifact, cast to TCast.

Parameters
action
identifier
Template Parameters
TCast
Returns
Type Constraints
TCast :TSubject 

◆ WithPostBuild()

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.WithPostBuild ( Action< TSubject > action)
protected

Add post-build actions.

Parameters
action
Returns

◆ WithPreCursor()

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.WithPreCursor ( Action toRun)
protected

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.

Parameters
toRun

◆ WithRandomTimes()

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.WithRandomTimes ( Action< TSubject > action)
protected

Applies the given mutator a random (1-4) number of times.

Parameters
action
Returns

◆ WithRandomTimes< TCast >()

TBuilder PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.WithRandomTimes< TCast > ( Action< TCast > action)
protected

Applies the given mutator on a cast item a random (1-4) number of times.

Parameters
action
Template Parameters
TCast
Returns
Type Constraints
TCast :TSubject 
The documentation for this class was generated from the following file:
  • source/TestUtils/PeanutButter.TestUtils.AspNetCore/Builders/Builder.cs