.NET API
AgentDefinitionStoreContract
Namespace Tracon.Testing.Contracts.Storage · Assembly
Tracon.Testing.Contracts.Xunit.dllBehavior tests for the IAgentDefinitionStore contract.
public abstract class AgentDefinitionStoreContract : TenantIsolationContract<IAgentDefinitionStore>, IAsyncLifetime, IAsyncDisposable- Inheritance
- object ← StoreCancellationContract<IAgentDefinitionStore> ← TenantIsolationContract<IAgentDefinitionStore> ← AgentDefinitionStoreContract
- Implements
- IAsyncLifetime, IAsyncDisposable
- Inherited Members
- TenantIsolationContract<IAgentDefinitionStore>.TenantA, TenantIsolationContract<IAgentDefinitionStore>.TenantB, TenantIsolationContract<IAgentDefinitionStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<IAgentDefinitionStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<IAgentDefinitionStore>.ExistsAsync(string, object), TenantIsolationContract<IAgentDefinitionStore>.CountAsync(string, CancellationToken), TenantIsolationContract<IAgentDefinitionStore>.TryDeleteAsync(string, object), TenantIsolationContract<IAgentDefinitionStore>.TryOverwriteAsync(string, string), TenantIsolationContract<IAgentDefinitionStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<IAgentDefinitionStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<IAgentDefinitionStore>.WroteAnythingAsync(), TenantIsolationContract<IAgentDefinitionStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<IAgentDefinitionStore>.Tenant_reads_its_own_record(), TenantIsolationContract<IAgentDefinitionStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<IAgentDefinitionStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<IAgentDefinitionStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<IAgentDefinitionStore>.AmbientTenant, StoreCancellationContract<IAgentDefinitionStore>.CreateStoreAsync(), StoreCancellationContract<IAgentDefinitionStore>.InitializeAsync(), StoreCancellationContract<IAgentDefinitionStore>.DisposeAsync(), StoreCancellationContract<IAgentDefinitionStore>.OnDisposeAsync(), StoreCancellationContract<IAgentDefinitionStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IAgentDefinitionStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IAgentDefinitionStore>.WroteAnythingAsync(), StoreCancellationContract<IAgentDefinitionStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IAgentDefinitionStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IAgentDefinitionStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IAgentDefinitionStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
Section titled “Remarks”These tests run against every implementation. A behavior difference between the in-memory store and the PostgreSQL store is a bug; this class catches that difference.
Constructors
Section titled “Constructors”AgentDefinitionStoreContract()
Section titled “ AgentDefinitionStoreContract()”protected AgentDefinitionStoreContract()Methods
Section titled “Methods”Concurrent_first_saves_of_a_new_name_get_distinct_versions()
Section titled “ Concurrent_first_saves_of_a_new_name_get_distinct_versions()”[Fact]public Task Concurrent_first_saves_of_a_new_name_get_distinct_versions()Returns
Section titled “Returns”Concurrent_saves_of_one_name_get_distinct_versions_across_a_delete()
Section titled “ Concurrent_saves_of_one_name_get_distinct_versions_across_a_delete()”[Fact]public Task Concurrent_saves_of_one_name_get_distinct_versions_across_a_delete()Returns
Section titled “Returns”CountAsync(string, CancellationToken)
Section titled “ CountAsync(string, CancellationToken)”Reports how many records the given tenant sees through the listing endpoint.
protected override ValueTask<int> CountAsync(string tenantId, CancellationToken cancellationToken)Parameters
Section titled “Parameters”tenantId string
The reading tenant.
cancellationToken CancellationToken
The token every store call inside the hook must be handed; see TenantIsolationContract.SeedAsync.
Returns
Section titled “Returns”The number of records seen.
DeleteAsync_of_a_name_that_never_existed_does_not_start_a_numbering()
Section titled “ DeleteAsync_of_a_name_that_never_existed_does_not_start_a_numbering()”[Fact]public Task DeleteAsync_of_a_name_that_never_existed_does_not_start_a_numbering()Returns
Section titled “Returns”DeleteAsync_removes_all_versions()
Section titled “ DeleteAsync_removes_all_versions()”[Fact]public Task DeleteAsync_removes_all_versions()Returns
Section titled “Returns”Each_tenants_version_counter_is_its_own()
Section titled “ Each_tenants_version_counter_is_its_own()”[Fact]public Task Each_tenants_version_counter_is_its_own()Returns
Section titled “Returns”ExistsAsync(string, object)
Section titled “ ExistsAsync(string, object)”Reports whether the record is visible from the given tenant’s viewpoint.
protected override ValueTask<bool> ExistsAsync(string tenantId, object key)Parameters
Section titled “Parameters”tenantId string
The reading tenant.
key object
The key returned by TenantIsolationContract.SeedAsync.
Returns
Section titled “Returns”true if the record is visible.
GetAsync_for_a_missing_definition_returns_null()
Section titled “ GetAsync_for_a_missing_definition_returns_null()”[Fact]public Task GetAsync_for_a_missing_definition_returns_null()Returns
Section titled “Returns”GetVersionAsync_for_a_missing_agent_returns_null()
Section titled “ GetVersionAsync_for_a_missing_agent_returns_null()”[Fact]public Task GetVersionAsync_for_a_missing_agent_returns_null()Returns
Section titled “Returns”GetVersionAsync_for_a_missing_version_returns_null()
Section titled “ GetVersionAsync_for_a_missing_version_returns_null()”[Fact]public Task GetVersionAsync_for_a_missing_version_returns_null()Returns
Section titled “Returns”GetVersionAsync_returns_the_requested_version()
Section titled “ GetVersionAsync_returns_the_requested_version()”[Fact]public Task GetVersionAsync_returns_the_requested_version()Returns
Section titled “Returns”ListAsync_orders_by_name()
Section titled “ ListAsync_orders_by_name()”[Fact]public Task ListAsync_orders_by_name()Returns
Section titled “Returns”ListVersionsAsync_orders_newest_to_oldest()
Section titled “ ListVersionsAsync_orders_newest_to_oldest()”[Fact]public Task ListVersionsAsync_orders_newest_to_oldest()Returns
Section titled “Returns”One_tenants_delete_does_not_move_another_tenants_numbering()
Section titled “ One_tenants_delete_does_not_move_another_tenants_numbering()”[Fact]public Task One_tenants_delete_does_not_move_another_tenants_numbering()Returns
Section titled “Returns”RollbackAsync_after_a_recreate_continues_the_numbering()
Section titled “ RollbackAsync_after_a_recreate_continues_the_numbering()”[Fact]public Task RollbackAsync_after_a_recreate_continues_the_numbering()Returns
Section titled “Returns”RollbackAsync_for_a_deleted_agent_throws_and_keeps_the_numbering()
Section titled “ RollbackAsync_for_a_deleted_agent_throws_and_keeps_the_numbering()”[Fact]public Task RollbackAsync_for_a_deleted_agent_throws_and_keeps_the_numbering()Returns
Section titled “Returns”RollbackAsync_for_a_missing_agent_throws()
Section titled “ RollbackAsync_for_a_missing_agent_throws()”[Fact]public Task RollbackAsync_for_a_missing_agent_throws()Returns
Section titled “Returns”RollbackAsync_saves_the_old_version_as_a_new_version()
Section titled “ RollbackAsync_saves_the_old_version_as_a_new_version()”[Fact]public Task RollbackAsync_saves_the_old_version_as_a_new_version()Returns
Section titled “Returns”RollbackAsync_to_a_missing_version_throws()
Section titled “ RollbackAsync_to_a_missing_version_throws()”[Fact]public Task RollbackAsync_to_a_missing_version_throws()Returns
Section titled “Returns”SaveAsync_after_DeleteAsync_continues_the_numbering()
Section titled “ SaveAsync_after_DeleteAsync_continues_the_numbering()”[Fact]public Task SaveAsync_after_DeleteAsync_continues_the_numbering()Returns
Section titled “Returns”SaveAsync_increments_version_and_keeps_history()
Section titled “ SaveAsync_increments_version_and_keeps_history()”[Fact]public Task SaveAsync_increments_version_and_keeps_history()Returns
Section titled “Returns”SaveAsync_marks_origin_as_database()
Section titled “ SaveAsync_marks_origin_as_database()”[Fact]public Task SaveAsync_marks_origin_as_database()Returns
Section titled “Returns”SaveAsync_round_trips_all_definition_fields()
Section titled “ SaveAsync_round_trips_all_definition_fields()”[Fact]public Task SaveAsync_round_trips_all_definition_fields()Returns
Section titled “Returns”SeedAsync(string, string, CancellationToken)
Section titled “ SeedAsync(string, string, CancellationToken)”Writes a sample record for the given tenant.
protected override ValueTask<object> SeedAsync(string tenantId, string name, CancellationToken cancellationToken)Parameters
Section titled “Parameters”tenantId string
The tenant that owns the record.
name string
The name distinguishing the record. The same name may be used by two tenants.
cancellationToken CancellationToken
The token every store call inside the hook must be handed. The cancellation contract calls this hook with a token that is already cancelled, so a hook that drops the token reports a store as sound when it is not.
Returns
Section titled “Returns”The key to use for reading the record back.
Remarks
Section titled “Remarks”The tenant is not a parameter on the interface; it is read from ITenantContext. Each hook therefore sets the active tenant first.
Tenant_cannot_roll_back_another_tenants_definition()
Section titled “ Tenant_cannot_roll_back_another_tenants_definition()”[Fact]public Task Tenant_cannot_roll_back_another_tenants_definition()Returns
Section titled “Returns”The_numbering_survives_every_delete_not_only_the_first()
Section titled “ The_numbering_survives_every_delete_not_only_the_first()”[Fact]public Task The_numbering_survives_every_delete_not_only_the_first()Returns
Section titled “Returns”TryDeleteAsync(string, object)
Section titled “ TryDeleteAsync(string, object)”Attempts to delete the record on behalf of the given tenant.
protected override ValueTask<bool?> TryDeleteAsync(string tenantId, object key)Parameters
Section titled “Parameters”tenantId string
The tenant attempting the delete.
key object
The key returned by TenantIsolationContract.SeedAsync.
Returns
Section titled “Returns”true if the delete succeeded, false if the record was not found; null if the store does not offer deletion.