解决 Extent Report 日志混淆：打造线程安全的 ExtentReportsAppender

2024-03-03 00:06:53

线程安全 ExtentReportAppender：告别日志混淆

引言

在自动化测试框架中，日志记录是至关重要的，它能提供测试执行期间发生的事件和错误的详细信息。然而，当使用 Extent Report 作为报告工具时，可能会出现线程安全问题，导致不同测试的日志相互混淆。本文将探讨这一问题及其解决方法，确保日志隔离和准确性。

问题

ExtentReportsAppender 作为 Extent Report 的一个组件，负责将日志事件记录到报告中。默认情况下，该 Appender 是静态的，这意味着所有测试线程都共享一个实例。当多个测试同时运行时，就会出现问题，因为不同的日志事件可能会被错误地混合到同一个报告中。这使得调试和分析测试结果变得困难。

解决方案

要解决这个问题，我们将 ExtentReportsAppender 设置为线程局部变量。这样，每个测试线程都会拥有自己的 ExtentReportsAppender 实例，从而保证日志的隔离性。以下是实现步骤：

1. Listener 类

在 onTestStart 方法中，我们创建 ExtentReportsAppender 实例并将其存储在 ThreadLocal 变量中。在 cleanupLogger 方法中，我们获取 ThreadLocal 变量中的 ExtentReportsAppender 实例并将其从根日志器中删除。

public class Listeners implements ITestListener, IConfigurationListener {
    private ThreadLocal<ExtentReportsAppender> appenderThreadLocal = new ThreadLocal<>();

    @Override
    public void onTestStart(ITestResult result) {
        ExtentReportsAppender extentAppender = new ExtentReportsAppender(testThreadLocal.get());
        appenderThreadLocal.set(extentAppender);
        extentAppender.start();
        Logger rootLogger = (Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
        rootLogger.addAppender(extentAppender);
    }

    @Override
    public void cleanupLogger() {
        Logger rootLogger = (Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
        ExtentReportsAppender extentAppender = appenderThreadLocal.get();
        if (extentAppender != null) {
            rootLogger.detachAppender(extentAppender);
            extentAppender.stop();
        }
    }
}

2. ExtentReportsAppender 类

在构造函数中，我们接收 ExtentTest 实例作为参数。在 append 方法中，我们根据提供的 ExtentTest 实例记录日志。

public class ExtentReportsAppender extends AppenderBase<ILoggingEvent> {
    private ExtentTest test;

    public ExtentReportsAppender(ExtentTest testInstance) {
        test = testInstance;
    }

    @Override
    protected void append(ILoggingEvent event) {
        if (test != null) {
            switch (event.getLevel().levelInt) {
                case Level.INFO_INT:
                    test.log(Status.INFO, event.getFormattedMessage());
                    break;
                case Level.WARN_INT:
                    test.log(Status.WARNING, event.getFormattedMessage());
                    break;
            }
        }
    }
}