gemfire-core/src/test/java/com/gemstone/gemfire/cache30/RegionAttributesTestCase.java

/*=========================================================================
 * Copyright (c) 2010-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.cache30;

import com.gemstone.gemfire.cache.*;
import com.gemstone.gemfire.cache.Region.Entry;

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.util.Properties;
//import com.gemstone.gemfire.cache.util.*;
//import java.util.*;

/**
 * An abstract class whose test methods test the functionality of a
 * {@link RegionAttributes}, {@link AttributesFactory}, and {@link
 * AttributesMutator}.
 *
 * @author David Whitlock
 *
 * @since 3.0
 */
public abstract class RegionAttributesTestCase
  extends RegionTestCase {

  public RegionAttributesTestCase(String name) {
    super(name);
  }

  protected static class TestExpiry implements CustomExpiry, Declarable {
      final Exception created = new Exception();

    public String toString() {
      final StringBuffer sb = new StringBuffer();
      sb.append("CustomExpiry from: <");
      OutputStream os = new OutputStream() {

        public void write(int b) throws IOException {
          sb.append((char)b);
        }
      };
      PrintStream ps = new PrintStream(os);
      created.printStackTrace(ps);
      sb.append(">");
      return sb.toString();
    }

    public ExpirationAttributes getExpiry(Entry entry) {
      return null;
    }

    public void init(Properties props) {
    }

    public void close() {
    }
  }
  // ///////////////////// Test Methods ///////////////////////

  /**
   * Tests that an {@link AttributesMutator} actually changes the
   * region's attributes.  Also tests the return values of the mutator
   * methods.
   */
  public void testAttributesMutator() throws CacheException {
    String name = this.getUniqueName();
    AttributesFactory fac = new AttributesFactory(getRegionAttributes());
    fac.setStatisticsEnabled(true);
    Region region = createRegion(name, fac.create());

    CacheListener listener = new TestCacheListener() { };
    CacheLoader loader = new TestCacheLoader() {
        public Object load2(LoaderHelper helper) {
          fail("Why was I invoked?");
          return null;
        }
      };
    CacheWriter writer = new TestCacheWriter() { };
    CustomExpiry customEntryIdle = new TestExpiry();
    CustomExpiry customTtl = new TestExpiry();
    ExpirationAttributes entryIdle =
      new ExpirationAttributes(5, ExpirationAction.DESTROY);
    ExpirationAttributes entryTTL =
      new ExpirationAttributes(6, ExpirationAction.INVALIDATE);
    ExpirationAttributes regionIdle =
      new ExpirationAttributes(7, ExpirationAction.DESTROY);
    ExpirationAttributes regionTTL =
      new ExpirationAttributes(8, ExpirationAction.INVALIDATE);

    AttributesMutator mutator = region.getAttributesMutator();
    assertEquals(region, mutator.getRegion());
    assertSame(region, mutator);

    mutator.setCacheListener(listener);
    mutator.setCacheLoader(loader);
    mutator.setCacheWriter(writer);
    mutator.setEntryIdleTimeout(entryIdle);
    mutator.setCustomEntryIdleTimeout(customEntryIdle);
    mutator.setEntryTimeToLive(entryTTL);
    mutator.setCustomEntryTimeToLive(customTtl);
    mutator.setRegionIdleTimeout(regionIdle);
    mutator.setRegionTimeToLive(regionTTL);

    RegionAttributes attrs = region.getAttributes();
    assertSame(region, attrs);

    assertEquals(listener, attrs.getCacheListener());
    assertEquals(loader, attrs.getCacheLoader());
    assertEquals(writer, attrs.getCacheWriter());
    assertEquals(entryIdle, attrs.getEntryIdleTimeout());
    assertEquals(entryTTL, attrs.getEntryTimeToLive());
    assertEquals(customEntryIdle, attrs.getCustomEntryIdleTimeout());
    assertEquals(customTtl, attrs.getCustomEntryTimeToLive());

    CacheListener listener2 = new TestCacheListener() { };
    CacheLoader loader2 = new TestCacheLoader() {
        public Object load2(LoaderHelper helper) {
          fail("Why was I invoked?");
          return null;
        }
      };
    CacheWriter writer2 = new TestCacheWriter() { };
    CustomExpiry customEntryIdle2 = new TestExpiry();
    CustomExpiry customTtl2 = new TestExpiry();
    ExpirationAttributes entryIdle2 =
      new ExpirationAttributes(5, ExpirationAction.DESTROY);
    ExpirationAttributes entryTTL2 =
      new ExpirationAttributes(6, ExpirationAction.INVALIDATE);
    ExpirationAttributes regionIdle2 =
      new ExpirationAttributes(7, ExpirationAction.DESTROY);
    ExpirationAttributes regionTTL2 =
      new ExpirationAttributes(8, ExpirationAction.INVALIDATE);

    assertEquals(listener, mutator.setCacheListener(listener2));
    assertEquals(loader, mutator.setCacheLoader(loader2));
    assertEquals(writer, mutator.setCacheWriter(writer2));
    assertEquals(entryIdle, mutator.setEntryIdleTimeout(entryIdle2));
    assertEquals(customEntryIdle, mutator.setCustomEntryIdleTimeout(customEntryIdle2));
    assertEquals(entryTTL, mutator.setEntryTimeToLive(entryTTL2));
    assertEquals(customTtl, mutator.setCustomEntryTimeToLive(customTtl2));
    assertEquals(regionIdle, mutator.setRegionIdleTimeout(regionIdle2));
    assertEquals(regionTTL, mutator.setRegionTimeToLive(regionTTL2));
  }

  /**
   * Tests sending <code>null</code> or bogus values to an {@link
   * AttributesMutator}.
   */
  public void testAttributesMutatorBogus() throws CacheException {
    String name = this.getUniqueName();
    Region region = createRegion(name);
    AttributesMutator mutator = region.getAttributesMutator();

    try {
      mutator.setEntryIdleTimeout(null);
      fail("Should have thrown an IllegalArgumentException");

    } catch (IllegalArgumentException ex) {
      // pass...
    }

    try {
      mutator.setEntryTimeToLive(null);
      fail("Should have thrown an IllegalArgumentException");

    } catch (IllegalArgumentException ex) {
      // pass...
    }

    try {
      mutator.setRegionIdleTimeout(null);
      fail("Should have thrown an IllegalArgumentException");

    } catch (IllegalArgumentException ex) {
      // pass...
    }

    try {
      mutator.setRegionTimeToLive(null);
      fail("Should have thrown an IllegalArgumentException");

    } catch (IllegalArgumentException ex) {
      // pass...
    }

    // Exception if stats not enabled
    try {
      mutator.setEntryIdleTimeout(new ExpirationAttributes(1, ExpirationAction.DESTROY));
      fail("Should have thrown an IllegalStateException");
    } catch (IllegalStateException ex) {
      // pass...
    }

    // Exception if stats not enabled
    try {
      mutator.setEntryTimeToLive(new ExpirationAttributes(1, ExpirationAction.DESTROY));
      fail("Should have thrown an IllegalStateException");
    } catch (IllegalStateException ex) {
      //pass
    }

    // Exception if stats not enabled
    try {
      mutator.setRegionIdleTimeout(new ExpirationAttributes(1, ExpirationAction.DESTROY));
      fail("Should have thrown an IllegalStateException");
    } catch (IllegalStateException ex) {
      // pass...
    }

    // Exception if stats not enabled
    try {
      mutator.setRegionTimeToLive(new ExpirationAttributes(1, ExpirationAction.DESTROY));
     fail("Should have thrown an IllegalStateException");

    } catch (IllegalStateException ex) {
      //pass

    }
  }

  /** Test to make sure region attributes take */
  public void testRegionAttributes() throws CacheException {
    // @todo for now just test concurrencyLevel, add tests for the rest
    AttributesFactory factory = new AttributesFactory();
    factory.setConcurrencyLevel(60);
    factory.setConcurrencyChecksEnabled(true);
    factory.setScope(Scope.DISTRIBUTED_ACK);
    RegionAttributes attrs = factory.create();
    String name = getUniqueName();
    Region region = createRegion(name, attrs);
    assertEquals(60, region.getAttributes().getConcurrencyLevel());
    assertTrue("expected concurrencyChecksEnabled to be true", region.getAttributes().getConcurrencyChecksEnabled());
  }
  
//  public void testCCEWithDNoAck() throws CacheException {
//    AttributesFactory factory = new AttributesFactory();
//    factory.setConcurrencyChecksEnabled(true);
//    factory.setScope(Scope.DISTRIBUTED_NO_ACK);
//    boolean caught = false;
//    try {
//      factory.create();
//    } catch (IllegalStateException expected) {
//      caught = true;
//    }
//    assertTrue("expected an IllegalStateException", caught);
//  }
  
  
  

}