# AgentDefinitionStoreContract > Tracon documentation. Tracon is a .NET package family that adds a control > plane on Microsoft Agent Framework, published as NuGet packages that run > inside your own ASP.NET Core application. > > Page: https://tracon.dev/api/tracon.testing.contracts.storage.agentdefinitionstorecontract/ > Summary: AgentDefinitionStoreContract: Behavior tests for the IAgentDefinitionStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [IAgentDefinitionStore](/api/tracon.iagentdefinitionstore/) contract. ```csharp public abstract class AgentDefinitionStoreContract : TenantIsolationContract, 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 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 ### AgentDefinitionStoreContract\(\) ```csharp protected AgentDefinitionStoreContract() ``` ## Methods ### Concurrent\_first\_saves\_of\_a\_new\_name\_get\_distinct\_versions\(\) ```csharp [Fact] public Task Concurrent_first_saves_of_a_new_name_get_distinct_versions() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Concurrent\_saves\_of\_one\_name\_get\_distinct\_versions\_across\_a\_delete\(\) ```csharp [Fact] public Task Concurrent_saves_of_one_name_get_distinct_versions_across_a_delete() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### CountAsync\(string, CancellationToken\) Reports how many records the given tenant sees through the listing endpoint. ```csharp protected override ValueTask CountAsync(string tenantId, CancellationToken cancellationToken) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The reading tenant. `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token every store call inside the hook must be handed; see [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\> The number of records seen. ### DeleteAsync\_of\_a\_name\_that\_never\_existed\_does\_not\_start\_a\_numbering\(\) ```csharp [Fact] public Task DeleteAsync_of_a_name_that_never_existed_does_not_start_a_numbering() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### DeleteAsync\_removes\_all\_versions\(\) ```csharp [Fact] public Task DeleteAsync_removes_all_versions() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Each\_tenants\_version\_counter\_is\_its\_own\(\) ```csharp [Fact] public Task Each_tenants_version_counter_is_its_own() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### ExistsAsync\(string, object\) Reports whether the record is visible from the given tenant's viewpoint. ```csharp protected override ValueTask ExistsAsync(string tenantId, object key) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The reading tenant. `key` [object](https://learn.microsoft.com/dotnet/api/system.object) The key returned by [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)\> [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the record is visible. ### GetAsync\_for\_a\_missing\_definition\_returns\_null\(\) ```csharp [Fact] public Task GetAsync_for_a_missing_definition_returns_null() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### GetVersionAsync\_for\_a\_missing\_agent\_returns\_null\(\) ```csharp [Fact] public Task GetVersionAsync_for_a_missing_agent_returns_null() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### GetVersionAsync\_for\_a\_missing\_version\_returns\_null\(\) ```csharp [Fact] public Task GetVersionAsync_for_a_missing_version_returns_null() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### GetVersionAsync\_returns\_the\_requested\_version\(\) ```csharp [Fact] public Task GetVersionAsync_returns_the_requested_version() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### ListAsync\_orders\_by\_name\(\) ```csharp [Fact] public Task ListAsync_orders_by_name() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### ListVersionsAsync\_orders\_newest\_to\_oldest\(\) ```csharp [Fact] public Task ListVersionsAsync_orders_newest_to_oldest() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### One\_tenants\_delete\_does\_not\_move\_another\_tenants\_numbering\(\) ```csharp [Fact] public Task One_tenants_delete_does_not_move_another_tenants_numbering() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### RollbackAsync\_after\_a\_recreate\_continues\_the\_numbering\(\) ```csharp [Fact] public Task RollbackAsync_after_a_recreate_continues_the_numbering() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### RollbackAsync\_for\_a\_deleted\_agent\_throws\_and\_keeps\_the\_numbering\(\) ```csharp [Fact] public Task RollbackAsync_for_a_deleted_agent_throws_and_keeps_the_numbering() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### RollbackAsync\_for\_a\_missing\_agent\_throws\(\) ```csharp [Fact] public Task RollbackAsync_for_a_missing_agent_throws() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### RollbackAsync\_saves\_the\_old\_version\_as\_a\_new\_version\(\) ```csharp [Fact] public Task RollbackAsync_saves_the_old_version_as_a_new_version() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### RollbackAsync\_to\_a\_missing\_version\_throws\(\) ```csharp [Fact] public Task RollbackAsync_to_a_missing_version_throws() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SaveAsync\_after\_DeleteAsync\_continues\_the\_numbering\(\) ```csharp [Fact] public Task SaveAsync_after_DeleteAsync_continues_the_numbering() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SaveAsync\_increments\_version\_and\_keeps\_history\(\) ```csharp [Fact] public Task SaveAsync_increments_version_and_keeps_history() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SaveAsync\_marks\_origin\_as\_database\(\) ```csharp [Fact] public Task SaveAsync_marks_origin_as_database() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SaveAsync\_round\_trips\_all\_definition\_fields\(\) ```csharp [Fact] public Task SaveAsync_round_trips_all_definition_fields() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SeedAsync\(string, string, CancellationToken\) Writes a sample record for the given tenant. ```csharp protected override ValueTask SeedAsync(string tenantId, string name, CancellationToken cancellationToken) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant that owns the record. `name` [string](https://learn.microsoft.com/dotnet/api/system.string) The name distinguishing the record. The same name may be used by two tenants. `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.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 [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[object](https://learn.microsoft.com/dotnet/api/system.object)\> The key to use for reading the record back. #### Remarks The tenant is not a parameter on the interface; it is read from [ITenantContext](/api/tracon.itenantcontext/). Each hook therefore sets the active tenant first. ### Tenant\_cannot\_roll\_back\_another\_tenants\_definition\(\) ```csharp [Fact] public Task Tenant_cannot_roll_back_another_tenants_definition() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### The\_numbering\_survives\_every\_delete\_not\_only\_the\_first\(\) ```csharp [Fact] public Task The_numbering_survives_every_delete_not_only_the_first() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### TryDeleteAsync\(string, object\) Attempts to delete the record on behalf of the given tenant. ```csharp protected override ValueTask TryDeleteAsync(string tenantId, object key) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant attempting the delete. `key` [object](https://learn.microsoft.com/dotnet/api/system.object) The key returned by [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)?\> [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the delete succeeded, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the record was not found; [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if the store does not offer deletion.