geode-core/src/test/java/org/apache/geode/distributed/ServerLauncherTest.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.distributed;

import static org.apache.geode.test.awaitility.GeodeAwaitility.await;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyZeroInteractions;
import static org.mockito.Mockito.when;

import java.io.IOException;
import java.util.Collections;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;

import org.junit.Before;
import org.junit.Test;

import org.apache.geode.cache.Cache;
import org.apache.geode.cache.server.CacheServer;
import org.apache.geode.distributed.ServerLauncher.Builder;
import org.apache.geode.distributed.internal.InternalDistributedSystem;
import org.apache.geode.internal.cache.InternalCache;
import org.apache.geode.internal.cache.control.InternalResourceManager;
import org.apache.geode.internal.process.ControllableProcess;

/**
 * Unit tests for {@link ServerLauncher}.
 *
 * @since GemFire 7.0
 */
public class ServerLauncherTest {

  @Before
  public void before() {
    DistributedSystem.removeSystem(InternalDistributedSystem.getConnectedInstance());
  }

  @Test
  public void constructorCorrectlySetsServerLauncherParameters() {
    ServerLauncher launcher = new Builder().setServerBindAddress(null).setServerPort(11235)
        .setMaxThreads(10).setMaxConnections(100).setMaxMessageCount(5).setMessageTimeToLive(10000)
        .setSocketBufferSize(2048).setHostNameForClients("hostName4Clients")
        .setDisableDefaultServer(Boolean.FALSE).build();

    assertThat(launcher).isNotNull();
    assertThat(ServerLauncherParameters.INSTANCE).isNotNull();
    assertThat(ServerLauncherParameters.INSTANCE.getPort()).isEqualTo(11235);
    assertThat(ServerLauncherParameters.INSTANCE.getMaxThreads()).isEqualTo(10);
    assertThat(ServerLauncherParameters.INSTANCE.getBindAddress()).isEqualTo(null);
    assertThat(ServerLauncherParameters.INSTANCE.getMaxConnections()).isEqualTo(100);
    assertThat(ServerLauncherParameters.INSTANCE.getMaxMessageCount()).isEqualTo(5);
    assertThat(ServerLauncherParameters.INSTANCE.getSocketBufferSize()).isEqualTo(2048);
    assertThat(ServerLauncherParameters.INSTANCE.getMessageTimeToLive()).isEqualTo(10000);
    assertThat(ServerLauncherParameters.INSTANCE.getHostnameForClients())
        .isEqualTo("hostName4Clients");
    assertThat(ServerLauncherParameters.INSTANCE.isDisableDefaultServer()).isFalse();
  }

  @Test
  public void isServingReturnsTrueWhenCacheHasOneCacheServer() {
    Cache cache = mock(Cache.class);
    CacheServer cacheServer = mock(CacheServer.class);
    when(cache.getCacheServers()).thenReturn(Collections.singletonList(cacheServer));

    ServerLauncher launcher = new Builder().build();

    assertThat(launcher.isServing(cache)).isTrue();
  }

  @Test
  public void isServingReturnsFalseWhenCacheHasZeroCacheServers() {
    Cache cache = mock(Cache.class);
    when(cache.getCacheServers()).thenReturn(Collections.emptyList());

    ServerLauncher launcher = new Builder().build();

    assertThat(launcher.isServing(cache)).isFalse();
  }

  @Test
  public void reconnectedCacheIsClosed() {
    Cache cache = mock(Cache.class, "Cache");
    Cache reconnectedCache = mock(Cache.class, "ReconnectedCache");
    when(cache.isReconnecting()).thenReturn(false).thenReturn(false).thenReturn(true);
    when(cache.getCacheServers()).thenReturn(Collections.emptyList());
    when(cache.getReconnectedCache()).thenReturn(reconnectedCache);

    new Builder().setCache(cache).build().waitOnServer();

    verify(cache, atLeast(3)).isReconnecting();
    verify(cache).getReconnectedCache();
    verify(reconnectedCache).close();
  }

  @Test
  public void isRunningReturnsTrueWhenRunningIsSetTrue() {
    ServerLauncher launcher = new Builder().build();

    launcher.running.set(true);

    assertThat(launcher.isRunning()).isTrue();
  }

  @Test
  public void isRunningReturnsFalseWhenRunningIsSetFalse() {
    ServerLauncher launcher = new Builder().build();

    launcher.running.set(false);

    assertThat(launcher.isRunning()).isFalse();
  }

  @Test
  public void reconnectingDistributedSystemIsDisconnectedOnStop() {
    Cache cache = mock(Cache.class, "Cache");
    DistributedSystem system = mock(DistributedSystem.class, "DistributedSystem");
    Cache reconnectedCache = mock(Cache.class, "ReconnectedCache");
    when(cache.isReconnecting()).thenReturn(true);
    when(cache.getReconnectedCache()).thenReturn(reconnectedCache);
    when(reconnectedCache.isReconnecting()).thenReturn(true);
    when(reconnectedCache.getReconnectedCache()).thenReturn(null);
    when(reconnectedCache.getDistributedSystem()).thenReturn(system);

    ServerLauncher launcher = new Builder().setCache(cache).build();
    launcher.running.set(true);
    launcher.stop();

    verify(cache).isReconnecting();
    verify(cache).getReconnectedCache();
    verify(cache).isReconnecting();
    verify(cache).getReconnectedCache();
    verify(reconnectedCache).getDistributedSystem();
    verify(system).stopReconnecting();
    verify(reconnectedCache).close();
  }

  @Test
  public void isWaitingReturnsTrueWhenSystemIsConnected() {
    Cache cache = mock(Cache.class, "Cache");
    DistributedSystem system = mock(DistributedSystem.class, "DistributedSystem");
    when(cache.getDistributedSystem()).thenReturn(system);
    when(system.isConnected()).thenReturn(true);

    ServerLauncher launcher = new Builder().build();
    launcher.running.set(true);

    assertThat(launcher.isWaiting(cache)).isTrue();
  }

  @Test
  public void isWaitingReturnsFalseWhenSystemIsNotConnected() {
    Cache cache = mock(Cache.class, "Cache");
    DistributedSystem system = mock(DistributedSystem.class, "DistributedSystem");
    when(cache.getDistributedSystem()).thenReturn(system);
    when(system.isConnected()).thenReturn(false);
    when(cache.isReconnecting()).thenReturn(false);

    ServerLauncher launcher = new Builder().setMemberName("serverOne").build();
    launcher.running.set(true);

    assertThat(launcher.isWaiting(cache)).isFalse();
  }

  @Test
  public void isWaitingReturnsFalseByDefault() {
    ServerLauncher launcher = new Builder().build();

    assertThat(launcher.isWaiting(null)).isFalse();
  }

  @Test
  public void isWaitingReturnsFalseWhenNotRunning() {
    ServerLauncher launcher = new Builder().build();

    launcher.running.set(false);

    assertThat(launcher.isWaiting(null)).isFalse();
  }

  @Test
  public void isDisableDefaultServerReturnsFalseByDefault() {
    ServerLauncher launcher = new Builder().build();

    assertThat(launcher.isDisableDefaultServer()).isFalse();
  }

  @Test
  public void isDefaultServerEnabledForCacheReturnsTrueByDefault() {
    Cache cache = mock(Cache.class, "Cache");

    ServerLauncher launcher = new Builder().build();

    assertThat(launcher.isDefaultServerEnabled(cache)).isTrue();
  }

  @Test
  public void isDefaultServerEnabledForNullThrowsNullPointerException() {
    ServerLauncher launcher = new Builder().build();

    assertThatThrownBy(() -> launcher.isDefaultServerEnabled(null))
        .isInstanceOf(NullPointerException.class);
  }

  @Test
  public void isDefaultServerEnabledReturnsFalseWhenCacheServersExist() {
    Cache cache = mock(Cache.class, "Cache");
    CacheServer cacheServer = mock(CacheServer.class, "CacheServer");
    when(cache.getCacheServers()).thenReturn(Collections.singletonList(cacheServer));

    ServerLauncher launcher = new Builder().build();

    assertThat(launcher.isDefaultServerEnabled(cache)).isFalse();
  }

  @Test
  public void isDisableDefaultServerReturnsTrueWhenDisabled() {
    ServerLauncher launcher = new Builder().setDisableDefaultServer(true).build();

    assertThat(launcher.isDisableDefaultServer()).isTrue();
  }

  @Test
  public void isDefaultServerEnabledReturnsFalseWhenDefaultServerDisabledIsTrueAndNoCacheServersExist() {
    Cache cache = mock(Cache.class, "Cache");
    when(cache.getCacheServers()).thenReturn(Collections.emptyList());

    ServerLauncher launcher = new Builder().setDisableDefaultServer(true).build();

    assertThat(launcher.isDefaultServerEnabled(cache)).isFalse();
  }

  @Test
  public void isDefaultServerEnabledReturnsFalseWhenDefaultServerDisabledIsTrueAndCacheServersExist() {
    Cache cache = mock(Cache.class, "Cache");
    CacheServer cacheServer = mock(CacheServer.class, "CacheServer");
    when(cache.getCacheServers()).thenReturn(Collections.singletonList(cacheServer));

    ServerLauncher launcher = new Builder().setDisableDefaultServer(true).build();

    assertThat(launcher.isDefaultServerEnabled(cache)).isFalse();
  }

  @Test
  public void startCacheServerStartsCacheServerWithBuilderValues() throws IOException {
    Cache cache = createCache();
    CacheServer cacheServer = mock(CacheServer.class, "CacheServer");
    when(cache.getCacheServers()).thenReturn(Collections.emptyList());
    when(cache.addCacheServer()).thenReturn(cacheServer);
    ServerLauncher launcher = new Builder()
        .setServerBindAddress(null)
        .setServerPort(11235)
        .setMaxThreads(10)
        .setMaxConnections(100)
        .setMaxMessageCount(5)
        .setMessageTimeToLive(10000)
        .setSocketBufferSize(2048)
        .setHostNameForClients("hostName4Clients")
        .setServerLauncherCacheProvider((a, b) -> cache)
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .build();

    launcher.start();

    verify(cacheServer).setBindAddress(null);
    verify(cacheServer).setPort(eq(11235));
    verify(cacheServer).setMaxThreads(10);
    verify(cacheServer).setMaxConnections(100);
    verify(cacheServer).setMaximumMessageCount(5);
    verify(cacheServer).setMessageTimeToLive(10000);
    verify(cacheServer).setSocketBufferSize(2048);
    verify(cacheServer).setHostnameForClients("hostName4Clients");
    verify(cacheServer).start();
  }

  @Test
  public void startCacheServerDoesNothingWhenDefaultServerDisabled() {
    Cache cache = createCache();
    CacheServer cacheServer = mock(CacheServer.class, "CacheServer");
    when(cache.getCacheServers()).thenReturn(Collections.emptyList());
    when(cache.addCacheServer()).thenReturn(cacheServer);
    ServerLauncher launcher = new Builder()
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider((a, b) -> cache)
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .build();

    launcher.start();

    verifyZeroInteractions(cacheServer);
  }

  @Test
  public void startCacheServerDoesNothingWhenCacheServerAlreadyExists() {
    Cache cache = createCache();
    CacheServer cacheServer1 = mock(CacheServer.class, "CacheServer1");
    CacheServer cacheServer2 = mock(CacheServer.class, "CacheServer2");
    when(cache.getCacheServers()).thenReturn(Collections.singletonList(cacheServer1));
    when(cache.addCacheServer()).thenReturn(cacheServer1);
    ServerLauncher launcher = new Builder()
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider((a, b) -> cache)
        .build();

    launcher.start();

    verifyZeroInteractions(cacheServer2);
  }

  @Test
  public void startRunsCompletionActionAfterStartupTasksComplete() {
    Runnable startupCompletionAction = mock(Runnable.class);
    @SuppressWarnings("unchecked")
    Consumer<Throwable> startupExceptionAction = mock(Consumer.class);
    InternalResourceManager internalResourceManager = mock(InternalResourceManager.class);
    Cache cache = createCache(internalResourceManager);
    ServerLauncher serverLauncher = new Builder()
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider((a, b) -> cache)
        .setStartupCompletionAction(startupCompletionAction)
        .setStartupExceptionAction(startupExceptionAction)
        .build();

    when(internalResourceManager.allOfStartupTasks())
        .thenReturn(CompletableFuture.completedFuture(null));

    serverLauncher.start();

    verify(startupCompletionAction).run();
    verifyZeroInteractions(startupExceptionAction);
  }

  @Test
  public void startRunsExceptionActionAfterStartupTasksError() {
    Runnable startupCompletionAction = mock(Runnable.class);
    @SuppressWarnings("unchecked")
    Consumer<Throwable> startupExceptionAction = mock(Consumer.class);
    InternalResourceManager internalResourceManager = mock(InternalResourceManager.class);
    Cache cache = createCache(internalResourceManager);
    ServerLauncher serverLauncher = new Builder()
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider((a, b) -> cache)
        .setStartupExceptionAction(startupExceptionAction)
        .build();

    when(internalResourceManager.allOfStartupTasks())
        .thenReturn(completedExceptionallyFuture());

    serverLauncher.start();

    verify(startupExceptionAction).accept(any());
    verifyZeroInteractions(startupCompletionAction);
  }

  @Test
  public void startUsesCacheProviderFromBuilder() {
    ServerLauncherCacheProvider serverLauncherCacheProvider =
        mock(ServerLauncherCacheProvider.class);
    Cache cacheFromBuilder = createCache();
    when(serverLauncherCacheProvider.createCache(any(), any())).thenReturn(cacheFromBuilder);

    ServerLauncher serverLauncher = new Builder()
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider(serverLauncherCacheProvider)
        .build();
    serverLauncher.start();

    assertThat(serverLauncher.getCache()).isSameAs(cacheFromBuilder);
  }

  @Test
  public void startUsesControllableProcessFromBuilder() {
    ServerLauncherCacheProvider serverLauncherCacheProvider =
        mock(ServerLauncherCacheProvider.class);
    ControllableProcess controllableProcess = mock(ControllableProcess.class);
    Cache cacheFromBuilder = createCache();
    when(serverLauncherCacheProvider.createCache(any(), any())).thenReturn(cacheFromBuilder);

    ServerLauncher serverLauncher = new Builder()
        .setControllableProcessFactory(() -> controllableProcess)
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider(serverLauncherCacheProvider)
        .build();
    serverLauncher.start();

    serverLauncher.stop();

    verify(controllableProcess).stop(anyBoolean());
  }

  @Test
  public void startWaitsForStartupTasksToComplete() {
    ServerLauncherCacheProvider cacheProvider = mock(ServerLauncherCacheProvider.class);
    InternalResourceManager internalResourceManager = mock(InternalResourceManager.class);
    InternalCache cacheFromBuilder = createCache(internalResourceManager);
    CompletableFuture<Void> startupTasks = spy(new CompletableFuture<>());
    when(cacheProvider.createCache(any(), any()))
        .thenReturn(cacheFromBuilder);
    when(internalResourceManager.allOfStartupTasks())
        .thenReturn(startupTasks);

    ServerLauncher serverLauncher = new Builder()
        .setControllableProcessFactory(() -> mock(ControllableProcess.class))
        .setDisableDefaultServer(true)
        .setServerLauncherCacheProvider(cacheProvider)
        .build();

    CompletableFuture<Void> serverLauncherStart = CompletableFuture.runAsync(serverLauncher::start);

    await().untilAsserted(() -> verify(startupTasks).thenRun(any()));
    assertThat(serverLauncherStart).isNotDone();

    startupTasks.complete(null);

    await().untilAsserted(() -> assertThat(serverLauncherStart).isDone());
  }

  private CompletableFuture<Void> completedExceptionallyFuture() {
    CompletableFuture<Void> completedExceptionallyFuture = new CompletableFuture<>();
    completedExceptionallyFuture.completeExceptionally(new RuntimeException());
    return completedExceptionallyFuture;
  }

  private InternalCache createCache() {
    return createCache(mock(InternalResourceManager.class));
  }

  private InternalCache createCache(InternalResourceManager internalResourceManager) {
    InternalCache cache = mock(InternalCache.class);
    CacheServer cacheServer = mock(CacheServer.class);

    when(cache.addCacheServer()).thenReturn(cacheServer);
    when(cache.getResourceManager()).thenReturn(internalResourceManager);
    when(internalResourceManager.allOfStartupTasks())
        .thenReturn(CompletableFuture.completedFuture(null));

    return cache;
  }
}