slf4j-api/src/test/java/org/slf4j/helpers/MDCAdapterTestBase.java

/**
 * Copyright (c) 2004-2013 QOS.ch, Copyright (C) 2015 Google Inc.
 * All rights reserved.
 *
 * Permission is hereby granted, free  of charge, to any person obtaining
 * a  copy  of this  software  and  associated  documentation files  (the
 * "Software"), to  deal in  the Software without  restriction, including
 * without limitation  the rights to  use, copy, modify,  merge, publish,
 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
 * permit persons to whom the Software  is furnished to do so, subject to
 * the following conditions:
 *
 * The  above  copyright  notice  and  this permission  notice  shall  be
 * included in all copies or substantial portions of the Software.
 *
 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.slf4j.helpers;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;

import java.lang.Thread.UncaughtExceptionHandler;
import java.util.Map;

import org.junit.After;
import org.junit.Test;
import org.slf4j.spi.MDCAdapter;

/**
 * Tests for {@link BasicMDCAdapter}
 * 
 * @author Lukasz Cwik
 */
public class MDCAdapterTestBase {
    
    protected MDCAdapter mdc = instantiateMDC();

    
    
    protected MDCAdapter instantiateMDC() {
        return new BasicMDCAdapter();
    }
    
    // leave MDC clean
    @After
    public void tearDown() throws Exception {
        mdc.clear();
    }

    @Test
    public void testSettingAndGettingWithMDC() {
        assertNull(mdc.get("testKey"));
        mdc.put("testKey", "testValue");
        assertEquals(mdc.get("testKey"), "testValue");
    }

    @Test
    public void testOverwritingAKeyInMDC() {
        assertNull(mdc.get("testKey"));
        mdc.put("testKey", "testValue");
        mdc.put("testKey", "differentTestValue");
        assertEquals(mdc.get("testKey"), "differentTestValue");
    }

    @Test
    public void testGetCopyOfContextMapFromMDC() {
        mdc.put("testKey", "testValue");
        Map<String, String> copy = mdc.getCopyOfContextMap();
        mdc.put("anotherTestKey", "anotherTestValue");
        assertFalse(copy.size() == mdc.getCopyOfContextMap().size());
    }

    @Test
    public void testMDCInheritsValuesFromParentThread() throws Exception {
        mdc.put("parentKey", "parentValue");
        runAndWait(() -> {
            mdc.put("childKey", "childValue");
            assertEquals("parentValue", mdc.get("parentKey"));
        });
    }

    @Test
    public void testMDCDoesntGetValuesFromChildThread() throws Exception {
        mdc.put("parentKey", "parentValue");
        runAndWait(() -> mdc.put("childKey", "childValue"));
        assertEquals("parentValue", mdc.get("parentKey"));
        assertNull(mdc.get("childKey"));
    }

    
    @Test
    public void testInvokingSetContextMap_WithANullMap_SLF4J_414() {
        mdc.setContextMap(null);
    }
    
    @Test
    public void testMDCChildThreadCanOverwriteParentThread() throws Exception {
        mdc.put("sharedKey", "parentValue");
        runAndWait(() -> {
            assertEquals("parentValue", mdc.get("sharedKey"));
            mdc.put("sharedKey", "childValue");
            assertEquals("childValue", mdc.get("sharedKey"));
        });
        assertEquals("parentValue", mdc.get("sharedKey"));
    }

    private void runAndWait(Runnable runnable) {
        RecordingExceptionHandler handler = new RecordingExceptionHandler();
        Thread thread = new Thread(runnable);
        thread.setUncaughtExceptionHandler(handler);
        thread.start();
        try {
            thread.join();
        } catch (Throwable t) {
            fail("Unexpected failure in child thread:" + t.getMessage());
        }
        assertFalse(handler.getMessage(), handler.hadException());
    }

    /** A {@link UncaughtExceptionHandler} that records whether the thread threw an exception. */
    private static class RecordingExceptionHandler implements UncaughtExceptionHandler {
        private Throwable exception;

        @Override
        public void uncaughtException(Thread t, Throwable e) {
            exception = e;
        }

        boolean hadException() {
            return exception != null;
        }

        String getMessage() {
            return exception != null ? exception.getMessage() : "";
        }
    }
}