LoggingUtilsTest.java

/*
 * Copyright 2020 Amazon.com, Inc. or its affiliates.
 * 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 software.amazon.lambda.powertools.logging;

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

import org.apache.logging.log4j.ThreadContext;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;


class LoggingUtilsTest {

    @BeforeEach
    void setUp() {
        ThreadContext.clearAll();
    }

    @Test
    void shouldSetCustomKeyOnThreadContext() {
        LoggingUtils.appendKey("test", "value");

        assertThat(ThreadContext.getImmutableContext())
                .hasSize(1)
                .containsEntry("test", "value");
    }

    @Test
    void shouldSetCustomKeyAsMapOnThreadContext() {
        Map<String, String> customKeys = new HashMap<>();
        customKeys.put("test", "value");
        customKeys.put("test1", "value1");

        LoggingUtils.appendKeys(customKeys);

        assertThat(ThreadContext.getImmutableContext())
                .hasSize(2)
                .containsEntry("test", "value")
                .containsEntry("test1", "value1");
    }

    @Test
    void shouldRemoveCustomKeyOnThreadContext() {
        LoggingUtils.appendKey("test", "value");

        assertThat(ThreadContext.getImmutableContext())
                .hasSize(1)
                .containsEntry("test", "value");

        LoggingUtils.removeKey("test");

        assertThat(ThreadContext.getImmutableContext())
                .isEmpty();
    }

    @Test
    void shouldRemoveCustomKeysOnThreadContext() {
        Map<String, String> customKeys = new HashMap<>();
        customKeys.put("test", "value");
        customKeys.put("test1", "value1");

        LoggingUtils.appendKeys(customKeys);

        assertThat(ThreadContext.getImmutableContext())
                .hasSize(2)
                .containsEntry("test", "value")
                .containsEntry("test1", "value1");

        LoggingUtils.removeKeys("test", "test1");

        assertThat(ThreadContext.getImmutableContext())
                .isEmpty();
    }
}