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

import org.apache.geode.cache.CacheCallback;
import org.apache.geode.test.awaitility.GeodeAwaitility;
import org.apache.geode.test.dunit.WaitCriterion;

/**
 * An abstract superclass of implementation of GemFire cache callbacks that are used for testing.
 *
 * @see #wasInvoked
 *
 * @since GemFire 3.0
 */
public abstract class TestCacheCallback implements CacheCallback {
  // differentiate between callback being closed and callback
  // event methods being invoked
  private volatile boolean isClosed = false;

  /** Was a callback event method invoked? */
  volatile boolean invoked = false;

  protected volatile Throwable callbackError = null;

  /**
   * Returns whether or not one of this <code>CacheListener</code> methods was invoked. Before
   * returning, the <code>invoked</code> flag is cleared.
   */
  public boolean wasInvoked() {
    checkForError();
    boolean value = this.invoked;
    if (value) {
      this.invoked = false;
    }
    return value;
  }

  /**
   * Waits up to timeoutMs milliseconds for the listener to be invoked. Calls wasInvoked and returns
   * its value
   */
  public boolean waitForInvocation(int timeoutMs) {
    return waitForInvocation(timeoutMs, 200);
  }

  public boolean waitForInvocation(int timeoutMs, long interval) {
    if (!this.invoked) {
      WaitCriterion ev = new WaitCriterion() {
        @Override
        public boolean done() {
          return invoked;
        }

        @Override
        public String description() {
          return "listener was never invoked";
        }
      };
      GeodeAwaitility.await().untilAsserted(ev);
    }
    return wasInvoked();
  }

  public boolean isClosed() {
    checkForError();
    return this.isClosed;
  }

  @Override
  public void close() {
    this.isClosed = true;
    close2();
  }

  /**
   * This method will do nothing. Note that it will not throw an exception.
   */
  public void close2() {

  }

  private void checkForError() {
    if (this.callbackError != null) {
      AssertionError error = new AssertionError("Exception occurred in callback");
      error.initCause(this.callbackError);
      throw error;
    }
  }
}