geode-dunit/src/main/java/org/apache/geode/cache30/CertifiableTestCacheListener.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.
 */

/**
 * Test class used to certify that a particular key has arrived in the cache This class is a great
 * way to reduce the liklihood of a race condition
 */
package org.apache.geode.cache30;

import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Properties;
import java.util.Set;

import org.apache.geode.LogWriter;
import org.apache.geode.cache.EntryEvent;
import org.apache.geode.internal.cache.xmlcache.Declarable2;
import org.apache.geode.test.awaitility.GeodeAwaitility;
import org.apache.geode.test.dunit.WaitCriterion;

public class CertifiableTestCacheListener extends TestCacheListener implements Declarable2 {
  public final Set destroys = Collections.synchronizedSet(new HashSet());
  public final Set creates = Collections.synchronizedSet(new HashSet());
  public final Set invalidates = Collections.synchronizedSet(new HashSet());
  public final Set updates = Collections.synchronizedSet(new HashSet());

  final LogWriter logger;

  public CertifiableTestCacheListener(LogWriter l) {
    this.logger = l;
  }

  /**
   * Clears the state of the listener, for consistent behavior this should only be called when there
   * is no activity on the Region
   */
  public void clearState() {
    this.destroys.clear();
    this.creates.clear();
    this.invalidates.clear();
    this.updates.clear();
  }

  @Override
  public List getEventHistory() {
    destroys.clear();
    creates.clear();
    invalidates.clear();
    updates.clear();
    return super.getEventHistory();
  }

  @Override
  public void afterCreate2(EntryEvent event) {
    this.creates.add(event.getKey());
  }

  @Override
  public void afterDestroy2(EntryEvent event) {
    this.destroys.add(event.getKey());
  }

  @Override
  public void afterInvalidate2(EntryEvent event) {
    Object key = event.getKey();
    // logger.fine("got invalidate for " + key);
    this.invalidates.add(key);
  }

  @Override
  public void afterUpdate2(EntryEvent event) {
    this.updates.add(event.getKey());
  }

  private static final String WAIT_PROPERTY = "CertifiableTestCacheListener.maxWaitTime";
  private static final int WAIT_DEFAULT = 30000;

  public static final long MAX_TIME = Integer.getInteger(WAIT_PROPERTY, WAIT_DEFAULT).intValue();;


  public boolean waitForCreated(final Object key) {
    WaitCriterion ev = new WaitCriterion() {
      @Override
      public boolean done() {
        return CertifiableTestCacheListener.this.creates.contains(key);
      }

      @Override
      public String description() {
        return "Waiting for key creation: " + key;
      }
    };
    GeodeAwaitility.await().untilAsserted(ev);
    return true;
  }

  public boolean waitForDestroyed(final Object key) {
    WaitCriterion ev = new WaitCriterion() {
      @Override
      public boolean done() {
        return CertifiableTestCacheListener.this.destroys.contains(key);
      }

      @Override
      public String description() {
        return "Waiting for key destroy: " + key;
      }
    };
    GeodeAwaitility.await().untilAsserted(ev);
    return true;
  }

  public boolean waitForInvalidated(final Object key) {
    WaitCriterion ev = new WaitCriterion() {
      @Override
      public boolean done() {
        return CertifiableTestCacheListener.this.invalidates.contains(key);
      }

      @Override
      public String description() {
        return "Waiting for key invalidate: " + key;
      }
    };
    GeodeAwaitility.await().untilAsserted(ev);
    return true;
  }

  public boolean waitForUpdated(final Object key) {
    WaitCriterion ev = new WaitCriterion() {
      @Override
      public boolean done() {
        return CertifiableTestCacheListener.this.updates.contains(key);
      }

      @Override
      public String description() {
        return "Waiting for key update: " + key;
      }
    };
    GeodeAwaitility.await().untilAsserted(ev);
    return true;
  }

  @Override
  public Properties getConfig() {
    return null;
  }

  @Override
  public void init(Properties props) {}
}