使用 Orleans 進行單元測試

使用 InProcessTestCluster（推薦）

InProcessTestCluster 是推薦的 Orleans 測試基礎設施。 它提供一個簡化、以委托為基礎的 API，用於配置測試叢集，讓測試與叢集間的服務共享更為方便。

主要優勢

相較於 TestCluster，InProcessTestCluster 的主要優點是人體工學。

• 基於委託式配置：使用內嵌代理配置孤島與用戶端，而非獨立的組態類別
• 共享服務實例：輕鬆在測試程式碼與孤島主機間共享模擬服務、測試雙重實例及其他實例
• 減少樣板程式碼：不需要建立獨立的 ISiloConfigurator 或 IClientConfigurator 類別。
• 更簡單的依賴注入：直接在 builder fluent API 中註冊服務

兩者InProcessTestClusterTestCluster預設使用相同的底層進程孤島主機，因此記憶體使用量和啟動時間是等效的。 API TestCluster 也被設計用於支援多程序情境（用於類似生產環境的模擬），這需要基於類別的配置方法，但預設情況下它像 InProcessTestCluster 一樣內部運行。

基本用法

using Orleans.TestingHost;
using Xunit;

public class HelloGrainTests : IAsyncLifetime
{
    private InProcessTestCluster _cluster = null!;

    public async Task InitializeAsync()
    {
        var builder = new InProcessTestClusterBuilder();
        _cluster = builder.Build();
        await _cluster.DeployAsync();
    }

    public async Task DisposeAsync()
    {
        await _cluster.DisposeAsync();
    }

    [Fact]
    public async Task SaysHello()
    {
        var grain = _cluster.Client.GetGrain<IHelloGrain>(0);
        var result = await grain.SayHello("World");
        Assert.Equal("Hello, World!", result);
    }
}

配置測試叢集

用於 InProcessTestClusterBuilder 配置孤島、客戶端與服務：

var builder = new InProcessTestClusterBuilder(initialSilosCount: 2);

// Configure silos
builder.ConfigureSilo((options, siloBuilder) =>
{
    siloBuilder.AddMemoryGrainStorage("Default");
    siloBuilder.AddMemoryGrainStorage("PubSubStore");
});

// Configure clients
builder.ConfigureClient(clientBuilder =>
{
    // Client-specific configuration
});

// Configure both silos and clients (shared services)
builder.ConfigureHost(hostBuilder =>
{
    hostBuilder.Services.AddSingleton<IMyService, MyService>();
});

var cluster = builder.Build();
await cluster.DeployAsync();

InProcessTestClusterOptions

在測試間共享測試群組

為了提升測試效能，請使用 xUnit 夾具在多個測試案例中共用單一叢集：

public class ClusterFixture : IAsyncLifetime
{
    public InProcessTestCluster Cluster { get; private set; } = null!;

    public async Task InitializeAsync()
    {
        var builder = new InProcessTestClusterBuilder();
        builder.ConfigureSilo((options, siloBuilder) =>
        {
            siloBuilder.AddMemoryGrainStorageAsDefault();
        });

        Cluster = builder.Build();
        await Cluster.DeployAsync();
    }

    public async Task DisposeAsync()
    {
        await Cluster.DisposeAsync();
    }
}

[CollectionDefinition(nameof(ClusterCollection))]
public class ClusterCollection : ICollectionFixture<ClusterFixture>
{
}

[Collection(nameof(ClusterCollection))]
public class HelloGrainTests
{
    private readonly ClusterFixture _fixture;

    public HelloGrainTests(ClusterFixture fixture)
    {
        _fixture = fixture;
    }

    [Fact]
    public async Task SaysHello()
    {
        var grain = _fixture.Cluster.Client.GetGrain<IHelloGrain>(0);
        var result = await grain.SayHello("World");
        Assert.Equal("Hello, World!", result);
    }
}

測試時增減筒倉

InProcessTestCluster支援用於測試叢集行為的動態孤島管理：

// Start with 2 silos
var builder = new InProcessTestClusterBuilder(initialSilosCount: 2);
var cluster = builder.Build();
await cluster.DeployAsync();

// Add a third silo
var newSilo = await cluster.StartSiloAsync();

// Stop a silo
await cluster.StopSiloAsync(newSilo);

// Restart all silos
await cluster.RestartAsync();

該系統 TestCluster 採用類別為基礎的配置方法，需要實作 ISiloConfigurator 與 IClientConfigurator 介面。 此設計支援多程序測試情境，讓獨立的程序分別運行，對類生產環境的模擬測試非常有幫助。 然而，預設 TestCluster 情況下，也會以與 InProcessTestCluster相當的效能在進程中執行。

當選擇TestCluster而不是InProcessTestCluster時

• 生產模擬需要多流程測試
• 你已經有使用 TestCluster API 進行的測試
• 你需要與 7.x 或 8.x 相容Orleans

對於新測試 InProcessTestCluster ，因其代理式配置較簡單而被推薦。