# TraceStoreContract > 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.tracestorecontract/ > Summary: TraceStoreContract: Behavior tests for the ITraceStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [ITraceStore](/api/tracon.itracestore/) contract. ```csharp public abstract class TraceStoreContract : TenantIsolationContract, IAsyncLifetime, IAsyncDisposable ```
Inheritance
object โ† StoreCancellationContract<ITraceStore> โ† TenantIsolationContract<ITraceStore> โ† TraceStoreContract
Implements
IAsyncLifetime, IAsyncDisposable
Inherited Members
TenantIsolationContract<ITraceStore>.TenantA, TenantIsolationContract<ITraceStore>.TenantB, TenantIsolationContract<ITraceStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<ITraceStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<ITraceStore>.ExistsAsync(string, object), TenantIsolationContract<ITraceStore>.CountAsync(string, CancellationToken), TenantIsolationContract<ITraceStore>.TryDeleteAsync(string, object), TenantIsolationContract<ITraceStore>.TryOverwriteAsync(string, string), TenantIsolationContract<ITraceStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<ITraceStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<ITraceStore>.WroteAnythingAsync(), TenantIsolationContract<ITraceStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<ITraceStore>.Tenant_reads_its_own_record(), TenantIsolationContract<ITraceStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<ITraceStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<ITraceStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<ITraceStore>.AmbientTenant, StoreCancellationContract<ITraceStore>.CreateStoreAsync(), StoreCancellationContract<ITraceStore>.InitializeAsync(), StoreCancellationContract<ITraceStore>.DisposeAsync(), StoreCancellationContract<ITraceStore>.OnDisposeAsync(), StoreCancellationContract<ITraceStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<ITraceStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<ITraceStore>.WroteAnythingAsync(), StoreCancellationContract<ITraceStore>.Canceled_token_throws_on_read(), StoreCancellationContract<ITraceStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<ITraceStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<ITraceStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Remarks Because span ids are derived from W3C ids, writing the same span twice must not produce a duplicate record; every implementation must satisfy this rule. ## Constructors ### TraceStoreContract\(\) ```csharp protected TraceStoreContract() ``` ## Properties ### TenantId The tenant spans are written under. The store reads its own tenant context; if the write and read tenants do not match, the trace can never be found. This is why the value comes from the same source as the ambient tenant. ```csharp protected string TenantId { get; } ``` #### Property Value [string](https://learn.microsoft.com/dotnet/api/system.string) ## Methods ### Attributes\_are\_preserved\(\) ```csharp [Fact] public Task Attributes_are_preserved() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### CancellableReadAsync\(CancellationToken\) Calls one **read** method of the store with the given token. ```csharp protected override ValueTask CancellableReadAsync(CancellationToken cancellationToken) ``` #### Parameters `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token the store must observe. #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask) The completion task; any result is discarded. #### Remarks The listing hook is the read: it needs no key, so it can be called on an untouched store. A contract whose store has no listing endpoint -- and whose [TenantIsolationContract.CountAsync](/api/tracon.testing.contracts.storage/) therefore makes no store call at all on an empty store -- overrides this with its own read. ### CancellableWriteAsync\(CancellationToken\) Calls one **write** method of the store with the given token. ```csharp protected override ValueTask CancellableWriteAsync(CancellationToken cancellationToken) ``` #### Parameters `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token the store must observe. #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask) The completion task. #### Remarks The write must be one [StoreCancellationContract.WroteAnythingAsync](/api/tracon.testing.contracts.storage/) can see. A write this contract cannot read back proves nothing about side effects, which is why [StoreCancellationContract.The_write_this_contract_checks_can_be_read_back](/api/tracon.testing.contracts.storage/) runs the same pair with a live token and requires the read to find it. ### 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. #### Remarks The span store has no listing endpoint; the count is reduced to how many of the runs seeded for that tenant are visible. ### Empty\_set\_is\_not\_written\(\) ```csharp [Fact] public Task Empty_set_is_not_written() ``` #### 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. ### 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 write takes the tenant from the batch, the read from [ITenantContext](/api/tracon.itenantcontext/); if the two diverge, the trace can never be found. ### SeedRunAsync\(Guid\) Opens a run for spans to attach to. ```csharp protected abstract ValueTask SeedRunAsync(Guid runId) ``` #### Parameters `runId` [Guid](https://learn.microsoft.com/dotnet/api/system.guid) The run id. #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask) A completed task. ### Span\_tree\_round\_trips\(\) ```csharp [Fact] public Task Span_tree_round_trips() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Unrecorded\_run\_returns\_empty\(\) ```csharp [Fact] public Task Unrecorded_run_returns_empty() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Writing\_the\_same\_span\_twice\_does\_not\_create\_a\_duplicate\(\) ```csharp [Fact] public Task Writing_the_same_span_twice_does_not_create_a_duplicate() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### WroteAnythingAsync\(\) Reports whether [StoreCancellationContract.CancellableWriteAsync](/api/tracon.testing.contracts.storage/) left anything behind. ```csharp protected override ValueTask WroteAnythingAsync() ``` #### 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 store holds any record the write would have created.