Class ProtoTestHost

Namespace: ProtoTest.AspNetCore

Assembly: ProtoTest.AspNetCore.dll

The low-ceremony composition for a suite whose subject is one ASP.NET Core application: register it in-process under the default application name, and compose its protocol registrations on the same call.

public static class ProtoTestHost

Inheritance: object

ProtoTestHost

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

protected override void Configure(IProtoHostBuilder builder) => ProtoTestHost.For<Program>(builder);

// or with the application's clients declared in the same line:
protected override void Configure(IProtoHostBuilder builder) => ProtoTestHost.For<Program>(
    builder,
    configure: app => app.AddRest(rest => rest.AddClient()));

Fields

DefaultApplicationName

The application name For<TProgram>(IProtoHostBuilder, string, Action<IProtoApplicationBuilder>?) registers when the caller names none.

public const string DefaultApplicationName = "Api"

Field Value

string

Methods

For<TProgram>(IProtoHostBuilder, string, Action<IProtoApplicationBuilder>?)

Registers TProgram as the suite's application, hosted in-process, exactly like AddApplication(applicationName, app => app.AddAspNetCoreServer<TProgram>()) with DefaultApplicationName when no name is given. The callback composes the application's protocol registrations - its REST, GraphQL or gRPC clients - after the server.

public static IProtoHostBuilder For<TProgram>(IProtoHostBuilder builder, string applicationName = "Api", Action<IProtoApplicationBuilder>? configure = null) where TProgram : class

Parameters

builder IProtoHostBuilder: The host builder to compose.
applicationName string: The application name; defaults to DefaultApplicationName.
configure Action<IProtoApplicationBuilder>: Optional application registrations, such as app.AddRest(rest => rest.AddClient()).

Returns

IProtoHostBuilder: The same host builder, so further composition chains.

Type Parameters

TProgram: The entry point class of the ASP.NET Core application under test.