如何验证（使用单元测试）错误堆栈是否打印在日志文件中？

Question

在继续这个答案时，我编写了一个单元测试来验证如果出现错误，堆栈将打印在日志文件中。

被测方法：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private final Logger logger = LoggerFactory.getLogger(getClass());

public long getFq(String fi) {
    try {            
        return calcSomeThing(fi.toLowerCase());
    } catch (Exception e) {
        logger.error("unable to calculate SomeThing.  Error: "
                , e);
        return -1;
    }
}

单元测试：

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.read.ListAppender;
import org.slf4j.LoggerFactory;

@Test
public void getFileQualifier() {

    // get Logback Logger
    Logger logger = (Logger) LoggerFactory.getLogger(QService.class);

    // create and start a ListAppender
    ListAppender<ILoggingEvent> listAppender = new ListAppender<>();
    listAppender.start();

    // add the appender to the logger
    // addAppender is outdated now
    logger.addAppender(listAppender);

    // call method under test
    QService.getFq(null);

    // JUnit assertions
    List<ILoggingEvent> logsList = listAppender.list;
    Assert.assertEquals("unable to calculate SomeThing.  Error: ", logsList.get(0)
            .getFormattedMessage());
    Assert.assertEquals(Level.ERROR, logsList.get(0)
            .getLevel());

    Assert.assertEquals("java.lang.NullPointerException: null", logsList.get(1)
            .getMessage());
    Assert.assertEquals(Level.ERROR, logsList.get(1)
            .getLevel());

    Assert.assertThat("(QService.java", containsString(logsList.get(2)
            .getMessage()));
    Assert.assertEquals(Level.ERROR, logsList.get(2)
            .getLevel());
}

好吧，虽然我可以看到日志文件中确实打印了堆栈，但单元测试失败了，因为logsList只包含一项（仅打印的第一行 [无法计算 SomeThing.Error: ]）。

java.lang.IndexOutOfBoundsException：索引 1 超出长度 1 的范围

为什么会发生以及如何对其进行测试？

编辑

答案：答案（都是@Gavin的回答和评论的引用，谢谢）：

第一个问题（为什么会发生）答案是：

在我看来，异常与日志事件中的消息分开存储

关于第二个问题（如何测试），答案是：

在日志事件列表中找到您要查找的内容，并且可以以适合您的域的方式表达，例如检查 Throwable 是否已记录，可能在 org.apache.log4j.spi.LoggingEvent 中查找适当的方法

最后，我验证它的代码是：

Assert.assertEquals(logsList.get(0).getThrowableProxy().getClassName(), "java.lang.NullPointerException");

Answer 1

这就是我过去捕获日志消息的方式，这是基于似乎不再可用的旧博客（不是我写的）。

这是为 Java 7/8 和 Junit4 编写的相当古老的代码。

我会尽量保持简短:)

首先，您需要一个Appender ，最好扩展AppenderSkeleton ，例如：

public class RuleAppender extends AppenderSkeleton {
    private final List<LoggingEvent> loggingEvents = new ArrayList<>();

    protected RuleAppender() {
        super(true);

        this.setThreshold(Level.TRACE);
        setName("Rule Appender");
    }

    @Override
    public void close() {
        // No op in this case
    }

    @Override
    public boolean requiresLayout() {
        return false;
    }

    @Override
    protected void append(final LoggingEvent event) {
        loggingEvents.add(event);
    }

    public boolean hasEventsMeeting(LogExpectation logExpectation) {
         // Use the LogExpectation to determine if the list of log events contains what you want.
    }

    @Override
    public String toString() {
        return "RuleAppender";
    }
}

LogExpectation只是在某个地方定义了一个期望/标准以匹配存储的日志事件。

然后将其包含在 Junit 规则中，以使将 Appender 添加到 Log4J 更容易一些，我通过实现TestRule和扩展Statement来做到这一点，确保Statement的evaluate方法所做的第一件事是：

LogManager.getRootLogger().addAppender(ruleAppender);
LogManager.getRootLogger().setLevel(Level.ALL);

注意：这可以在没有 JUnit 规则的情况下完成，只要在测试之前执行上述两行以确保将附加添加到 Log4J （仍然需要自定义附加器）。

我没有进入 JUnit 规则代码，因为我们可能应该移动到不支持规则的 JUnit 5 并且我没有进入LogExpecation ，因为这只是为了在日志事件列表中找到您要查找的内容并且可以以适合您的域的方式表达，例如检查Throwable是否已记录，可能在org.apache.log4j.spi.LoggingEvent中查找适当的方法