无法将ExtentReportManager作为ITestListener附加到NUnit测试运行器

核心问题说明 #

NUnit 3.x已废弃ITestListener接口的公开注册方式，TestExecutionContext也未提供Listener或AddListener方法（这些是NUnit 2.x的遗留API），需改用NUnit 3原生支持的测试生命周期钩子方案。

方案一：使用TestActionAttribute（推荐，适配Visual Studio Test Runner） #

这是NUnit 3中最直接的测试事件绑定方式，无需额外配置，可直接在测试类中生效。

步骤1：重构全局Extent Report管理器（单例模式） #

确保Extent Report实例全局唯一，避免重复创建：

using AventStack.ExtentReports;
using AventStack.ExtentReports.Reporter;

public static class ExtentReportManager
{
    private static ExtentReports _extentInstance;
    private static ExtentTest _currentTestNode;

    public static ExtentReports GetExtent()
    {
        if (_extentInstance == null)
        {
            var htmlReporter = new ExtentHtmlReporter(@"D:\TestReports\AutomationReport.html");
            _extentInstance = new ExtentReports();
            _extentInstance.AttachReporter(htmlReporter);
            
            // 添加环境信息
            _extentInstance.AddSystemInfo("NUnit Version", "3.14.0");
            _extentInstance.AddSystemInfo("Test Runner", "Visual Studio NUnit Test Adapter 4.5.0");
            _extentInstance.AddSystemInfo("Browser", "Chrome");
        }
        return _extentInstance;
    }

    public static void StartTestNode(string testName, string fixtureName)
    {
        // 创建Fixture父节点，不存在则新建
        var fixtureNode = GetExtent().CreateTest(fixtureName);
        _currentTestNode = fixtureNode.CreateNode(testName);
    }

    public static void LogTestResult(TestStatus status, string message = null)
    {
        if (_currentTestNode != null)
        {
            _currentTestNode.Log(status, message ?? "Test completed");
        }
    }

    public static void AttachScreenshot(string screenshotPath)
    {
        _currentTestNode?.AddScreenCaptureFromPath(screenshotPath);
    }

    public static void FlushReport()
    {
        _extentInstance?.Flush();
    }
}

步骤2：实现TestActionAttribute绑定测试事件 #

创建自定义Action类，拦截测试的启动和结束事件：

using NUnit.Framework;
using NUnit.Framework.Interfaces;
using AventStack.ExtentReports;

public class ExtentReportHook : TestActionAttribute
{
    public override void BeforeTest(ITest test)
    {
        // 获取测试所属的Fixture类名
        var fixtureName = test.Fixture.GetType().Name;
        // 启动Extent的测试节点（Fixture为父节点，Test为子节点）
        ExtentReportManager.StartTestNode(test.Name, fixtureName);

        // 调用BaseClass的截图方法，需确保TestFixture继承自BaseClass
        if (test.Fixture is BaseClass baseTest)
        {
            var screenshotPath = baseTest.CaptureScreen($"{test.Name}_Start");
            ExtentReportManager.AttachScreenshot(screenshotPath);
        }
    }

    public override void AfterTest(ITestResult result)
    {
        // 转换NUnit测试状态为Extent状态
        var extentStatus = result.Status switch
        {
            TestStatus.Passed => TestStatus.Pass,
            TestStatus.Failed => TestStatus.Fail,
            TestStatus.Skipped => TestStatus.Skip,
            _ => TestStatus.Pass
        };

        // 记录测试结果
        ExtentReportManager.LogTestResult(extentStatus, result.Message);

        // 测试失败时额外捕获截图并记录堆栈信息
        if (result.Status == TestStatus.Failed && result.Fixture is BaseClass baseTest)
        {
            var failureScreenshot = baseTest.CaptureScreen($"{result.Name}_Failure");
            ExtentReportManager.AttachScreenshot(failureScreenshot);
            ExtentReportManager.LogTestResult(TestStatus.Fail, result.StackTrace);
        }
    }

    // 指定Action作用于所有测试方法
    public override ActionTargets Targets => ActionTargets.Test;
}

步骤3：配置BaseClass和全局清理 #

修改BaseClass，添加TestAction标记确保全局生效，并完善截图方法：

using OpenQA.Selenium;
using OpenQA.Selenium.Chrome;
using NUnit.Framework;
using System.IO;

[TestAction(typeof(ExtentReportHook))]
public class BaseClass
{
    protected IWebDriver Driver;

    [SetUp]
    public void InitializeDriver()
    {
        Driver = new ChromeDriver();
        Driver.Manage().Window.Maximize();
    }

    [TearDown]
    public void CleanupDriver()
    {
        Driver?.Quit();
        Driver?.Dispose();
    }

    public string CaptureScreen(string fileName)
    {
        var screenshotDir = @"D:\TestScreenshots";
        Directory.CreateDirectory(screenshotDir);
        var filePath = Path.Combine(screenshotDir, $"{fileName}_{DateTime.Now:yyyyMMddHHmmss}.png");
        
        var screenshot = ((ITakesScreenshot)Driver).GetScreenshot();
        screenshot.SaveAsFile(filePath, ScreenshotImageFormat.Png);
        
        return filePath;
    }
}

修改全局SetUpFixture，完成报告的最终输出：

using NUnit.Framework;

[SetUpFixture]
public class GlobalTestSetup
{
    [OneTimeTearDown]
    public void FinalizeReport()
    {
        ExtentReportManager.FlushReport();
    }
}

方案二：使用IEventListener（适合复杂扩展场景） #

如果需要更底层的事件监听，可实现NUnit 3的IEventListener接口，需通过配置文件注册：

步骤1：实现IEventListener #

using NUnit.Framework.Interfaces;
using System.Xml;
using AventStack.ExtentReports;

public class ExtentReportEventListener : IEventListener
{
    public void OnTestEvent(string report)
    {
        var xmlDoc = new XmlDocument();
        xmlDoc.LoadXml(report);
        
        switch (xmlDoc.DocumentElement.Name)
        {
            case "start-test":
                var testName = xmlDoc.DocumentElement.GetAttribute("name");
                var fixtureName = xmlDoc.DocumentElement.GetAttribute("classname");
                ExtentReportManager.StartTestNode(testName, fixtureName);
                break;
            case "test-finished":
                var result = xmlDoc.DocumentElement.GetAttribute("result");
                var status = result switch
                {
                    "Passed" => TestStatus.Pass,
                    "Failed" => TestStatus.Fail,
                    "Skipped" => TestStatus.Skip,
                    _ => TestStatus.Pass
                };
                ExtentReportManager.LogTestResult(status);
                break;
        }
    }
}

步骤2：注册监听器 #

在项目根目录创建nunit.extensions.config文件，内容如下：

<extensions>
  <add type="YourProjectNamespace.ExtentReportEventListener, YourProjectAssemblyName" />
</extensions>

注意：这种方式在Visual Studio Test Runner中可能需要调整测试运行配置，不如TestActionAttribute便捷。

关键注意事项 #

1. 确保Extent Reports版本与NUnit版本兼容（推荐使用最新稳定版的Extent Reports）
2. 截图路径需确保测试进程有写入权限
3. 单例模式的ExtentReportManager避免了多线程环境下的实例冲突（NUnit默认并行测试需额外配置）

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