package org.infinispan.notifications.cachelistener;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyString;
import static org.mockito.Mockito.RETURNS_DEEP_STUBS;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.withSettings;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.infinispan.Cache;
import org.infinispan.CacheStream;
import org.infinispan.compat.TypeConverter;
import org.infinispan.configuration.cache.CacheMode;
import org.infinispan.configuration.cache.Configuration;
import org.infinispan.container.InternalEntryFactoryImpl;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.container.entries.ImmortalCacheEntry;
import org.infinispan.container.entries.TransientMortalCacheEntry;
import org.infinispan.context.InvocationContext;
import org.infinispan.context.impl.NonTxInvocationContext;
import org.infinispan.distribution.DistributionManager;
import org.infinispan.interceptors.impl.WrappedByteArrayConverter;
import org.infinispan.interceptors.locking.ClusteringDependentLogic;
import org.infinispan.lifecycle.ComponentStatus;
import org.infinispan.metadata.Metadata;
import org.infinispan.notifications.Listener;
import org.infinispan.notifications.cachelistener.annotation.CacheEntryCreated;
import org.infinispan.notifications.cachelistener.annotation.CacheEntryModified;
import org.infinispan.notifications.cachelistener.annotation.CacheEntryRemoved;
import org.infinispan.notifications.cachelistener.cluster.ClusterEventManager;
import org.infinispan.notifications.cachelistener.event.CacheEntryEvent;
import org.infinispan.notifications.cachelistener.event.Event;
import org.infinispan.notifications.cachelistener.filter.CacheEventConverter;
import org.infinispan.notifications.cachelistener.filter.CacheEventFilter;
import org.infinispan.notifications.cachelistener.filter.EventType;
import org.infinispan.test.AbstractInfinispanTest;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import org.mockito.Mockito;
import org.mockito.stubbing.Answer;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
@Test(groups = "unit", testName = "notifications.cachelistener.BaseCacheNotifierImplInitialTransferTest")
public abstract class BaseCacheNotifierImplInitialTransferTest extends AbstractInfinispanTest {
CacheNotifierImpl n;
Cache mockCache;
InvocationContext ctx;
protected CacheMode cacheMode;
protected BaseCacheNotifierImplInitialTransferTest(CacheMode mode) {
if (mode.isDistributed()) {
throw new IllegalArgumentException("This test only works with non distributed cache modes");
}
this.cacheMode = mode;
}
private enum Operation {
PUT(Event.Type.CACHE_ENTRY_MODIFIED) {
@Override
public void raiseEvent(CacheNotifier notifier, Object key, Object prevValue, Object newValue,
InvocationContext ctx) {
notifier.notifyCacheEntryModified(key, newValue, null, prevValue, null, true, ctx, null);
notifier.notifyCacheEntryModified(key, newValue, null, prevValue, null, false, ctx, null);
}
}, REMOVE(Event.Type.CACHE_ENTRY_REMOVED) {
@Override
public void raiseEvent(CacheNotifier notifier, Object key, Object prevValue, Object newValue,
InvocationContext ctx) {
notifier.notifyCacheEntryRemoved(key, prevValue, null, true, ctx, null);
notifier.notifyCacheEntryRemoved(key, prevValue, null, false, ctx, null);
}
}, CREATE(Event.Type.CACHE_ENTRY_CREATED) {
@Override
public void raiseEvent(CacheNotifier notifier, Object key, Object prevValue, Object newValue,
InvocationContext ctx) {
notifier.notifyCacheEntryCreated(key, newValue, null, true, ctx, null);
notifier.notifyCacheEntryCreated(key, newValue, null, false, ctx, null);
}
};
private final Event.Type type;
Operation(Event.Type type) {
this.type = type;
}
public Event.Type getType() {
return type;
}
public abstract void raiseEvent(CacheNotifier notifier, Object key, Object prevValue, Object newValue,
InvocationContext ctx);
}
@BeforeMethod
public void setUp() {
n = new CacheNotifierImpl();
mockCache = mock(Cache.class, RETURNS_DEEP_STUBS);
Configuration config = mock(Configuration.class, RETURNS_DEEP_STUBS);
when(config.clustering().cacheMode()).thenReturn(cacheMode);
when(mockCache.getAdvancedCache().getStatus()).thenReturn(ComponentStatus.INITIALIZING);
Answer answer = i -> Mockito.mock(i.getArgument(0));
when(mockCache.getAdvancedCache().getComponentRegistry().getComponent(any(Class.class))).then(answer);
when(mockCache.getAdvancedCache().getComponentRegistry().getComponent(TypeConverter.class)).thenReturn(
new WrappedByteArrayConverter());
when(mockCache.getAdvancedCache().getComponentRegistry().getComponent(any(Class.class), anyString())).then(answer);
ClusteringDependentLogic.LocalLogic cdl = new ClusteringDependentLogic.LocalLogic();
cdl.init(null);
n.injectDependencies(mockCache, cdl, null, config,
mock(DistributionManager.class), new InternalEntryFactoryImpl(),
mock(ClusterEventManager.class));
n.start();
ctx = new NonTxInvocationContext(null);
}
// TODO: commented out until local listners support includeCurrentState
// public void testSimpleCacheStartingNonClusterListener() {
// testSimpleCacheStarting(new StateListenerNotClustered());
// }
public void testSimpleCacheStartingClusterListener() {
testSimpleCacheStarting(new StateListenerClustered());
}
private void testSimpleCacheStarting(final StateListener<String, String> listener) {
final List<CacheEntry<String, String>> initialValues = new ArrayList<>(10);
for (int i = 0; i < 10; i++) {
String key = "key-" + i;
String value = "value-" + i;
initialValues.add(new ImmortalCacheEntry(key, value));
}
CacheStream mockStream = mockStream();
doReturn(initialValues.iterator()).when(mockStream).iterator();
when(mockCache.getAdvancedCache().cacheEntrySet().stream()).thenReturn(mockStream);
n.addListener(listener);
verifyEvents(isClustered(listener), listener, initialValues);
}
public void testFilterConverterUnusedDuringIteration() {
testFilterConverterUnusedDuringIteration(new StateListenerClustered());
}
private void testFilterConverterUnusedDuringIteration(final StateListener<String, String> listener) {
final List<CacheEntry<String, String>> initialValues = new ArrayList<CacheEntry<String, String>>(10);
for (int i = 0; i < 10; i++) {
String key = "key-" + i;
String value = "value-" + i;
initialValues.add(new ImmortalCacheEntry(key, value));
}
// Note we don't actually use the filter/converter to retrieve values since it is being mocked, thus we can assert
// the filter/converter are not used by us
CacheStream mockStream = mockStream();
doReturn(initialValues.iterator()).when(mockStream).iterator();
when(mockCache.getAdvancedCache().cacheEntrySet().stream()).thenReturn(mockStream);
CacheEventFilter filter = mock(CacheEventFilter.class, withSettings().serializable());
CacheEventConverter converter = mock(CacheEventConverter.class, withSettings().serializable());
n.addListener(listener, filter, converter);
verifyEvents(isClustered(listener), listener, initialValues);
verify(filter, never()).accept(any(), any(), any(Metadata.class), any(), any(Metadata.class),
any(EventType.class));
verify(converter, never()).convert(any(), any(), any(Metadata.class), any(), any(Metadata.class),
any(EventType.class));
}
public void testMetadataAvailable() {
final List<CacheEntry<String, String>> initialValues = new ArrayList<>(10);
for (int i = 0; i < 10; i++) {
String key = "key-" + i;
String value = "value-" + i;
initialValues.add(new TransientMortalCacheEntry(key, value, i, -1, System.currentTimeMillis()));
}
// Note we don't actually use the filter/converter to retrieve values since it is being mocked, thus we can assert
// the filter/converter are not used by us
CacheStream mockStream = mockStream();
doReturn(initialValues.iterator()).when(mockStream).iterator();
when(mockCache.getAdvancedCache().cacheEntrySet().stream()).thenReturn(mockStream);
CacheEventFilter filter = mock(CacheEventFilter.class, withSettings().serializable());
CacheEventConverter converter = mock(CacheEventConverter.class, withSettings().serializable());
StateListener<String, String> listener = new StateListenerClustered();
n.addListener(listener, filter, converter);
verifyEvents(isClustered(listener), listener, initialValues);
for (CacheEntryEvent<String, String> event : listener.events) {
String key = event.getKey();
Metadata metadata = event.getMetadata();
assertNotNull(metadata);
assertEquals(metadata.lifespan(), -1);
assertEquals(metadata.maxIdle(), Long.parseLong(key.substring(4)));
}
}
private void verifyEvents(boolean isClustered, StateListener<String, String> listener,
List<CacheEntry<String, String>> expected) {
assertEquals(listener.events.size(), isClustered ? expected.size() : expected.size() * 2);
int eventPosition = 0;
for (CacheEntryEvent<String, String> event : listener.events) {
// Even checks means it will be post and have a value - note we force every check to be
// even for clustered since those should always be post
int position;
boolean isPost;
if (isClustered) {
isPost = true;
position = eventPosition;
} else {
isPost = (eventPosition & 1) == 1;
position = eventPosition / 2;
}
assertEquals(event.getType(), Event.Type.CACHE_ENTRY_CREATED);
assertEquals(event.getKey(), expected.get(position).getKey());
assertEquals(event.isPre(), !isPost);
if (isPost) {
assertEquals(event.getValue(), expected.get(position).getValue());
} else {
assertNull(event.getValue());
}
eventPosition++;
}
}
// TODO: commented out until local listners support includeCurrentState
// public void testCreateAfterIterationBeganButNotIteratedValueYetNotClustered()
// throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException {
// testModificationAfterIterationBeganButNotIteratedValueYet(new StateListenerNotClustered(), Operation.CREATE);
// }
public void testCreateAfterIterationBeganButNotIteratedValueYetClustered()
throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException {
testModificationAfterIterationBeganButNotIteratedValueYet(new StateListenerClustered(), Operation.CREATE);
}
// TODO: commented out until local listners support includeCurrentState
// public void testRemoveAfterIterationBeganButNotIteratedValueYetNotClustered()
// throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException {
// testModificationAfterIterationBeganButNotIteratedValueYet(new StateListenerNotClustered(), Operation.REMOVE);
// }
public void testRemoveAfterIterationBeganButNotIteratedValueYetClustered()
throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException {
testModificationAfterIterationBeganButNotIteratedValueYet(new StateListenerClustered(), Operation.REMOVE);
}
// TODO: commented out until local listners support includeCurrentState
// public void testModificationAfterIterationBeganButNotIteratedValueYetNotClustered()
// throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException {
// testModificationAfterIterationBeganButNotIteratedValueYet(new StateListenerNotClustered(), Operation.PUT);
// }
public void testModificationAfterIterationBeganButNotIteratedValueYetClustered()
throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException {
testModificationAfterIterationBeganButNotIteratedValueYet(new StateListenerClustered(), Operation.PUT);
}
/**
* This test is to verify that the modification event replaces the current value for the key
*/
private void testModificationAfterIterationBeganButNotIteratedValueYet(final StateListener<String, String> listener,
Operation operation) throws InterruptedException,
TimeoutException, BrokenBarrierException, ExecutionException {
final List<CacheEntry<String, String>> initialValues = new ArrayList<>();
for (int i = 0; i < 10; i++) {
String key = "key-" + i;
String value = "value-" + i;
initialValues.add(new ImmortalCacheEntry(key, value));
}
final CyclicBarrier barrier = new CyclicBarrier(2);
CacheStream mockStream = mockStream();
doAnswer(i -> {
barrier.await(10, TimeUnit.SECONDS);
barrier.await(10, TimeUnit.SECONDS);
return initialValues.iterator();
}).when(mockStream).iterator();
when(mockCache.getAdvancedCache().cacheEntrySet().stream()).thenReturn(mockStream);
Future<Void> future = fork(() -> {
n.addListener(listener);
return null;
});
barrier.await(10, TimeUnit.SECONDS);
switch (operation) {
case REMOVE:
String key = "key-3";
Object prevValue = initialValues.get(3).getValue();
n.notifyCacheEntryRemoved(key, prevValue, null, true, ctx, null);
n.notifyCacheEntryRemoved(key, prevValue, null, false, ctx, null);
// We shouldn't see the event at all now!
initialValues.remove(3);
break;
case CREATE:
key = "new-key";
String value = "new-value";
n.notifyCacheEntryCreated(key, value, null, true, ctx, null);
n.notifyCacheEntryCreated(key, value, null, false, ctx, null);
// Need to add a new value to the end
initialValues.add(new ImmortalCacheEntry(key, value));
break;
case PUT:
key = "key-3";
value = "value-3-changed";
n.notifyCacheEntryModified(key, initialValues.get(3).getValue(), null, value, null, true, ctx, null);
n.notifyCacheEntryModified(key, initialValues.get(3).getValue(), null, value, null, false, ctx, null);
// Now remove the old value and put in the new one
initialValues.remove(3);
initialValues.add(3, new ImmortalCacheEntry(key, value));
break;
default:
throw new IllegalArgumentException("Unsupported Operation provided " + operation);
}
// Now let the iteration complete
barrier.await(10, TimeUnit.SECONDS);
future.get(10, TimeUnit.MINUTES);
verifyEvents(isClustered(listener), listener, initialValues);
}
// TODO: commented out until local listners support includeCurrentState
// public void testCreateAfterIterationBeganAndIteratedValueNotClustered()
// throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException, IOException {
// testModificationAfterIterationBeganAndIteratedValue(new StateListenerNotClustered(), Operation.CREATE);
// }
public void testCreateAfterIterationBeganAndIteratedValueClustered() throws Exception {
testModificationAfterIterationBeganAndIteratedValue(new StateListenerClustered(), Operation.CREATE);
}
// TODO: commented out until local listners support includeCurrentState
// public void testRemoveAfterIterationBeganAndIteratedValueNotClustered()
// throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException, IOException {
// testModificationAfterIterationBeganAndIteratedValue(new StateListenerNotClustered(), Operation.REMOVE);
// }
public void testRemoveAfterIterationBeganAndIteratedValueClustered()throws Exception {
testModificationAfterIterationBeganAndIteratedValue(new StateListenerClustered(), Operation.REMOVE);
}
// TODO: commented out until local listners support includeCurrentState
// public void testModificationAfterIterationBeganAndIteratedValueNotClustered()
// throws InterruptedException, BrokenBarrierException, TimeoutException, ExecutionException, IOException {
// testModificationAfterIterationBeganAndIteratedValue(new StateListenerNotClustered(), Operation.PUT);
// }
public void testModificationAfterIterationBeganAndIteratedValueClustered() throws Exception {
testModificationAfterIterationBeganAndIteratedValue(new StateListenerClustered(), Operation.PUT);
}
/**
* This test is to verify that the modification event is sent after the creation event is done
*/
private void testModificationAfterIterationBeganAndIteratedValue(final StateListener<String, String> listener,
Operation operation)throws Exception {
final List<CacheEntry<String, String>> initialValues = new ArrayList<CacheEntry<String, String>>();
for (int i = 0; i < 10; i++) {
String key = "key-" + i;
String value = "value-" + i;
initialValues.add(new ImmortalCacheEntry(key, value));
}
final CyclicBarrier barrier = new CyclicBarrier(2);
CacheStream mockStream = mockStream();
doReturn(initialValues.iterator()).when(mockStream).iterator();
doAnswer(i -> {
barrier.await(10, TimeUnit.SECONDS);
barrier.await(10, TimeUnit.SECONDS);
return null;
}).when(mockStream).close();
when(mockCache.getAdvancedCache().cacheEntrySet().stream()).thenReturn(mockStream);
Future<Void> future = fork(() -> {
n.addListener(listener);
return null;
});
barrier.await(10, TimeUnit.SECONDS);
String key;
String prevValue;
String value;
switch (operation) {
case REMOVE:
key = "key-3";
value = null;
prevValue = initialValues.get(3).getValue();
break;
case CREATE:
key = "new-key";
value = "new-value";
prevValue = null;
break;
case PUT:
key = "key-3";
value = "key-3-new";
prevValue = initialValues.get(3).getValue();
break;
default:
throw new IllegalArgumentException("Unsupported Operation provided " + operation);
}
operation.raiseEvent(n, key, prevValue, value, ctx);
// Now let the iteration complete
barrier.await(10, TimeUnit.SECONDS);
future.get(10, TimeUnit.MINUTES);
boolean isClustered = isClustered(listener);
// We should have 1 or 2 (local) events due to the modification coming after we iterated on it. Note the value
// isn't brought up until the iteration is done
assertEquals(listener.events.size(), isClustered ? initialValues.size() + 1 : (initialValues.size() + 1) * 2);
int position = 0;
for (CacheEntry<String, String> expected : initialValues) {
if (isClustered) {
CacheEntryEvent<String, String> event = listener.events.get(position);
assertEquals(event.getType(), Event.Type.CACHE_ENTRY_CREATED);
assertEquals(event.isPre(), false);
assertEquals(event.getKey(), expected.getKey());
assertEquals(event.getValue(), expected.getValue());
} else {
CacheEntryEvent<String, String> event = listener.events.get(position * 2);
assertEquals(event.getType(), Event.Type.CACHE_ENTRY_CREATED);
assertEquals(event.isPre(), true);
assertEquals(event.getKey(), expected.getKey());
assertNull(event.getValue());
event = listener.events.get((position * 2) + 1);
assertEquals(event.getType(), Event.Type.CACHE_ENTRY_CREATED);
assertEquals(event.isPre(), false);
assertEquals(event.getKey(), expected.getKey());
assertEquals(event.getValue(), expected.getValue());
}
position++;
}
// We should have 2 extra events at the end which are our modifications
if (isClustered) {
CacheEntryEvent<String, String> event = listener.events.get(position);
assertEquals(event.getType(), operation.getType());
assertEquals(event.isPre(), false);
assertEquals(event.getKey(), key);
assertEquals(event.getValue(), value);
} else {
CacheEntryEvent<String, String> event = listener.events.get(position * 2);
assertEquals(event.getType(), operation.getType());
assertEquals(event.isPre(), true);
assertEquals(event.getKey(), key);
assertEquals(event.getValue(), prevValue);
event = listener.events.get((position * 2) + 1);
assertEquals(event.getType(), operation.getType());
assertEquals(event.isPre(), false);
assertEquals(event.getKey(), key);
assertEquals(event.getValue(), value);
}
}
private boolean isClustered(StateListener listener) {
return listener.getClass().getAnnotation(Listener.class).clustered();
}
protected static abstract class StateListener<K, V> {
final List<CacheEntryEvent<K, V>> events = new ArrayList<>();
private final Log log = LogFactory.getLog(getClass());
@CacheEntryCreated
@CacheEntryModified
@CacheEntryRemoved
public synchronized void onCacheNotification(CacheEntryEvent<K, V> event) {
log.tracef("Received event: %s", event);
events.add(event);
}
}
@Listener(includeCurrentState = true, clustered = false)
private static class StateListenerNotClustered extends StateListener {
}
@Listener(includeCurrentState = true, clustered = true)
private static class StateListenerClustered extends StateListener {
}
// This is a helper method so that subsequent calls to the stream will return a mocked instance so we
// can keep track of invocations properly.
protected CacheStream mockStream() {
CacheStream mockStream = mock(CacheStream.class, withSettings().defaultAnswer(i -> i.getMock()));
doNothing().when(mockStream).close();
return mockStream;
}
}