log4j-core/src/test/java/org/apache/logging/log4j/core/util/ContextDataProviderTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.logging.log4j.core.util;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.config.ConfigurationFactory;
import org.apache.logging.log4j.core.impl.ThreadContextDataInjector;
import org.apache.logging.log4j.test.appender.ListAppender;
import org.junit.BeforeClass;
import org.junit.Test;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

/**
 *
 */
public class ContextDataProviderTest {

    private static Logger logger;
    private static ListAppender appender;

    @BeforeClass
    public static void beforeClass() {
        ThreadContextDataInjector.contextDataProviders.add(new TestContextDataProvider());
        System.setProperty(ConfigurationFactory.CONFIGURATION_FILE_PROPERTY, "target/test-classes/log4j-contextData.xml");
        LoggerContext loggerContext = (LoggerContext) LogManager.getContext(false);
        logger = loggerContext.getLogger(ContextDataProviderTest.class.getName());
        appender = loggerContext.getConfiguration().getAppender("List");
        assertNotNull("No List appender", appender);
    }

    @Test
    public void testContextProvider() throws Exception {
        ThreadContext.put("loginId", "jdoe");
        logger.debug("This is a test");
        List<String> messages = appender.getMessages();
        assertEquals("Incorrect number of messages", 1, messages.size());
        assertTrue("Context data missing", messages.get(0).contains("testKey=testValue"));
    }

    private static class TestContextDataProvider implements ContextDataProvider {

        @Override
        public Map<String, String> supplyContextData() {
            Map<String, String> contextData = new HashMap<>();
            contextData.put("testKey", "testValue");
            return contextData;
        }

    }
}