From 1a19c228be9e39d4d9ec9b0efe3fffa7056fa4b0 Mon Sep 17 00:00:00 2001 From: John Blum Date: Mon, 4 May 2020 19:11:13 -0700 Subject: [PATCH] Introduce new CacheDataImporter and CacheDataExporter interfaces to import and export data into and out from a GemFire/Geode cache on startup. These new interfaces and APIs are intended to be used in SBDG's auto-configuration when the Spring Boot app using Apache Geode starts up in order to load or save data. Resolves gh-67. --- .../geode/data/CacheDataExporter.java | 64 ++++++++++++++ .../geode/data/CacheDataImporter.java | 67 +++++++++++++++ .../data/CacheDataExporterUnitTests.java | 80 +++++++++++++++++ .../data/CacheDataImporterUnitTests.java | 85 +++++++++++++++++++ 4 files changed, 296 insertions(+) create mode 100644 spring-geode/src/main/java/org/springframework/geode/data/CacheDataExporter.java create mode 100644 spring-geode/src/main/java/org/springframework/geode/data/CacheDataImporter.java create mode 100644 spring-geode/src/test/java/org/springframework/geode/data/CacheDataExporterUnitTests.java create mode 100644 spring-geode/src/test/java/org/springframework/geode/data/CacheDataImporterUnitTests.java diff --git a/spring-geode/src/main/java/org/springframework/geode/data/CacheDataExporter.java b/spring-geode/src/main/java/org/springframework/geode/data/CacheDataExporter.java new file mode 100644 index 00000000..56e3c0d2 --- /dev/null +++ b/spring-geode/src/main/java/org/springframework/geode/data/CacheDataExporter.java @@ -0,0 +1,64 @@ +/* + * 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.data; + +import org.apache.geode.cache.Region; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor; +import org.springframework.lang.NonNull; + +/** + * The {@link CacheDataExporter} interface is a {@link FunctionalInterface} defining a contract for exporting data + * from a cache {@link Region}. + * + * @author John Blum + * @see java.lang.FunctionalInterface + * @see org.apache.geode.cache.Region + * @see org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor + * @since 1.3.0 + */ +@FunctionalInterface +@SuppressWarnings("rawtypes") +public interface CacheDataExporter extends DestructionAwareBeanPostProcessor { + + /** + * Exports any data contained in a {@link Region} on destruction. + * + * @param bean {@link Object} bean to evaluate. + * @param beanName {@link String} containing the name of the bean. + * @throws BeansException if exporting data from a {@link Region} fails! + * @see org.apache.geode.cache.Region + * @see #exportFrom(Region) + */ + @Override + default void postProcessBeforeDestruction(Object bean, String beanName) throws BeansException { + + if (bean instanceof Region) { + exportFrom((Region) bean); + } + } + + /** + * Exports data contained in the given {@link Region}. + * + * @param region {@link Region} to export data from. + * @return the given {@link Region}. + * @see org.apache.geode.cache.Region + */ + @NonNull Region exportFrom(@NonNull Region region); + +} diff --git a/spring-geode/src/main/java/org/springframework/geode/data/CacheDataImporter.java b/spring-geode/src/main/java/org/springframework/geode/data/CacheDataImporter.java new file mode 100644 index 00000000..6177aa90 --- /dev/null +++ b/spring-geode/src/main/java/org/springframework/geode/data/CacheDataImporter.java @@ -0,0 +1,67 @@ +/* + * 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.data; + +import org.apache.geode.cache.Region; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.config.BeanPostProcessor; +import org.springframework.lang.NonNull; +import org.springframework.lang.Nullable; + +/** + * The {@link CacheDataImporter} interface is a {@link FunctionalInterface} defininig a contract for importing data + * into a cache {@link Region}. + * + * @author John Blum + * @see java.lang.FunctionalInterface + * @see org.apache.geode.cache.Region + * @see org.springframework.beans.factory.config.BeanPostProcessor + * @since 1.3.0 + */ +@FunctionalInterface +@SuppressWarnings("rawtypes") +public interface CacheDataImporter extends BeanPostProcessor { + + /** + * Imports data from an external data source into a given {@link Region} after initialization. + * + * @param bean {@link Object} bean to evaluate. + * @param beanName {@link String} containing the name of the bean. + * @throws BeansException if importing data into a {@link Region} fails! + * @see org.apache.geode.cache.Region + * @see #importInto(Region) + */ + @Nullable @Override + default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { + + if (bean instanceof Region) { + bean = importInto((Region) bean); + } + + return bean; + } + + /** + * Imports data into the given {@link Region}. + * + * @param region {@link Region} to import data into. + * @return the given {@link Region}. + * @see org.apache.geode.cache.Region + */ + @NonNull Region importInto(@NonNull Region region); + +} diff --git a/spring-geode/src/test/java/org/springframework/geode/data/CacheDataExporterUnitTests.java b/spring-geode/src/test/java/org/springframework/geode/data/CacheDataExporterUnitTests.java new file mode 100644 index 00000000..9b711e5c --- /dev/null +++ b/spring-geode/src/test/java/org/springframework/geode/data/CacheDataExporterUnitTests.java @@ -0,0 +1,80 @@ +/* + * 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.data; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doCallRealMethod; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import org.junit.Test; + +import org.apache.geode.cache.Region; + +/** + * Unit Tests for {@link CacheDataExporter} + * + * @author John Blum + * @see org.junit.Test + * @see org.mockito.Mockito + * @see org.apache.geode.cache.Region + * @see org.springframework.geode.data.CacheDataExporter + * @since 1.3.0 + */ +public class CacheDataExporterUnitTests { + + @Test + public void postProcessBeforeDestructionCallsExportFromGivenARegionArgument() { + + Region mockRegion = mock(Region.class); + + CacheDataExporter exporter = mock(CacheDataExporter.class); + + doCallRealMethod().when(exporter).postProcessBeforeDestruction(any(), anyString()); + + exporter.postProcessBeforeDestruction(mockRegion, "TestRegion"); + + verify(exporter, times(1)).exportFrom(eq(mockRegion)); + } + + @Test + public void postProcessBeforeDestructionWillNotCallExportFromGivenAnObject() { + + CacheDataExporter exporter = mock(CacheDataExporter.class); + + doCallRealMethod().when(exporter).postProcessBeforeDestruction(any(), anyString()); + + exporter.postProcessBeforeDestruction(new Object(), "TestRegion"); + + verify(exporter, never()).exportFrom(any(Region.class)); + } + + @Test + public void postProcessBeforeDestructionIsNullSafe() { + + CacheDataExporter exporter = mock(CacheDataExporter.class); + + doCallRealMethod().when(exporter).postProcessBeforeDestruction(any(), anyString()); + + exporter.postProcessBeforeDestruction(null, "TestRegion"); + + verify(exporter, never()).exportFrom(any(Region.class)); + } +} diff --git a/spring-geode/src/test/java/org/springframework/geode/data/CacheDataImporterUnitTests.java b/spring-geode/src/test/java/org/springframework/geode/data/CacheDataImporterUnitTests.java new file mode 100644 index 00000000..93a94207 --- /dev/null +++ b/spring-geode/src/test/java/org/springframework/geode/data/CacheDataImporterUnitTests.java @@ -0,0 +1,85 @@ +/* + * 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.data; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doCallRealMethod; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import org.junit.Test; + +import org.apache.geode.cache.Region; + +/** + * Unit Tests for {@link CacheDataImporter}. + * + * @author John Blum + * @see org.junit.Test + * @see org.mockito.Mockito + * @see org.apache.geode.cache.Region + * @see org.springframework.geode.data.CacheDataImporter + * @since 1.3.0 + */ +public class CacheDataImporterUnitTests { + + @Test + public void postProcessAfterInitializationCallsImportFromGivenARegionArgument() { + + Region mockRegion = mock(Region.class); + + CacheDataImporter importer = mock(CacheDataImporter.class); + + doCallRealMethod().when(importer).postProcessAfterInitialization(any(), anyString()); + doReturn(mockRegion).when(importer).importInto(eq(mockRegion)); + + assertThat(importer.postProcessAfterInitialization(mockRegion, "TestRegion")).isEqualTo(mockRegion); + + verify(importer, times(1)).importInto(eq(mockRegion)); + } + + @Test + public void postProcessAfterInitializationWillNotCallImportFromGivenAnObject() { + + CacheDataImporter importer = mock(CacheDataImporter.class); + + doCallRealMethod().when(importer).postProcessAfterInitialization(any(), anyString()); + + Object bean = new Object(); + + assertThat(importer.postProcessAfterInitialization(bean, "TestRegion")).isEqualTo(bean); + + verify(importer, never()).importInto(any(Region.class)); + } + + @Test + public void postProcessAfterInitializationIsNullSafe() { + + CacheDataImporter importer = mock(CacheDataImporter.class); + + doCallRealMethod().when(importer).postProcessAfterInitialization(any(), anyString()); + + assertThat(importer.postProcessAfterInitialization(null, "TestRegion")).isNull(); + + verify(importer, never()).importInto(any(Region.class)); + } +}