如何让NUnit测试等待StartServer的监听线程执行完成？

我在使用NUnit测试类库时遇到一个问题：在控制台应用或其他项目中调用StartServer方法时，程序会正常持续运行直到listenerThread结束；但在NUnit测试方法中调用该方法时，测试会立即完成，就像启动了一个“fire and forget”任务一样。

我已经尝试过以下两种方式，但都没有效果：

• 用Task.Run包裹StartServer方法并调用Wait()：

[Test]
public void Test()
{
    Task.Run(() =>
    {
        server.StartServer(IPAddress.Any, 5000, $"{Workspace}\\{ServerWorkspace}\\Server.pfx", "123", false);
    }).Wait();
}

• 为测试方法添加[Test,RequiresThread]属性

我知道可以将StartServer改为返回Task并调用Wait()，或者通过TaskCompletionSource等待listenerThread结束，但希望找到更好的方法，最好无需修改StartServer方法。

可行解决方案 #

1. 直接等待内部监听线程完成 #

如果StartServer启动的listenerThread是类的公开成员，可直接在测试中调用线程的Join()方法阻塞测试线程：

[Test]
public void TestServerRun()
{
    server.StartServer(IPAddress.Any, 5000, $"{Workspace}\\{ServerWorkspace}\\Server.pfx", "123", false);
    server.listenerThread.Join();
}

如果线程是私有成员，可通过反射获取并等待：

using System.Reflection;

[Test]
public void TestServerRunWithReflection()
{
    server.StartServer(IPAddress.Any, 5000, $"{Workspace}\\{ServerWorkspace}\\Server.pfx", "123", false);
    var threadField = typeof(Server).GetField("listenerThread", BindingFlags.NonPublic | BindingFlags.Instance);
    var listenerThread = threadField?.GetValue(server) as Thread;
    listenerThread?.Join();
}

2. 用信号量配合超时控制测试生命周期 #

如果需要主动终止测试避免无限等待，可使用ManualResetEvent或CancellationTokenSource实现可控等待：

private ManualResetEvent _serverStoppedSignal = new ManualResetEvent(false);

[Test, Timeout(10000)] // 设置10秒超时，防止测试挂起
public void TestServerWithSignal()
{
    // 假设Server类提供停止事件回调
    server.ServerStopped += () => _serverStoppedSignal.Set();
    
    server.StartServer(IPAddress.Any, 5000, $"{Workspace}\\{ServerWorkspace}\\Server.pfx", "123", false);
    
    _serverStoppedSignal.WaitOne();
}

若Server无现成回调，可额外启动监控线程，检测服务器运行状态，满足终止条件时触发信号量。

3. 指定测试线程的公寓状态 #

部分场景下，线程公寓状态会导致等待逻辑失效，可强制测试线程使用MTA模式：

[Test, RequiresThread(ApartmentState.MTA)]
public void TestServerInMTA()
{
    server.StartServer(IPAddress.Any, 5000, $"{Workspace}\\{ServerWorkspace}\\Server.pfx", "123", false);
    // 搭配上述线程Join或信号量等待逻辑
}

之前方法无效的原因 #

• Task.Run+Wait()无效：StartServer内部的listenerThread大概率是后台线程，当Task对应的前台线程完成后，后台线程会被系统终止，而NUnit测试线程不会主动等待后台线程。
• [RequiresThread]仅保证测试在独立线程执行，但未解决“测试线程等待内部线程”的核心问题，测试线程仍会在StartServer返回后直接结束。

内容的提问来源于stack exchange，提问作者vvvanderer