Add RegionSpyingBeanPostProcessor class to spy on Region beans managed in a Spring TestContext for testing purposes.

spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/beans/factory/config/RegionSpyingBeanPostProcessor.java

@@ -0,0 +1,85 @@
+/*
+ *  Copyright 2019 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.data.gemfire.tests.mock.beans.factory.config;
+
+import static org.mockito.Mockito.spy;
+
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
+
+import org.apache.geode.cache.Region;
+
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.context.ApplicationContext;
+import org.springframework.data.gemfire.util.ArrayUtils;
+import org.springframework.data.gemfire.util.CollectionUtils;
+import org.springframework.lang.NonNull;
+import org.springframework.lang.Nullable;
+import org.springframework.util.StringUtils;
+
+/**
+ * Spring {@link BeanPostProcessor} that creates spies for all managed {@link Region Regions} (beans)
+ * in the Spring {@link ApplicationContext}.
+ *
+ * @author John Blum
+ * @see org.apache.geode.cache.Region
+ * @see org.mockito.Mockito#spy(Object)
+ * @see org.springframework.beans.factory.config.BeanPostProcessor
+ * @see org.springframework.context.ApplicationContext
+ * @since 0.0.22
+ */
+@SuppressWarnings("unused")
+public class RegionSpyingBeanPostProcessor implements BeanPostProcessor {
+
+	private final Set<String> regionBeanNames;
+
+	public RegionSpyingBeanPostProcessor(String... regionBeanNames) {
+		this(Arrays.asList(ArrayUtils.nullSafeArray(regionBeanNames, String.class)));
+	}
+
+	public RegionSpyingBeanPostProcessor(@NonNull Iterable<String> regionBeanNames) {
+
+		this.regionBeanNames =
+			StreamSupport.stream(CollectionUtils.nullSafeIterable(regionBeanNames).spliterator(), false)
+				.filter(StringUtils::hasText)
+				.collect(Collectors.toSet());
+	}
+
+	protected boolean isRegion(@Nullable Object target) {
+		return target instanceof Region;
+	}
+
+	protected boolean isRegionBeanNameMatch(@NonNull String beanName) {
+
+		return this.regionBeanNames.isEmpty()
+			|| (StringUtils.hasText(beanName) && this.regionBeanNames.contains(beanName));
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	@Override
+	public Object postProcessAfterInitialization(@NonNull Object bean, @NonNull String beanName) throws BeansException {
+		return isRegion(bean) && isRegionBeanNameMatch(beanName) ? doSpy(bean) : bean;
+	}
+
+	protected @Nullable <T> T doSpy(@Nullable T target) {
+		return target != null ? spy(target) : target;
+	}
+}

spring-data-geode-test/src/test/java/org/springframework/data/gemfire/tests/mock/beans/factory/config/RegionSpyingBeanPostProcessorUnitTests.java

@@ -0,0 +1,171 @@
+/*
+ *  Copyright 2019 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.data.gemfire.tests.mock.beans.factory.config;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoInteractions;
+
+import org.junit.Test;
+
+import org.apache.geode.cache.Region;
+
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
+/**
+ * Unit Tests for {@link RegionSpyingBeanPostProcessor}.
+ *
+ * @author John Blum
+ * @see org.junit.Test
+ * @see org.mockito.Mockito
+ * @see org.apache.geode.cache.Region
+ * @see org.springframework.data.gemfire.tests.mock.beans.factory.config.RegionSpyingBeanPostProcessor
+ * @since 0.0.22
+ */
+public class RegionSpyingBeanPostProcessorUnitTests {
+
+	@Test
+	public void spiesOnAllRegions() {
+
+		Region<?, ?> mockRegionOne = mock(Region.class, "MockRegionOne");
+		Region<?, ?> mockRegionTwo = mock(Region.class, "MockRegionTwo");
+
+		RegionSpyingBeanPostProcessor beanPostProcessor = spy(new RegionSpyingBeanPostProcessor());
+
+		doAnswer(invocation -> invocation.getArgument(0)).when(beanPostProcessor).doSpy(any());
+
+		assertThat(beanPostProcessor).isNotNull();
+
+		assertThat(beanPostProcessor.postProcessAfterInitialization(mockRegionOne, "MockRegionOne"))
+			.isEqualTo(mockRegionOne);
+
+		assertThat(beanPostProcessor.postProcessAfterInitialization(mockRegionTwo, "MockRegionTwo"))
+			.isEqualTo(mockRegionTwo);
+
+		verify(beanPostProcessor, times(1)).doSpy(eq(mockRegionOne));
+		verify(beanPostProcessor, times(1)).doSpy(eq(mockRegionTwo));
+
+		verifyNoInteractions(mockRegionOne, mockRegionTwo);
+	}
+
+	@Test
+	public void spiesOnTargetedRegions() {
+
+		Region<?, ?> mockRegionOne = mock(Region.class, "MockRegionOne");
+		Region<?, ?> mockRegionTwo = mock(Region.class, "MockRegionTwo");
+
+		RegionSpyingBeanPostProcessor beanPostProcessor =
+			spy(new RegionSpyingBeanPostProcessor("MockRegionOne"));
+
+		doAnswer(invocation -> invocation.getArgument(0)).when(beanPostProcessor).doSpy(any());
+
+		assertThat(beanPostProcessor).isNotNull();
+
+		assertThat(beanPostProcessor.postProcessAfterInitialization(mockRegionOne, "MockRegionOne"))
+			.isEqualTo(mockRegionOne);
+
+		assertThat(beanPostProcessor.postProcessAfterInitialization(mockRegionTwo, "MockRegionTwo"))
+			.isEqualTo(mockRegionTwo);
+
+		verify(beanPostProcessor, times(1)).doSpy(eq(mockRegionOne));
+		verify(beanPostProcessor, never()).doSpy(eq(mockRegionTwo));
+
+		verifyNoInteractions(mockRegionOne, mockRegionTwo);
+	}
+
+	@Test
+	public void willNotSpyOnNonRegion() {
+
+		Object bean = "TEST";
+
+		RegionSpyingBeanPostProcessor beanPostProcessor = spy(new RegionSpyingBeanPostProcessor());
+
+		assertThat(beanPostProcessor.postProcessAfterInitialization(bean, "TestBeanName")).isEqualTo(bean);
+
+		verify(beanPostProcessor, never()).doSpy(any());
+	}
+
+	@Test
+	public void doSpyIsNullSafe() {
+		assertThat(new RegionSpyingBeanPostProcessor().<Object>doSpy(null)).isNull();
+	}
+
+	@Test
+	public void doSpySpiesOnNonNullObject() {
+
+		User jonDoe = User.as("Jon Doe").identifiedBy(1L);
+		User jonDoeSpy = new RegionSpyingBeanPostProcessor().doSpy(jonDoe);
+
+		assertThat(jonDoeSpy).isNotNull();
+		assertThat(jonDoeSpy).isInstanceOf(User.class);
+		assertThat(jonDoeSpy).isNotSameAs(jonDoe);
+		assertThat(jonDoeSpy.getName()).isEqualTo(jonDoe.getName());
+	}
+
+	@Test
+	public void isRegionReturnsTrue() {
+		assertThat(new RegionSpyingBeanPostProcessor().isRegion(mock(Region.class))).isTrue();
+	}
+
+	@Test
+	public void isRegionReturnsFalse() {
+		assertThat(new RegionSpyingBeanPostProcessor().isRegion("TEST")).isFalse();
+	}
+
+	@Test
+	public void isRegionBeanNameMatchReturnsTrue() {
+
+		assertThat(new RegionSpyingBeanPostProcessor().isRegionBeanNameMatch("TestRegionBeanName")).isTrue();
+
+		assertThat(new RegionSpyingBeanPostProcessor("TestRegionBeanName")
+			.isRegionBeanNameMatch("TestRegionBeanName")).isTrue();
+	}
+
+	@Test
+	public void isRegionBeanNameMatchReturnsFalse() {
+
+		assertThat(new RegionSpyingBeanPostProcessor("TestRegionBeanName")
+			.isRegionBeanNameMatch("MockRegionBeanName")).isFalse();
+	}
+
+	@Getter
+	@ToString(of = "name")
+	@EqualsAndHashCode(of = "name")
+	@RequiredArgsConstructor(staticName = "as")
+	static class User {
+
+		private Long id;
+
+		@NonNull
+		private final String name;
+
+		public User identifiedBy(Long id) {
+			this.id = id;
+			return this;
+		}
+	}
+}