在 JUnit4 中使用 SystemOutRule 获取不到控制台的标准输出内容

测试积点老人 · 发表于 2022-2-23 13:21:26

自己在练习《Spring实战》第四版这本书的第一章例子时发现在测试部分无法使用 SystemOutRule 获取到 System.out 或者 PrintStream 输出到控制台的内容。

测试类

import org.junit.Rule;
import org.junit.Test;
import org.junit.contrib.java.lang.system.StandardOutputStreamLog;
import org.junit.contrib.java.lang.system.SystemErrRule;
import org.junit.contrib.java.lang.system.SystemOutRule;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = KnightConfig.class)
public class SlayDragonQuestTest {
@Rule
public final StandardOutputStreamLog log = new StandardOutputStreamLog();
@Rule
public final SystemOutRule systemOutRule = new SystemOutRule().enableLog();
@Rule
public final SystemErrRule systemErrRule = new SystemErrRule().enableLog();
@Autowired
private Knight knight;
@Test
public void shouldBeNotNull() {
Assert.assertNotNull(knight);
}
@Test
public void writesTextToSystemErr() {
System.err.print("hello world");
Assert.assertEquals("hello world", systemErrRule.getLog());
}
@Test
public void shouldBeEqual() {
systemOutRule.clearLog();
knight.embarkOnQuest();
// System.out.println("Embarking on quest to slay the dragon!");
Assert.assertEquals("Embarking on quest to slay the dragon!\r\n", systemOutRule.getLog());
}
}

复制代码

当我执行下面这个测试方法 shouldBeEqual()，结果显示 SystemOutRule 的 getLog() 方法获取的控制台输出内容是空的。

@Test
public void shouldBeEqual() {
systemOutRule.clearLog();
knight.embarkOnQuest();
// System.out.println("Embarking on quest to slay the dragon!");
Assert.assertEquals("Embarking on quest to slay the dragon!\r\n", systemOutRule.getLog());
}

复制代码

点开 Click to see difference

显示 systemOutRule.getLog() 并没有获取到控制台的输出内容，而第一张结果图显示控制台是有输出内容的。

配置类

package com.hb.config;
import com.hb.impl.BraveKnight;
import com.hb.impl.SlayDragonQuest;
import com.hb.interfaces.Knight;
import com.hb.interfaces.Quest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class KnightConfig {
@Bean
public Knight knight() {
return new BraveKnight(quest());
}
@Bean
public Quest quest() {
return new SlayDragonQuest(System.out);
}
}

复制代码

BraveKnight 类和 Knight 接口

public class BraveKnight implements Knight {
private Quest quest;
public BraveKnight(Quest quest) {
this.quest = quest;
}
@Override
public void embarkOnQuest() {
quest.embark();
}
}
public interface Knight {
void embarkOnQuest();
}

复制代码

SlayDragonQuest 类和 Quest 接口

package com.hb.impl;
import com.hb.interfaces.Quest;
import java.io.PrintStream;
public class SlayDragonQuest implements Quest {
private PrintStream stream;
public SlayDragonQuest(PrintStream stream) {
this.stream = stream;
}
@Override
public void embark() {
stream.println("Embarking on quest to slay the dragon!");
}
}
public interface Quest {
void embark();
}

复制代码

刚开始我以为是构造 SlayDragonQuest 类注入的 PrintStream 有问题，于是我新建了一个程序入口看看 BraveKnight 类的实际输出了什么。

package com.hb;
import com.hb.config.KnightConfig;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class Knight {
public static void main(String[] args) throws Exception {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(KnightConfig.class);
com.hb.interfaces.Knight knight = context.getBean(com.hb.interfaces.Knight.class);
knight.embarkOnQuest();
context.close();
}
}

复制代码

结果显示

说明通过 PrintStream 调用 Println() 方法是能够将内容输出到控制台的。那么也就说明了 SystemOutRule 的 getLog() 方法并没有获取到控制台的输出内容。接着我注释了测试方法 shouldBeEqual() 中的 knight.embarkOnQuest(); 而直接使用 System.out.println() 方法。

@Test
public void shouldBeEqual() {
systemOutRule.clearLog();
// knight.embarkOnQuest();
System.out.println("Embarking on quest to slay the dragon!");
Assert.assertEquals("Embarking on quest to slay the dragon!\r\n", systemOutRule.getLog());
}

复制代码

结果还是一样失败

操作系统：Win10
IDE：Intellij IDEA 2021.1.2
依赖的包(pom.xml)：