gemfire-core/src/test/java/com/gemstone/gemfire/distributed/AbstractLauncherJUnitTest.java

/*
 * =========================================================================
 *  Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 *  This product is protected by U.S. and international copyright
 *  and intellectual property laws. Pivotal products are covered by
 *  more patents listed at http://www.pivotal.io/patents.
 * ========================================================================
 */
package com.gemstone.gemfire.distributed;

import static org.junit.Assert.*;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import java.util.concurrent.TimeUnit;

import com.gemstone.gemfire.distributed.internal.DistributionConfig;
import com.gemstone.gemfire.internal.lang.StringUtils;
import com.gemstone.gemfire.test.junit.categories.UnitTest;

import org.junit.Test;
import org.junit.experimental.categories.Category;

/**
 * The AbstractLauncherJUnitTest class is a test suite of unit tests testing the contract and functionality
 * of the AbstractLauncher class.
 * <p/>
 * @author John Blum
 * @author Kirk Lund
 * @see com.gemstone.gemfire.distributed.AbstractLauncher
 * @see com.gemstone.gemfire.distributed.CommonLauncherTestSuite
 * @see org.junit.Assert
 * @see org.junit.Test
 * @since 7.0
 */
@Category(UnitTest.class)
public class AbstractLauncherJUnitTest extends CommonLauncherTestSuite {

  protected AbstractLauncher<?> createAbstractLauncher(final String memberName, final String memberId) {
    return new TestServiceLauncher(memberName, memberId);
  }

  @Test
  public void testIsAttachAPINotFound() {
    final AbstractLauncher<?> launcher = createAbstractLauncher("012", "TestMember");

    assertTrue(launcher.isAttachAPINotFound(new NoClassDefFoundError(
      "Exception in thread \"main\" java.lang.NoClassDefFoundError: com/sun/tools/attach/AttachNotSupportedException")));
    assertTrue(launcher.isAttachAPINotFound(new ClassNotFoundException(
      "Caused by: java.lang.ClassNotFoundException: com.sun.tools.attach.AttachNotSupportedException")));
    assertTrue(launcher.isAttachAPINotFound(new NoClassDefFoundError(
      "Exception in thread \"main\" java.lang.NoClassDefFoundError: com/ibm/tools/attach/AgentNotSupportedException")));
    assertTrue(launcher.isAttachAPINotFound(new ClassNotFoundException(
      "Caused by: java.lang.ClassNotFoundException: com.ibm.tools.attach.AgentNotSupportedException")));
    assertFalse(launcher.isAttachAPINotFound(new IllegalArgumentException(
      "Caused by: java.lang.ClassNotFoundException: com.sun.tools.attach.AttachNotSupportedException")));
    assertFalse(launcher.isAttachAPINotFound(new IllegalStateException(
      "Caused by: java.lang.ClassNotFoundException: com.ibm.tools.attach.AgentNotSupportedException")));
    assertFalse(launcher.isAttachAPINotFound(new NoClassDefFoundError(
      "Exception in thread \"main\" java.lang.NoClassDefFoundError: com/companyx/app/service/MyServiceClass")));
    assertFalse(launcher.isAttachAPINotFound(new ClassNotFoundException(
      "Caused by: java.lang.ClassNotFoundException: com.companyx.app.attach.NutsNotAttachedException")));
  }

  @Test
  public void testIsSet() {
    final Properties properties = new Properties();

    assertFalse(properties.containsKey(DistributionConfig.NAME_NAME));
    assertFalse(AbstractLauncher.isSet(properties, DistributionConfig.NAME_NAME));

    properties.setProperty(DistributionConfig.NAME_NAME, "");

    assertTrue(properties.containsKey(DistributionConfig.NAME_NAME));
    assertFalse(AbstractLauncher.isSet(properties, DistributionConfig.NAME_NAME));

    properties.setProperty(DistributionConfig.NAME_NAME, "  ");

    assertTrue(properties.containsKey(DistributionConfig.NAME_NAME));
    assertFalse(AbstractLauncher.isSet(properties, DistributionConfig.NAME_NAME));

    properties.setProperty(DistributionConfig.NAME_NAME, "memberOne");

    assertTrue(AbstractLauncher.isSet(properties, DistributionConfig.NAME_NAME));
    assertFalse(AbstractLauncher.isSet(properties, "NaMe"));
  }

  @Test
  public void testLoadGemFirePropertiesWithNullURL() {
    final Properties properties = AbstractLauncher.loadGemFireProperties(null);
    assertNotNull(properties);
    assertTrue(properties.isEmpty());
  }

  @Test
  public void testLoadGemFirePropertiesWithNonExistingURL() throws MalformedURLException {
    final Properties properties = AbstractLauncher.loadGemFireProperties(new URL("file:///path/to/non_existing/gemfire.properties"));
    assertNotNull(properties);
    assertTrue(properties.isEmpty());
  }

  @Test
  public void testLoadGemFirePropertiesFromFile() throws IOException {
    final Properties expectedGemfireProperties = new Properties();

    expectedGemfireProperties.setProperty(DistributionConfig.NAME_NAME, "memberOne");
    expectedGemfireProperties.setProperty(DistributionConfig.GROUPS_NAME, "groupOne, groupTwo");

    final File gemfirePropertiesFile = writeGemFirePropertiesToFile(expectedGemfireProperties, "gemfire.properties",
      "Test gemfire.properties file for AbstractLauncherJUnitTest.testLoadGemFirePropertiesFromFile");

    assertNotNull(gemfirePropertiesFile);
    assertTrue(gemfirePropertiesFile.isFile());

    final Properties actualGemFireProperties = AbstractLauncher.loadGemFireProperties(
      gemfirePropertiesFile.toURI().toURL());

    assertNotNull(actualGemFireProperties);
    assertEquals(expectedGemfireProperties, actualGemFireProperties);
  }

  @Test
  public void testGetDistributedSystemProperties() {
    AbstractLauncher<?> launcher = createAbstractLauncher("memberOne", "1");

    assertNotNull(launcher);
    assertEquals("1", launcher.getMemberId());
    assertEquals("memberOne", launcher.getMemberName());

    Properties distributedSystemProperties = launcher.getDistributedSystemProperties();

    assertNotNull(distributedSystemProperties);
    assertTrue(distributedSystemProperties.containsKey(DistributionConfig.NAME_NAME));
    assertEquals("memberOne", distributedSystemProperties.getProperty(DistributionConfig.NAME_NAME));

    launcher = createAbstractLauncher(null, "22");

    assertNotNull(launcher);
    assertEquals("22", launcher.getMemberId());
    assertNull(launcher.getMemberName());

    distributedSystemProperties = launcher.getDistributedSystemProperties();

    assertNotNull(distributedSystemProperties);
    assertFalse(distributedSystemProperties.containsKey(DistributionConfig.NAME_NAME));

    launcher = createAbstractLauncher(StringUtils.EMPTY_STRING, "333");

    assertNotNull(launcher);
    assertEquals("333", launcher.getMemberId());
    assertEquals(StringUtils.EMPTY_STRING, launcher.getMemberName());

    distributedSystemProperties = launcher.getDistributedSystemProperties();

    assertNotNull(distributedSystemProperties);
    assertFalse(distributedSystemProperties.containsKey(DistributionConfig.NAME_NAME));

    launcher = createAbstractLauncher("  ", "4444");

    assertNotNull(launcher);
    assertEquals("4444", launcher.getMemberId());
    assertEquals("  ", launcher.getMemberName());

    distributedSystemProperties = launcher.getDistributedSystemProperties();

    assertNotNull(distributedSystemProperties);
    assertFalse(distributedSystemProperties.containsKey(DistributionConfig.NAME_NAME));
  }

  @Test
  public void testGetDistributedSystemPropertiesWithDefaults() {
    AbstractLauncher<?> launcher = createAbstractLauncher("TestMember", "123");

    assertNotNull(launcher);
    assertEquals("123", launcher.getMemberId());
    assertEquals("TestMember", launcher.getMemberName());

    Properties defaults = new Properties();

    defaults.setProperty("testKey", "testValue");

    Properties distributedSystemProperties = launcher.getDistributedSystemProperties(defaults);

    assertNotNull(distributedSystemProperties);
    assertEquals(launcher.getMemberName(), distributedSystemProperties.getProperty(DistributionConfig.NAME_NAME));
    assertEquals("testValue", distributedSystemProperties.getProperty("testKey"));
  }

  @Test
  public void testGetMember() {
    AbstractLauncher<?> launcher = createAbstractLauncher("memberOne", "123");

    assertNotNull(launcher);
    assertEquals("123", launcher.getMemberId());
    assertEquals("memberOne", launcher.getMemberName());
    assertEquals("memberOne", launcher.getMember());

    launcher = createAbstractLauncher(null, "123");

    assertNotNull(launcher);
    assertEquals("123", launcher.getMemberId());
    assertNull(launcher.getMemberName());
    assertEquals("123", launcher.getMember());

    launcher = createAbstractLauncher(StringUtils.EMPTY_STRING, "123");

    assertNotNull(launcher);
    assertEquals("123", launcher.getMemberId());
    assertEquals(StringUtils.EMPTY_STRING, launcher.getMemberName());
    assertEquals("123", launcher.getMember());

    launcher = createAbstractLauncher(" ", "123");

    assertNotNull(launcher);
    assertEquals("123", launcher.getMemberId());
    assertEquals(" ", launcher.getMemberName());
    assertEquals("123", launcher.getMember());

    launcher = createAbstractLauncher(null, StringUtils.EMPTY_STRING);

    assertNotNull(launcher);
    assertEquals(StringUtils.EMPTY_STRING, launcher.getMemberId());
    assertNull(launcher.getMemberName());
    assertNull(launcher.getMember());

    launcher = createAbstractLauncher(null, " ");

    assertNotNull(launcher);
    assertEquals(" ", launcher.getMemberId());
    assertNull(launcher.getMemberName());
    assertNull(launcher.getMember());
  }

  @Test
  public void testAbstractLauncherServiceStateToDaysHoursMinutesSeconds() {
    assertEquals("", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(null));
    assertEquals("0 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(0l));
    assertEquals("1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(1000l));
    assertEquals("1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(1999l));
    assertEquals("2 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(2001l));
    assertEquals("45 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(45000l));
    assertEquals("1 minute 0 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 1000l));
    assertEquals("1 minute 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(61 * 1000l));
    assertEquals("1 minute 30 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(90 * 1000l));
    assertEquals("2 minutes 0 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(120 * 1000l));
    assertEquals("2 minutes 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(121 * 1000l));
    assertEquals("2 minutes 15 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(135 * 1000l));
    assertEquals("1 hour 0 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 60 * 1000l));
    assertEquals("1 hour 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 60 * 1000l + 1000l));
    assertEquals("1 hour 15 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 60 * 1000l + 15000l));
    assertEquals("1 hour 1 minute 0 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 61 * 1000l));
    assertEquals("1 hour 1 minute 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 61 * 1000l + 1000l));
    assertEquals("1 hour 1 minute 45 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 61 * 1000l + 45000l));
    assertEquals("1 hour 2 minutes 0 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 62 * 1000l));
    assertEquals("1 hour 5 minutes 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 65 * 1000l + 1000l));
    assertEquals("1 hour 5 minutes 10 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 65 * 1000l + 10000l));
    assertEquals("1 hour 59 minutes 11 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(60 * 119 * 1000l + 11000l));
    assertEquals("1 day 1 hour 1 minute 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(
      TimeUnit.DAYS.toMillis(1) + TimeUnit.HOURS.toMillis(1) + TimeUnit.MINUTES.toMillis(1) + TimeUnit.SECONDS.toMillis(1)));
    assertEquals("1 day 5 hours 15 minutes 45 seconds", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(
      TimeUnit.DAYS.toMillis(1) + TimeUnit.HOURS.toMillis(5) + TimeUnit.MINUTES.toMillis(15) + TimeUnit.SECONDS.toMillis(45)));
    assertEquals("2 days 1 hour 30 minutes 1 second", AbstractLauncher.ServiceState.toDaysHoursMinutesSeconds(
      TimeUnit.DAYS.toMillis(2) + TimeUnit.HOURS.toMillis(1) + TimeUnit.MINUTES.toMillis(30) + TimeUnit.SECONDS.toMillis(1)));
  }

  protected static final class TestServiceLauncher extends AbstractLauncher<String> {

    private final String memberId;
    private final String memberName;

    public TestServiceLauncher(final String memberName, final String memberId) {
      this.memberId = memberId;
      this.memberName = memberName;
    }

    @Override
    boolean isAttachAPIOnClasspath() {
      return false;
    }

    public String getLogFileName() {
      throw new UnsupportedOperationException("Not Implemented!");
    }

    @Override
    public String getMemberId() {
      return memberId;
    }

    public String getMemberName() {
      return memberName;
    }

    public Integer getPid() {
      throw new UnsupportedOperationException("Not Implemented!");
    }

    public String getServiceName() {
      return "TestService";
    }

    public String getId() {
      throw new UnsupportedOperationException("Not Implemented!");
    }

    public void run() {
      throw new UnsupportedOperationException("Not Implemented!");
    }
  }

}