org.springframework.boot.logging.log4j.Log4JLoggingSystemTests.java Source code

Introduction

Here is the source code for org.springframework.boot.logging.log4j.Log4JLoggingSystemTests.java

Source

/*
 * Copyright 2012-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.logging.log4j;

import java.io.File;
import java.util.logging.Handler;
import java.util.logging.LogManager;

import org.apache.commons.logging.impl.Log4JLogger;
import org.junit.After;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.slf4j.bridge.SLF4JBridgeHandler;

import org.springframework.boot.logging.AbstractLoggingSystemTests;
import org.springframework.boot.logging.LogLevel;
import org.springframework.boot.test.OutputCapture;
import org.springframework.util.StringUtils;

import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;

/**
 * Tests for {@link Log4JLoggingSystem}.
 *
 * @author Phillip Webb
 * @author Andy Wilkinson
 */
@SuppressWarnings("deprecation")
public class Log4JLoggingSystemTests extends AbstractLoggingSystemTests {

    @Rule
    public OutputCapture output = new OutputCapture();

    private final Log4JLoggingSystem loggingSystem = new Log4JLoggingSystem(getClass().getClassLoader());

    private Log4JLogger logger;

    @Before
    public void setup() {
        this.logger = new Log4JLogger(getClass().getName());
    }

    @Override
    @After
    public void clear() {
        this.loggingSystem.cleanUp();
    }

    @Test
    public void noFile() throws Exception {
        this.loggingSystem.beforeInitialize();
        this.logger.info("Hidden");
        this.loggingSystem.initialize(null, null, null);
        this.logger.info("Hello world");
        String output = this.output.toString().trim();
        assertTrue("Wrong output:\n" + output, output.contains("Hello world"));
        assertFalse("Output not hidden:\n" + output, output.contains("Hidden"));
        assertFalse(new File(tmpDir() + "/spring.log").exists());
    }

    @Test
    public void withFile() throws Exception {
        this.loggingSystem.beforeInitialize();
        this.logger.info("Hidden");
        this.loggingSystem.initialize(null, null, getLogFile(null, tmpDir()));
        this.logger.info("Hello world");
        String output = this.output.toString().trim();
        assertTrue("Wrong output:\n" + output, output.contains("Hello world"));
        assertFalse("Output not hidden:\n" + output, output.contains("Hidden"));
        assertTrue(new File(tmpDir() + "/spring.log").exists());
    }

    @Test
    public void testNonDefaultConfigLocation() throws Exception {
        this.loggingSystem.beforeInitialize();
        this.loggingSystem.initialize(null, "classpath:log4j-nondefault.properties", getLogFile(null, tmpDir()));
        this.logger.info("Hello world");
        String output = this.output.toString().trim();
        assertTrue("Wrong output:\n" + output, output.contains("Hello world"));
        assertTrue("Wrong output:\n" + output, output.contains(tmpDir() + "/spring.log"));
        assertFalse(new File(tmpDir() + "/tmp.log").exists());
    }

    @Test(expected = IllegalStateException.class)
    public void testNonexistentConfigLocation() throws Exception {
        this.loggingSystem.beforeInitialize();
        this.loggingSystem.initialize(null, "classpath:log4j-nonexistent.xml", null);
    }

    @Test
    public void setLevel() throws Exception {
        this.loggingSystem.beforeInitialize();
        this.loggingSystem.initialize(null, null, null);
        this.logger.debug("Hello");
        this.loggingSystem.setLogLevel("org.springframework.boot", LogLevel.DEBUG);
        this.logger.debug("Hello");
        assertThat(StringUtils.countOccurrencesOf(this.output.toString(), "Hello"), equalTo(1));
    }

    @Test
    @Ignore("Fails on Bamboo")
    public void loggingThatUsesJulIsCaptured() {
        this.loggingSystem.beforeInitialize();
        this.loggingSystem.initialize(null, null, null);
        java.util.logging.Logger julLogger = java.util.logging.Logger.getLogger(getClass().getName());
        julLogger.severe("Hello world");
        String output = this.output.toString().trim();
        assertTrue("Wrong output:\n" + output, output.contains("Hello world"));
    }

    @Test
    public void bridgeHandlerLifecycle() {
        assertFalse(bridgeHandlerInstalled());
        this.loggingSystem.beforeInitialize();
        assertTrue(bridgeHandlerInstalled());
        this.loggingSystem.cleanUp();
        assertFalse(bridgeHandlerInstalled());
    }

    private boolean bridgeHandlerInstalled() {
        java.util.logging.Logger rootLogger = LogManager.getLogManager().getLogger("");
        Handler[] handlers = rootLogger.getHandlers();
        for (Handler handler : handlers) {
            if (handler instanceof SLF4JBridgeHandler) {
                return true;
            }
        }
        return false;
    }

}