Class TestScenarioScopeBuilder

Namespace: XBullet.EasyTesting.Hosting

Assembly: XBullet.EasyTesting.dll

Configures service and application-configuration overrides for one test scope.

public sealed class TestScenarioScopeBuilder

Inheritance: object

TestScenarioScopeBuilder

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: TestObservabilityExtensions.UseObservability(TestScenarioScopeBuilder)

TestObservabilityExtensions.UseObservability(TestScenarioScopeBuilder, Action<TestObservabilityOptions>)

TestObservabilityExtensions.UseObservability(TestScenarioScopeBuilder, string, Action<TestObservabilityOptions>?)

TestcontainerExtensions.UseTestcontainer<TContainer>(TestScenarioScopeBuilder, string, Func<TestScenarioContext, TContainer>)

TestcontainerExtensions.UseTestcontainer<TContainer>(TestScenarioScopeBuilder, string, Func<TestScenarioContext, TContainer>, Func<TContainer, IReadOnlyDictionary<string, string?>>?, Action<TContainer, IServiceCollection>?, int)

TestcontainerModuleExtensions.UseAzurite(TestScenarioScopeBuilder)

TestcontainerModuleExtensions.UseAzurite(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<AzuriteBuilder>>)

TestcontainerModuleExtensions.UseKafka(TestScenarioScopeBuilder)

TestcontainerModuleExtensions.UseKafka(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<KafkaBuilder>>)

TestcontainerModuleExtensions.UsePostgreSql(TestScenarioScopeBuilder)

TestcontainerModuleExtensions.UsePostgreSql(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<PostgreSqlBuilder>>)

TestcontainerModuleExtensions.UseRabbitMq(TestScenarioScopeBuilder)

TestcontainerModuleExtensions.UseRabbitMq(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<RabbitMqBuilder>>)

TestcontainerModuleExtensions.UseRedis(TestScenarioScopeBuilder)

TestcontainerModuleExtensions.UseRedis(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<RedisBuilder>>)

TestcontainerModuleExtensions.UseServiceBusEmulator(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<ServiceBusBuilder>>)

TestcontainerModuleExtensions.UseServiceBusEmulator(TestScenarioScopeBuilder, bool)

TestcontainerModuleExtensions.UseSqlServer(TestScenarioScopeBuilder)

TestcontainerModuleExtensions.UseSqlServer(TestScenarioScopeBuilder, Action<TestcontainerModuleOptions<MsSqlBuilder>>)

Methods

ConfigureConfiguration(Action<IConfigurationBuilder>)

Adds a configuration override that exists only for this scenario.

public TestScenarioScopeBuilder ConfigureConfiguration(Action<IConfigurationBuilder> configure)

Parameters

configure Action<IConfigurationBuilder>: The callback invoked during scenario host construction after environment resources have contributed their configuration. It receives the caller-owned configuration builder, runs once for this scenario, and is not invoked concurrently by a single test factory.

Returns

TestScenarioScopeBuilder: This builder so additional scenario overrides can be registered.

ConfigureServices(Action<IServiceCollection>)

Adds a service override that exists only for this scenario.

public TestScenarioScopeBuilder ConfigureServices(Action<IServiceCollection> configure)

Parameters

configure Action<IServiceCollection>: The callback invoked during scenario host construction after environment resources and the factory have registered their services. It receives the caller-owned service collection, runs once for this scenario, and is not invoked concurrently by a single test factory.

Returns

TestScenarioScopeBuilder: This builder so additional scenario overrides can be registered.

UseEnvironmentResource(string, Func<TestScenarioContext, ITestScenarioEnvironmentResource>)

Adds an external dependency factory owned by this scenario.

public TestScenarioScopeBuilder UseEnvironmentResource(string name, Func<TestScenarioContext, ITestScenarioEnvironmentResource> createResource)

Parameters

name string: The non-empty, case-insensitively unique name used to retrieve the resource from the scope.
createResource Func<TestScenarioContext, ITestScenarioEnvironmentResource>: The factory invoked once while this scenario is being created. It receives the scenario context and must return a non-null resource. The scenario assumes ownership of the returned resource and disposes it during cleanup.

Returns

TestScenarioScopeBuilder: This builder so additional scenario overrides can be registered.

UseEnvironmentResource(string, ITestScenarioEnvironmentResource)

Adds an external dependency owned by this scenario.

public TestScenarioScopeBuilder UseEnvironmentResource(string name, ITestScenarioEnvironmentResource resource)

Parameters

name string: The non-empty, case-insensitively unique name used to retrieve the resource from the scope.
resource ITestScenarioEnvironmentResource: The resource whose ownership transfers to this scenario. It is started before the test host and asynchronously disposed during scenario cleanup.

Returns

TestScenarioScopeBuilder: This builder so additional scenario overrides can be registered.