# QuotaStoreContract > 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.quotastorecontract/ > Summary: QuotaStoreContract: Behavior tests for the IQuotaStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [IQuotaStore](/api/tracon.iquotastore/) contract. ```csharp public abstract class QuotaStoreContract : TenantIsolationContract, IAsyncLifetime, IAsyncDisposable ```
Inheritance
object โ† StoreCancellationContract<IQuotaStore> โ† TenantIsolationContract<IQuotaStore> โ† QuotaStoreContract
Implements
IAsyncLifetime, IAsyncDisposable
Inherited Members
TenantIsolationContract<IQuotaStore>.TenantA, TenantIsolationContract<IQuotaStore>.TenantB, TenantIsolationContract<IQuotaStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<IQuotaStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<IQuotaStore>.ExistsAsync(string, object), TenantIsolationContract<IQuotaStore>.CountAsync(string, CancellationToken), TenantIsolationContract<IQuotaStore>.TryDeleteAsync(string, object), TenantIsolationContract<IQuotaStore>.TryOverwriteAsync(string, string), TenantIsolationContract<IQuotaStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<IQuotaStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<IQuotaStore>.WroteAnythingAsync(), TenantIsolationContract<IQuotaStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<IQuotaStore>.Tenant_reads_its_own_record(), TenantIsolationContract<IQuotaStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<IQuotaStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<IQuotaStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<IQuotaStore>.AmbientTenant, StoreCancellationContract<IQuotaStore>.CreateStoreAsync(), StoreCancellationContract<IQuotaStore>.InitializeAsync(), StoreCancellationContract<IQuotaStore>.DisposeAsync(), StoreCancellationContract<IQuotaStore>.OnDisposeAsync(), StoreCancellationContract<IQuotaStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IQuotaStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IQuotaStore>.WroteAnythingAsync(), StoreCancellationContract<IQuotaStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IQuotaStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IQuotaStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IQuotaStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Remarks The in-memory store and the PostgreSQL store must pass the same scenarios. Two rules are especially critical: scope uniqueness (`COALESCE(agent_name, '')`) and the atomicity of usage increments (`ON CONFLICT DO UPDATE`). ## Constructors ### QuotaStoreContract\(\) ```csharp protected QuotaStoreContract() ``` ## Methods ### A\_different\_metric\_is\_a\_separate\_claim\(\) ```csharp [Fact] public Task A_different_metric_is_a_separate_claim() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### A\_different\_tenants\_identically\_shaped\_claim\_is\_independent\(\) ```csharp [Fact] public Task A_different_tenants_identically_shaped_claim_is_independent() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### A\_different\_threshold\_percent\_is\_a\_separate\_claim\(\) ```csharp [Fact] public Task A_different_threshold_percent_is_a_separate_claim() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### A\_new\_period\_starts\_with\_no\_claim\_even\_if\_the\_previous\_period\_already\_has\_one\(\) ```csharp [Fact] public Task A_new_period_starts_with_no_claim_even_if_the_previous_period_already_has_one() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### A\_period\_left\_out\_of\_the\_period\_starts\_is\_not\_returned\(\) A period missing from [QuotaUsageQuery.PeriodStarts](/api/tracon.quotausagequery/#Tracon_QuotaUsageQuery_PeriodStarts) returns no counters. ```csharp [Fact] public Task A_period_left_out_of_the_period_starts_is_not_returned() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### A\_threshold\_already\_claimed\_in\_this\_period\_is\_not\_claimed\_again\(\) ```csharp [Fact] public Task A_threshold_already_claimed_in_this_period_is_not_claimed_again() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Another\_tenants\_rule\_is\_not\_visible\(\) ```csharp [Fact] public Task Another_tenants_rule_is_not_visible() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Another\_tenants\_usage\_is\_not\_visible\(\) ```csharp [Fact] public Task Another_tenants_usage_is_not_visible() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Claim\_fails\_when\_the\_usage\_row\_does\_not\_exist\_yet\(\) ```csharp [Fact] public Task Claim_fails_when_the_usage_row_does_not_exist_yet() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Concurrent\_claims\_of\_the\_same\_threshold\_let\_only\_one\_caller\_win\(\) ```csharp [Fact] public Task Concurrent_claims_of_the_same_threshold_let_only_one_caller_win() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Concurrent\_increments\_lose\_no\_increment\(\) ```csharp [Fact] public Task Concurrent_increments_lose_no_increment() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Consecutive\_usage\_accumulates\(\) ```csharp [Fact] public Task Consecutive_usage_accumulates() ``` #### 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\_rule\_is\_not\_read\_back\(\) ```csharp [Fact] public Task Deleted_rule_is_not_read_back() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Deleting\_a\_nonexistent\_rule\_returns\_false\(\) ```csharp [Fact] public Task Deleting_a_nonexistent_rule_returns_false() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Different\_agent\_becomes\_a\_separate\_rule\(\) ```csharp [Fact] public Task Different_agent_becomes_a_separate_rule() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Different\_period\_becomes\_a\_separate\_rule\(\) ```csharp [Fact] public Task Different_period_becomes_a_separate_rule() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Empty\_limits\_are\_preserved\_as\_null\(\) ```csharp [Fact] public Task Empty_limits_are_preserved_as_null() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Empty\_period\_starts\_return\_no\_counters\(\) An empty [QuotaUsageQuery.PeriodStarts](/api/tracon.quotausagequery/#Tracon_QuotaUsageQuery_PeriodStarts) names no period and returns nothing. ```csharp [Fact] public Task Empty_period_starts_return_no_counters() ``` #### 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. ### First\_claim\_of\_a\_threshold\_succeeds\(\) ```csharp [Fact] public Task First_claim_of_a_threshold_succeeds() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Period\_starts\_apply\_together\_with\_the\_other\_filters\(\) The period filter applies together with the agent and period filters. ```csharp [Fact] public Task Period_starts_apply_together_with_the_other_filters() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Saved\_rule\_is\_read\_back\(\) ```csharp [Fact] public Task Saved_rule_is_read_back() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Saving\_the\_same\_scope\_a\_second\_time\_overwrites\_it\(\) ```csharp [Fact] public Task Saving_the_same_scope_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. ### Separate\_period\_keeps\_a\_separate\_counter\(\) ```csharp [Fact] public Task Separate_period_keeps_a_separate_counter() ``` #### 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. ### Usage\_increments\_both\_the\_agent\_and\_tenant\_counters\(\) ```csharp [Fact] public Task Usage_increments_both_the_agent_and_tenant_counters() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Usage\_is\_filtered\_by\_agent\_name\(\) ```csharp [Fact] public Task Usage_is_filtered_by_agent_name() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Usage\_is\_filtered\_by\_period\(\) ```csharp [Fact] public Task Usage_is_filtered_by_period() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Usage\_is\_filtered\_to\_the\_given\_period\_starts\(\) [QuotaUsageQuery.PeriodStarts](/api/tracon.quotausagequery/#Tracon_QuotaUsageQuery_PeriodStarts) returns only the counters of the named periods, each for its given first day. The admission check reads usage before every run; a store that ignores the filter returns the tenant's whole history on each read. ```csharp [Fact] public Task Usage_is_filtered_to_the_given_period_starts() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Usage\_that\_adds\_no\_run\_adds\_its\_tokens\_and\_cost\_to\_a\_counter\_that\_does\_not\_exist\_yet\(\) ```csharp [Fact] public Task Usage_that_adds_no_run_adds_its_tokens_and_cost_to_a_counter_that_does_not_exist_yet() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Usage\_that\_adds\_no\_run\_leaves\_the\_run\_count\_where\_the\_root\_put\_it\(\) ```csharp [Fact] public Task Usage_that_adds_no_run_leaves_the_run_count_where_the_root_put_it() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Usage\_with\_undefined\_price\_does\_not\_break\_the\_cost\_total\(\) ```csharp [Fact] public Task Usage_with_undefined_price_does_not_break_the_cost_total() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)