Add abstract utility class for working with GemFire/Geode cache instances (ClientCache & peer Cache) and Regions.
This commit is contained in:
John Blum
@@ -0,0 +1,373 @@
|
||||
/*
|
||||
* Copyright 2020 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.geode.util;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.ArgumentMatchers.eq;
|
||||
import static org.mockito.Mockito.doReturn;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.verifyNoInteractions;
|
||||
import static org.mockito.Mockito.verifyNoMoreInteractions;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.TreeSet;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import org.apache.geode.cache.Cache;
|
||||
import org.apache.geode.cache.GemFireCache;
|
||||
import org.apache.geode.cache.Region;
|
||||
import org.apache.geode.cache.RegionAttributes;
|
||||
import org.apache.geode.cache.RegionService;
|
||||
import org.apache.geode.cache.client.ClientCache;
|
||||
import org.apache.geode.internal.cache.GemFireCacheImpl;
|
||||
|
||||
/**
|
||||
* Unit Tests for {@link CacheUtils}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see org.junit.Test
|
||||
* @see org.mockito.Mockito
|
||||
* @see org.apache.geode.cache.Cache
|
||||
* @see org.apache.geode.cache.GemFireCache
|
||||
* @see org.apache.geode.cache.Region
|
||||
* @see org.apache.geode.cache.RegionAttributes
|
||||
* @see org.apache.geode.cache.RegionService
|
||||
* @see org.apache.geode.cache.client.ClientCache
|
||||
* @since 1.3.0
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public class CacheUtilsUnitTests {
|
||||
|
||||
@Test
|
||||
public void collectValuesFromClientRegion() {
|
||||
|
||||
Region<Object, Object> mockRegion = mock(Region.class);
|
||||
|
||||
RegionService mockRegionService = mock(ClientCache.class);
|
||||
|
||||
Set<?> keySetOnServer = new TreeSet<>(Arrays.asList(1, 2, 3));
|
||||
|
||||
Map<Object, Object> keysValues = new HashMap<>();
|
||||
|
||||
keysValues.put(1, "one");
|
||||
keysValues.put(2, "two");
|
||||
keysValues.put(3, "three");
|
||||
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
doReturn(keySetOnServer).when(mockRegion).keySetOnServer();
|
||||
doReturn(keysValues).when(mockRegion).getAll(eq(keySetOnServer));
|
||||
|
||||
assertThat(CacheUtils.collectValues(mockRegion)).containsExactlyInAnyOrder(keysValues.values().toArray());
|
||||
|
||||
verify(mockRegion, times(1)).getRegionService();
|
||||
verify(mockRegion, times(1)).keySetOnServer();
|
||||
verify(mockRegion, times(1)).getAll(eq(keySetOnServer));
|
||||
verifyNoMoreInteractions(mockRegion);
|
||||
verifyNoInteractions(mockRegionService);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void collectValuesFromClientRegionWhenClientRegionGetAllKeysReturnsNullMapIsNullSafe() {
|
||||
|
||||
Region<Object, Object> mockRegion = mock(Region.class);
|
||||
|
||||
RegionService mockRegionService = mock(ClientCache.class);
|
||||
|
||||
Set<Object> keySetOnServer = new TreeSet<>(Arrays.asList(1, 2));
|
||||
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
doReturn(keySetOnServer).when(mockRegion).keySetOnServer();
|
||||
doReturn(null).when(mockRegion).getAll(eq(keySetOnServer));
|
||||
|
||||
Collection<Object> values = CacheUtils.collectValues(mockRegion);
|
||||
|
||||
assertThat(values).isNotNull();
|
||||
assertThat(values).isEmpty();
|
||||
|
||||
verify(mockRegion, times(1)).getRegionService();
|
||||
verify(mockRegion, times(1)).keySetOnServer();
|
||||
verify(mockRegion, times(1)).getAll(eq(keySetOnServer));
|
||||
verifyNoMoreInteractions(mockRegion);
|
||||
verifyNoInteractions(mockRegionService);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void collectValuesFromClientRegionWhenClientRegionKeySetOnServerReturnsNullSetIsNullSafe() {
|
||||
|
||||
Region<Object, Object> mockRegion = mock(Region.class);
|
||||
|
||||
RegionService mockRegionService = mock(ClientCache.class);
|
||||
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
doReturn(null).when(mockRegion).keySetOnServer();
|
||||
|
||||
Collection<Object> values = CacheUtils.collectValues(mockRegion);
|
||||
|
||||
assertThat(values).isNotNull();
|
||||
assertThat(values).isEmpty();
|
||||
|
||||
verify(mockRegion, times(1)).getRegionService();
|
||||
verify(mockRegion, times(1)).keySetOnServer();
|
||||
verifyNoMoreInteractions(mockRegion);
|
||||
verifyNoInteractions(mockRegionService);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void collectValuesFromClientRegionWhenClientRegionGetRegionServiceReturnsNullIsNullSafe() {
|
||||
|
||||
Collection<Object> values = Arrays.asList("one", "two", "three");
|
||||
|
||||
Region<Object, Object> mockRegion = mock(Region.class);
|
||||
|
||||
doReturn(null).when(mockRegion).getRegionService();
|
||||
doReturn(values).when(mockRegion).values();
|
||||
|
||||
assertThat(CacheUtils.collectValues(mockRegion)).containsExactlyInAnyOrder(values.toArray());
|
||||
|
||||
verify(mockRegion, times(1)).getRegionService();
|
||||
verify(mockRegion, times(1)).values();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void collectValuesFromPeerRegion() {
|
||||
|
||||
Region<Object, Object> mockRegion = mock(Region.class);
|
||||
|
||||
RegionService mockRegionService = mock(Cache.class);
|
||||
|
||||
Collection<Object> values = Arrays.asList("one", "two", "three");
|
||||
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
doReturn(values).when(mockRegion).values();
|
||||
|
||||
assertThat(CacheUtils.collectValues(mockRegion)).containsExactlyInAnyOrder(values.toArray());
|
||||
|
||||
verify(mockRegion, times(1)).getRegionService();
|
||||
verify(mockRegion, times(1)).values();
|
||||
verifyNoInteractions(mockRegionService);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void collectValuesWithNullRegionThrowsIllegalArgumentException() {
|
||||
|
||||
try {
|
||||
CacheUtils.collectValues(null);
|
||||
}
|
||||
catch (IllegalArgumentException expected) {
|
||||
|
||||
assertThat(expected).hasMessageStartingWith("Argument must not be null");
|
||||
assertThat(expected).hasNoCause();
|
||||
|
||||
throw expected;
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientCacheWithClientCache() {
|
||||
assertThat(CacheUtils.isClientCache(mock(ClientCache.class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientCacheWithGemFireCacheImplWhenIsClientReturnsTrue() {
|
||||
|
||||
GemFireCacheImpl mockCache = mock(GemFireCacheImpl.class);
|
||||
|
||||
doReturn(true).when(mockCache).isClient();
|
||||
|
||||
assertThat(CacheUtils.isClientCache(mockCache)).isTrue();
|
||||
|
||||
verify(mockCache, times(1)).isClient();
|
||||
verifyNoMoreInteractions(mockCache);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientCacheWithGemFireCacheImplWhenIsClientReturnsFalse() {
|
||||
|
||||
GemFireCacheImpl mockCache = mock(GemFireCacheImpl.class);
|
||||
|
||||
doReturn(false).when(mockCache).isClient();
|
||||
|
||||
assertThat(CacheUtils.isClientCache(mockCache)).isFalse();
|
||||
|
||||
verify(mockCache, times(1)).isClient();
|
||||
verifyNoMoreInteractions(mockCache);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientCacheWithNonClientCache() {
|
||||
assertThat(CacheUtils.isClientCache(mock(Cache.class))).isFalse();
|
||||
assertThat(CacheUtils.isClientCache(mock(GemFireCache.class))).isFalse();
|
||||
assertThat(CacheUtils.isClientCache(mock(RegionService.class))).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientCacheWithNull() {
|
||||
assertThat(CacheUtils.isClientCache(null)).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientRegionWithClientRegionInClientCache() {
|
||||
|
||||
Region<?, ?> mockRegion = mock(Region.class);
|
||||
|
||||
RegionService mockRegionService = mock(ClientCache.class);
|
||||
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
|
||||
assertThat(CacheUtils.isClientRegion(mockRegion)).isTrue();
|
||||
assertThat(CacheUtils.isPeerRegion(mockRegion)).isFalse();
|
||||
|
||||
verify(mockRegion, times(2)).getRegionService();
|
||||
verifyNoMoreInteractions(mockRegion);
|
||||
verifyNoInteractions(mockRegionService);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientRegionWithClientRegionDeterminedByPoolName() {
|
||||
|
||||
Region<?, ?> mockRegion = mock(Region.class);
|
||||
|
||||
RegionAttributes<?, ?> mockRegionAttributes = mock(RegionAttributes.class);
|
||||
|
||||
RegionService mockRegionService = mock(RegionService.class);
|
||||
|
||||
doReturn(mockRegionAttributes).when(mockRegion).getAttributes();
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
doReturn("TestPool").when(mockRegionAttributes).getPoolName();
|
||||
|
||||
assertThat(CacheUtils.isClientRegion(mockRegion)).isTrue();
|
||||
assertThat(CacheUtils.isPeerRegion(mockRegion)).isFalse();
|
||||
|
||||
verify(mockRegion, times(2)).getRegionService();
|
||||
verify(mockRegion, times(2)).getAttributes();
|
||||
verify(mockRegionAttributes, times(2)).getPoolName();
|
||||
verifyNoMoreInteractions(mockRegion, mockRegionAttributes);
|
||||
verifyNoInteractions(mockRegionService);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientRegionWithRegionHavingNoPoolName() {
|
||||
|
||||
Region<?, ?> mockRegion = mock(Region.class);
|
||||
|
||||
RegionAttributes<?, ?> mockRegionAttributes = mock(RegionAttributes.class);
|
||||
|
||||
doReturn(mockRegionAttributes).when(mockRegion).getAttributes();
|
||||
doReturn(null).when(mockRegion).getRegionService();
|
||||
doReturn(" ").when(mockRegionAttributes).getPoolName();
|
||||
|
||||
assertThat(CacheUtils.isClientRegion(mockRegion)).isFalse();
|
||||
assertThat(CacheUtils.isPeerRegion(mockRegion)).isTrue();
|
||||
|
||||
verify(mockRegion, times(2)).getRegionService();
|
||||
verify(mockRegion, times(2)).getAttributes();
|
||||
verify(mockRegionAttributes, times(2)).getPoolName();
|
||||
verifyNoMoreInteractions(mockRegion, mockRegionAttributes);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientRegionWithRegionHavingNoRegionAttributes() {
|
||||
|
||||
Region<?, ?> mockRegion = mock(Region.class);
|
||||
|
||||
doReturn(null).when(mockRegion).getAttributes();
|
||||
doReturn(null).when(mockRegion).getRegionService();
|
||||
|
||||
assertThat(CacheUtils.isClientRegion(mockRegion)).isFalse();
|
||||
assertThat(CacheUtils.isPeerRegion(mockRegion)).isTrue();
|
||||
|
||||
verify(mockRegion, times(2)).getRegionService();
|
||||
verify(mockRegion, times(2)).getAttributes();
|
||||
verifyNoMoreInteractions(mockRegion);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientRegionWithPeerRegionInPeerCache() {
|
||||
|
||||
Region<?, ?> mockRegion = mock(Region.class);
|
||||
|
||||
RegionService mockRegionService = mock(Cache.class);
|
||||
|
||||
doReturn(mockRegionService).when(mockRegion).getRegionService();
|
||||
|
||||
assertThat(CacheUtils.isClientRegion(mockRegion)).isFalse();
|
||||
assertThat(CacheUtils.isPeerRegion(mockRegion)).isTrue();
|
||||
|
||||
verify(mockRegion, times(2)).getRegionService();
|
||||
verify(mockRegion, times(2)).getAttributes();
|
||||
verifyNoMoreInteractions(mockRegion);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isClientRegionWithNull() {
|
||||
assertThat(CacheUtils.isClientRegion(null)).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPeerCacheWithPeerCache() {
|
||||
assertThat(CacheUtils.isPeerCache(mock(Cache.class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPeerCacheWithGemFireCacheImplWhenIsClientReturnsTrue() {
|
||||
|
||||
GemFireCacheImpl mockCache = mock(GemFireCacheImpl.class);
|
||||
|
||||
doReturn(true).when(mockCache).isClient();
|
||||
|
||||
assertThat(CacheUtils.isPeerCache(mockCache)).isFalse();
|
||||
|
||||
verify(mockCache, times(1)).isClient();
|
||||
verifyNoMoreInteractions(mockCache);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPeerCacheWithGemFireCacheImplWhenIsClientReturnsFalse() {
|
||||
|
||||
GemFireCacheImpl mockCache = mock(GemFireCacheImpl.class);
|
||||
|
||||
doReturn(false).when(mockCache).isClient();
|
||||
|
||||
assertThat(CacheUtils.isPeerCache(mockCache)).isTrue();
|
||||
|
||||
verify(mockCache, times(1)).isClient();
|
||||
verifyNoMoreInteractions(mockCache);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPeerCacheWithNonPeerCache() {
|
||||
assertThat(CacheUtils.isPeerCache(mock(ClientCache.class))).isFalse();
|
||||
assertThat(CacheUtils.isPeerCache(mock(GemFireCache.class))).isFalse();
|
||||
assertThat(CacheUtils.isPeerCache(mock(RegionService.class))).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPeerCacheWithNull() {
|
||||
assertThat(CacheUtils.isPeerCache(null)).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isPeerRegionWithNull() {
|
||||
assertThat(CacheUtils.isPeerRegion(null)).isFalse();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user