Back to Repositories

Validating Logging Configuration Implementation in Alibaba Arthas

This test suite validates the logging functionality in Arthas core utilities, focusing on LogUtil class implementation and configuration. It verifies logging initialization, file handling, and environment-specific behaviors.

Test Coverage Overview

The test suite provides comprehensive coverage of LogUtil functionality, including:

Arthas home directory configuration validation
Custom log configuration file handling
Default log file location verification
Custom log file path and name testing
Logger level configuration validation

Implementation Analysis

The testing approach utilizes JUnit framework with TemporaryFolder rule for file system operations. Tests employ systematic verification of logger context initialization, appender configuration, and log level settings using Assertions from AssertJ library.

Technical Details

Key technical components include:

JUnit 4 testing framework
Logback for logging implementation
AssertJ for assertions
TemporaryFolder for test file management
ArthasEnvironment for configuration

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test isolation using @Before setup
Systematic resource cleanup
Comprehensive edge case handling
Clear test method naming conventions
Effective use of assertion libraries

alibaba/arthas

core/src/test/java/com/taobao/arthas/core/util/LogUtilTest.java

            
package com.taobao.arthas.core.util;

import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Iterator;
import java.util.Properties;

import org.assertj.core.api.Assertions;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;

import com.alibaba.arthas.deps.ch.qos.logback.classic.Level;
import com.alibaba.arthas.deps.ch.qos.logback.classic.Logger;
import com.alibaba.arthas.deps.ch.qos.logback.classic.LoggerContext;
import com.alibaba.arthas.deps.ch.qos.logback.classic.spi.ILoggingEvent;
import com.alibaba.arthas.deps.ch.qos.logback.core.Appender;
import com.alibaba.arthas.deps.ch.qos.logback.core.rolling.RollingFileAppender;
import com.taobao.arthas.core.env.ArthasEnvironment;
import com.taobao.arthas.core.env.PropertiesPropertySource;

/**
 * 
 * @author hengyunabc
 *
 */
public class LogUtilTest {
    @Rule
    public TemporaryFolder tempFolder = new TemporaryFolder();

    ArthasEnvironment arthasEnvironment;
    String testResourcesDir;

    @Before
    public void before() throws URISyntaxException {
        ClassLoader classLoader = LogUtilTest.class.getClassLoader();
        String logbakXmlPath = classLoader.getResource("logback-test.xml").toURI().getPath();

        testResourcesDir = new File(logbakXmlPath).getParent();

        arthasEnvironment = new ArthasEnvironment();
    }

    @Test
    public void testArthasHome() throws URISyntaxException {
        Properties properties1 = new Properties();
        properties1.put("arthas.home", testResourcesDir);
        arthasEnvironment.addLast(new PropertiesPropertySource("test1", properties1));

        LoggerContext loggerContext = LogUtil.initLogger(arthasEnvironment);

        Logger logger = loggerContext.getLogger("root");
        Level level = logger.getLevel();

        Assertions.assertThat(level).isEqualTo(Level.ERROR);
    }

    @Test
    public void testLogConfig() throws URISyntaxException {
        Properties properties1 = new Properties();
        properties1.put("arthas.home", testResourcesDir);
        properties1.put(LogUtil.LOGGING_CONFIG_PROPERTY, testResourcesDir + "/logback-test.xml");
        arthasEnvironment.addLast(new PropertiesPropertySource("test1", properties1));

        LoggerContext loggerContext = LogUtil.initLogger(arthasEnvironment);

        Logger logger = loggerContext.getLogger("root");
        Level level = logger.getLevel();

        Assertions.assertThat(level).isEqualTo(Level.WARN);
    }

    @Test
    public void test_DefaultLogFile() throws URISyntaxException, IOException {
        Properties properties1 = new Properties();
        properties1.put("arthas.home", testResourcesDir);
        String logFile = new File(System.getProperty("user.home"), "logs/arthas/arthas.log").getCanonicalPath();

        arthasEnvironment.addLast(new PropertiesPropertySource("test1", properties1));

        LoggerContext loggerContext = LogUtil.initLogger(arthasEnvironment);

        Logger logger = loggerContext.getLogger("root");
        Level level = logger.getLevel();

        Assertions.assertThat(level).isEqualTo(Level.ERROR);

        Iterator<Appender<ILoggingEvent>> appenders = logger.iteratorForAppenders();

        boolean foundFileAppender = false;
        while (appenders.hasNext()) {
            Appender<ILoggingEvent> appender = appenders.next();
            if (appender instanceof RollingFileAppender) {
                RollingFileAppender fileAppender = (RollingFileAppender) appender;
                String file = fileAppender.getFile();
                Assertions.assertThat(new File(file).getCanonicalPath()).isEqualTo(logFile);
                foundFileAppender = true;
            }
        }
        Assertions.assertThat(foundFileAppender).isEqualTo(true);
    }

    @Test
    public void test_ARTHAS_LOG_FILE() throws URISyntaxException, IOException {
        Properties properties1 = new Properties();
        properties1.put("arthas.home", testResourcesDir);

        String logFile = new File(tempFolder.getRoot().getAbsoluteFile(), "test.log").getCanonicalPath();

        properties1.put(LogUtil.FILE_NAME_PROPERTY, logFile);
        arthasEnvironment.addLast(new PropertiesPropertySource("test1", properties1));

        LoggerContext loggerContext = LogUtil.initLogger(arthasEnvironment);

        Logger logger = loggerContext.getLogger("root");
        Level level = logger.getLevel();

        Assertions.assertThat(level).isEqualTo(Level.ERROR);

        Iterator<Appender<ILoggingEvent>> appenders = logger.iteratorForAppenders();

        boolean foundFileAppender = false;
        while (appenders.hasNext()) {
            Appender<ILoggingEvent> appender = appenders.next();
            if (appender instanceof RollingFileAppender) {
                RollingFileAppender fileAppender = (RollingFileAppender) appender;
                String file = fileAppender.getFile();
                Assertions.assertThat(new File(file).getCanonicalPath()).isEqualTo(logFile);
                foundFileAppender = true;
            }
        }
        Assertions.assertThat(foundFileAppender).isEqualTo(true);
    }

    @Test
    public void test_ARTHAS_LOG_PATH() throws URISyntaxException, IOException {
        Properties properties1 = new Properties();
        properties1.put("arthas.home", testResourcesDir);

        String logFile = new File(tempFolder.getRoot().getAbsoluteFile(), "arthas.log").getCanonicalPath();

        properties1.put(LogUtil.FILE_PATH_PROPERTY, tempFolder.getRoot().getAbsolutePath());
        arthasEnvironment.addLast(new PropertiesPropertySource("test1", properties1));

        LoggerContext loggerContext = LogUtil.initLogger(arthasEnvironment);

        Logger logger = loggerContext.getLogger("root");
        Level level = logger.getLevel();

        Assertions.assertThat(level).isEqualTo(Level.ERROR);

        Iterator<Appender<ILoggingEvent>> appenders = logger.iteratorForAppenders();

        boolean foundFileAppender = false;
        while (appenders.hasNext()) {
            Appender<ILoggingEvent> appender = appenders.next();
            if (appender instanceof RollingFileAppender) {
                RollingFileAppender fileAppender = (RollingFileAppender) appender;
                String file = fileAppender.getFile();
                Assertions.assertThat(new File(file).getCanonicalPath()).isEqualTo(logFile);
                foundFileAppender = true;
            }
        }
        Assertions.assertThat(foundFileAppender).isEqualTo(true);
    }
}