.NET API
ApiKeyStoreContract
Tracon.Testing.Contracts.Xunit.dllBehavior tests for the IApiKeyStore contract.
public abstract class ApiKeyStoreContract : TenantIsolationContract<IApiKeyStore>, IAsyncLifetime, IAsyncDisposable- Inheritance
- object ← StoreCancellationContract<IApiKeyStore> ← TenantIsolationContract<IApiKeyStore> ← ApiKeyStoreContract
- Implements
- IAsyncLifetime, IAsyncDisposable
- Inherited Members
- TenantIsolationContract<IApiKeyStore>.TenantA, TenantIsolationContract<IApiKeyStore>.TenantB, TenantIsolationContract<IApiKeyStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<IApiKeyStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<IApiKeyStore>.ExistsAsync(string, object), TenantIsolationContract<IApiKeyStore>.CountAsync(string, CancellationToken), TenantIsolationContract<IApiKeyStore>.TryDeleteAsync(string, object), TenantIsolationContract<IApiKeyStore>.TryOverwriteAsync(string, string), TenantIsolationContract<IApiKeyStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<IApiKeyStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<IApiKeyStore>.WroteAnythingAsync(), TenantIsolationContract<IApiKeyStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<IApiKeyStore>.Tenant_reads_its_own_record(), TenantIsolationContract<IApiKeyStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<IApiKeyStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<IApiKeyStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<IApiKeyStore>.AmbientTenant, StoreCancellationContract<IApiKeyStore>.CreateStoreAsync(), StoreCancellationContract<IApiKeyStore>.InitializeAsync(), StoreCancellationContract<IApiKeyStore>.DisposeAsync(), StoreCancellationContract<IApiKeyStore>.OnDisposeAsync(), StoreCancellationContract<IApiKeyStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IApiKeyStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IApiKeyStore>.WroteAnythingAsync(), StoreCancellationContract<IApiKeyStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IApiKeyStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IApiKeyStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IApiKeyStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
Section titled “Remarks”In this contract, the raw key value is visible only in the ApiKeyCreationResult.PlaintextKey returned by IApiKeyStore.CreateAsync; no read path (IApiKeyStore.ListAsync, IApiKeyStore.FindByHashAsync) returns the raw value or its hash.
Constructors
Section titled “Constructors”ApiKeyStoreContract()
Section titled “ ApiKeyStoreContract()”protected ApiKeyStoreContract()Methods
Section titled “Methods”Active_scope_is_found_system_wide()
Section titled “ Active_scope_is_found_system_wide()”[Fact]public Task Active_scope_is_found_system_wide()Returns
Section titled “Returns”Cannot_revoke_another_tenants_key()
Section titled “ Cannot_revoke_another_tenants_key()”[Fact]public Task Cannot_revoke_another_tenants_key()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.
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.
Expiration_is_read_back()
Section titled “ Expiration_is_read_back()”[Fact]public Task Expiration_is_read_back()Returns
Section titled “Returns”Finding_another_tenants_key_by_hash_returns_the_correct_tenant()
Section titled “ Finding_another_tenants_key_by_hash_returns_the_correct_tenant()”[Fact]public Task Finding_another_tenants_key_by_hash_returns_the_correct_tenant()Returns
Section titled “Returns”Found_by_hash_of_the_raw_value()
Section titled “ Found_by_hash_of_the_raw_value()”[Fact]public Task Found_by_hash_of_the_raw_value()Returns
Section titled “Returns”Last_used_timestamp_is_updated()
Section titled “ Last_used_timestamp_is_updated()”[Fact]public Task Last_used_timestamp_is_updated()Returns
Section titled “Returns”Revoked_key_carries_RevokedAt_and_appears_inactive()
Section titled “ Revoked_key_carries_RevokedAt_and_appears_inactive()”[Fact]public Task Revoked_key_carries_RevokedAt_and_appears_inactive()Returns
Section titled “Returns”Revoked_keys_scope_is_no_longer_active()
Section titled “ Revoked_keys_scope_is_no_longer_active()”[Fact]public Task Revoked_keys_scope_is_no_longer_active()Returns
Section titled “Returns”Same_key_cannot_be_revoked_twice()
Section titled “ Same_key_cannot_be_revoked_twice()”[Fact]public Task Same_key_cannot_be_revoked_twice()Returns
Section titled “Returns”Saved_key_is_read_back()
Section titled “ Saved_key_is_read_back()”[Fact]public Task Saved_key_is_read_back()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.
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.
Unknown_hash_is_not_found()
Section titled “ Unknown_hash_is_not_found()”[Fact]public Task Unknown_hash_is_not_found()