Class ProtoHostBuilder

Namespace

ProtoTest.Core

Assembly

ProtoTest.Core.dll

Implements the builder pattern for configuring and constructing a ProtoHost instance.

public sealed class ProtoHostBuilder : IProtoHostBuilder

Inheritance

object

ProtoHostBuilder

Implements

IProtoHostBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ProtoApplicationHostBuilderExtensions.AddApplication(IProtoHostBuilder, string, Action<IProtoApplicationBuilder>)

ProtoCapabilityExtensions.AddCapability(IProtoHostBuilder, ProtoCapabilityDescriptor)

ProtoHostBuilderSinkExtensions.AddSink<TSink>(IProtoHostBuilder, Action<TSink>?)

ProtoHostBuilderSinkExtensions.AddSink<TSink>(IProtoHostBuilder, TSink)

ProtoInfrastructureExtensions.AddInfrastructure(IProtoHostBuilder, IProtoInfrastructure, params string[])

ProtoHostBuilderExtensions.AddData(IProtoHostBuilder, Action<ProtoDataConfiguration>?)

ProtoHostBuilderExtensions.AddDataProvisioner<T, TProvisioner>(IProtoHostBuilder)

ProtoHostBuilderExtensions.AddDataProvisioner<TInput, TResult, TProvisioner>(IProtoHostBuilder)

ProtoHostBuilderExtensions.AddGraphQL(IProtoHostBuilder, Action<ProtoGraphQLBuilder>?)

ProtoHostBuilderExtensions.AddGrpc(IProtoHostBuilder, Action<ProtoGrpcBuilder>?)

ProtoHostBuilderExtensions.AddMessaging(IProtoHostBuilder, Action<ProtoMessagingBuilder>?)

ProtoHostBuilderExtensions.AddRest(IProtoHostBuilder, Action<ProtoRestBuilder>?)

ProtoHostBuilderExtensions.AddEntityFrameworkCore<TContext>(IProtoHostBuilder, Action<IServiceProvider, DbContextOptionsBuilder>)

ProtoHostBuilderExtensions.AddSql(IProtoHostBuilder, Func<IServiceProvider, DbConnection>, Action<SqlOptions>?)

PlaywrightWebHostBuilderExtensions.AddWeb(IProtoHostBuilder, Action<PlaywrightWebOptions>?)

ProtoHostBuilderExtensions.AddWebBackend(IProtoHostBuilder, IWebBackendFactory)

ProtoHostBuilderExtensions.AddWebMiddleware<TMiddleware>(IProtoHostBuilder)

ProtoHostBuilderExtensions.AddWebWait<TCondition>(IProtoHostBuilder, WebWaitTiming, TimeSpan?, TimeSpan?, params WebOperationKind[])

SeleniumWebHostBuilderExtensions.AddWeb(IProtoHostBuilder, Func<IWebDriver>, Action<SeleniumWebOptions>?)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Methods

AddResource(IProtoResource)

Registers a run-scoped resource: infrastructure the whole suite owns, such as a database container, released when the host is disposed after the run has stopped.

public IProtoHostBuilder AddResource(IProtoResource resource)

Parameters

resource IProtoResource

Returns

IProtoHostBuilder

AddRunGate(string, Func<ProtoRunGateContext, ProtoRunGateResult>)

Registers a Run gate defined by a delegate.

public IProtoHostBuilder AddRunGate(string name, Func<ProtoRunGateContext, ProtoRunGateResult> evaluate)

Parameters

name string

evaluate Func<ProtoRunGateContext, ProtoRunGateResult>

Returns

IProtoHostBuilder

AddRunGate<TGate>()

Registers a Run gate evaluated once the suite finishes. Gates see everything the run's collectors produced; a failed gate fails the run after the reports are written.

public IProtoHostBuilder AddRunGate<TGate>() where TGate : class, IProtoRunGate

Returns

IProtoHostBuilder

Type Parameters

TGate

AddRunHook<TRunHook>()

Registers a suite-level lifecycle hook.

public IProtoHostBuilder AddRunHook<TRunHook>() where TRunHook : class, IProtoRunHook

Returns

IProtoHostBuilder

Type Parameters

TRunHook

AddTestHook<THook>()

Registers a global execution lifecycle hook.

public IProtoHostBuilder AddTestHook<THook>() where THook : class, IProtoTestHook

Returns

IProtoHostBuilder

The current IProtoHostBuilder instance.

Type Parameters

THook

Build()

Builds and initializes the configured ProtoHost instance.

public ProtoHost Build()

Returns

ProtoHost

A fully configured ProtoHost.

ConfigureAppConfiguration(Action<IConfigurationBuilder>)

Configures the application configuration (appsettings.json, environment variables, etc.).

public IProtoHostBuilder ConfigureAppConfiguration(Action<IConfigurationBuilder> configure)

Parameters

configure Action<IConfigurationBuilder>

Returns

IProtoHostBuilder

The current IProtoHostBuilder instance.

ConfigureServices(Action<IServiceCollection>)

Registers dependencies with the internal service collection.

public IProtoHostBuilder ConfigureServices(Action<IServiceCollection> configure)

Parameters

configure Action<IServiceCollection>

Returns

IProtoHostBuilder

The current IProtoHostBuilder instance.

ConfigureTestIds(Action<ProtoTestIdOptions>)

Configures numeric test execution IDs generated by the host.

public IProtoHostBuilder ConfigureTestIds(Action<ProtoTestIdOptions> configure)

Parameters

configure Action<ProtoTestIdOptions>

Returns

IProtoHostBuilder

ConfigureTracing(Action<ProtoTraceOptions>)

Configures the automatic execution trace written by ProtoTest.Core.

public IProtoHostBuilder ConfigureTracing(Action<ProtoTraceOptions> configure)

Parameters

configure Action<ProtoTraceOptions>

Returns

IProtoHostBuilder