Maven 的 log4j 配置以显示测试日志
log4j configuration for Maven to show logs of tests
我们使用以下log4j.xml
配置文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false">
<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
<param name="target" value="System.out"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="conversionPattern" value="[%d{ISO8601}] %-5p [%c{1}]#[%t] %m %n"/>
</layout>
</appender>
<category name="some.internal.enterprise.custom.library">
<priority value="DEBUG"/>
</category>
<!-- Removing the useless logging of "Invalid JavaBean property" -->
<logger name="org.springframework.beans.GenericTypeAwarePropertyDescriptor">
<level value="ERROR"/>
</logger>
<logger name="org.springframework">
<level value="WARN"/>
</logger>
<root>
<priority value="INFO"/>
<appender-ref ref="STDOUT"/>
</root>
</log4j:configuration>
我们设置 JUnit 测试 class 以这种方式记录:
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
// more imports...
@RunWith(JUnitParamsRunner.class)
@ContextConfiguration(locations = {ProxyConfiguration.SPRING_CONTEXT_CONFIGURATION_LOCATIONS})
@Category(Integration.class)
@FixMethodOrder(MethodSorters.JVM)
public class MyTest {
private final Logger log = LogManager.getLogger(MyTest.class);
@Test
public void test() {
log.info("Blah blah");
}
}
我希望 Maven 的 Console Output
显示此日志,但它没有。然而,当我 运行 在 IntelliJ 上使用 运行 配置 JUnit
.
进行本地测试时,它出现了
我应该怎么做才能让我的日志显示在 Console Output
中?
我在网上找到的答案提到即使测试成功也想查看日志记录:这也是我的要求。然而,他们的问题暗示当他们的测试失败时它已经在记录日志,但这不是这里发生的事情。我从测试中得到的唯一信息是抛出异常时的堆栈跟踪。
一位同事让我意识到日志是在 target/surefire-reports/my.package.TestClassName-output.txt
中输出的。
原来我们 maven-surefire-plugin
的 redirectTestOutputToFile
标志被设置为 true
。我通过阅读 mvn clean verify --debug
.
的输出发现了这一点
所以 pom.xml
最终看起来像那样(我删除了一大堆不相关的东西):
<project>
<properties>
<slf4j.version>1.7.28</slf4j.version>
</properties>
<dependencies>
<!-- Make sure you exclude any conflicting versions from your other dependencies -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<redirectTestOutputToFile>${logToFile}</redirectTestOutputToFile>
</configuration>
</plugin>
</plugins>
</build>
</project>
现在您可以使用 logToFile
JVM 参数来控制日志记录的位置。不为该变量提供任何值将使其默认为 false
,这正是我们想要的。或者,我们可以选择使用 mvn clean verify -DlogToFile=true
.
输出到报告文件
关于 surefire 标志的文档在那里:http://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html
我们使用以下log4j.xml
配置文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false">
<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
<param name="target" value="System.out"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="conversionPattern" value="[%d{ISO8601}] %-5p [%c{1}]#[%t] %m %n"/>
</layout>
</appender>
<category name="some.internal.enterprise.custom.library">
<priority value="DEBUG"/>
</category>
<!-- Removing the useless logging of "Invalid JavaBean property" -->
<logger name="org.springframework.beans.GenericTypeAwarePropertyDescriptor">
<level value="ERROR"/>
</logger>
<logger name="org.springframework">
<level value="WARN"/>
</logger>
<root>
<priority value="INFO"/>
<appender-ref ref="STDOUT"/>
</root>
</log4j:configuration>
我们设置 JUnit 测试 class 以这种方式记录:
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
// more imports...
@RunWith(JUnitParamsRunner.class)
@ContextConfiguration(locations = {ProxyConfiguration.SPRING_CONTEXT_CONFIGURATION_LOCATIONS})
@Category(Integration.class)
@FixMethodOrder(MethodSorters.JVM)
public class MyTest {
private final Logger log = LogManager.getLogger(MyTest.class);
@Test
public void test() {
log.info("Blah blah");
}
}
我希望 Maven 的 Console Output
显示此日志,但它没有。然而,当我 运行 在 IntelliJ 上使用 运行 配置 JUnit
.
我应该怎么做才能让我的日志显示在 Console Output
中?
我在网上找到的答案提到即使测试成功也想查看日志记录:这也是我的要求。然而,他们的问题暗示当他们的测试失败时它已经在记录日志,但这不是这里发生的事情。我从测试中得到的唯一信息是抛出异常时的堆栈跟踪。
一位同事让我意识到日志是在 target/surefire-reports/my.package.TestClassName-output.txt
中输出的。
原来我们 maven-surefire-plugin
的 redirectTestOutputToFile
标志被设置为 true
。我通过阅读 mvn clean verify --debug
.
所以 pom.xml
最终看起来像那样(我删除了一大堆不相关的东西):
<project>
<properties>
<slf4j.version>1.7.28</slf4j.version>
</properties>
<dependencies>
<!-- Make sure you exclude any conflicting versions from your other dependencies -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<redirectTestOutputToFile>${logToFile}</redirectTestOutputToFile>
</configuration>
</plugin>
</plugins>
</build>
</project>
现在您可以使用 logToFile
JVM 参数来控制日志记录的位置。不为该变量提供任何值将使其默认为 false
,这正是我们想要的。或者,我们可以选择使用 mvn clean verify -DlogToFile=true
.
关于 surefire 标志的文档在那里:http://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html