/*
 * Copyright 2010-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.data.gemfire.client;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.ArgumentMatchers.startsWith;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doThrow;
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.when;
import static org.springframework.data.gemfire.util.RuntimeExceptionFactory.newIllegalArgumentException;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;

import org.apache.geode.cache.DataPolicy;
import org.apache.geode.cache.Region;
import org.apache.geode.cache.RegionAttributes;
import org.apache.geode.cache.Scope;
import org.apache.geode.cache.client.ClientCache;
import org.apache.geode.cache.client.ClientRegionFactory;
import org.apache.geode.cache.client.ClientRegionShortcut;
import org.apache.geode.cache.execute.Function;
import org.apache.geode.management.internal.cli.domain.RegionInformation;
import org.apache.geode.management.internal.cli.functions.GetRegionsFunction;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;

import org.springframework.beans.TypeMismatchException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.data.gemfire.client.function.ListRegionsOnServerFunction;
import org.springframework.data.gemfire.util.RegionUtils;

/**
 * Unit tests for {@link GemfireDataSourcePostProcessor}.
 *
 * @author John Blum
 * @see org.junit.Test
 * @see org.mockito.Mockito
 * @see org.apache.geode.cache.Region
 * @see org.apache.geode.cache.RegionAttributes
 * @see org.apache.geode.cache.client.ClientCache
 * @see org.apache.geode.cache.client.ClientRegionFactory
 * @see org.apache.geode.cache.execute.Function
 * @see org.springframework.beans.factory.BeanFactory
 * @see org.springframework.beans.factory.config.ConfigurableBeanFactory
 * @see org.springframework.data.gemfire.client.GemfireDataSourcePostProcessor
 * @see org.springframework.data.gemfire.client.function.ListRegionsOnServerFunction
 * @since 1.7.0
 */
@RunWith(MockitoJUnitRunner.class)
public class GemfireDataSourcePostProcessorTest {

	@Mock
	private ConfigurableBeanFactory mockBeanFactory;

	@Mock
	private ClientCache mockClientCache;

	@SuppressWarnings("unchecked")
	private Region<Object, Object> mockRegion(String name) {

		Region<Object, Object> mockRegion = mock(Region.class, name);

		RegionAttributes<Object, Object> mockRegionAttributes =
			mock(RegionAttributes.class, String.format("%s-RegionAttributes", name));

		when(mockRegion.getParentRegion()).thenReturn(null);
		when(mockRegion.getFullPath()).thenReturn(RegionUtils.toRegionPath(name));
		when(mockRegion.getAttributes()).thenReturn(mockRegionAttributes);
		when(mockRegionAttributes.getDataPolicy()).thenReturn(DataPolicy.PARTITION);
		when(mockRegionAttributes.getScope()).thenReturn(Scope.DISTRIBUTED_ACK);

		return mockRegion;
	}

	private RegionInformation newRegionInformation(Region<?, ?> region) {
		return new RegionInformation(region, false);
	}

	@Test
	public void constructGemfireDataSourcePostProcessor() {

		GemfireDataSourcePostProcessor postProcessor = new GemfireDataSourcePostProcessor();

		assertThat(postProcessor).isNotNull();
		assertThat(postProcessor.getClientRegionShortcut().orElse(null)).isNull();
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.PROXY);
		assertThat(postProcessor.getLogger()).isNotNull();
	}

	@Test
	public void setAndGetBeanFactory() {

		GemfireDataSourcePostProcessor postProcessor = new GemfireDataSourcePostProcessor();

		assertThat(postProcessor).isNotNull();
		assertThat(postProcessor.getBeanFactory().orElse(null)).isNull();

		postProcessor.setBeanFactory(this.mockBeanFactory);

		assertThat(postProcessor.getBeanFactory().orElse(null)).isSameAs(this.mockBeanFactory);
	}

	@Test(expected = TypeMismatchException.class)
	public void setBeanFactoryToIncompatibleTypeThrowsBeansException() {
		new GemfireDataSourcePostProcessor().setBeanFactory(mock(BeanFactory.class));
	}

	@Test(expected = TypeMismatchException.class)
	public void setBeanFactoryToNullThrowsBeansException() {
		new GemfireDataSourcePostProcessor().setBeanFactory(null);
	}

	@Test
	public void setAndGetClientRegionShortcut() {

		GemfireDataSourcePostProcessor postProcessor = new GemfireDataSourcePostProcessor();

		assertThat(postProcessor).isNotNull();
		assertThat(postProcessor.getClientRegionShortcut().orElse(null)).isNull();
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.PROXY);

		postProcessor.setClientRegionShortcut(ClientRegionShortcut.CACHING_PROXY);

		assertThat(postProcessor.getClientRegionShortcut().orElse(null))
			.isEqualTo(ClientRegionShortcut.CACHING_PROXY);
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.CACHING_PROXY);

		postProcessor.setClientRegionShortcut(ClientRegionShortcut.LOCAL);

		assertThat(postProcessor.getClientRegionShortcut().orElse(null))
			.isEqualTo(ClientRegionShortcut.LOCAL);
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.LOCAL);

		postProcessor.setClientRegionShortcut(null);

		assertThat(postProcessor.getClientRegionShortcut().orElse(null)).isNull();
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.PROXY);
	}

	@Test
	public void usingBeanFactory() {

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		assertThat(postProcessor).isNotNull();
		assertThat(postProcessor.getBeanFactory().orElse(null)).isNull();
		assertThat(postProcessor.using(this.mockBeanFactory)).isSameAs(postProcessor);
		assertThat(postProcessor.getBeanFactory().orElse(null)).isSameAs(this.mockBeanFactory);

		verify(postProcessor, times(1)).setBeanFactory(eq(this.mockBeanFactory));
	}

	@Test
	public void usingClientRegionShortcut() {

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor())
			.using(ClientRegionShortcut.LOCAL_PERSISTENT);

		assertThat(postProcessor).isNotNull();
		assertThat(postProcessor.getClientRegionShortcut().orElse(null)).isEqualTo(ClientRegionShortcut.LOCAL_PERSISTENT);
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.LOCAL_PERSISTENT);
		assertThat(postProcessor.using(ClientRegionShortcut.LOCAL_OVERFLOW)).isSameAs(postProcessor);
		assertThat(postProcessor.getClientRegionShortcut().orElse(null)).isEqualTo(ClientRegionShortcut.LOCAL_OVERFLOW);
		assertThat(postProcessor.resolveClientRegionShortcut()).isEqualTo(ClientRegionShortcut.LOCAL_OVERFLOW);

		verify(postProcessor, times(1))
			.setClientRegionShortcut(eq(ClientRegionShortcut.LOCAL_PERSISTENT));

		verify(postProcessor, times(1))
			.setClientRegionShortcut(eq(ClientRegionShortcut.LOCAL_OVERFLOW));
	}

	@Test
	@SuppressWarnings("unchecked")
	public void postProcessAfterInitializationCallsCreateClientRegionProxiesWithRegionNames() {

		String[] testRegionNames = { "Test" };

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		postProcessor.setBeanFactory(this.mockBeanFactory);

		doReturn(Arrays.asList(testRegionNames)).when(postProcessor).regionNames(any(ClientCache.class));

		doAnswer(invocation -> {

			ConfigurableBeanFactory beanFactory = invocation.getArgument(0);
			ClientCache clientCache = invocation.getArgument(1);
			Iterable<String> regionNames = invocation.getArgument(2);

			assertThat(beanFactory).isSameAs(this.mockBeanFactory);
			assertThat(clientCache).isSameAs(this.mockClientCache);
			assertThat(regionNames).containsExactly(testRegionNames);

			return null;

		}).when(postProcessor)
			.createClientProxyRegions(any(ConfigurableBeanFactory.class), any(ClientCache.class), any(Iterable.class));

		postProcessor.postProcessAfterInitialization(this.mockClientCache, "mockClientCache");

		verify(postProcessor, times(1)).regionNames(eq(this.mockClientCache));
		verify(postProcessor, times(1))
			.createClientProxyRegions(eq(this.mockBeanFactory), eq(this.mockClientCache), isA(Iterable.class));
	}

	@Test
	@SuppressWarnings("unchecked")
	public void postProcessAfterInitializationWithNoBeanFactoryDoesNothing() {

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		assertThat(postProcessor.getBeanFactory().orElse(null)).isNull();

		postProcessor.postProcessAfterInitialization(this.mockClientCache, "mockClientCache");

		verify(postProcessor, never()).regionNames(any(ClientCache.class));
		verify(postProcessor, never()).createClientProxyRegions(any(ConfigurableBeanFactory.class),
			any(ClientCache.class), any(Iterable.class));
	}

	@Test
	public void regionNamesWithListRegionsOnServerFunction() {

		String[] expectedRegionNames = { "ExampleOne", "ExampleTwo" };

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		doReturn(Arrays.asList(expectedRegionNames)).when(postProcessor)
			.execute(isA(ClientCache.class), isA(ListRegionsOnServerFunction.class), any());

		Iterable<String> actualRegionNames = postProcessor.regionNames(this.mockClientCache);

		assertThat(actualRegionNames).containsExactly(expectedRegionNames);

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(ListRegionsOnServerFunction.class));

		verify(postProcessor, never()).execute(any(ClientCache.class), any(GetRegionsFunction.class));
	}

	@Test
	public void regionNamesWithGetRegionsFunction() {

		String[] expectedRegionNames = { "ExampleOne", "ExampleTwo" };

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		doThrow(new RuntimeException("FAIL")).when(postProcessor)
			.execute(isA(ClientCache.class), isA(ListRegionsOnServerFunction.class), any());

		doAnswer(invocation ->
			Arrays.stream(expectedRegionNames)
				.map(this::mockRegion)
				.map(this::newRegionInformation)
				.collect(Collectors.toList())
				.toArray()
		).when(postProcessor).execute(isA(ClientCache.class), isA(GetRegionsFunction.class), any());

		List<String> actualRegionNames =
			StreamSupport.stream(postProcessor.regionNames(this.mockClientCache).spliterator(), false)
				.collect(Collectors.toList());

		assertThat(actualRegionNames).containsExactly(expectedRegionNames);

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(ListRegionsOnServerFunction.class));

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(GetRegionsFunction.class));
	}

	@Test
	public void regionNamesWithGetRegionsFunctionReturningNoResults() {

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		doThrow(new RuntimeException("FAIL")).when(postProcessor)
			.execute(any(ClientCache.class), isA(ListRegionsOnServerFunction.class), any());

		doReturn(null).when(postProcessor)
			.execute(any(ClientCache.class), isA(GetRegionsFunction.class), any());

		Iterable<String> actualRegionNames = postProcessor.regionNames(this.mockClientCache);

		assertThat(actualRegionNames).isNotNull();
		assertThat(actualRegionNames).isEmpty();

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(ListRegionsOnServerFunction.class));

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(GetRegionsFunction.class));
	}

	@Test
	public void regionNamesWithGetRegionsFunctionThrowingException() {

		GemfireDataSourcePostProcessor postProcessor = spy(new GemfireDataSourcePostProcessor());

		doAnswer(invocation -> {

			Function function = invocation.getArgument(0);

			throw newIllegalArgumentException("Function [%1$s] with ID [%2$s] not registered",
				function.getClass().getName(), function.getId());

		}).when(postProcessor).execute(any(ClientCache.class), any(Function.class), any());

		Iterable<String> actualRegionNames = postProcessor.regionNames(this.mockClientCache);

		assertThat(actualRegionNames).isNotNull();
		assertThat(actualRegionNames).isEmpty();

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(ListRegionsOnServerFunction.class));

		verify(postProcessor, times(1))
			.execute(eq(this.mockClientCache), isA(GetRegionsFunction.class));

		verify(postProcessor, times(1))
			.logDebug(startsWith("Failed to determine the Regions available on the Server:"), any());
	}

	@Test
	public void containsRegionInformationIsTrue() {
		assertThat(new GemfireDataSourcePostProcessor()
			.containsRegionInformation(new Object[] { newRegionInformation(mockRegion("Example")) }))
				.isTrue();
	}

	@Test
	public void containsRegionInformationWithEmptyArrayIsFalse() {
		assertThat(new GemfireDataSourcePostProcessor().containsRegionInformation(new Object[0])).isFalse();
	}

	@Test
	public void containsRegionInformationWithListOfRegionInformationIsFalse() {
		assertThat(new GemfireDataSourcePostProcessor()
			.containsRegionInformation(Collections.singletonList(newRegionInformation(mockRegion("Example")))))
				.isFalse();
	}

	@Test
	public void containsRegionInformationWithNonEmptyArrayContainingNonRegionInformationIsFalse() {
		assertThat(new GemfireDataSourcePostProcessor().containsRegionInformation(new Object[] { "TEST" })).isFalse();
	}

	@Test
	public void containsRegionInformationWithNullIsFalse() {
		assertThat(new GemfireDataSourcePostProcessor().containsRegionInformation(null)).isFalse();
	}

	@Test
	@SuppressWarnings("unchecked")
	public void createClientProxyRegionsIsSuccessful() {

		ClientRegionFactory mockClientRegionFactory = mock(ClientRegionFactory.class);

		when(this.mockClientCache.createClientRegionFactory(eq(ClientRegionShortcut.PROXY)))
			.thenReturn(mockClientRegionFactory);

		Region mockRegionOne = mock(Region.class, "MockGemFireRegionOne");
		Region mockRegionTwo = mock(Region.class, "MockGemFireRegionTwo");

		Map<String, Region<?, ?>> regionMap = new HashMap<>(2);

		regionMap.put("RegionOne", mockRegionOne);
		regionMap.put("RegionTwo", mockRegionTwo);

		doAnswer(invocation -> {

			String regionName = invocation.getArgument(0);

			assertThat(regionMap.containsKey(regionName)).isTrue();

			return regionMap.get(regionName);

		}).when(mockClientRegionFactory).create(any(String.class));

		when(mockBeanFactory.containsBean(any(String.class))).thenReturn(false);

		GemfireDataSourcePostProcessor postProcessor = new GemfireDataSourcePostProcessor();

		postProcessor.createClientProxyRegions(this.mockBeanFactory, this.mockClientCache, regionMap.keySet());

		verify(this.mockClientCache, times(1)).createClientRegionFactory(eq(ClientRegionShortcut.PROXY));
		verify(mockClientRegionFactory, times(1)).create(eq("RegionOne"));
		verify(mockClientRegionFactory, times(1)).create(eq("RegionTwo"));
		verify(this.mockBeanFactory, times(1)).registerSingleton(eq("RegionOne"), same(mockRegionOne));
		verify(this.mockBeanFactory, times(1)).registerSingleton(eq("RegionTwo"), same(mockRegionTwo));
	}

	@Test
	@SuppressWarnings("unchecked")
	public void createClientProxyRegionsWhenRegionBeanExists() {

		ClientRegionFactory mockClientRegionFactory = mock(ClientRegionFactory.class);

		when(this.mockClientCache.createClientRegionFactory(eq(ClientRegionShortcut.PROXY)))
			.thenReturn(mockClientRegionFactory);

		Region mockRegion = mock(Region.class);

		when(this.mockBeanFactory.containsBean(any(String.class))).thenReturn(true);
		when(this.mockBeanFactory.getBean(eq("Example"))).thenReturn(mockRegion);

		GemfireDataSourcePostProcessor postProcessor = new GemfireDataSourcePostProcessor();

		postProcessor.createClientProxyRegions(this.mockBeanFactory, this.mockClientCache, Collections.singletonList("Example"));

		verify(this.mockClientCache, times(1)).createClientRegionFactory(eq(ClientRegionShortcut.PROXY));
		verify(mockClientRegionFactory, never()).create(any(String.class));
		verify(this.mockBeanFactory, never()).registerSingleton(any(String.class), any(Region.class));
	}
}
