From 53893bd49f242dca68de52616698421665e2402d Mon Sep 17 00:00:00 2001
From: John Blum <jblum@pivotal.io>
Date: Tue, 19 May 2020 21:58:00 -0700
Subject: [PATCH] Add support to suppress GemFire/Geode Mock Object destruction
 on ContextClosedEvents.

---
 .../annotation/EnableGemFireMockObjects.java  |  12 ++
 .../GemFireMockObjectsConfiguration.java      |  35 +++++-
 ...FireMockObjectsConfigurationUnitTests.java | 112 ++++++++++++++++++
 3 files changed, 155 insertions(+), 4 deletions(-)
 create mode 100644 spring-data-geode-test/src/test/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfigurationUnitTests.java

diff --git a/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java b/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java
index 2165fec..94c1a92 100644
--- a/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java
+++ b/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java
@@ -46,6 +46,18 @@ import org.springframework.context.annotation.Import;
 @SuppressWarnings("unused")
 public @interface EnableGemFireMockObjects {
 
+	/**
+	 * Configures whether the {@link org.springframework.context.event.ContextClosedEvent} Spring
+	 * {@link org.springframework.context.ApplicationEvent} listener and handler for GemFire/Geode
+	 * {@link Object Mock Objects} is suppressed from taking action.
+	 *
+	 * Defaults to {@literal false}.
+	 *
+	 * @return a boolean value indicating whether the {@link org.springframework.context.event.ContextClosedEvent}
+	 * listener and handler for GemFire/Geode {@link Object Mock Objects} is suppressed from taking action.
+	 */
+	boolean suppressOnContextClosedEventHandler() default false;
+
 	/**
 	 * Configures whether the mock {@link GemFireCache} created for Unit Testing is a Singleton.
 	 *
diff --git a/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java b/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java
index b1c6031..78cc16b 100644
--- a/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java
+++ b/spring-data-geode-test/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java
@@ -53,6 +53,8 @@ import org.springframework.data.gemfire.tests.mock.config.GemFireMockObjectsBean
 @SuppressWarnings("unused")
 public class GemFireMockObjectsConfiguration implements ApplicationListener<ContextClosedEvent>, ImportAware {
 
+	private boolean suppressContextClosedEventHandler = false;
+
 	private boolean useSingletonCache = false;
 
 	@Override @SuppressWarnings("all")
@@ -61,8 +63,14 @@ public class GemFireMockObjectsConfiguration implements ApplicationListener<Cont
 		Optional.of(importingClassMetadata)
 			.filter(this::isAnnotationPresent)
 			.map(this::getAnnotationAttributes)
-			.ifPresent(enableGemFireMockObjectsAttributes ->
-				this.useSingletonCache = enableGemFireMockObjectsAttributes.getBoolean("useSingletonCache"));
+			.ifPresent(enableGemFireMockObjectsAttributes -> {
+
+				this.suppressContextClosedEventHandler =
+					enableGemFireMockObjectsAttributes.getBoolean("suppressOnContextClosedEventHandler");
+
+				this.useSingletonCache =
+					enableGemFireMockObjectsAttributes.getBoolean("useSingletonCache");
+			});
 	}
 
 	private Class<? extends Annotation> getAnnotationType() {
@@ -89,18 +97,37 @@ public class GemFireMockObjectsConfiguration implements ApplicationListener<Cont
 		return AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(annotationType.getName()));
 	}
 
+	protected boolean isNotSuppressOnContextClosedEvent() {
+		return !isSuppressOnContextClosedEvent();
+	}
+
+	protected boolean isSuppressOnContextClosedEvent() {
+		return this.suppressContextClosedEventHandler;
+	}
+
+	protected boolean isUseSingletonCacheConfigured() {
+		return this.useSingletonCache;
+	}
+
 	@Bean
 	public BeanPostProcessor gemfireMockObjectsBeanPostProcessor() {
-		return GemFireMockObjectsBeanPostProcessor.newInstance(this.useSingletonCache);
+		return GemFireMockObjectsBeanPostProcessor.newInstance(isUseSingletonCacheConfigured());
 	}
 
 	@EventListener
 	public void releaseMockObjectResources(ContextClosedEvent event) {
-		GemFireMockObjectsSupport.destroy();
+
+		if (isNotSuppressOnContextClosedEvent()) {
+			destroyGemFireMockObjects();
+		}
 	}
 
 	@Override @SuppressWarnings("all")
 	public void onApplicationEvent(ContextClosedEvent event) {
 		releaseMockObjectResources(event);
 	}
+
+	void destroyGemFireMockObjects() {
+		GemFireMockObjectsSupport.destroy();
+	}
 }
diff --git a/spring-data-geode-test/src/test/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfigurationUnitTests.java b/spring-data-geode-test/src/test/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfigurationUnitTests.java
new file mode 100644
index 0000000..f8efffa
--- /dev/null
+++ b/spring-data-geode-test/src/test/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfigurationUnitTests.java
@@ -0,0 +1,112 @@
+/*
+ *  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.annotation;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.eq;
+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.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.Test;
+
+import org.springframework.context.event.ContextClosedEvent;
+import org.springframework.core.type.AnnotationMetadata;
+
+/**
+ * Unit Tests for {@link GemFireMockObjectsConfiguration}.
+ *
+ * @author John Blum
+ * @see org.junit.Test
+ * @see org.mockito.Mockito
+ * @see org.springframework.context.event.ContextClosedEvent
+ * @see org.springframework.core.type.AnnotationMetadata
+ * @see org.springframework.data.gemfire.tests.mock.annotation.GemFireMockObjectsConfiguration
+ * @since 0.0.16
+ */
+public class GemFireMockObjectsConfigurationUnitTests {
+
+	@Test
+	public void setImportMetadataConfiguresSingletonCacheAndSuppressContextClosedEvents() {
+
+		GemFireMockObjectsConfiguration configuration = new GemFireMockObjectsConfiguration();
+
+		assertThat(configuration.isSuppressOnContextClosedEvent()).isFalse();
+		assertThat(configuration.isUseSingletonCacheConfigured()).isFalse();
+
+		Map<String, Object> enableGemFireMockObjectsAttributes = new HashMap<>();
+
+		enableGemFireMockObjectsAttributes.put("suppressOnContextClosedEventHandler", true);
+		enableGemFireMockObjectsAttributes.put("useSingletonCache", true);
+
+		AnnotationMetadata mockAnnotationMetadata = mock(AnnotationMetadata.class);
+
+		doReturn(true).when(mockAnnotationMetadata)
+			.hasAnnotation(eq(EnableGemFireMockObjects.class.getName()));
+
+		doReturn(enableGemFireMockObjectsAttributes).when(mockAnnotationMetadata)
+			.getAnnotationAttributes(eq(EnableGemFireMockObjects.class.getName()));
+
+		configuration.setImportMetadata(mockAnnotationMetadata);
+
+		assertThat(configuration.isSuppressOnContextClosedEvent()).isTrue();
+		assertThat(configuration.isUseSingletonCacheConfigured()).isTrue();
+
+		verify(mockAnnotationMetadata, times(1))
+			.hasAnnotation(eq(EnableGemFireMockObjects.class.getName()));
+		verify(mockAnnotationMetadata, times(1))
+			.getAnnotationAttributes(eq(EnableGemFireMockObjects.class.getName()));
+	}
+
+	@Test
+	public void destroysGemFireMockObjectsWhenSuppressOnContextClosedEventIsFalse() {
+
+		ContextClosedEvent mockEvent = mock(ContextClosedEvent.class);
+
+		GemFireMockObjectsConfiguration configuration = spy(new GemFireMockObjectsConfiguration());
+
+		doReturn(false).when(configuration).isSuppressOnContextClosedEvent();
+		doNothing().when(configuration).destroyGemFireMockObjects();
+
+		configuration.onApplicationEvent(mockEvent);
+
+		verify(configuration, times(1)).destroyGemFireMockObjects();
+		verify(configuration, times(1)).releaseMockObjectResources(eq(mockEvent));
+	}
+
+	@Test
+	public void doesNotDestroyGemFireMockObjectsWhenSuppressOnContextClosedEventIsTrue() {
+
+		ContextClosedEvent mockEvent = mock(ContextClosedEvent.class);
+
+		GemFireMockObjectsConfiguration configuration = spy(new GemFireMockObjectsConfiguration());
+
+		doReturn(true).when(configuration).isSuppressOnContextClosedEvent();
+		doNothing().when(configuration).destroyGemFireMockObjects();
+
+		configuration.onApplicationEvent(mockEvent);
+
+		verify(configuration, never()).destroyGemFireMockObjects();
+		verify(configuration, times(1)).releaseMockObjectResources(eq(mockEvent));
+	}
+}