# RetentionPolicyStoreContract > 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.retentionpolicystorecontract/ > Summary: RetentionPolicyStoreContract: Behavior tests for the IRetentionPolicyStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [IRetentionPolicyStore](/api/tracon.iretentionpolicystore/) contract. ```csharp public abstract class RetentionPolicyStoreContract : TenantIsolationContract, IAsyncLifetime, IAsyncDisposable ```
Inheritance
object โ† StoreCancellationContract<IRetentionPolicyStore> โ† TenantIsolationContract<IRetentionPolicyStore> โ† RetentionPolicyStoreContract
Implements
IAsyncLifetime, IAsyncDisposable
Inherited Members
TenantIsolationContract<IRetentionPolicyStore>.TenantA, TenantIsolationContract<IRetentionPolicyStore>.TenantB, TenantIsolationContract<IRetentionPolicyStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<IRetentionPolicyStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<IRetentionPolicyStore>.ExistsAsync(string, object), TenantIsolationContract<IRetentionPolicyStore>.CountAsync(string, CancellationToken), TenantIsolationContract<IRetentionPolicyStore>.TryDeleteAsync(string, object), TenantIsolationContract<IRetentionPolicyStore>.TryOverwriteAsync(string, string), TenantIsolationContract<IRetentionPolicyStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<IRetentionPolicyStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<IRetentionPolicyStore>.WroteAnythingAsync(), TenantIsolationContract<IRetentionPolicyStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<IRetentionPolicyStore>.Tenant_reads_its_own_record(), TenantIsolationContract<IRetentionPolicyStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<IRetentionPolicyStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<IRetentionPolicyStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<IRetentionPolicyStore>.AmbientTenant, StoreCancellationContract<IRetentionPolicyStore>.CreateStoreAsync(), StoreCancellationContract<IRetentionPolicyStore>.InitializeAsync(), StoreCancellationContract<IRetentionPolicyStore>.DisposeAsync(), StoreCancellationContract<IRetentionPolicyStore>.OnDisposeAsync(), StoreCancellationContract<IRetentionPolicyStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IRetentionPolicyStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IRetentionPolicyStore>.WroteAnythingAsync(), StoreCancellationContract<IRetentionPolicyStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IRetentionPolicyStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IRetentionPolicyStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IRetentionPolicyStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Constructors ### RetentionPolicyStoreContract\(\) ```csharp protected RetentionPolicyStoreContract() ``` ## Methods ### Another\_tenants\_policy\_is\_not\_visible\(\) ```csharp [Fact] public Task Another_tenants_policy_is_not_visible() ``` #### 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. ### Deleted\_policy\_is\_not\_read\_back\(\) ```csharp [Fact] public Task Deleted_policy_is_not_read_back() ``` #### 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. ### Failed\_run\_carries\_the\_error\_message\(\) ```csharp [Fact] public Task Failed_run_carries_the_error_message() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Falls\_back\_to\_the\_wildcard\_policy\_when\_no\_tenant\_specific\_record\_exists\(\) ```csharp [Fact] public Task Falls_back_to_the_wildcard_policy_when_no_tenant_specific_record_exists() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Run\_history\_returns\_newest\_first\(\) ```csharp [Fact] public Task Run_history_returns_newest_first() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Run\_is\_created\_and\_progress\_accumulates\(\) ```csharp [Fact] public Task Run_is_created_and_progress_accumulates() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Saved\_policy\_is\_read\_back\(\) ```csharp [Fact] public Task Saved_policy_is_read_back() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Saving\_the\_same\_target\_a\_second\_time\_overwrites\_it\(\) ```csharp [Fact] public Task Saving_the_same_target_a_second_time_overwrites_it() ``` #### 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. ### Tenant\_specific\_record\_takes\_precedence\_over\_the\_wildcard\(\) ```csharp [Fact] public Task Tenant_specific_record_takes_precedence_over_the_wildcard() ``` #### 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. ### TryOverwriteAsync\(string, string\) Attempts to change the record's content on behalf of the given tenant. ```csharp protected override ValueTask TryOverwriteAsync(string tenantId, string name) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant attempting the update. `name` [string](https://learn.microsoft.com/dotnet/api/system.string) The record's name. #### 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 update was attempted; [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the store does not support this scenario. #### Remarks The default implementation calls [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/) a second time: writing a record with the same name verifies that two tenants can carry the same name independently.