# AgentSourceContract

> 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.agentsources.agentsourcecontract/
> Summary: AgentSourceContract: Behavior tests for an IAgentSource implementation.

<div class="api-provenance">Namespace Tracon.Testing.Contracts.AgentSources · Assembly <code>Tracon.Testing.Contracts.Xunit.dll</code></div>

Behavior tests for an [IAgentSource](/api/tracon.iagentsource/) implementation.

```csharp
public abstract class AgentSourceContract : IAsyncLifetime, IAsyncDisposable
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.testing.contracts.agentsources.agentsourcecontract/">AgentSourceContract</a></dd><dt>Derived</dt><dd><a href="/api/tracon.testing.contracts.agentsources.tenantawareagentsourcecontract/">TenantAwareAgentSourceContract</a>, <a href="/api/tracon.testing.contracts.agentsources.versionedagentsourcecontract/">VersionedAgentSourceContract</a></dd><dt>Implements</dt><dd>IAsyncLifetime, <a href="https://learn.microsoft.com/dotnet/api/system.iasyncdisposable">IAsyncDisposable</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Constructors

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract__ctor"></a> AgentSourceContract\(\)

```csharp
protected AgentSourceContract()
```

## Properties

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_KnownAgentName"></a> KnownAgentName

Gets an agent name the source definitely resolves.

```csharp
protected abstract string KnownAgentName { get; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Source"></a> Source

Gets the source under test.

```csharp
protected IAgentSource Source { get; }
```

#### Property Value

 [IAgentSource](/api/tracon.iagentsource/)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_UnknownAgentName"></a> UnknownAgentName

Gets an agent name the source definitely does not resolve.

```csharp
protected virtual string UnknownAgentName { get; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Methods

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_A_pre_cancelled_token_is_honored"></a> A\_pre\_cancelled\_token\_is\_honored\(\)

```csharp
[Fact]
public Task A_pre_cancelled_token_is_honored()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_CreateSourceAsync"></a> CreateSourceAsync\(\)

Creates a source ready for use.

```csharp
protected abstract ValueTask<IAgentSource> CreateSourceAsync()
```

#### Returns

 [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[IAgentSource](/api/tracon.iagentsource/)\>

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_DisposeAsync"></a> DisposeAsync\(\)

```csharp
public ValueTask DisposeAsync()
```

#### Returns

 [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Every_listed_agent_resolves"></a> Every\_listed\_agent\_resolves\(\)

Every name [IAgentSource.ListAsync](/api/tracon.iagentsource/#Tracon_IAgentSource_ListAsync_System_Threading_CancellationToken_) reports must resolve.

```csharp
[Fact]
public Task Every_listed_agent_resolves()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_InitializeAsync"></a> InitializeAsync\(\)

Called immediately after the class has been created, before it is used.

```csharp
public ValueTask InitializeAsync()
```

#### Returns

 [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Known_agent_resolves"></a> Known\_agent\_resolves\(\)

```csharp
[Fact]
public Task Known_agent_resolves()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Listed_descriptors_name_the_source"></a> Listed\_descriptors\_name\_the\_source\(\)

```csharp
[Fact]
public Task Listed_descriptors_name_the_source()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Listed_names_are_unique_and_valid"></a> Listed\_names\_are\_unique\_and\_valid\(\)

```csharp
[Fact]
public Task Listed_names_are_unique_and_valid()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Listing_is_repeatable"></a> Listing\_is\_repeatable\(\)

```csharp
[Fact]
public Task Listing_is_repeatable()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Listing_is_safe_under_concurrency"></a> Listing\_is\_safe\_under\_concurrency\(\)

```csharp
[Fact]
public Task Listing_is_safe_under_concurrency()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Name_is_not_empty"></a> Name\_is\_not\_empty\(\)

```csharp
[Fact]
public void Name_is_not_empty()
```

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Priority_is_stable_across_calls"></a> Priority\_is\_stable\_across\_calls\(\)

```csharp
[Fact]
public Task Priority_is_stable_across_calls()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Resolution_is_safe_under_concurrency"></a> Resolution\_is\_safe\_under\_concurrency\(\)

```csharp
[Fact]
public Task Resolution_is_safe_under_concurrency()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Resolved_agent_is_listed"></a> Resolved\_agent\_is\_listed\(\)

The other half of the M7 consistency rule (see [IAgentSource](/api/tracon.iagentsource/)):
a name [IAgentSource.ResolveAsync](/api/tracon.iagentsource/#Tracon_IAgentSource_ResolveAsync_System_String_System_String_System_Threading_CancellationToken_) resolves must also appear in
[IAgentSource.ListAsync](/api/tracon.iagentsource/#Tracon_IAgentSource_ListAsync_System_Threading_CancellationToken_). [AgentSourceContract.KnownAgentName](/api/tracon.testing.contracts.agentsources.agentsourcecontract/#Tracon_Testing_Contracts_AgentSources_AgentSourceContract_KnownAgentName) is guaranteed
resolvable by contract (see [AgentSourceContract.Known_agent_resolves](/api/tracon.testing.contracts.agentsources.agentsourcecontract/#Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Known_agent_resolves)), so it doubles as
the "resolvable name" this direction needs without a dedicated fixture hook.

```csharp
[Fact]
public Task Resolved_agent_is_listed()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

### <a id="Tracon_Testing_Contracts_AgentSources_AgentSourceContract_Unknown_agent_returns_null"></a> Unknown\_agent\_returns\_null\(\)

```csharp
[Fact]
public Task Unknown_agent_returns_null()
```

#### Returns

 [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)