gemfire-core/src/test/java/com/gemstone/gemfire/internal/cache/tier/sockets/EventIDVerificationInP2PDUnitTest.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.internal.cache.tier.sockets;

import java.util.Properties;

import com.gemstone.gemfire.cache.AttributesFactory;
import com.gemstone.gemfire.cache.Cache;
import com.gemstone.gemfire.cache.CacheFactory;
import com.gemstone.gemfire.cache.DataPolicy;
import com.gemstone.gemfire.cache.EntryEvent;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.RegionAttributes;
import com.gemstone.gemfire.cache.RegionEvent;
import com.gemstone.gemfire.cache.Scope;
import com.gemstone.gemfire.cache.util.CacheListenerAdapter;
import com.gemstone.gemfire.distributed.DistributedSystem;
import com.gemstone.gemfire.internal.cache.EventID;
import com.gemstone.gemfire.internal.cache.InternalCacheEvent;

import dunit.DistributedTestCase;
import dunit.Host;
import dunit.VM;

/**
 * Test to verify EventID generated from a peer is correctly passed on to the
 * other peer for create, update and destroy operations. In case of D-ACK or
 * GLOBAL scope the EventIDs should be same in P2P for a propagation of given
 * operation. In case of NO-ACK EventIDs should be different.Currently this test
 * is commented because of a bug.
 * 
 * @author Suyog Bhokare
 * 
 */

public class EventIDVerificationInP2PDUnitTest extends DistributedTestCase
{
  private static Cache cache = null;

  static VM vm0 = null;

  private static final String REGION_NAME = "EventIDVerificationInP2PDUnitTest_region";

  protected static EventID eventId;

  static boolean receiver = true;

  static boolean gotCallback = false;

  static int DISTRIBUTED_ACK = 1;

  static int GLOBAL = 2;

  /* Constructor */

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

  public void setUp() throws Exception
  {
    super.setUp();
    final Host host = Host.getHost(0);
    vm0 = host.getVM(0);
    receiver = false;
  }

  public void testEventIDsDACK() throws Exception
  {
    createServerCache(new Integer(DISTRIBUTED_ACK));
    vm0.invoke(EventIDVerificationInP2PDUnitTest.class, "createServerCache",
        new Object[] { new Integer(DISTRIBUTED_ACK) });
    verifyOperations();
  }

  public void testEventIDsGLOBAL() throws Exception
  {
    createServerCache(new Integer(GLOBAL));
    vm0.invoke(EventIDVerificationInP2PDUnitTest.class, "createServerCache",
        new Object[] { new Integer(GLOBAL) });
    verifyOperations();
  }

  public void _testEventIDsNOACK() throws Exception
  {
    createServerCache(new Integer(0));
    vm0.invoke(EventIDVerificationInP2PDUnitTest.class, "createServerCache",
        new Object[] { new Integer(0) });

    createEntry();
    Boolean pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertFalse(pass.booleanValue());
    put();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertFalse(pass.booleanValue());
    destroy();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertFalse(pass.booleanValue());
    destroyRegion();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertFalse(pass.booleanValue());
  }

  private void createCache(Properties props) throws Exception
  {
    DistributedSystem ds = getSystem(props);
    ds.disconnect();
    ds = getSystem(props);
    assertNotNull(ds);
    cache = CacheFactory.create(ds);
    assertNotNull(cache);
  }

  public static void createServerCache(Integer type) throws Exception
  {
    new EventIDVerificationInP2PDUnitTest("temp").createCache(new Properties());
    AttributesFactory factory = new AttributesFactory();
    if (type.intValue() == DISTRIBUTED_ACK)
      factory.setScope(Scope.DISTRIBUTED_ACK);
    if (type.intValue() == GLOBAL)
      factory.setScope(Scope.GLOBAL);
    else
      factory.setScope(Scope.DISTRIBUTED_NO_ACK);

    factory.setDataPolicy(DataPolicy.REPLICATE);
    factory.addCacheListener(new CacheListenerAdapter() {
      public void afterCreate(EntryEvent event)
      {

        eventId = ((InternalCacheEvent)event).getEventId();
        if (receiver) {
          synchronized (EventIDVerificationInP2PDUnitTest.class) {
            gotCallback = true;
            EventIDVerificationInP2PDUnitTest.class.notify();
          }
        }
      }

      public void afterUpdate(EntryEvent event)
      {
        eventId = ((InternalCacheEvent)event).getEventId();
        if (receiver) {
          synchronized (EventIDVerificationInP2PDUnitTest.class) {
            gotCallback = true;
            EventIDVerificationInP2PDUnitTest.class.notify();
          }
        }
      }

      public void afterDestroy(EntryEvent event)
      {
        eventId = ((InternalCacheEvent)event).getEventId();
        if (receiver) {
          synchronized (EventIDVerificationInP2PDUnitTest.class) {
            gotCallback = true;
            EventIDVerificationInP2PDUnitTest.class.notify();
          }
        }
      }

      public void afterRegionDestroy(RegionEvent event)
      {
        eventId = ((InternalCacheEvent)event).getEventId();
        if (receiver) {
          synchronized (EventIDVerificationInP2PDUnitTest.class) {
            gotCallback = true;
            EventIDVerificationInP2PDUnitTest.class.notify();
          }
        }
      }
      
      public void afterRegionInvalidate(RegionEvent event)
      {
        eventId = ((InternalCacheEvent)event).getEventId();
        if (receiver) {
          synchronized (EventIDVerificationInP2PDUnitTest.class) {
            gotCallback = true;
            EventIDVerificationInP2PDUnitTest.class.notify();
          }
        }
      }
    });

    RegionAttributes attrs = factory.create();
    cache.createRegion(REGION_NAME, attrs);

  }

  public static void createEntry()
  {
    try {
      Region r = cache.getRegion("/" + REGION_NAME);
      assertNotNull(r);

      if (!r.containsKey("key-1")) {
        r.create("key-1", "key-1");
      }
      // Verify that no invalidates occurred to this region
      assertEquals(r.getEntry("key-1").getValue(), "key-1");
    }
    catch (Exception ex) {
      fail("failed while createEntries()", ex);
    }
  }

  public static void put()
  {
    try {
      Region r = cache.getRegion("/" + REGION_NAME);
      assertNotNull(r);

      r.put("key-1", "vm0-key-1");
      // Verify that no invalidates occurred to this region
      assertEquals(r.getEntry("key-1").getValue(), "vm0-key-1");

    }
    catch (Exception ex) {
      fail("failed while r.put()", ex);
    }
  }

  public static void destroy()
  {
    try {
      Region r = cache.getRegion("/" + REGION_NAME);
      assertNotNull(r);
      r.destroy("key-1");
    }
    catch (Exception ex) {
      fail("test failed due to exception in destroy ", ex);
    }
  }

  public static void destroyRegion()
  {
    try {
      Region r = cache.getRegion("/" + REGION_NAME);
      assertNotNull(r);
      r.destroyRegion();
    }
    catch (Exception ex) {
      fail("test failed due to exception in destroyRegion ", ex);
    }
  }
  
  public static void invalidateRegion()
  {
    try {
      Region r = cache.getRegion("/" + REGION_NAME);
      assertNotNull(r);
      r.invalidateRegion();
    }
    catch (Exception ex) {
      fail("test failed due to exception in invalidateRegion ", ex);
    }
  }

  public static Boolean verifyResult(EventID correctId)
  {
    synchronized (EventIDVerificationInP2PDUnitTest.class) {
      if (!gotCallback) {
        try {
          EventIDVerificationInP2PDUnitTest.class.wait();
        }
        catch (InterruptedException e) {
          Thread.currentThread().interrupt();
          gotCallback = false;
          e.printStackTrace();
          return Boolean.FALSE;
        }
      }
      gotCallback = false;
    }
    boolean temp = correctId.equals(eventId);
    return new Boolean(temp);
  }


  public static void verifyOperations()
  {
    createEntry();
    Boolean pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertTrue(pass.booleanValue());
    put();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertTrue(pass.booleanValue());
    invalidateRegion();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertTrue(pass.booleanValue());
    destroy();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertTrue(pass.booleanValue());
    destroyRegion();
    pass = (Boolean)vm0.invoke(EventIDVerificationInP2PDUnitTest.class,
        "verifyResult", new Object[]{eventId} );
    assertTrue(pass.booleanValue());   
  }

  public void tearDown2() throws Exception
  {
    super.tearDown2();
    closeCache();
    vm0.invoke(EventIDVerificationInP2PDUnitTest.class, "closeCache");
  }

  public static void closeCache()
  {
    if (cache != null && !cache.isClosed()) {
      cache.close();
      cache.getDistributedSystem().disconnect();
    }
  }
}