gemfire-core/src/test/java/com/gemstone/gemfire/management/internal/cli/functions/ListDiskStoresFunctionJUnitTest.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
 * one or more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */
package com.gemstone.gemfire.management.internal.cli.functions;

import static org.junit.Assert.*;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.UUID;

import com.gemstone.gemfire.cache.Cache;
import com.gemstone.gemfire.cache.CacheClosedException;
import com.gemstone.gemfire.cache.execute.FunctionContext;
import com.gemstone.gemfire.cache.execute.ResultSender;
import com.gemstone.gemfire.distributed.DistributedMember;
import com.gemstone.gemfire.internal.cache.DiskStoreImpl;
import com.gemstone.gemfire.internal.cache.InternalCache;
import com.gemstone.gemfire.management.internal.cli.domain.DiskStoreDetails;
import com.gemstone.gemfire.test.junit.categories.UnitTest;

import org.jmock.Expectations;
import org.jmock.Mockery;
import org.jmock.lib.legacy.ClassImposteriser;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.experimental.categories.Category;

/**
 * The ListDiskStoreFunctionJUnitTest test suite class tests the contract and functionality of the
 * ListDiskStoresFunction.
 * </p>
 * @author jblum
 * @see com.gemstone.gemfire.internal.cache.DiskStoreImpl
 * @see com.gemstone.gemfire.management.internal.cli.domain.DiskStoreDetails
 * @see com.gemstone.gemfire.management.internal.cli.functions.ListDiskStoresFunction
 * @see org.jmock.Expectations
 * @see org.jmock.Mockery
 * @see org.junit.Assert
 * @see org.junit.Test
 * @since 7.0
 */
@Category(UnitTest.class)
public class ListDiskStoresFunctionJUnitTest {

  private Mockery mockContext;

  @Before
  public void setup() {
    mockContext = new Mockery() {{
      setImposteriser(ClassImposteriser.INSTANCE);
    }};
  }

  @After
  public void tearDown() {
    mockContext.assertIsSatisfied();
    mockContext = null;
  }

  protected DiskStoreDetails createDiskStoreDetails(final UUID id,
                                                    final String name,
                                                    final String memberName,
                                                    final String memberId) {
    return new DiskStoreDetails(id, name, memberId, memberName);
  }

  protected ListDiskStoresFunction createListDiskStoresFunction(final Cache cache) {
    return new TestListDiskStoresFunction(cache);
  }

  @Test
  @SuppressWarnings("unchecked")
  public void testExecute() throws Throwable {
    final UUID mockDiskStoreOneId = UUID.randomUUID();
    final UUID mockDiskStoreTwoId = UUID.randomUUID();
    final UUID mockDiskStoreThreeId = UUID.randomUUID();

    final String memberId = "mockMemberId";
    final String memberName = "mockMemberName";

    final InternalCache mockCache = mockContext.mock(InternalCache.class, "Cache");

    final DistributedMember mockMember = mockContext.mock(DistributedMember.class, "DistributedMember");

    final DiskStoreImpl mockDiskStoreOne = mockContext.mock(DiskStoreImpl.class, "DiskStoreOne");
    final DiskStoreImpl mockDiskStoreTwo = mockContext.mock(DiskStoreImpl.class, "DiskStoreTwo");
    final DiskStoreImpl mockDiskStoreThree = mockContext.mock(DiskStoreImpl.class, "DiskStoreThree");

    final Collection<DiskStoreImpl> mockDiskStores = new ArrayList<DiskStoreImpl>();

    mockDiskStores.add(mockDiskStoreOne);
    mockDiskStores.add(mockDiskStoreTwo);
    mockDiskStores.add(mockDiskStoreThree);

    final FunctionContext mockFunctionContext = mockContext.mock(FunctionContext.class, "FunctionContext");

    final TestResultSender testResultSender = new TestResultSender();

    mockContext.checking(new Expectations() {{
      oneOf(mockCache).getMyId();
      will(returnValue(mockMember));
      oneOf(mockCache).listDiskStoresIncludingRegionOwned();
      will(returnValue(mockDiskStores));
      exactly(3).of(mockMember).getId();
      will(returnValue(memberId));
      exactly(3).of(mockMember).getName();
      will(returnValue(memberName));
      oneOf(mockDiskStoreOne).getDiskStoreUUID();
      will(returnValue(mockDiskStoreOneId));
      oneOf(mockDiskStoreOne).getName();
      will(returnValue("ds-backup"));
      oneOf(mockDiskStoreTwo).getDiskStoreUUID();
      will(returnValue(mockDiskStoreTwoId));
      oneOf(mockDiskStoreTwo).getName();
      will(returnValue("ds-overflow"));
      oneOf(mockDiskStoreThree).getDiskStoreUUID();
      will(returnValue(mockDiskStoreThreeId));
      oneOf(mockDiskStoreThree).getName();
      will(returnValue("ds-persistence"));
      oneOf(mockFunctionContext).getResultSender();
      will(returnValue(testResultSender));
    }});

    final ListDiskStoresFunction function = createListDiskStoresFunction(mockCache);

    function.execute(mockFunctionContext);

    final List<?> results = testResultSender.getResults();

    assertNotNull(results);
    assertEquals(1, results.size());

    final Set<DiskStoreDetails> diskStoreDetails = (Set<DiskStoreDetails>) results.get(0);

    assertNotNull(diskStoreDetails);
    assertEquals(3, diskStoreDetails.size());
    diskStoreDetails.containsAll(Arrays.asList(
      createDiskStoreDetails(mockDiskStoreOneId, "ds-backup", memberId, memberName),
      createDiskStoreDetails(mockDiskStoreTwoId, "ds-overflow", memberId, memberName),
      createDiskStoreDetails(mockDiskStoreThreeId, "ds-persistence", memberId, memberName)));
  }

  @Test(expected = CacheClosedException.class)
  public void testExecuteOnMemberWithNoCache() throws Throwable {
    final FunctionContext mockFunctionContext = mockContext.mock(FunctionContext.class, "MockFunctionContext");

    final ListDiskStoresFunction testListDiskStoresFunction = new TestListDiskStoresFunction(mockContext.mock(Cache.class, "MockCache")) {
      @Override protected Cache getCache() {
        throw new CacheClosedException("Expected");
      }
    };

    final TestResultSender testResultSender = new TestResultSender();

    mockContext.checking(new Expectations() {{
      oneOf(mockFunctionContext).getResultSender();
      will(returnValue(testResultSender));
    }});

    testListDiskStoresFunction.execute(mockFunctionContext);

    try {
      testResultSender.getResults();
    }
    catch (CacheClosedException expected) {
      assertEquals("Expected", expected.getMessage());
      throw expected;
    }
  }

  @Test
  @SuppressWarnings("unchecked")
  public void testExecuteOnMemberHavingNoDiskStores() throws Throwable {
    final InternalCache mockCache = mockContext.mock(InternalCache.class, "Cache");

    final DistributedMember mockMember = mockContext.mock(DistributedMember.class, "DistributedMember");

    final FunctionContext mockFunctionContext = mockContext.mock(FunctionContext.class, "FunctionContext");

    final TestResultSender testResultSender = new TestResultSender();

    mockContext.checking(new Expectations() {{
      oneOf(mockCache).getMyId();
      will(returnValue(mockMember));
      oneOf(mockCache).listDiskStoresIncludingRegionOwned();
      will(returnValue(Collections.emptyList()));
      oneOf(mockFunctionContext).getResultSender();
      will(returnValue(testResultSender));
    }});

    final ListDiskStoresFunction function = createListDiskStoresFunction(mockCache);

    function.execute(mockFunctionContext);

    final List<?> results = testResultSender.getResults();

    assertNotNull(results);
    assertEquals(1, results.size());

    final Set<DiskStoreDetails> diskStoreDetails = (Set<DiskStoreDetails>) results.get(0);

    assertNotNull(diskStoreDetails);
    assertTrue(diskStoreDetails.isEmpty());
  }

  @Test
  @SuppressWarnings("unchecked")
  public void testExecuteOnMemberWithANonGemFireCache() throws Throwable {
    final Cache mockCache = mockContext.mock(Cache.class, "Cache");

    final FunctionContext mockFunctionContext = mockContext.mock(FunctionContext.class, "FunctionContext");

    final TestResultSender testResultSender = new TestResultSender();

    mockContext.checking(new Expectations() {{
      oneOf(mockFunctionContext).getResultSender();
      will(returnValue(testResultSender));
    }});

    final ListDiskStoresFunction function = createListDiskStoresFunction(mockCache);

    function.execute(mockFunctionContext);

    final List<?> results = testResultSender.getResults();

    assertNotNull(results);
    assertEquals(1, results.size());

    final Set<DiskStoreDetails> diskStoreDetails = (Set<DiskStoreDetails>) results.get(0);

    assertNotNull(diskStoreDetails);
    assertTrue(diskStoreDetails.isEmpty());
  }

  @Test(expected = RuntimeException.class)
  public void testExecuteThrowsRuntimeException() throws Throwable {
    final InternalCache mockCache = mockContext.mock(InternalCache.class, "Cache");

    final DistributedMember mockMember = mockContext.mock(DistributedMember.class, "DistributedMember");

    final FunctionContext mockFunctionContext = mockContext.mock(FunctionContext.class, "FunctionContext");

    final TestResultSender testResultSender = new TestResultSender();

    mockContext.checking(new Expectations() {{
      oneOf(mockCache).getMyId();
      will(returnValue(mockMember));
      oneOf(mockCache).listDiskStoresIncludingRegionOwned();
      will(throwException(new RuntimeException("expected")));
      oneOf(mockFunctionContext).getResultSender();
      will(returnValue(testResultSender));
    }});

    final ListDiskStoresFunction function = createListDiskStoresFunction(mockCache);

    function.execute(mockFunctionContext);

    try {
      testResultSender.getResults();
    }
    catch (Throwable throwable) {
      assertTrue(throwable instanceof RuntimeException);
      assertEquals("expected", throwable.getMessage());
      throw throwable;
    }
  }

  protected static class TestListDiskStoresFunction extends ListDiskStoresFunction {

    private final Cache cache;

    public TestListDiskStoresFunction(final Cache cache) {
      assert cache != null : "The Cache cannot be null!";
      this.cache = cache;
    }

    @Override protected Cache getCache() {
      return cache;
    }
  }

  protected static class TestResultSender implements ResultSender {

    private final List<Object> results = new LinkedList<Object>();

    private Throwable t;

    protected List<Object> getResults() throws Throwable {
      if (t != null) {
        throw t;
      }
      return Collections.unmodifiableList(results);
    }

    public void lastResult(final Object lastResult) {
      results.add(lastResult);
    }

    public void sendResult(final Object oneResult) {
      results.add(oneResult);
    }

    public void sendException(final Throwable t) {
      this.t = t;
    }
  }

}