[java] TestNG와 log4j, logback 같은 로깅 라이브러리 통합

20 Nov 2023

java

로깅은 개발자들에게 디버깅과 모니터링을 위해 중요한 도구입니다. 자바 애플리케이션에서 가장 일반적인 로깅 라이브러리로는 log4j와 logback이 있습니다. 이러한 로깅 라이브러리들은 콘솔 또는 파일에 로그를 출력하고 다양한 로깅 레벨을 지원하여 개발자가 필요한 정보만 출력할 수 있도록 해줍니다.

TestNG는 자바 기반의 테스트 프레임워크로써, 로깅 라이브러리와 통합하여 테스트 실행 중에 발생하는 이벤트와 로그 메시지를 기록하고 분석할 수 있습니다. 이를 통해 테스트 결과를 실시간으로 확인하고 디버깅할 수 있습니다.

log4j와 TestNG 통합하기

log4j와 TestNG를 통합하려면 다음 단계를 따라야 합니다:

log4j 라이브러리를 프로젝트에 추가합니다. Maven을 사용하는 경우, pom.xml 파일에 다음 의존성을 추가합니다:

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

log4j.properties 파일을 생성하고 로그 설정을 구성합니다. 예를 들어, 다음과 같은 설정을 사용할 수 있습니다:

log4j.rootLogger=DEBUG, console

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

TestNG 실행 전에 log4j를 초기화합니다. 이를 위해 TestNG의 @BeforeSuite 애너테이션을 사용하여 초기화 메서드를 생성합니다. 이 메서드는 log4j.properties 파일을 로딩하는 코드를 포함해야 합니다:

import org.testng.annotations.BeforeSuite;
import org.apache.log4j.PropertyConfigurator;

public class BaseTest {

    @BeforeSuite
    public void setUp() {
        PropertyConfigurator.configure("log4j.properties");
    }
}

TestNG 테스트 클래스에서 BaseTest를 상속받습니다:

import org.testng.annotations.Test;

public class MyTest extends BaseTest {

    @Test
    public void testMethod() {
        // 테스트 로그 메시지 출력
        Logger logger = Logger.getLogger(MyTest.class);
        logger.info("테스트 메시지 출력");
        
        // 테스트 실행
        // ...
    }
}

logback와 TestNG 통합하기

logback은 log4j의 개선 버전으로, 로깅 구성이 더욱 유연하고 성능 면에서 향상되었습니다. logback을 TestNG와 통합하려면 다음 단계를 따르십시오:

logback 라이브러리를 프로젝트에 추가합니다. Maven을 사용하는 경우, pom.xml 파일에 다음 의존성을 추가합니다:

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

logback.xml 파일을 생성하고 로그 설정을 구성합니다. 예를 들어, 다음과 같은 설정을 사용할 수 있습니다:

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
        </encoder>
    </appender>
    
    <root level="debug">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

TestNG 실행 전에 logback을 초기화합니다. 이를 위해 TestNG의 @BeforeSuite 애너테이션을 사용하여 초기화 메서드를 생성합니다. 이 메서드는 logback.xml 파일을 로딩하는 코드를 포함해야 합니다:

import org.testng.annotations.BeforeSuite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class BaseTest {

    @BeforeSuite
    public void setUp() {
        Logger logger = LoggerFactory.getLogger(BaseTest.class);
        logger.debug("logback 설정 로딩");
    }
}

TestNG 테스트 클래스에서 BaseTest를 상속받습니다:

import org.testng.annotations.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyTest extends BaseTest {

    @Test
    public void testMethod() {
        // 테스트 로그 메시지 출력
        Logger logger = LoggerFactory.getLogger(MyTest.class);
        logger.info("테스트 메시지 출력");
        
        // 테스트 실행
        // ...
    }
}

결론

TestNG와 log4j 또는 logback을 통합하면 애플리케이션의 테스트 수행 시 로그를 적절하게 관리하고 분석할 수 있습니다. 테스트 결과를 확인하고 디버깅하는데 유용한 이러한 로깅 라이브러리들을 활용하여 개발 과정을 더욱 원활하게 진행할 수 있습니다.

log4j와 TestNG 통합하기

logback와 TestNG 통합하기

결론

참고 자료