geode-logging/src/test/java/org/apache/geode/logging/internal/executors/LoggingUncaughtExceptionHandlerTest.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.geode.logging.internal.executors;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

import java.lang.Thread.UncaughtExceptionHandler;

import org.apache.logging.log4j.Logger;
import org.junit.Test;
import org.junit.experimental.categories.Category;

import org.apache.geode.logging.internal.executors.LoggingUncaughtExceptionHandler.FailureSetter;
import org.apache.geode.logging.internal.executors.LoggingUncaughtExceptionHandler.Implementation;
import org.apache.geode.test.junit.categories.LoggingTest;

/**
 * Unit tests for {@link
 * org.apache.geode.logging.internal.executors.LoggingUncaughtExceptionHandler}.
 */
@Category(LoggingTest.class)
public class LoggingUncaughtExceptionHandlerTest {

  @Test
  public void verifyGetInstanceIsNotNull() {
    UncaughtExceptionHandler handler = LoggingUncaughtExceptionHandler.getInstance();

    assertThat(handler).isNotNull();
  }

  @Test
  public void verifyThatSetOnThreadSetsTheThreadsHandler() {
    Thread thread = new Thread();
    Implementation handler = new Implementation(null);

    handler.setOnThread(thread);

    assertThat(thread.getUncaughtExceptionHandler()).isSameAs(handler);
  }

  @Test
  public void verifyThatCallingUncaughtExceptionIncreasesTheCountByOne() {
    Logger logger = mock(Logger.class);
    Implementation handler = new Implementation(logger);
    int count = handler.getUncaughtExceptionsCount();

    handler.uncaughtException(null, null);

    assertThat(handler.getUncaughtExceptionsCount()).isEqualTo(count + 1);
  }

  @Test
  public void verifyThatCallingClearSetsTheCountToZero() {
    Logger logger = mock(Logger.class);
    Implementation handler = new Implementation(logger);
    // force the count to be non-zero
    handler.uncaughtException(null, null);

    handler.clearUncaughtExceptionsCount();

    assertThat(handler.getUncaughtExceptionsCount()).isEqualTo(0);
  }

  @Test
  public void verifyFatalMessageLoggedWhenUncaughtExceptionIsCalled() {
    Logger logger = mock(Logger.class);
    Thread thread = mock(Thread.class);
    Throwable throwable = mock(Throwable.class);
    Implementation handler = new Implementation(logger);

    handler.uncaughtException(thread, throwable);

    verify(logger).fatal("Uncaught exception in thread " + thread, throwable);
  }

  @Test
  public void verifyInfoMessageLoggedWhenUncaughtExceptionIsCalledWithTreatExceptionAsFatalFalse() {
    Logger logger = mock(Logger.class);
    Thread thread = new LoggingThread("test", false, () -> {
    }, false);
    Throwable throwable = mock(NoClassDefFoundError.class);
    Implementation handler = new Implementation(logger);

    handler.uncaughtException(thread, throwable);

    verify(logger).info(
        "Uncaught exception in thread {} this message can be disregarded if it occurred during an Application Server shutdown. The Exception message was: {}",
        thread, throwable);
  }

  @Test
  public void verifySetFailureCalledWhenUncaughtExceptionCalledWithVirtualMachineError() {
    Logger logger = mock(Logger.class);
    Thread thread = mock(Thread.class);
    VirtualMachineError error = mock(VirtualMachineError.class);
    FailureSetter failureSetter = mock(FailureSetter.class);
    Implementation handler = new Implementation(logger);
    handler.setFailureSetter(failureSetter);
    handler.uncaughtException(thread, error);

    verify(failureSetter).setFailure(error);
  }

}